Aller au contenu principal

postFormsData

Création d'un objet de données de formulaire enregistrant des informations.

Description​

Cette méthode retourne un objet FormDataEntity créé. Si vous souhaitez changer la langue, il suffit de le passer en tant que deuxième argument.

Les méthodes avec une requête POST acceptent comme corps de la requête un objet avec le champ de données de formulaire, qui correspond au type d'information envoyée. Voici des exemples d'objets de données de formulaire pour différents types de données.

FormData.postFormsData(

body, body.formIdentifier, body.formModuleConfigId, body.moduleEntityIdentifier, body.replayTo, body.status, body.formData, body.fileQuery, langCode

);

Schéma des paramètres​

Schéma (body)

body(obligatoire): IBodyPostFormData
Corps de la requête
exemple:

  {
    "formIdentifier": "test-form",
    "formModuleConfigId": 2,
    "moduleEntityIdentifier": "blog",
    "replayTo": null,
    "status": "sent",
    "formData": [
      {
        "marker": "name",
        "type": "string",
        "value": "Test"
      }
    ]
  }

body.formIdentifier(obligatoire): string
Identifiant textuel (marqueur) du formulaire.
exemple: "form"

body.formModuleConfigId(obligatoire): number
L'identifiant unique de la configuration du module de formulaire.
exemple: 2

body.moduleEntityIdentifier(obligatoire): string
Identifiant textuel (marqueur) de l'entité du module.
exemple: "blog"

body.replayTo(obligatoire): string | null
Email pour répondre.
exemple: "some@email.com"

body.status(obligatoire): string
Statut du formulaire.
exemple: "sent"

body.formData(obligatoire): FormDataType[]
Tableau d'objets de données de formulaire.
exemple:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Jack"
  }
]

body.fileQuery: IUploadingQuery
Requête de fichier optionnelle pour le téléchargement de fichiers.
exemple:

{
  "type": "page",
  "entity": "editor",
  "id": 3787
}

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

body.formIdentifier: string
L'identifiant du formulaire
exemple: "contact-form"

body.formData: string
**
exemple:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Jack"
  }
]

body.formData.marker: string
Marqueur d'attribut de formulaire
exemple: "name"

body.formData.type: string
Type d'attribut de formulaire
exemple: "string"

body.formData.value: string
Valeur d'attribut de formulaire
exemple: "Jack"

Exemples​

Exemple minimal​

const body = {
"formIdentifier": "contact_us",
"formData": [
{
"marker": "last_name",
"type": "string"
"value": "Andrey"
}
]
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "string", "number", "float"​

const body = {
  "marker": "last_name",
  "type": "string",
  "value": "Username"
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "date", "dateTime", "time"​

const body = {
  "marker": "birthday",
  "type": "date",
  "value": {
    "fullDate": "2024-05-07T21:02:00.000Z",
    "formattedValue": "08-05-2024 00:02",
    "formatString": "DD-MM-YYYY HH:mm"
  }
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "text"​

const body = {
  "marker": "about",
  "type": "text",
  "value": {
    "htmlValue": "<p>Hello world</p>",
    "plainValue": "",
    "params": {
      "isEditorDisabled": false,
      "isImageCompressed": true
    }
  }
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "textWithHeader"​

const body = {
  "marker": "about",
  "type": "textWithHeader",
  "value": {
    "header": "Titre",
    "htmlValue": "<p>Hello World</p>",
    "plainValue": "",
    "params": {
      "isEditorDisabled": false,
      "isImageCompressed": true
    }
  }
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "image" ou "groupOfImages"​

const body = {
  "marker": "avatar",
  "type": "image",
  "value": [
    {
      "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "size": 392585,
      "previewLink": "",
      "params": {
        "isImageCompressed": true
      }
    }
  ]
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "files"​

const body = {
  "marker": "picture",
  "type": "file",
  "value": [
    {
      "filename": "files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "downloadLink": "http://my-site.com/cloud-static/files/project/page/10/image/Screenshot-from-2024-05-02-15-23-14.png",
      "size": 392585
    }
  ]
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type simple "radioButton" ou "list"​

const body = {
  "marker": "selector",
  "type": "list",
  "value": [
    {
      "title": "rouge",
      "value": "1",
      "extended": {
        "value": "red",
        "type": "string"
      }
    }
  ]
};

const response = await FormData.postFormsData(body);

Exemple avec un attribut de type "entity" (liste imbriquée)​

const body = {
  "formIdentifier": "entity_form",
  "formData": {
    "en_US": [
      {
        "marker": "entity-marker",
        "type": "entity",
        "value": [25, 32, 24]
      }
    ]
  }
};

const response = await FormData.postFormsData(body);

Valeur - identifiants numériques pour les pages et identifiants textuels pour les produits. Les identifiants pour les produits doivent inclure le préfixe 'p-', par exemple, 'p-1-', 'p-2-', etc. p-[parentId]-[productId]

Exemple avec un attribut de type "timeInterval"​

const body = {
  "formIdentifier": "reg",
  "formData": {
    "en_US": [
      {
        "marker": "interval",
        "type": "timeInterval",
        "value": [
          [
            "2025-02-11T16:00:00:000Z",
            "2025-02-13T16:00:00:000Z",
          ]
        ]
      }
    ]
  }
};

const response = await FormData.postFormsData(body);

valeur — tableau de tableaux d'intervalles au format ISO 8601. par exemple 2025-02-11T16:00:00:000Z

2025 — année; 02 — mois; 11 — jour du mois; T — séparateur entre la date et l'heure; 16:00:00 — heure au format heures:minutes:secondes; 000Z — indication des millisecondes et du fuseau horaire. Z signifie que l'heure est spécifiée au format UTC.

Exemple de retour :​

{
  "formData": {
    "formIdentifier": "test-form",
    "time": "2025-07-21T09:40:06.587Z",
    "formData": [
      {
        "marker": "name",
        "type": "string",
        "value": "Test"
      }
    ],
    "id": 286
  },
  "actionMessage": ""
}

Schéma de réponse​

Schéma: IPostFormResponse

actionMessage: string | null
Message d'action pour les données du formulaire.
exemple: "Formulaire soumis avec succès"

formData: object
Données du formulaire.
exemple:


formData.id: number
L'identifiant unique de la page du formulaire.
exemple: 12345

formData.formIdentifier: string
L'identifiant du formulaire.
exemple: "contact_form"

time: Date | string
L'heure de la soumission du formulaire.
exemple: "2023-10-01T12:00:00Z"

entityIdentifier: string | null
L'identifiant de l'entité.
exemple: "blog"

isUserAdmin: boolean
L'utilisateur est-il administrateur.
exemple: false

formModuleId: number
L'identifiant du module de formulaire.
exemple: 2

parentId: any
L'identifiant parent.
exemple: null

userIdentifier: number
L'identifiant de l'utilisateur.
exemple: null

formData.formData: FormDataType[]
Données des champs du formulaire.
exemple:

[
  {
    "marker": "name",
    "type": "string",
    "value": "Test"
  }
]