getAllForms

Obtenir tous les objets de formulaire

Forms.getAllForms(langCode, offset, limit)

const value = await Forms.getAllForms()

Schéma

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

offset number
Paramètre pour la pagination. Par défaut 0
exemple : 0

limit number
Paramètre pour la pagination. Par défaut 30
exemple : 30

Cette méthode récupère tous les objets de formulaire de l'API. Elle renvoie une promesse qui se résout en un tableau d'objets 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: number
identifiant de l'objet
exemple : 1764

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

processingType: string
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: number
numéro de version de l'objet
exemple : 10

identifier: string
identifiant textuel pour le champ d'enregistrement
exemple : catalog
par défaut : marker

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

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