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ódigo 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": 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
}

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

items.id: number
O identificador único da página do formulário.
exemplo: 12345

items.parentId: null | number
O identificador único da página do formulário pai.
exemplo: 123

items.formIdentifier: string
O identificador da página.
exemplo: "contact_form"

items.depth: number
**
exemplo: 1

items.ip: string | null
Ip.
exemplo: '127.0.0.1'

items.fingerprint: string | null
Fingerprint.
exemplo: 'fingerprint'

items.status: string | null
Status.
exemplo: 'approved'

items.userIdentifier: string | null
Identificador de texto (marcador) do usuário.
exemplo: "admin"

items.formData: FormDataType[]
Dados do formulário.
exemplo:

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

items.attributeSetIdentifier: string | null
Identificador de texto (marcador) do conjunto de atributos utilizado.
exemplo: "product_attributes"

items.time: Date | string
O identificador do formulário.
exemplo: "2023-10-01T12:00:00Z"

items.entityIdentifier: string
Identificador de texto (marcador) da entidade.
exemplo: "test"

items.isUserAdmin: boolean
O usuário é administrador.
exemplo: true

items.formModuleConfigId: number
ID de configuração do módulo de formulário.
exemplo: 2

items.moduleIdentifier: string
Identificador do módulo.
exemplo: "blog"

items.entityId: number
ID de configuração do módulo de formulário.
exemplo: 2

total: number
Número total de registros encontrados.
exemplo: 100

---