---
id: search-form-element-data-by-element-id
sidebar_label: Retrieves dynamic data by element.
hide_title: true
hide_table_of_contents: true
api: {"tags":["Custom Forms"],"description":"Parameter `{formInstanceID}` should match a form instance ID.\nParameter `{formElementID}` should match a form element ID at the data source configuration.","operationId":"searchFormElementDataByElementID","parameters":[{"name":"formInstanceID","in":"path","description":"Form instance ID","required":true,"schema":{"type":"string","x-go-name":"FormInstanceID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormInstanceID"},{"name":"formElementID","in":"path","description":"Form element ID","required":true,"schema":{"type":"string","x-go-name":"FormElementID"},"example":1,"x-go-name":"FormElementID"},{"name":"limit","in":"query","description":"Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":250,"x-go-name":"Limit"},"example":250,"required":false,"x-go-name":"Limit"},{"name":"filters","in":"query","description":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n<b>value</b>: <i>eq, ne, in</i>\n<b>label</b>: <i>eq, ne, in</i>\n<b>subLabel</b>: <i>eq, ne, in</i>","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}],"responses":{"200":{"description":"Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration","content":{"application/json":{"schema":{"properties":{"results":{"description":"Results holds a list of FormElementDataSourceConfigOptions items","example":"{\"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\"}]}","items":{"type":"object","properties":{"label":{"description":"Label is the main label to display to the user when selecting this option","type":"string","example":"regression-test-access-request-07c55dd6-3056-430a-86b5-fccc395bb6c5","x-go-name":"Label"},"subLabel":{"description":"SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option","type":"string","example":"","x-go-name":"SubLabel"},"value":{"description":"Value is the value to save as an entry when the user selects this option","type":"string","example":"e96674448eba4ca1ba04eee999a8f3cd","x-go-name":"Value"}},"x-go-package":"github.com/sailpoint/sp-forms/domain"},"type":"array","x-go-name":"Results"}},"type":"object","x-go-package":"github.com/sailpoint/sp-forms/domain"}}}},"400":{"description":"An error with the request occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"401":{"description":"An error with the authorization occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"403":{"description":"An error with the user permissions occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"404":{"description":"An error with the item not found","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}},"429":{"description":"Too many requests","content":{"application/json":{"schema":{"title":"Error is the standard API error response type.","type":"object","properties":{"detailCode":{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"trackingId":{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"}}}},"500":{"description":"An internal server error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detailCode":{"type":"string","x-go-name":"DetailCode"},"messages":{"type":"array","items":{"title":"ErrorMessage is the standard API error response message type.","type":"object","properties":{"locale":{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"},"localeOrigin":{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"},"text":{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}},"x-go-package":"github.com/sailpoint/atlas-go/atlas/web"},"x-go-name":"Messages"},"statusCode":{"type":"integer","format":"int64","x-go-name":"StatusCode"},"trackingId":{"type":"string","x-go-name":"TrackingID"}}}}}}},"security":[{"oauth2":[]}],"method":"get","path":"/form-instances/{formInstanceID}/data-source/{formElementID}","servers":[{"url":"https://{tenant}.api.identitynow.com/beta","description":"This is the beta API server.","variables":{"tenant":{"default":"sailpoint","description":"This is the name of your tenant, typically your company's name."}}}],"securitySchemes":{"oauth2":{"type":"oauth2","description":"OAuth2 Bearer token (JWT). See [IdentityNow REST API Authentication](https://developer.sailpoint.com/idn/api/authentication) for more information.\n- Directions for generating a [personal access token](https://developer.sailpoint.com/idn/api/authentication#personal-access-tokens)\n- Directions using [client credentials flow](https://developer.sailpoint.com/idn/api/authentication#client-credentials-grant-flow)\n- Directions for using [authorization code flow](https://developer.sailpoint.com/idn/api/authentication#authorization-code-grant-flow)\n\nWhich authentication method should I choose?  See our [guide](https://developer.sailpoint.com/idn/api/authentication#which-oauth-20-grant-flow-should-i-use)\n\nLearn more about how to find your `tokenUrl` and `authorizationUrl` [in our docs](https://developer.sailpoint.com/idn/api/authentication#find-your-tenants-oauth-details)\n","flows":{"clientCredentials":{"tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}},"authorizationCode":{"authorizationUrl":"https://tenant.identitynow.com/oauth/authorize","tokenUrl":"https://tenant.api.identitynow.com/oauth/token","scopes":{"sp:scopes:default":"default scope","sp:scopes:all":"access to all scopes"}}}}},"info":{"title":"IdentityNow Beta API","description":"Use these APIs to interact with the IdentityNow platform to achieve repeatable, automated processes with greater scalability. These APIs are in beta and are subject to change. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.","termsOfService":"https://developer.sailpoint.com/discuss/tos","contact":{"name":"Developer Relations","url":"https://developer.sailpoint.com/discuss/api-help"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"version":"3.1.0-beta"},"postman":{"name":"Retrieves dynamic data by element.","description":{"content":"Parameter `{formInstanceID}` should match a form instance ID.\nParameter `{formElementID}` should match a form element ID at the data source configuration.","type":"text/plain"},"url":{"path":["form-instances",":formInstanceID","data-source",":formElementID"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.","type":"text/plain"},"key":"limit","value":""},{"disabled":false,"description":{"content":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n<b>value</b>: <i>eq, ne, in</i>\n<b>label</b>: <i>eq, ne, in</i>\n<b>subLabel</b>: <i>eq, ne, in</i>","type":"text/plain"},"key":"filters","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Form instance ID","type":"text/plain"},"type":"any","value":"","key":"formInstanceID"},{"disabled":false,"description":{"content":"(Required) Form element ID","type":"text/plain"},"type":"any","value":"","key":"formElementID"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"oauth2","oauth2":[]}}}
sidebar_class_name: "get api-method"
info_path: idn/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieves dynamic data by element.' (search-form-element-data-by-element-id)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## 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.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"formInstanceID","in":"path","description":"Form instance ID","required":true,"schema":{"type":"string","x-go-name":"FormInstanceID"},"example":"00000000-0000-0000-0000-000000000000","x-go-name":"FormInstanceID"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"formElementID","in":"path","description":"Form element ID","required":true,"schema":{"type":"string","x-go-name":"FormElementID"},"example":1,"x-go-name":"FormElementID"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"limit","in":"query","description":"Limit\n\nInteger specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).\nIf it is not specified, a default limit is used.","schema":{"type":"integer","format":"int64","maxLength":250,"minLength":0,"default":250,"x-go-name":"Limit"},"example":250,"required":false,"x-go-name":"Limit"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"filters","in":"query","description":"Filters\n\nFilter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\nFiltering is supported for the following fields and operators:\n<b>value</b>: <i>eq, ne, in</i>\n<b>label</b>: <i>eq, ne, in</i>\n<b>subLabel</b>: <i>eq, ne, in</i>","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Retrieves dynamic data to aid in correctly completing a valid form by form element ID from data source configuration

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>results</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Results holds a list of FormElementDataSourceConfigOptions items

</div><SchemaItem collapsible={false} name={"label"} required={false} deprecated={undefined} schemaDescription={"Label is the main label to display to the user when selecting this option"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"subLabel"} required={false} deprecated={undefined} schemaDescription={"SubLabel is the sub label to display below the label in diminutive styling to help describe or identify this option"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={"Value is the value to save as an entry when the user selects this option"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"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\\\"}]}\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

An error with the request occurred

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"Locale is the current Locale"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"LocaleOrigin holds possible values of how the locale was selected"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Text is the actual text of the error message"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int64"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

An error with the authorization occurred

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"Locale is the current Locale"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"LocaleOrigin holds possible values of how the locale was selected"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Text is the actual text of the error message"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int64"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

An error with the user permissions occurred

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"Locale is the current Locale"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"LocaleOrigin holds possible values of how the locale was selected"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Text is the actual text of the error message"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int64"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

An error with the item not found

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"Locale is the current Locale"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"LocaleOrigin holds possible values of how the locale was selected"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Text is the actual text of the error message"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int64"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>

Too many requests

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={"DetailCode is the text of the status code returned"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"Locale is the current Locale"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"LocaleOrigin holds possible values of how the locale was selected"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Text is the actual text of the error message"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={"TrackingID is the request tracking unique identifier"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"Internal Server Error\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

An internal server error occurred

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>messages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"locale"} required={false} deprecated={undefined} schemaDescription={"Locale is the current Locale"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} deprecated={undefined} schemaDescription={"LocaleOrigin holds possible values of how the locale was selected"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} deprecated={undefined} schemaDescription={"Text is the actual text of the error message"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"int64"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"string\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"This is an error\"\n    }\n  ],\n  \"statusCode\": 0,\n  \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>