getAllForms
Obtenir tous les formulaires.
Description
Récupère les formulaires avec pagination. Renvoie un IFormsResponse : les formulaires sont dans items, leur nombre dans total.
.getAllForms(
,
,
);
Schéma des paramètres
Schema
langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"
offset: number
Nombre d'enregistrements à ignorer. Par défaut : 0. offset + limit ne doit pas dépasser 200 ; une fenêtre plus grande est rejetée avec 400.
exemple : 0
limit: number
Nombre maximal d'enregistrements à renvoyer. Par défaut : 30.
exemple : 30
Limite d’enregistrements. Si la permission du groupe d’utilisateurs pour cette méthode n’autorise qu’une lecture restreinte, l’API renvoie au plus le nombre d’enregistrements défini dans les paramètres du projet (10 par défaut), quelle que soit la valeur de limit. Avec un accès complet en lecture, limit fonctionne normalement. Voir Module permissions (ouvre dans un nouvel onglet).
Exemples
Exemple minimal
const response = await Forms.getAllForms();
Exemple avec les paramètres facultatifs
const response = await Forms.getAllForms('en_US', 0, 30);
Exemple de réponse
{
"items": [
{
"id": 4,
"attributeSetId": 11,
"type": "data",
"localizeInfos": {
"title": "user_form",
"titleForSite": "",
"successMessage": "",
"unsuccessMessage": "",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 10,
"position": 1,
"identifier": "user_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name_attr",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "name"
},
"additionalFields": {}
},
{
"type": "string",
"marker": "username",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "username"
},
"additionalFields": {}
},
{
"type": "string",
"marker": "password",
"position": 3,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "password"
},
"additionalFields": {}
}
]
},
{
"id": 6,
"attributeSetId": 15,
"type": "data",
"localizeInfos": {
"title": "Test form",
"titleForSite": "",
"successMessage": "",
"unsuccessMessage": "",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 15,
"position": 2,
"identifier": "test-form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data"
}
}
},
{
"type": "file",
"marker": "file",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {}
}
]
},
{
"id": 7,
"attributeSetId": 15,
"type": "data",
"localizeInfos": {
"title": "File form",
"titleForSite": "Form title (for application)",
"successMessage": "Message about successful data processing",
"unsuccessMessage": "Message about unsuccessful data processing",
"urlAddress": "",
"database": "0",
"script": "0"
},
"version": 16,
"position": 3,
"identifier": "file_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {
"requiredValidator": {
"strict": true
},
"stringInspectionValidator": {
"stringMax": 0,
"stringMin": 0,
"stringLength": 0
}
},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "Name"
},
"additionalFields": {
"additional_field": {
"type": "string",
"value": "Additional field data"
}
}
},
{
"type": "file",
"marker": "file",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"multiselect": false,
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {}
}
]
}
],
"total": 9
}
Schéma de réponse
Schéma : IFormsResponse
total: number
Nombre total de formulaires.
items: IFormsEntity[]
Formulaires de cette réponse.
items.id: number
ID du formulaire.
exemple : 12345
items.attributeSetId: number | null
ID de l'ensemble d'attributs utilisé par le formulaire, ou null s'il n'y en a pas.
exemple : 1234
items.type: string | null
Type de formulaire.
exemple : "contact"
items.localizeInfos: IFormLocalizeInfo
Nom localisé du formulaire et textes côté formulaire, comme les messages de succès et d'erreur.
exemple :
{
"title": "Example title"
}
items.version: number
Numéro de version de l'objet ; change à chaque mise à jour.
exemple : 1
items.position: number
Position, à partir de 1, du formulaire dans la liste complète triée par ID ; avec offset, la numérotation reprend à offset + 1. Toujours 1 pour getFormByMarker().
exemple : 1
items.identifier: string
Marqueur du formulaire.
exemple : "form_contact_us"
items.processingType: string
Mode de traitement des envois du formulaire, par exemple "email" ou "url".
exemple : "async"
items.templateId: number | null
ID du modèle utilisé par le formulaire, ou null si le formulaire n'a pas de modèle.
exemple : 6789
items.attributes: IFormAttribute[]
Champs du formulaire avec leur localisation, leurs validateurs et leurs indicateurs propres au formulaire, triés par position. L'API renvoie un objet vide pour les formulaires sans attributs — le SDK le normalise en tableau vide.
items.total: number | string
Compteur de lignes interne que getFormByMarker() renvoie par erreur (toujours "1") ; ne vous y fiez pas. Non renvoyé dans les éléments de getAllForms() ; utilisez plutôt le total de premier niveau.
exemple : "1"
items.moduleFormConfigs: IFormConfig[]
Liaisons de modules du formulaire. Renvoyé uniquement par getFormByMarker() ; getAllForms() l'omet.
Exemples d'utilisation
Tutoriel pas à pas dans la documentation :
- Get all forms — récupérer tous les formulaires configurés dans le projet.
Essayer en direct
Exécutez cette méthode de manière interactive dans le bac à sable JS SDK. Lors de votre première visite, connectez l'URL de votre projet et votre App Token, puis ouvrez :
- Get all forms — récupérer tous les formulaires configurés dans le projet.