getAllForms
Obtenir tous les objets de formulaire.
Description
Cette méthode récupère tous les objets de formulaire avec pagination. Elle renvoie une promesse qui se résout en un objet IFormsResponse contenant des éléments et un compte total.
Forms.getAllForms(
langCode,
offset,
limit
);
Schéma des paramètres
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
Par défaut, vous pouvez récupérer 10 objets. Cela est dû à la limite d'enregistrement dans les paramètres de permissions du module.
Pour que la pagination fonctionne correctement, vous devez configurer les permissions du module selon vos besoins dans la section correspondante.
Exemples
Exemple minimal
const response = await Forms.getAllForms();
Exemple avec des attributs
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": 9,
"position": 1,
"identifier": "user_form",
"processingType": "script",
"templateId": null,
"attributes": [
{
"type": "string",
"marker": "name_attr",
"position": 1,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "name"
},
"additionalFields": {}
},
{
"type": "string",
"marker": "username",
"position": 2,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "username"
},
"additionalFields": {}
},
{
"type": "string",
"marker": "password",
"position": 3,
"settings": {},
"isVisible": true,
"listTitles": [],
"validators": {},
"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": 14,
"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
}
},
"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": {},
"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": 15,
"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
}
},
"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": {},
"initialValue": null,
"localizeInfos": {
"title": "File"
},
"additionalFields": {}
}
]
},
"..."
],
"total": 9
}
Schéma de réponse
Schéma : IFormsEntity[]
total: number
Nombre total d'éléments.
items: IFormsEntity[]
Tableau des entités de formulaire.
items.id: number
L'identifiant de l'objet.
exemple : 12345
items.attributeSetId: number | null
L'identifiant de l'ensemble d'attributs utilisé, ou null si non applicable.
exemple : 1234
items.type: string | null
Type de formulaire.
exemple : "contact"
items.localizeInfos: IFormLocalizeInfo
Le nom du formulaire et les champs de localisation côté formulaire (messages de succès/erreur, configuration de traitement, etc.).
exemple :
{
"key": "value"
}
items.version: number
Le numéro de version de l'objet.
exemple : 1
items.position: number
La position de l'objet.
exemple : 1
items.identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "form_contact_us"
items.processingType: string
Type de traitement du formulaire.
exemple : "async"
items.templateId: number | null
L'identifiant du modèle utilisé par le formulaire, ou null si aucun modèle n'est utilisé.
exemple : 6789
items.attributes: IFormAttribute[]
Champs de formulaire avec leur localisation, validateurs et indicateurs spécifiques au formulaire.
items.total: number | string
Nombre total d'entrées associées.
exemple : "1"
items.moduleFormConfigs: IFormConfig[]
Tableau des configurations de formulaire de module associées au formulaire.
Exemples d'utilisation
Guide étape par étape dans la documentation :
- Obtenir tous les formulaires — récupérer chaque formulaire configuré dans le projet.
Essayez-le en direct
Exécutez cette méthode de manière interactive dans le bac à sable JS SDK — connectez votre URL de projet et votre jeton d'application lors de votre première visite, puis ouvrez :
- Obtenir tous les formulaires — récupérer chaque formulaire configuré dans le projet.