getFormsDataByMarker

Mencari data formulir berdasarkan pengidentifikasi teks (marker).

Deskripsi

Metode ini mengambil objek data formulir tertentu berdasarkan markernya dari API. Ini menerima parameter marker sebagai marker dari data formulir. Ini mengembalikan Promise yang menyelesaikan menjadi array objek dari tipe FormDataEntity.

FormData.getFormsDataByMarker(

marker*, formModuleConfigId*, body, isExtended, langCode, offset, limit

);

Skema parameter

Skema

marker(diperlukan): string
Marker dari formulir
contoh: "contact_form"

formModuleConfigId(diperlukan): number
ID konfigurasi modul formulir
contoh: 4

body: IFormsDataFilter
Filter untuk catatan yang akan dikembalikan. Setiap field bersifat opsional; yang dihilangkan atau kosong tidak diterapkan
contoh:

{
  "entityIdentifier": "blog",
  "parentId": 10,
  "userIdentifier": "",
  "status": [
    "moderation",
    "approved"
  ],
  "dateFrom": "2025-01-01",
  "dateTo": ""
}

body.entityIdentifier: string | number
Pengidentifikasi entitas yang dimiliki catatan; string kosong berarti "tanpa filter". Marker teks untuk entitas konten ("blog"), ID numerik untuk produk (2954), login untuk pengguna dan admins.
contoh: "blog"

body.parentId: number
Pengidentifikasi catatan induk — cara untuk mengambil balasan untuk satu komentar.
contoh: 10

body.userIdentifier: string
Pengidentifikasi teks dari pengirim; string kosong berarti "tanpa filter".
contoh: "admin"

body.status: FormDataStatus[]
Status moderasi yang akan dipertahankan. Harus berupa array — string biasa ditolak dengan 400. Array kosong berarti "tanpa filter".
contoh: ["approved"]

body.dateFrom: string
Batas bawah tanggal pengiriman, YYYY-MM-DD; string kosong berarti "tanpa batas" — getFormsDataByMarker menghilangkannya dari body, karena endpoint menolak tanggal kosong dengan 400. Nilai yang tidak kosong yang tidak dapat diparsing oleh API tetap gagal dalam permintaan.
contoh: "2025-01-01"

body.dateTo: string
Batas atas tanggal pengiriman, YYYY-MM-DD; string kosong berarti "tanpa batas", ditangani seperti dateFrom.
contoh: "2025-12-31"

isExtended: number
Tanda untuk mendapatkan field tambahan
contoh: 1

langCode: string
Kode bahasa. Default: "en_US"
contoh: "en_US"

offset: number
Parameter untuk paginasi. Default: 0
contoh: 0

limit: number
Parameter untuk paginasi. Default: 30
contoh: 30

Secara default, Anda dapat mengambil 10 objek. Ini disebabkan oleh batas catatan dalam pengaturan izin modul.
Agar paginasi berfungsi dengan benar, Anda perlu mengonfigurasi Izin Modul sesuai kebutuhan Anda di bagian yang sesuai.

Contoh

Contoh minimal

const response = await FormData.getFormsDataByMarker('my-marker', 2);

Contoh dengan filter

const response = await FormData.getFormsDataByMarker(
    'my-marker',
    2,
    { entityIdentifier: 'blog', status: ['approved'] },
    0,
    'en_US',
    0,
    30,
);

formData kembali tanpa pembungkus lokal

API mengembalikan field setiap catatan yang dibungkus oleh bahasa — "formData": { "en_US": [ … ] } — dan SDK membongkarnya untuk langCode yang diminta. Baca record.formData sebagai array; record.formData[langCode] adalah undefined dan tidak menghasilkan apa-apa. Ini berlaku untuk kedua nilai isExtended.

Contoh respons

{
  "items": [
    {
      "id": 8938,
      "formIdentifier": "test-form",
      "time": "2026-09-25T17:03:14.498Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content",
      "entityIdentifier": "blog",
      "entityId": 8,
      "formModuleConfigId": 2
    },
    {
      "id": 8921,
      "formIdentifier": "test-form",
      "time": "2026-09-25T17:02:47.269Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content",
      "entityIdentifier": "blog",
      "entityId": 8,
      "formModuleConfigId": 2
    },
    {
      "id": 8904,
      "formIdentifier": "test-form",
      "time": "2026-09-25T17:01:47.534Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content",
      "entityIdentifier": "blog",
      "entityId": 8,
      "formModuleConfigId": 2
    },
    "..."
  ],
  "total": 885
}

Skema respons

Skema: IFormsDataEntity

items: IFormByMarkerDataEntity[]
Array objek data formulir.
contoh:

[
  {
    "id": 42,
    "parentId": null,
    "formIdentifier": "test-form",
    "depth": 0,
    "ip": null,
    "status": null,
    "userIdentifier": null,
    "formData": [
      {
        "marker": "name",
        "type": "string",
        "value": "Test"
      }
    ],
    "attributeSetIdentifier": "form",
    "time": "2025-03-03T15:51:17.458Z",
    "entityIdentifier": "blog",
    "isUserAdmin": false,
    "formModuleConfigId": 2
  }
]

items.id: number
Pengidentifikasi unik dari halaman formulir.
contoh: 12345

items.parentId: null | number
Pengidentifikasi unik dari halaman formulir induk.
contoh: 123

items.formIdentifier: string
Pengidentifikasi dari halaman.
contoh: "contact_form"

items.depth: number
**
contoh: 1

items.ip: string | null
Ip.
contoh: '127.0.0.1'

items.fingerprint: string | null
Fingerprint.
contoh: 'fingerprint'

items.status: string | null
Status moderasi dari catatan: "sent", "moderation", "approved", "banned" atau "deleted"; null ketika formulir tidak dimoderasi.
contoh: 'approved'

items.userIdentifier: string | null
Pengidentifikasi teks (marker) dari pengguna.
contoh: "admin"

items.formData: FormDataType[]
Field yang diajukan, sudah dibongkar dari lokal: API mengembalikan { "en_US": [ … ] } dan SDK menyerahkan array untuk langCode yang diminta. Baca formData langsung — formData[langCode] adalah undefined.
contoh:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Test"
  }
]

items.attributeSetIdentifier: string | null
Pengidentifikasi teks (marker) dari set atribut yang digunakan.
contoh: "product_attributes"

items.time: Date | string
Pengidentifikasi dari formulir.
contoh: "2023-10-01T12:00:00Z"

items.entityIdentifier: string
Pengidentifikasi teks (marker) dari entitas.
contoh: "test"

items.isUserAdmin: boolean
Apakah pengguna adalah admin.
contoh: true

items.formModuleConfigId: number
ID konfigurasi modul formulir.
contoh: 2

items.moduleIdentifier: string
Pengidentifikasi modul.
contoh: "blog"

items.entityId: number
ID konfigurasi modul formulir.
contoh: 2

total: number
Total jumlah catatan yang ditemukan.
contoh: 100

---