getFormByMarker

Obteniendo un objeto de formulario por marcador

Forms.getFormByMarker(marker, langCode)

const value = await Forms.getFormByMarker('my-form')

Esquema

marker:* cadena
Marcador del formulario
ejemplo: my-form

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

Este método recupera un único objeto de formulario basado en su identificador textual (marcador) de la API. Devuelve una Promesa que se resuelve en un objeto 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: número
identificador del objeto
ejemplo: 1764

attributeSetId: número
identificador del conjunto de atributos utilizado

processingType: cadena
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: número
número de versión del objeto
ejemplo: 10

identifier: cadena
identificador textual para el campo del registro
ejemplo: catalog
por defecto: marcador

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

position: cadena
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"
    }
  }
]

---