Fetch Remote Data Action Form

Version 4.0.24.20 (latest)

For some data actions, the remote server may supply a form requesting further user input. This endpoint takes a data action, asks the remote server to generate a form for it, and returns that form to you for presentation to the user.

Request

POST /data_actions/form
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
body
object
Data Action Request

Response

200: Data Action Form

Datatype
Description
(object)
state
User state
Expand DataActionUserState definition...
data
string
User state data
refresh_time
integer
Time in seconds until the state needs to be refreshed
Expand DataActionFormField definition...
name
string
Name
label
string
Human-readable label
description
string
Description of field
type
string
Type of field.
default
string
Default value of the field.
oauth_url
string
The URL for an oauth link, if type is 'oauth_link'.
interactive
boolean
Whether or not a field supports interactive forms.
required
boolean
Whether or not the field is required. This is a user-interface hint. A user interface displaying this form should not submit it without a value for this field. The action server must also perform this validation.
Expand DataActionFormSelectOption definition...
name
string
Name
label
string
Human-readable label

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link