Ana içeriğe geç

getFormsDataByMarker

Metin tanımlayıcısına (marker) göre form verilerini arama.

Açıklama​

Bu yöntem, API'den belirli bir form veri nesnesini marker'ına göre alır. Form verisinin marker'ı olarak bir marker parametresi kabul eder. FormDataEntity türünde nesnelerden oluşan bir dizi döndüren bir Promise döner.

FormData.getFormsDataByMarker(

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

);

Parametreler şeması​

Şema

marker(required): string
Formun marker'ı
örnek: "contact_form"

formModuleConfigId(required): number
Form modülü yapılandırma ID'si
örnek: 4

body: object
İstek gövdesi
örnek:

{
  "entityIdentifier": "test",
  "userIdentifier": "",
  "status": "",
  "dateFrom": "2025-08-11",
  "dateTo": ""
}

isNested: any
Hiyerarşik verileri almak için bayrak
örnek: 1

langCode: string
Dil kodu. Varsayılan: "en_US"
örnek: "en_US"

offset: number
Sayfalama için parametre. Varsayılan: 0
örnek: 0

limit: number
Sayfalama için parametre. Varsayılan: 30
örnek: 30

Örnekler​

Minimal örnek​

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

Özelliklerle örnek​

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

Örnek yanıt​

{
  "items": [
    {
      "id": 42,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "fingerprint": 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
    },
    {
      "id": 43,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "fingerprint": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:51:43.596Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    {
      "id": 44,
      "parentId": null,
      "formIdentifier": "test-form",
      "depth": 0,
      "ip": null,
      "fingerprint": null,
      "status": null,
      "userIdentifier": null,
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "time": "2025-03-03T15:52:00.625Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    "..."
  ],
  "total": 341
}

Yanıt şeması​

Şema: IFormsDataEntity

items: IFormByMarkerDataEntity[]
Form veri nesneleri dizisi.
örnek:

[
  {
    "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
  }
]

total: number
Bulunan kayıtların toplam sayısı.
örnek: 100