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, isExtended, langCode, offset, limit

);

Parametreler şeması

Şema

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

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

body: object
İstek gövdesi
örnek:

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

isExtended: number
Ek alanları 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

Varsayılan olarak, 10 nesne alabilirsiniz. Bu, modülün izin ayarlarında kayıt limitinden kaynaklanmaktadır.
Sayfalamanın doğru çalışması için, ihtiyaçlarınıza göre Modül izinlerini ilgili bölümde yapılandırmanız gerekmektedir.

Ö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": 5794,
"formIdentifier": "test-form",
"time": "2026-04-14T14:53:27.413Z",
"formData": [
{
"marker": "name",
"type": "string",
"value": "Test"
}
],
"attributeSetIdentifier": "form",
"moduleIdentifier": "content"
},
{
"id": 5777,
"formIdentifier": "test-form",
"time": "2026-04-14T13:22:33.279Z",
"formData": [
{
"marker": "name",
"type": "string",
"value": "Test"
}
],
"attributeSetIdentifier": "form",
"moduleIdentifier": "content"
},
{
"id": 5760,
"formIdentifier": "test-form",
"time": "2026-04-14T13:20:53.653Z",
"formData": [
{
"marker": "name",
"type": "string",
"value": "Test"
}
],
"attributeSetIdentifier": "form",
"moduleIdentifier": "content"
},
"..."
],
"total": 686
}

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
}
]

items.id: number
Form sayfasının benzersiz tanımlayıcısı.
örnek: 12345

items.parentId: null | number
Üst form sayfasının benzersiz tanımlayıcısı.
örnek: 123

items.formIdentifier: string
Sayfanın tanımlayıcısı.
örnek: "contact_form"

items.depth: number
**
örnek: 1

items.ip: string | null
Ip.
örnek: '127.0.0.1'

items.fingerprint: string | null
Fingerprint.
örnek: 'fingerprint'

items.status: string | null
Durum.
örnek: 'approved'

items.userIdentifier: string | null
Kullanıcının metin tanımlayıcısı (marker).
örnek: "admin"

items.formData: FormDataType[]
Form verisi.
örnek:

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

items.attributeSetIdentifier: string | null
Kullanılan özellik setinin metin tanımlayıcısı (marker).
örnek: "product_attributes"

items.time: Date | string
Formun tanımlayıcısı.
örnek: "2023-10-01T12:00:00Z"

items.entityIdentifier: string
Varlığın metin tanımlayıcısı (marker).
örnek: "test"

items.isUserAdmin: boolean
Kullanıcı admin mi.
örnek: true

items.formModuleConfigId: number
Form modülü yapılandırma ID'si.
örnek: 2

items.moduleIdentifier: string
Modül tanımlayıcısı.
örnek: "blog"

items.entityId: number
Form modülü yapılandırma ID'si.
örnek: 2

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