Aller au contenu principal

getFormByMarker

Obtenir un objet formulaire par marqueur.

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

Forms.getFormByMarker( marker, langCode );

Exemple minimal​

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

Exemple avec des attributs​

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

Schéma des paramètres​

Schéma

marker(required): string
Marqueur du formulaire
exemple : "contact_form"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Exemple de réponse​

{
  "id": 6,
  "attributeSetId": 15,
  "type": "data",
  "localizeInfos": {
    "title": "Formulaire de test",
    "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": "Nom"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    },
    {
      "type": "file",
      "marker": "file",
      "isLogin": null,
      "isSignUp": null,
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "localizeInfos": {
        "title": "Fichier"
      },
      "additionalFields": [],
      "isNotificationEmail": null,
      "isNotificationPhoneSMS": null,
      "isNotificationPhonePush": null
    }
  ]
}

Schéma de réponse​

Schéma : IFormsEntity

id: number
L'identifiant de l'objet.
exemple : 12345

attributeSetId: number | null
L'identifiant de l'ensemble d'attributs utilisé, ou null si non applicable.
exemple : 1234

type: string | null
Type de formulaire.
exemple : "contact"

localizeInfos: ILocalizeInfo
Le nom du formulaire, en tenant compte de la localisation.
exemple :

{
  "key": "value"
}

version: number
Le numéro de version de l'objet.
exemple : 1

position: number
La position de l'objet.
exemple : 1

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "form_contact_us"

processingType: string
Type de traitement du formulaire.
exemple : "async"

templateId: number | null
L'identifiant du modèle utilisé par le formulaire, ou null si aucun modèle n'est utilisé.
exemple : 6789

attributes: IAttributes[] | Record<string, any>
Les attributs du formulaire, qui peuvent être un tableau d'objets attributs ou un enregistrement de paires clé-valeur.
exemple :

{
  "key": "value"
}