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, isExtended, 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": 14,
  "entityparentIdentifier": 167,
  "userIdentifier": "",
  "status": [
    "new",
    "approved"
  ],
  "dateFrom": "2025-01-01",
  "dateTo": ""
}

isExtended: number
Indicador para obtener campos adicionales
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

Por defecto, puedes recuperar 10 objetos. Esto se debe al límite de registros en la configuración de permisos del módulo.
Para que la paginación funcione correctamente, necesitas configurar Permisos del módulo de acuerdo a tus necesidades en la sección correspondiente.

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": 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 respuesta

Esquema: IFormsDataEntity

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

[
  {
    "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
El identificador único de la página del formulario.
ejemplo: 12345

items.parentId: null | number
El identificador único de la página del formulario padre.
ejemplo: 123

items.formIdentifier: string
El identificador de la página.
ejemplo: "contact_form"

items.depth: number
**
ejemplo: 1

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

items.fingerprint: string | null
Huella digital.
ejemplo: 'fingerprint'

items.status: string | null
Estado.
ejemplo: 'approved'

items.userIdentifier: string | null
Identificador de texto (marcador) del usuario.
ejemplo: "admin"

items.formData: FormDataType[]
Datos del formulario.
ejemplo:

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

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

items.time: Date | string
El identificador del formulario.
ejemplo: "2023-10-01T12:00:00Z"

items.entityIdentifier: string
Identificador de texto (marcador) de la entidad.
ejemplo: "test"

items.isUserAdmin: boolean
¿Es el usuario administrador?
ejemplo: true

items.formModuleConfigId: number
ID de configuración del módulo de formulario.
ejemplo: 2

items.moduleIdentifier: string
Identificador del módulo.
ejemplo: "blog"

items.entityId: number
ID de configuración del módulo de formulario.
ejemplo: 2

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

---