getFormByMarker

Obtenir un objet de formulaire par marqueur

Forms.getFormByMarker(marker, langCode)

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

Schéma

marker:* chaîne de caractères
Marqueur du formulaire
exemple : my-form

langCode: chaîne de caractères
Code de langue. Par défaut "en_US"
exemple : en_US

Cette méthode récupère un seul objet de formulaire basé sur son identifiant textuel (marqueur) depuis l'API. Elle retourne une promesse qui se résout en un objet FormEntity.

Exemple de retour :

{
  "id": 1764,
  "attributeSetId": 0,
  "processingType": "email",
  "localizeInfos": {
    "title": "Mon Formulaire",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "processingData": "Type Inconnu : ProcessingData",
  "version": 10,
  "type": "data",
  "identifier": "catalog",
  "position": 192,
  "attributes": [
    {
      "type": "list",
      "marker": "l1",
      "position": 2,
      "settings": {},
      "listTitles": [
        {
          "title": "rouge",
          "value": 1,
          "position": 1,
          "extendedValue": null,
          "extendedValueType": null
        },
        {
          "title": "jaune",
          "value": 2,
          "position": 2,
          "extendedValue": null,
          "extendedValueType": null
        }
      ],
      "validators": {},
      "localizeInfos": {
        "title": "l1"
      }
    }
  ]
}

Schéma

id: nombre
identifiant de l'objet
exemple : 1764

attributeSetId: nombre
identifiant de l'ensemble d'attributs utilisé

processingType: chaîne de caractères
type de traitement du formulaire
exemple : email

localizeInfos: FormLocalizeInfos
nom du formulaire avec localisation
Enum : [ db, email, script ] exemple :

{
  "en_US": {
    "title": "Mon Formulaire",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  }
}

processingData: ProcessingData
données du formulaire

version: nombre
numéro de version de l'objet
exemple : 10

identifier: chaîne de caractères
identifiant textuel pour le champ d'enregistrement
exemple : catalog
par défaut : marqueur

position: nombre
numéro de position (pour le tri)
exemple : 192

type: chaîne de caractères
Type de formulaire
exemple : 'data'

attributes:
tableau des valeurs d'attributs de l'ensemble d'attributs utilisé pour afficher le formulaire (en tenant compte de la langue spécifiée)
exemple :

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

---