Aller au contenu principal

postFormsData

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

FormData.postFormsData(data, langCode)

Les méthodes avec une requête POST acceptent comme corps de la requête un objet contenant le champ de données du 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.


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

{
"marker": "last_name",
"type": "string",
"value": "Nom d'utilisateur"
}

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

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

Exemple avec un attribut de type simple "text"

{
"marker": "about",
"type": "text",
"value": {
"htmlValue": "<p>Bonjour le monde</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}

Exemple avec un attribut de type simple "textWithHeader"

{
"marker": "about",
"type": "textWithHeader",
"value": {
"header": "Titre",
"htmlValue": "<p>Bonjour le monde</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}

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

{
"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
}
}
]
}

Exemple avec un attribut de type simple "files"

{
"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
}
]
}

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

{
"marker": "selector",
"type": "list",
"value": [
{
"title": "rouge",
"value": "1",
"extended": {
"value": "rouge",
"type": "string"
}
}
]
}

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

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

Valeur - identifiants numériques pour les pages et identifiants de chaîne 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"

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

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

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

const value = await FormData.postFormsData(body)
Schéma (corps)

formIdentifier: chaîne
Identifiant textuel de l'objet formulaire (marqueur)
exemple : my-form

formData: FormDataLangType
Données soumises par le formulaire
exemple :

[
{
"marker": "name_field",
"type": "string",
"value": "Nom"
}
]

fileQuery: objet
fileQuery pour télécharger des fichiers avec le formulaire
exemple :

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

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

Exemple de retour :

{
"id": 1764,
"formIdentifier": "my-form",
"time": "2025-05-09T18:32:46.834Z",
"formData": {
"marker": "name_1",
"value": "Nom",
"type": "string"
}
}
Schéma

id: nombre
identifiant de l'objet
exemple : 1764

formIdentifier: chaîne
Identifiant textuel de l'objet formulaire (marqueur)
exemple : my-form

time: Date
Date et heure de modification du formulaire
exemple : 2025-05-09T18:32:46.834Z

formData: FormDataLangType
Données soumises par le formulaire
exemple :

  [
{
"marker": "marker_1",
"value": "Nom"
}
]

.