getAllForms

Obtener todos los objetos de formulario

Forms.getAllForms(langCode, offset, limit)

const value = await Forms.getAllForms()

Esquema

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

offset number
Parámetro para la paginación. Por defecto 0
ejemplo: 0

limit number
Parámetro para la paginación. Por defecto 30
ejemplo: 30

Este método recupera todos los objetos de formulario de la API. Devuelve una Promesa que se resuelve en un array de objetos FormEntity.

Ejemplo de retorno:

[
  {
    "id": 1764,
    "attributeSetId": 0,
    "processingType": "email",
    "localizeInfos": {
      "title": "Mi Formulario",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "processingData": "Tipo Desconocido: ProcessingData",
    "version": 10,
    "type": "data",
    "identifier": "catalog",
    "position": 192,
    "attributes": [
      {
        "type": "list",
        "marker": "l1",
        "position": 2,
        "settings": {},
        "listTitles": [
          {
            "title": "rojo",
            "value": 1,
            "position": 1,
            "extendedValue": null,
            "extendedValueType": null
          },
          {
            "title": "amarillo",
            "value": 2,
            "position": 2,
            "extendedValue": null,
            "extendedValueType": null
          }
        ],
        "validators": {},
        "localizeInfos": {
          "title": "l1"
        }
      }
    ]
  }
]

Esquema

id: number
identificador del objeto
ejemplo: 1764

attributeSetId: number
identificador del conjunto de atributos utilizado

processingType: string
tipo de procesamiento del formulario
ejemplo: email

localizeInfos: FormLocalizeInfos
nombre del formulario con localización
Enum: [ db, email, script ] ejemplo:

{
  "en_US": {
    "title": "Mi Formulario",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  }
}

processingData: ProcessingData
datos del formulario

version: number
número de versión del objeto
ejemplo: 10

identifier: string
identificador textual para el campo del registro
ejemplo: catalog
por defecto: marker

position: number
número de posición (para ordenar)
ejemplo: 192

position: string
Tipo de formulario
ejemplo: 'data'

attributes:
array de valores de atributos del conjunto de atributos utilizado para mostrar el formulario (teniendo en cuenta el idioma especificado)
ejemplo:

[
  {
    "type": "list",
    "marker": "l1",
    "position": 2,
    "listTitles": [
      {
        "title": "rojo",
        "value": 1,
        "position": 1,
        "extendedValue": null,
        "extendedValueType": null
      },
      {
        "title": "amarillo",
        "value": 2,
        "position": 2,
        "extendedValue": null,
        "extendedValueType": null
      }
    ],
    "validators": {},
    "localizeInfos": {
      "title": "l1"
    }
  }
]