getAllForms
Obtener todos los formularios.
Descripción
Obtiene formularios con paginación. Se resuelve en un IFormsResponse: los formularios están en items y el recuento en total.
.getAllForms(
,
,
);
Esquema de parámetros
Esquema
langCode: string
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"
offset: number
Número de registros que se omiten. Predeterminado: 0. offset + limit no debe superar 200; una ventana mayor se rechaza con 400.
ejemplo: 0
limit: number
Número máximo de registros que se devuelven. Predeterminado: 30.
ejemplo: 30
Límite de registros. Si el permiso del grupo de usuarios para este método solo permite lectura restringida, la API devuelve como máximo el número de registros configurado en los ajustes del proyecto (10 por defecto), sin importar el limit que pases. Con acceso de lectura completo, limit funciona con normalidad. Consulta Module permissions (abre en una nueva pestaña).
Ejemplos
Ejemplo mínimo
const response = await Forms.getAllForms();
Ejemplo con parámetros opcionales
const response = await Forms.getAllForms('en_US', 0, 30);
Ejemplo de respuesta
{
"items": [
{
"id": 4,
"attributeSetId": 11,
"type": "data",
"localizeInfos": {
"title": "user_form",
"titleForSite": "",
"successMessage": "",
"unsuccessMessage": "",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 10,
"position": 1,
"identifier": "user_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name_attr",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "name"
},
"additionalFields": {}
},
{
"type": "string",
"marker": "username",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "username"
},
"additionalFields": {}
},
{
"type": "string",
"marker": "password",
"position": 3,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "password"
},
"additionalFields": {}
}
]
},
{
"id": 6,
"attributeSetId": 15,
"type": "data",
"localizeInfos": {
"title": "Test form",
"titleForSite": "",
"successMessage": "",
"unsuccessMessage": "",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 15,
"position": 2,
"identifier": "test-form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data"
}
}
},
{
"type": "file",
"marker": "file",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {}
}
]
},
{
"id": 7,
"attributeSetId": 15,
"type": "data",
"localizeInfos": {
"title": "File form",
"titleForSite": "Form title (for application)",
"successMessage": "Message about successful data processing",
"unsuccessMessage": "Message about unsuccessful data processing",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 16,
"position": 3,
"identifier": "file_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data"
}
}
},
{
"type": "file",
"marker": "file",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {}
}
]
}
],
"total": 9
}
Esquema de respuesta
Esquema: IFormsResponse
total: number
Número total de formularios.
items: IFormsEntity[]
Formularios de esta respuesta.
items.id: number
ID del formulario.
ejemplo: 12345
items.attributeSetId: number | null
ID del conjunto de atributos que usa el formulario, o null si no hay ninguno.
ejemplo: 1234
items.type: string | null
Tipo de formulario.
ejemplo: "contact"
items.localizeInfos: IFormLocalizeInfo
Nombre localizado del formulario y textos del formulario, como los mensajes de éxito y de error.
ejemplo:
{
"title": "Example title"
}
items.version: number
Número de versión del objeto; cambia con cada actualización.
ejemplo: 1
items.position: number
Posición del formulario, empezando por 1, en la lista completa ordenada por ID; con offset, la numeración continúa desde offset + 1. Siempre 1 en getFormByMarker().
ejemplo: 1
items.identifier: string
Marcador del formulario.
ejemplo: "form_contact_us"
items.processingType: string
Cómo se procesan los envíos del formulario, por ejemplo "email" o "url".
ejemplo: "async"
items.templateId: number | null
ID de la plantilla que usa el formulario, o null si el formulario no tiene plantilla.
ejemplo: 6789
items.attributes: IFormAttribute[]
Campos del formulario con su localización, validadores e indicadores propios del formulario, ordenados por position. La API devuelve un objeto vacío para formularios sin atributos; el SDK lo normaliza a un array vacío.
items.total: number | string
Recuento interno de filas que getFormByMarker() devuelve por error (siempre "1"); no te bases en él. No aparece en los elementos de getAllForms(); usa en su lugar el total de nivel superior.
ejemplo: "1"
items.moduleFormConfigs: IFormConfig[]
Vinculaciones del formulario con módulos. Solo lo devuelve getFormByMarker(); getAllForms() lo omite.
Ejemplos de uso
Guía paso a paso en la documentación:
- Obtener todos los formularios: obtén todos los formularios configurados en el proyecto.
Pruébalo en vivo
Ejecuta este método de forma interactiva en el sandbox del JS SDK. En tu primera visita, conecta la URL de tu proyecto y el App Token y luego abre:
- Obtener todos los formularios: obtén todos los formularios configurados en el proyecto.