Formulário de ação de busca de dados remotos

Versão 3.1.23.6

Para algumas ações de dados, o servidor remoto pode fornecer um formulário solicitando mais informações do usuário. Esse endpoint executa uma ação de dados, solicita que o servidor remoto gere um formulário e o retorna para apresentação ao usuário.

Solicitação

POST /data_actions/form
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
objeto
Solicitação de ação de dados

Resposta

200: formulário de ação de dados

Tipo de dados
Descrição
(objeto)
estado
Estado do usuário
Expandir a definição de DataActionUserState...
dados
string
Dados de estado do usuário
tempo de atualização
integer
Tempo em segundos até que o estado precise ser atualizado
Expandir a definição de DataActionFormField...
nome
string
Nome
Rótulo
string
Marcador legível
Descrição
string
Descrição do campo
tipo
string
Tipo de campo.
padrão
string
Valor padrão do campo.
URL_oauth
string
O URL de um link do OAuth, se o tipo for "oauth_link".
interativo
booleano
Se um campo é compatível com formulários interativos.
obrigatório
booleano
Se o campo é obrigatório ou não. Esta é uma dica sobre a interface do usuário. Uma interface do usuário que exibe este formulário não deve enviá-lo sem um valor para esse campo. O servidor de ações também precisa realizar essa validação.
Expandir a definição de DataActionFormSelectOption...
nome
string
Nome
Rótulo
string
Marcador legível

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação