Saltar al contenido principal

getFormsDataByMarker

Buscando datos de formularios por identificador de texto (marcador).

Descripción​

Este método recupera un objeto de datos de formulario específico por su marcador desde la API. Acepta un parámetro de marcador como el marcador de los datos del formulario. Devuelve una Promesa que se resuelve en un array de objetos del tipo FormDataEntity.

FormData.getFormsDataByMarker(

marker, formModuleConfigId, body, isNested, langCode, offset, limit

);

Esquema de parámetros​

Esquema

marker(requerido): string
Marcador del formulario
ejemplo: "contact_form"

formModuleConfigId(requerido): number
ID de configuración del módulo de formulario
ejemplo: 4

body: object
Cuerpo de la solicitud
ejemplo:

{
  "entityIdentifier": "test",
  "userIdentifier": "",
  "status": "",
  "dateFrom": "2025-08-11",
  "dateTo": ""
}

isNested: any
Indicador para obtener datos jerárquicos
ejemplo: 1

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

offset: number
Parámetro para paginación. Predeterminado: 0
ejemplo: 0

limit: number
Parámetro para paginación. Predeterminado: 30
ejemplo: 30

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con atributos​

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

Ejemplo de respuesta​

{
  "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 respuesta​

Esquema: IFormsDataEntity

items: IFormByMarkerDataEntity[]
Array de objetos de datos de formulario.
ejemplo:

  [
    {
      "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.
ejemplo: 100