getFormsDataByMarker

Tìm kiếm dữ liệu biểu mẫu theo định danh văn bản (marker).

Mô tả

Phương thức này lấy một đối tượng dữ liệu biểu mẫu cụ thể theo marker của nó từ API. Nó chấp nhận tham số marker như là marker của dữ liệu biểu mẫu. Nó trả về một Promise mà khi hoàn thành sẽ trả về một mảng các đối tượng thuộc loại FormDataEntity.

FormData.getFormsDataByMarker(

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

);

Sơ đồ tham số

Sơ đồ

marker(bắt buộc): string
Marker của biểu mẫu
ví dụ: "contact_form"

formModuleConfigId(bắt buộc): number
ID cấu hình mô-đun biểu mẫu
ví dụ: 4

body: object
Nội dung yêu cầu
ví dụ:

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

isExtended: number
Cờ để lấy các trường bổ sung
ví dụ: 1

langCode: string
Mã ngôn ngữ. Mặc định: "en_US"
ví dụ: "en_US"

offset: number
Tham số cho phân trang. Mặc định: 0
ví dụ: 0

limit: number
Tham số cho phân trang. Mặc định: 30
ví dụ: 30

Mặc định, bạn có thể lấy 10 đối tượng. Điều này là do giới hạn bản ghi trong cài đặt quyền của mô-đun.
Để phân trang hoạt động chính xác, bạn cần cấu hình Quyền mô-đun theo nhu cầu của bạn trong phần tương ứng.

Ví dụ

Ví dụ tối thiểu

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

Ví dụ với các thuộc tính

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

Ví dụ phản hồi

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

Sơ đồ phản hồi

Sơ đồ: IFormsDataEntity

items: IFormByMarkerDataEntity[]
Mảng các đối tượng dữ liệu biểu mẫu.
ví dụ:

[
  {
    "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
Định danh duy nhất của trang biểu mẫu.
ví dụ: 12345

items.parentId: null | number
Định danh duy nhất của trang biểu mẫu cha.
ví dụ: 123

items.formIdentifier: string
Định danh của trang.
ví dụ: "contact_form"

items.depth: number
**
ví dụ: 1

items.ip: string | null
Ip.
ví dụ: '127.0.0.1'

items.fingerprint: string | null
Fingerprint.
ví dụ: 'fingerprint'

items.status: string | null
Trạng thái.
ví dụ: 'approved'

items.userIdentifier: string | null
Định danh văn bản (marker) của người dùng.
ví dụ: "admin"

items.formData: FormDataType[]
Dữ liệu biểu mẫu.
ví dụ:

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

items.attributeSetIdentifier: string | null
Định danh văn bản (marker) của bộ thuộc tính đã sử dụng.
ví dụ: "product_attributes"

items.time: Date | string
Định danh của biểu mẫu.
ví dụ: "2023-10-01T12:00:00Z"

items.entityIdentifier: string
Định danh văn bản (marker) của thực thể.
ví dụ: "test"

items.isUserAdmin: boolean
Người dùng có phải là admin không.
ví dụ: true

items.formModuleConfigId: number
ID cấu hình mô-đun biểu mẫu.
ví dụ: 2

items.moduleIdentifier: string
Định danh mô-đun.
ví dụ: "blog"

items.entityId: number
ID cấu hình mô-đun biểu mẫu.
ví dụ: 2

total: number
Tổng số bản ghi tìm thấy.
ví dụ: 100

---