getAllForms

Obtenez tous les objets de formulaire.

Formulaires?.getAllForms( langCode?, offset?, limit? );

Exemple minimal

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 réponse

[
  {
    "id": 9,
    "attributeSetId": 20,
    "type": "sing_in_up",
    "localizeInfos": {
      "title": "Inscription",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 1,
    "identifier": "reg",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "string",
        "marker": "email_reg",
        "isLogin": true,
        "isSignUp": false,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {
          "emailInspectionValidator": true
        },
        "localizeInfos": {
          "title": "email"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      {
        "type": "string",
        "marker": "password_reg",
        "isLogin": null,
        "isSignUp": false,
        "position": 2,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {
          "requiredValidator": {
            "strict": true
          },
          "stringInspectionValidator": {
            "stringMax": 0,
            "stringMin": 0,
            "stringLength": 0
          }
        },
        "localizeInfos": {
          "title": "mot de passe"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      {
        "type": "string",
        "marker": "name_reg",
        "isLogin": null,
        "isSignUp": true,
        "position": 3,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "nom"
        },
        "additionalFields": [],
        "isNotificationEmail": false,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      },
      "..."
    ]
  },
  {
    "id": 11,
    "attributeSetId": 28,
    "type": "data",
    "localizeInfos": {
      "title": "Horaire",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 2,
    "identifier": "schedule_form",
    "processingType": "script",
    "templateId": null,
    "attributes": [
      {
        "type": "timeInterval",
        "marker": "schedule",
        "isLogin": null,
        "isSignUp": null,
        "position": 1,
        "settings": {},
        "isVisible": true,
        "listTitles": [],
        "validators": {},
        "localizeInfos": {
          "title": "Horaire",
          "intervals": [
            {
              "id": "f88c8793-798d-4fb1-9f8f-7b2013bcf04f",
              "range": [
                "2025-05-07T21:00:00.000Z",
                "2025-05-07T21:00:00.000Z"
              ],
              "external": [],
              "intervals": [
                {
                  "id": "47851bf0-1d39-422f-a155-3a6ba1d00a13",
                  "end": {
                    "hours": 12,
                    "minutes": 0
                  },
                  "start": {
                    "hours": 9,
                    "minutes": 0
                  },
                  "period": 60
                }
              ],
              "inEveryWeek": true,
              "inEveryMonth": true
            }
          ]
        },
        "additionalFields": [],
        "isNotificationEmail": null,
        "isNotificationPhoneSMS": null,
        "isNotificationPhonePush": null
      }
    ]
  },
  {
    "id": 10,
    "attributeSetId": 16,
    "type": null,
    "localizeInfos": {
      "title": "Formulaire de collecte ru_RU",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "version": 0,
    "position": 3,
    "identifier": "collection_form",
    "processingType": "script",
    "templateId": null,
    "attributes": {}
  },
  "..."
]

Schéma

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 d'attributs ou un enregistrement de paires clé-valeur.
exemple :

{
  "key": "value"
}

---