getAllForms

Obter todos os objetos de formulário

Forms.getAllForms(langCode, offset, limit)

const value = await Forms.getAllForms()

Esquema

langCode string
Código 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

Este método recupera todos os objetos de formulário da API. Ele retorna uma Promise que resolve para um array de objetos FormEntity.

Exemplo de retorno:

[
  {
    "id": 1764,
    "attributeSetId": 0,
    "processingType": "email",
    "localizeInfos": {
      "title": "Meu Formulário",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "processingData": "Tipo Desconhecido: ProcessingData",
    "version": 10,
    "type": "data",
    "identifier": "catalog",
    "position": 192,
    "attributes": [
      {
        "type": "list",
        "marker": "l1",
        "position": 2,
        "settings": {},
        "listTitles": [
          {
            "title": "vermelho",
            "value": 1,
            "position": 1,
            "extendedValue": null,
            "extendedValueType": null
          },
          {
            "title": "amarelo",
            "value": 2,
            "position": 2,
            "extendedValue": null,
            "extendedValueType": null
          }
        ],
        "validators": {},
        "localizeInfos": {
          "title": "l1"
        }
      }
    ]
  }
]

Esquema

id: number
identificador do objeto
exemplo: 1764

attributeSetId: number
identificador do conjunto de atributos utilizado

processingType: string
tipo de processamento do formulário
exemplo: email

localizeInfos: FormLocalizeInfos
nome do formulário com localização
Enum: [ db, email, script ] exemplo:

{
  "en_US": {
    "title": "Meu Formulário",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  }
}

processingData: ProcessingData
dados do formulário

version: number
número da versão do objeto
exemplo: 10

identifier: string
identificador textual para o campo do registro
exemplo: catalog
padrão: marker

position: number
número da posição (para ordenação)
exemplo: 192

position: string
Tipo de Formulário
exemplo: 'data'

attributes:
array de valores de atributos do conjunto de atributos utilizado para exibir o formulário (levando em consideração o idioma especificado)
exemplo:

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