Pular para o conteúdo principal

postFormsData

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

Descrição​

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

Métodos com uma solicitação POST aceitam como corpo da solicitaçã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.

FormData.postFormsData(

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

);

Esquema de parâmetros​

Esquema (body)

body(obrigatório): IBodyPostFormData
Corpo da solicitação
exemplo:

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

body.formIdentifier(obrigatório): string
Identificador de texto (marcador) do formulário.
exemplo: "form"

body.formModuleConfigId(obrigatório): number
O identificador único da configuração do módulo do formulário.
exemplo: 2

body.moduleEntityIdentifier(obrigatório): string
Identificador de texto (marcador) da entidade do módulo.
exemplo: "blog"

body.replayTo(obrigatório): string | null
Email para resposta.
exemplo: "some@email.com"

body.status(obrigatório): string
Status do formulário.
exemplo: "sent"

body.formData(obrigatório): FormDataType[]
Array de objetos de dados do formulário.
exemplo:

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

body.fileQuery: IUploadingQuery
Consulta de arquivo opcional para upload de arquivos.
exemplo:

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

langCode: string
Código 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"

Exemplos​

Exemplo mínimo​

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

const response = await FormData.postFormsData(body);

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

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

const response = await FormData.postFormsData(body);

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

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

Exemplo com um atributo de tipo simples "textWithHeader"​

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

const response = await FormData.postFormsData(body);

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

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

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

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

const response = await FormData.postFormsData(body);

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

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

const response = await FormData.postFormsData(body);

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 do tipo "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);

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: IPostFormResponse

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

formData: object
Dados do formulário.
exemplo:


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

formData.formIdentifier: string
O identificador do formulário.
exemplo: "contact_form"

time: Date | string
O tempo de envio do formulário.
exemplo: "2023-10-01T12:00:00Z"

entityIdentifier: string | null
O identificador da entidade.
exemplo: "blog"

isUserAdmin: boolean
O usuário é administrador.
exemplo: false

formModuleId: number
O identificador do módulo do formulário.
exemplo: 2

parentId: any
O identificador pai.
exemplo: null

userIdentifier: number
O identificador do usuário.
exemplo: null

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

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