Retrieves dynamic data by element.
GET/form-instances/:formInstanceID/data-source/:formElementID
Parameter {formInstanceID} should match a form instance ID.
Parameter {formElementID} should match a form element ID at the data source configuration.
Request
Path Parameters
Form instance ID
Form element ID
Query Parameters
Possible values: <= 250 characters
Default value: 250
Limit
Integer specifying the maximum number of records to return in a single API call. The standard syntax described in V3 API Standard Collection Parameters. If it is not specified, a default limit is used.
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
value: eq, ne, in
Supported composite operators: not
Only a single not may be used, and it can only be used with the in operator. The not composite operator must be used in front of the field. For example, the following is valid: not value in ("ID01")
String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a "starts with" filter against several fields.
Responses
- 200
- 400
- 401
- 403
- 404
- 429
- 500
Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
results
object[]
Results holds a list of FormElementDataSourceConfigOptions items
Label is the main label to display to the user when selecting this option
SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option
Value is the value to save as an entry when the user selects this option
{
"results": "{\"results\":[{\"label\":\"Alfred 255e71dfc6e\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2e16676\"},{\"label\":\"Alize eba9d4cd27da\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2f1667c\"},{\"label\":\"Antonina 01f69c3ea\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2f9667e\"},{\"label\":\"Ardella 21e78ce155\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2e6667a\"},{\"label\":\"Arnaldo d8582b6e17\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced3426686\"},{\"label\":\"Aurelia admin24828\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2e16674\"},{\"label\":\"Barbara 72ca418fdd\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2fb6680\"},{\"label\":\"Barbara ee1a2436ee\",\"subLabel\":\"[email protected]\",\"value\":\"2c918084821847c5018227ced2e56678\"},{\"label\":\"Baylee 652d72432f3\",\"subLabel\":\"[email protected]\",\"value\":\"2c91808582184782018227ced28b6aee\"},{\"label\":\"Brock e76b56ae4d49\",\"subLabel\":\"[email protected]\",\"value\":\"2c91808582184782018227ced28b6aef\"}]}"
}
An error with the request occurred
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the authorization occurred
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the user permissions occurred
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
An error with the item not found
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}
Too many requests
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
DetailCode is the text of the status code returned
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
TrackingID is the request tracking unique identifier
{
"detailCode": "Internal Server Error",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"trackingId": "9cd03ef80e6a425eb6b11bdbb057cdb4"
}
An internal server error occurred
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
messages
object[]
Locale is the current Locale
LocaleOrigin holds possible values of how the locale was selected
Text is the actual text of the error message
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}