getFormsDataByMarker

Buscando dados de formulário por identificador de texto (marcador).

Descrição

Este método recupera um objeto de dados de formulário específico pelo seu marcador da API. Ele aceita um parâmetro de marcador como o marcador dos dados do formulário. Retorna uma Promise que resolve para um array de objetos do tipo FormDataEntity.

FormData.getFormsDataByMarker(

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

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador do formulário
exemplo: "contact_form"

formModuleConfigId(obrigatório): number
ID de configuração do módulo de formulário
exemplo: 4

body: object
Corpo da solicitação
exemplo:

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

isExtended: number
Flag para obter campos adicionais
exemplo: 1

langCode: string
Códig do idioma. Padrão: "en_US"
exemplo: "en_US"

offset: number
Parâmetro para paginação. Padrão: 0
exemplo: 0

limit: number
Parâmetro para paginação. Padrão: 30
exemplo: 30

Por padrão, você pode recuperar 10 objetos. Isso se deve ao limite de registro nas configurações de permissões do módulo.
Para que a paginação funcione corretamente, você precisa configurar as Permissões do módulo de acordo com suas necessidades na seção correspondente.

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

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

Esquema de resposta

Esquema: IFormsDataEntity

items: IFormByMarkerDataEntity[]
Array de objetos de dados de formulário.
exemplo:

[
  {
    "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
Total de registros encontrados.
exemplo: 100

---