mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
68 lines
30 KiB
Plaintext
68 lines
30 KiB
Plaintext
---
|
|
id: search-form-element-data-by-element-id
|
|
sidebar_label: Retrieves dynamic data by element.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tv2zgW/iuE5mHbIvIttuPkZTdtmkUG6bZo0ulDHKAURdtsJVIVqaaeIP99zyFFS7KVS9MALXbdh5lIPCS/c/kOD2nqOjB0roODi+BVoY1KybHKUx1c7gQx1ywXmRFKBgfBO5rTlBuek0/XMxA5kdpQyfjJ0c0noheqSGKSUsMWhBJsJ6IUICdHnalc7/464SmX5tbe3LVDZ0INMQtOYmoo0arIYUim5EzMi5wiuE6wE6iMu4eTGLBqTnO2OK6mOYK+L5erOaFD5vGg6teBhAfo2FQMxASqnlGzCNbtcbymIwjk/Gshcg4ITF7wnUCzBU9pcHAdmGWGw2uTCzkHye/hXIXlnMfNOW92Av6dplmCbb3yX9jyH//vvuEaytVNcI9ulQd+SrVqxrpm/bsFV5gTkQrjsX4teL7cAHuKIlM5lSfS8DkEmM44E7MlwLFxk9LvIi1SIos0glY1IzlnKo81MQr+NEUuwY8Qdxp6JJwcvjshjCZJh5xDbzRkTPOY6KU09Dtxc0c8xj4Xf+1a8TMv9EolCWcIjKwCXl8+WxiT6YNuN+bfeIKh2tFUJJkS0nSYSrsill2aia6fLGSrccIqUP/I6FxIiHI5D3Oui8To58CskxkRhghNpDKl7oLHO6BQzGcUpIg1IkoUmsfIlg3vCWc6aMIgoca9Gg/hBZjvlMs5RMnBYNSDZyH9cw9dYaco2+outW5p+NyKVIE0o4nm7X2qkBWJpeidAXBshUhpElDSe/538p3TpO46DNlj/xa9o4ssU7kBeOAEq8AMhlJX2AwuTSBiYQriUp3K9QGO8OLFN5oU/MWLA/KCf90hku+Adi9cU0IjnrQ36SI6bWtti452bpeuaeQrOyHRV2QapEtin6ZBcI/XVyNdoqDOlNRc4/QDSG7wv6a333NAA77QJF7CAIK5hQG4TIV1LHAbCG6SJfyFsJAvQAYwk4jd2hItN9aYWQ4r360rDGgAzwZkEQ/NskQw29D9rBHUdc1mWY4OMsKpUDq7TQ0XrQtl/Qoc1QZz09qidWbRvLJg3tq+GtjOU6REZfbrqZ9oiqvZNCgtfzANDpMZ2J0MRiO+149nbMynwc408O6vyXRqMv8yXJsU4rwjYkAizFIrWGjBoLa3DTnbdcD2+5PeZDgZ9CfDPTbq9SeDwR7j8YD3x+O98RTZ3MQj/uaER3Q/HrJ4sBfTNjwg06nLPAGeGeJhm3ikURKyKun1Z+N9tsvb8JQynZXMU+DZBzx8E08e8yShZNDnexPG+6NRCx4n06lknsJfY8BDW/BImsSKxJPRZBCNeX+vDY+V6VQyP49ndzgYjyct8VPkPBGU0BgWogH0m7TgcTKdSuap4nm4geclzSPI8mRvwOiwP5nF8SaeUqZTyTxF/ERgn96teDjv08Fwd8xb+O7xVDJPYZ8R2GfSgmeZcE7Go0G8B3MNZrtteFCmU5P5UTwjh2cyqPBMojHlm/x6mSv2hfC9cTSC9mE83G/BgzKdusxT4ZkBnssbLGdsDq+WWBV9hjUL9yWN5cPi3lw8LFQsGVx9C4ueW3hhEYyFzhK6xD+xESq+nFwtuCSa26rElkbQU2Xlwra+xlerSs7nsKpoLGRQ/ZAyBo8hruX42AP3j+J4HO72RuNwuNuj4QQsFs4YY7v7oygas9FazWBxY8Xgzb2p2lnZ4rUDyU3l4FFd2WbXBAaIoXSUhRHfsOxbJlZPRRY8yVZlH4GqyrlvtnywEdY08PBQCev1TQ3+wtcevpVBJJoCMooVHAEE+dI5ZeUi5x39YFgcV4/hcDiBVXLIaD+ivSHnfH9/n05muyxeg20xBTc35duMsi90jg1zYRZFZAvZVVnb1VmI9ZHuxgqDC4EIk6zt026pTtAwJWya53S5BqQseyyU9dD/OWinUEDdvuN/X9aVMDFOPWyrLA/BNXkOQXIFM1vXlKFOFGNFjuXrD9SBdxM75gZ0eqVifl+dfVRJAvAUGAjmqacOb+YqpZQWeY3KvHEdVnTyux3c+jhtfclNyrEJjtsJNv2zlpoUbJJbwv/UvvfzWbtBie3eNkNYhh/OWoK8kTBcN1DcTfc2F3Mhb5vUtZYldaYgdUVJSUGNtfXCJw0H8Qro6HhnPVshO3p9fPjh9PxB2EpEGM78u9lEdg5vvTEoMwWFRIavAA6+ci4oLd8AcY6ZQLiEgUL3oMF5HkxwahKqQc790b3iUXDTHO6NjzNM1oaaQq/F6h0nBo18WfVFE+WAC7DjId3dUX/uJY8sYx1n+w/hLC3MQuXib8vLLXO3zN0y99czd/chzLWFEMRpKmzRqbfk3ZJ3S95fT97hQ8iLNLC/QMxUIbeM3TJ2y9hfxtjBfot5lSIplUu/p9U/RNE6UR7CkIcxo8ntJt6KzX6+ejQ4SxOGze4n3LXIxN+C8VSanPH8G5QVrx8QGdsEsk0gvzaBNGm/pt6K6F5Jfzrle5FCiq949OjOOIVNOpWa+yzu7fLZpMfHdDgY8Wgc9ftRHEW90R6Lo+F9atcTzeOVtxlqdMvxm/Cs1Y61zmfbbcA2J/z/5oTfoqhAHByiSZilvS73AQj6Crn43RwWeBXo4hJvb6TcLBRewJtzG7J4t+wg6CLG0F+V093164NdvHcRunsX3bXLgQFOjLnAXdMr8gQG9FdyriEXUGluOjQTqx/mpLqy9o6AucH6VSHvVnQ+ClgiugmQc99oLihErSOyHdzFVHnJKVg58c6R0YoYYktQibhhdpDXAq+VLd1rvJsC5dg/tJXuoJ13NvQDvT7kyc3P6+IGukWXNvPdORvIE0C6piKqcFnFyRnmYjf7RrRU+RlPawcbk71FsQF5yWkOq4BRX7gkz/78eP6czLnE2088Lq95cSAYiFDyDkJE4dJxaH+lLDvZe1S5KuZuk3rYOBu2xeUsAYXJVJ5xTi5OSiP8B1LV+9dn59ak2Alfu7Xm4RfCaKPfc3upK1U5JGfpSItXV6cyJEcid/fFtJUpVXS3li4yrxet6fVYEH/40fxvuXY0vIrWQOFMe8ESgYsHg6UXh6CJttZ69ORuvLA2XjjPIXBCHHUdA1qixNE80Wfea4/G0RgvxPGaOKby40LgTeRGN+KSm7+sfELYQinN/0kIhg7S4GJeAIseDesKJw0tI8JBrwYpdFOGIiw0t/hOgRjSBRONVGHc2qrITMjYUfKT9Sxw/pO9M/ipobN9fQFrNUrGiv3ALcc1zDhhiBOGLgfoEr8rsDCwcIkCHWwecAHwqvK/zQQl0Frec2O1ZnU7fNf2waWBAVQ7is4O3MNBleD89VfbgNIrGUjDWLp5RhF4JuVYuNQ1jOVX3nULbuJNFNQia3ZzeH1fRPHb6YsaH1bF9FuZLJ86S9+SSX6fvPuLMt420/wvZpqyYMZwq28I60H+sqzXNjj1AQ/PFlzbzxAsV+2eGPYu1VF7faAsocbeZUZWswVejIYtZcahoobabwcjS6WWibB/RPrDXswONM9BBi8eQU1KI5HAePaDBz8ztYRxhSX6FZ91YTejOBdbUDnnHfIRNlGSgVtw6wruwbbP4EsL9Aw88w4dS468s6HoStNCwmzIyyLFj3vui4hYaFa4xAX7f8m9LZQt/Va9PIsx1FAFu4nmearfzvAQUDBec/w9c4Hf/QEpmB69uDoP8Iq85wl1N5521sr2+8aGaAvxYprdWAMsvJZUzfDm5HxjRBhMuv1RR+XzbtlJd1EWL6KB8i58djv9Ti+02wV4D5twk1JZG/yWy/PR0t+F76xH5HV15vKbfwJWLla4y+gCLdyxQOF2PW4nehE0d6LQ6WDji6/aZtS3V18mwf5mAUbFoa6vI6o5bs9u8LX7NAX3qOBm5F71rcOt9tx+ufTDXy61OvkLB8uvPhUrr2UG9juihztj+xXR035FdIenqq+6Kl9dVicWP8iiZ+/Lj4uek5ZvMlth+LNbuaxjWMHb/ILy8WgaX1E+Ekzty8hL6LDgNOa5tZKTwSOPrB76G2fjjcO5f7/GFYbeUuOXf+CJ3s3NfwG/Zd1U
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/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 DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
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 Markdown from "@theme/Markdown";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Retrieves dynamic data by element.</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/form-instances/{formInstanceID}/data-source/{formElementID}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Parameter `{formInstanceID}` should match a form instance ID.
|
|
Parameter `{formElementID}` should match a form element ID at the data source configuration.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></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"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></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":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**value**: *eq, ne, in*\n\n**label**: *eq, ne, in*\n\n**subLabel**: *eq, ne, in*","schema":{"type":"string","x-go-name":"Filters"},"example":"label sw \"my label\"","required":false,"x-go-name":"Filters"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>results</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Results holds a list of FormElementDataSourceConfigOptions items
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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"}}></SchemaItem><SchemaItem collapsible={false} name={"subLabel"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"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"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Value is the value to save as an entry when the user selects this option","type":"string","example":"e96674448eba4ca1ba04eee999a8f3cd","x-go-name":"Value"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></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 className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"DetailCode"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></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></div> |