Pular para o conteúdo principal

postFormsData

Criando um objeto para salvar informações dos dados do formulário

FormData.postFormsData(data, langCode)

Métodos que utilizam uma requisição POST aceitam um objeto no corpo da requisição contendo os campos de dados do formulário, que correspondem ao tipo de informação sendo enviada. Abaixo estão exemplos de objetos de dados do formulário para diferentes tipos de dados.

const value = await FormData.postFormsData(data, langCode);

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

{
"marker": "last_name",
"type": "string",
"value": "Nome de Usuário"
}

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>Olá mundo</p>",
"plainValue": "",
"params": {
"isEditorDisabled": false,
"isImageCompressed": true
}
}
}

Exemplo com um atributo de tipo simples "textWithHeader"

{
"marker": "about",
"type": "textWithHeader",
"value": {
"header": "Título",
"htmlValue": "<p>Olá Mundo</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://meu-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://meu-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": "vermelho",
"value": "1",
"extended": {
"value": "vermelho",
"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 de 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 — um 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

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

const value = await FormData.postFormsData(body)
Esquema (corpo)

formIdentifier: string
Identificador de texto do objeto do formulário (marcador)
exemplo: meu-formulário

formData: FormDataLangType
Dados enviados pelo formulário
exemplo:

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

fileQuery: object
fileQuery para upload de arquivos com o formulário
exemplo:

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

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

Exemplo de retorno:

{
"id": 1764,
"formIdentifier": "meu-formulário",
"time": "2025-05-09T18:32:46.834Z",
"formData": {
"marker": "name_1",
"value": "Nome",
"type": "string"
}
}
Esquema

id: number
identificador do objeto
exemplo: 1764

formIdentifier: string
Identificador de texto do objeto do formulário (marcador)
exemplo: meu-formulário

time: Date
Data e hora da modificação do formulário
exemplo: 2025-05-09T18:32:46.834Z

formData: FormDataLangType
Dados enviados pelo formulário
exemplo:

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