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 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: IFormsDataFilter
Lọc các bản ghi để trả về. Mỗi trường là tùy chọn; một trường bị bỏ qua hoặc để trống sẽ không được áp dụng
ví dụ:

{
  "entityIdentifier": "blog",
  "parentId": 10,
  "userIdentifier": "",
  "status": [
    "moderation",
    "approved"
  ],
  "dateFrom": "2025-01-01",
  "dateTo": ""
}

body.entityIdentifier: string
Định danh văn bản (marker) của thực thể mà các bản ghi thuộc về; một chuỗi trống có nghĩa là "không lọc".
ví dụ: "blog"

body.parentId: number
Định danh của bản ghi cha — cách để lấy phản hồi cho một bình luận.
ví dụ: 10

body.userIdentifier: string
Định danh văn bản của người gửi; một chuỗi trống có nghĩa là "không lọc".
ví dụ: "admin"

body.status: FormDataStatus[]
Các trạng thái kiểm duyệt để giữ lại. Phải là một mảng — một chuỗi đơn sẽ bị từ chối với 400. Một mảng trống có nghĩa là "không lọc".
ví dụ: ["approved"]

body.dateFrom: string
Giới hạn dưới của ngày gửi, YYYY-MM-DD; một chuỗi trống có nghĩa là "không giới hạn". Một giá trị mà API không thể phân tích sẽ làm thất bại yêu cầu với 500.
ví dụ: "2025-01-01"

body.dateTo: string
Giới hạn trên của ngày gửi, YYYY-MM-DD; một chuỗi trống có nghĩa là "không giới hạn".
ví dụ: "2025-12-31"

isExtended: number
Cờ để lấy thêm các trường
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

Theo 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', 2);

Ví dụ với bộ lọc

const response = await FormData.getFormsDataByMarker(
    'my-marker',
    2,
    { entityIdentifier: 'blog', status: ['approved'] },
    0,
    'en_US',
    0,
    30,
);

formData trở lại mà không có bao bọc ngôn ngữ

API trả về các trường của mỗi bản ghi được bao bọc theo ngôn ngữ — "formData": { "en_US": [ … ] } — và SDK sẽ giải nén chúng cho langCode được yêu cầu. Đọc record.formData như một mảng; record.formData[langCode] là undefined và không trả về gì cả. Điều này áp dụng cho cả hai giá trị của isExtended.

Ví dụ phản hồi

{
  "items": [
    {
      "id": 8409,
      "formIdentifier": "test-form",
      "time": "2026-08-23T17:47:58.472Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 8392,
      "formIdentifier": "test-form",
      "time": "2026-08-23T14:37:47.250Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    {
      "id": 8375,
      "formIdentifier": "test-form",
      "time": "2026-08-23T14:31:26.065Z",
      "formData": [
        {
          "marker": "name",
          "type": "string",
          "value": "Test"
        }
      ],
      "attributeSetIdentifier": "form",
      "moduleIdentifier": "content"
    },
    "..."
  ],
  "total": 853
}

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 kiểm duyệt của bản ghi: "đã gửi", "kiểm duyệt", "được phê duyệt", "bị cấm" hoặc "đã xóa"; null khi biểu mẫu không được kiểm duyệt.
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[]
Các trường đã gửi, đã được giải nén từ ngôn ngữ: API trả về { "en_US": [ … ] } và SDK chuyển giao mảng cho langCode được yêu cầu. Đọc formData trực tiếp — formData[langCode] là undefined.
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

---