getFormsDataByMarker

البحث عن بيانات النموذج بواسطة معرف نصي (علامة).

الوصف

تسترجع هذه الطريقة كائن بيانات نموذج محدد بواسطة علامته من واجهة برمجة التطبيقات (API). تقبل معلمة العلامة كعلامة لبيانات النموذج. تعيد وعدًا (Promise) يتم حله إلى مصفوفة من كائنات من نوع FormDataEntity.

FormData.getFormsDataByMarker(
marker*,
formModuleConfigId*,
body,
isExtended,
langCode,
offset,
limit
);

مخطط المعلمات

المخطط

marker(مطلوب): string
علامة النموذج
مثال: "contact_form"

formModuleConfigId(مطلوب): number
معرف تكوين وحدة النموذج
مثال: 4

body: object
جسم الطلب
مثال:

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

isExtended: number
علامة للحصول على حقول إضافية
مثال: 1

langCode: string
رمز اللغة. الافتراضي: "en_US"
مثال: "en_US"

offset: number
معلمة للتصفح. الافتراضي: 0
مثال: 0

limit: number
معلمة للتصفح. الافتراضي: 30
مثال: 30

بشكل افتراضي، يمكنك استرجاع 10 كائنات. وذلك بسبب حد السجلات في إعدادات أذونات الوحدة.
لعمل التصفح بشكل صحيح، تحتاج إلى تكوين أذونات الوحدة وفقًا لاحتياجاتك في القسم المقابل.

أمثلة

مثال بسيط

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

مثال مع السمات

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

مثال على الاستجابة

{
  "items": [
    {
      "id": 3464,
      "formIdentifier": "test-form",
      "time": "2026-01-07T04:10:50.809Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 3447,
      "formIdentifier": "test-form",
      "time": "2026-01-07T02:09:20.987Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 3430,
      "formIdentifier": "test-form",
      "time": "2026-01-07T00:05:59.818Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    "..."
  ],
  "total": 518
}

مخطط الاستجابة

المخطط: IFormsDataEntity

items: IFormByMarkerDataEntity[]
مصفوفة من كائنات بيانات النموذج.
مثال:

[
  {
    "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
إجمالي عدد السجلات التي تم العثور عليها.
مثال: 100

getFormsDataByMarker

الوصف​

مخطط المعلمات​

أمثلة​

مثال بسيط​

مثال مع السمات​

مثال على الاستجابة​

مخطط الاستجابة​