Pular para o conteúdo principal

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, isNested, 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": "test",
  "userIdentifier": "",
  "status": "",
  "dateFrom": "2025-08-11",
  "dateTo": ""
}

isNested: any
Flag para obter dados hierárquicos
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

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": 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
    },
    {
      "id": 43,
      "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:43.596Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    {
      "id": 44,
      "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:52:00.625Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    },
    "..."
  ],
  "total": 213
}

Esquema de resposta​

Esquema: IFormsDataEntity

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

  [
    {
      "id": 43,
      "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:43.596Z",
      "entityIdentifier": "blog",
      "isUserAdmin": false,
      "formModuleConfigId": 2
    }
  ]

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