Lewati ke konten utama

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: object
Badan permintaan
contoh:

{
  "entityIdentifier": 14,
  "entityparentIdentifier": 167,
  "userIdentifier": "",
  "status": [
    "new",
    "approved"
  ],
  "dateFrom": "2025-01-01",
  "dateTo": ""
}

isExtended: number
Tanda untuk mendapatkan bidang 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 batasan 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');

Contoh dengan atribut​

const response = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30);

Contoh respons​

{
  "items": [
    {
      "id": 6740,
      "formIdentifier": "test-form",
      "time": "2026-06-07T13:31:57.741Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 6738,
      "formIdentifier": "test-form",
      "time": "2026-06-07T08:06:47.851Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 6721,
      "formIdentifier": "test-form",
      "time": "2026-06-07T08:02:56.300Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    "..."
  ],
  "total": 748
}

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.
contoh: 'approved'

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

items.formData: FormDataType[]
Data formulir.
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