Pular para o conteúdo principal

postFormsData

Criando um objeto de dados de formulário que salva informações.

Este método retorna um objeto FormDataEntity criado. Se você quiser mudar o idioma, basta passá-lo como segundo argumento.

FormData.postFormsData( body, langCode );

Métodos com uma requisição POST aceitam como corpo da requisição um objeto com o campo de dados do formulário, que corresponde ao tipo de informação sendo enviada. A seguir estão exemplos de objetos de dados de formulário para diferentes tipos de dados.

Exemplo mínimo​

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

const value = await FormData.postFormsData(body)

Esquema de parâmetros​

Esquema (corpo)

body(required): objeto
Corpo da requisição
exemplo:

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

langCode: string
Códig do idioma. Padrão: "en_US"
exemplo: "en_US"

body.formIdentifier: string
O identificador do formulário
exemplo: "contact-form"

body.formData: string
**
exemplo:

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

body.formData.marker: string
Marcador de atributo do formulário
exemplo: "name"

body.formData.type: string
Tipo de atributo do formulário
exemplo: "string"

body.formData.value: string
Valor do atributo do formulário
exemplo: "Jack"

Exemplo com um atributo de tipo simples "string", "number", "float"​

{
  "marker": "last_name",
  "type": "string",
  "value": "Username"
}

Exemplo com um atributo de tipo simples "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"
  }
}

Exemplo com um atributo de tipo simples "text"​

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

Exemplo com um atributo de tipo simples "textWithHeader"​

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

Exemplo com um atributo de tipo simples "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
      }
    }
  ]
}

Exemplo com um atributo de tipo simples "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
    }
  ]
}

Exemplo com um atributo de tipo simples "radioButton" ou "list"​

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

Exemplo com atributo de tipo "entity" (lista aninhada)​

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

Valor - identificadores numéricos para páginas e identificadores de string para produtos. Identificadores para produtos devem incluir o prefixo 'p-', por exemplo, 'p-1-', 'p-2-', etc. p-[parentId]-[productId]

Exemplo com atributo de tipo "timeInterval"​

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

valor — array de arrays de intervalo no formato ISO 8601. por exemplo 2025-02-11T16:00:00:000Z

2025 — ano; 02 — mês; 11 — dia do mês; T — separador entre data e hora; 16:00:00 — hora no formato horas:minutos:segundos; 000Z — milissegundos e indicação de fuso horário. Z significa que a hora está especificada no formato UTC.

Exemplo de retorno:​

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

Esquema de resposta​

Esquema: IFormDataEntity

formIdentifier: string
O identificador da página.
exemplo: "contact_form"

time: Date | string
O identificador do formulário.
exemplo:

"2023-10-01T12:00:00Z"

formData: FormDataType[]
Dados do formulário.
exemplo:

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

id: number
O identificador único da página do formulário.
exemplo: 12345

actionMessage: string | null
Mensagem de ação para os dados do formulário.
exemplo: "Formulário enviado com sucesso"

attributeSetIdentifier: string | null
Identificador de texto (marcador) do conjunto de atributos utilizado.
exemplo: "product_attributes"