Retrieves dynamic data by element.​
Parameter {formInstanceID}
should match a form instance ID.
Parameter {formElementID}
should match a form element ID at the data source configuration.
Path Parameters
- formInstanceID string required
Form instance ID
Example: 00000000-0000-0000-0000-000000000000 - formElementID string required
Form element ID
Example: 1
Query Parameters
- limit int64
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.
Example: 250 - filters string
Filters
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 label: eq, ne, in subLabel: eq, ne, in
Example: label sw "my label"
- 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
results object[]
Results holds a list of FormElementDataSourceConfigOptions items
label stringLabel is the main label to display to the user when selecting this option
subLabel stringSubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option
value stringValue is the value to save as an entry when the user selects this option
{
"results": "{\"results\":[{\"label\":\"Alfred 255e71dfc6e\",\"subLabel\":\"Alfred.255e71dfc6e@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2e16676\"},{\"label\":\"Alize eba9d4cd27da\",\"subLabel\":\"Alize.eba9d4cd27da@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2f1667c\"},{\"label\":\"Antonina 01f69c3ea\",\"subLabel\":\"Antonina.01f69c3ea@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2f9667e\"},{\"label\":\"Ardella 21e78ce155\",\"subLabel\":\"Ardella.21e78ce155@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2e6667a\"},{\"label\":\"Arnaldo d8582b6e17\",\"subLabel\":\"Arnaldo.d8582b6e17@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced3426686\"},{\"label\":\"Aurelia admin24828\",\"subLabel\":\"Aurelia.admin24828@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2e16674\"},{\"label\":\"Barbara 72ca418fdd\",\"subLabel\":\"Barbara.72ca418fdd@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2fb6680\"},{\"label\":\"Barbara ee1a2436ee\",\"subLabel\":\"Barbara.ee1a2436ee@testmail.identitysoon.com\",\"value\":\"2c918084821847c5018227ced2e56678\"},{\"label\":\"Baylee 652d72432f3\",\"subLabel\":\"Baylee.652d72432f3@testmail.identitysoon.com\",\"value\":\"2c91808582184782018227ced28b6aee\"},{\"label\":\"Brock e76b56ae4d49\",\"subLabel\":\"Brock.e76b56ae4d49@testmail.identitysoon.com\",\"value\":\"2c91808582184782018227ced28b6aef\"}]}"
}
An error with the request occurred
- application/json
- Schema
- Example (from schema)
Schema
- detailCode string
messages object[]
locale stringLocale is the current Locale
localeOrigin stringLocaleOrigin holds possible values of how the locale was selected
text stringText is the actual text of the error message
- statusCode int64
- trackingId string
{
"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
- detailCode string
messages object[]
locale stringLocale is the current Locale
localeOrigin stringLocaleOrigin holds possible values of how the locale was selected
text stringText is the actual text of the error message
- statusCode int64
- trackingId string
{
"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
- detailCode string
messages object[]
locale stringLocale is the current Locale
localeOrigin stringLocaleOrigin holds possible values of how the locale was selected
text stringText is the actual text of the error message
- statusCode int64
- trackingId string
{
"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
- detailCode string
messages object[]
locale stringLocale is the current Locale
localeOrigin stringLocaleOrigin holds possible values of how the locale was selected
text stringText is the actual text of the error message
- statusCode int64
- trackingId string
{
"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
- detailCode string
DetailCode is the text of the status code returned
messages object[]
locale stringLocale is the current Locale
localeOrigin stringLocaleOrigin holds possible values of how the locale was selected
text stringText is the actual text of the error message
- trackingId string
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
- detailCode string
messages object[]
locale stringLocale is the current Locale
localeOrigin stringLocaleOrigin holds possible values of how the locale was selected
text stringText is the actual text of the error message
- statusCode int64
- trackingId string
{
"detailCode": "string",
"messages": [
{
"locale": "en-US",
"localeOrigin": "DEFAULT",
"text": "This is an error"
}
],
"statusCode": 0,
"trackingId": "string"
}