getFormByMarker

Obteniendo un objeto de formulario por marcador.

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.

Forms.getFormByMarker( marker, langCode );

Ejemplo mínimo

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

Ejemplo con atributos

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

Esquema de parámetros

Esquema

marker(required): string
Marcador del formulario
ejemplo: "contact_form"

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

Ejemplo de respuesta

{
  "id": 6,
  "attributeSetId": 15,
  "type": "data",
  "localizeInfos": {
    "title": "Formulario de prueba",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 4,
  "position": 1,
  "identifier": "test-form",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "string",
      "marker": "name",
      "isLogin": null,
      "isSignUp": null,
      "position": 1,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Nombre"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "file",
      "marker": "file",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Archivo"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

Esquema de respuesta

Esquema: IFormsEntity

id: number
El identificador del objeto.
ejemplo: 12345

attributeSetId: number | null
El identificador del conjunto de atributos que se está utilizando, o null si no es aplicable.
ejemplo: 1234

type: string | null
Tipo de formulario.
ejemplo: "contact"

localizeInfos: ILocalizeInfo
El nombre del formulario, teniendo en cuenta la localización.
ejemplo:

{
  "key": "value"
}

version: number
El número de versión del objeto.
ejemplo: 1

position: number
La posición del objeto.
ejemplo: 1

identifier: string
El identificador textual para el campo del registro.
ejemplo: "form_contact_us"

processingType: string
Tipo de procesamiento del formulario.
ejemplo: "async"

templateId: number | null
El identificador de la plantilla utilizada por el formulario, o null si no se utiliza ninguna plantilla.
ejemplo: 6789

attributes: IAttributes[] | Record<string, any>
Los atributos del formulario, que pueden ser un array de objetos de atributo o un registro de pares clave-valor.
ejemplo:

{
  "key": "value"
}

---