mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
91 lines
44 KiB
Plaintext
91 lines
44 KiB
Plaintext
---
|
|
id: list-identity-snapshot-access-items
|
|
sidebar_label: Gets the list of identity access items at a given date filterd by item type
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtv2zgS/1cI34c+ED/jxLW/HNKk3cuiu+3lgQKXLVBapG22MqklqbTeIP/7zgwpW7KdpEmL27YQsOjK0nA4b/6GEnPVMJm03Cujj0Vj1EiV88dCaq/84lTzzM2MP0gS6dyxl3PX2Gl4PnWN0UWjoGL/gSHGLhrvdhpCusSqDLkBr7OZcmwu/cwIZqW3Sl5Kx/xMMpyFmQlTBQ9OUzCFczDuGWdTdSk1E9xLNlGpl1aw8YIImF9kkp3IP3NlgR/PYQKr/iIdmEtAH2T9SAk9Kvg3Z0HGkZVcPGKgRcYtB9GkRV2uGgrlzbifwSMND+CXEnDtkpmc88boqoGTwl0Hauhp43qnYYMAYDRvc7mpu1xpR6zkZz7PUuTxLOkOO3J/8GzAeV+KIR92xmIo9nb7/b3e7mQM3LdKhMb4WplcJhM1UVKwyG0lVq/TGTQ7u81O96y7O+p04L//rUT5M5fg46UsNPWtsmzOXXIyi+NXs8NDk2vfuH6HarjMaCcdMgax8H+3mNeMP8jEt4BdYrSHm0jPsyxVCQVF+4PDQVeb0nJrOSpFcYf3jZavJxQRkSLwxrBXnuRcJUO4emMNxKc8iSKTwb5oLGp731FZds8RLzTdm8t7z3Viykq9u75eOosMFQgZUrKKIdhy0IbTDnQRAlmkLRwNElzyNJdly/MyV/QRlqdeMuw+6zwbDPZ35f5QDDtdvBr05HAw6XT2J6sAdSGwIERNbhP5e7h7xD0/TZTUicRLJ/2SgspfbzDcNbs98Qkzdk36ipZN9tbYj4Iv2ofKq7+kdjOVRfVwqHJZyhfFrLbFDiyEKzsxUz7T7LcjjP2Vbw4p9Efd3g7G7VFlMDidrsAHO+tmx2F3GpyI7rA0zX8fG3soz8UKgKXJtjgq2CL9WuKr7L7dMHebdNNCWXaHdYDgVstk2f0jj9/ksFIy3i5WyQAM1kxyzYZsJaJ7yMg9FOhx7pHD1Jo8cyvejfPsE3iRzc1YpatVueqRs22zf6scK1voqzNsw/5Y0m4zPLPmjpqEBF9RiqrzkTi3aoll9xorb3/bGniYKrTTC2uNBT4n0udWw8KuJoSxEAtIgFljIwCBwLKrQR0lHrJMLpcJqNuAFr0Ka4CQnqv00Ai5CQDWlX2ptGxOLVcooSSRExiIK8GlEjACos5KFlgifkMViK5VgQlgiVaXPeeCACDqdxiVATN5y5OPwAvD7C6BzrWC8awYAmiCTUCoG6aVA8nH+51hrz/Z73Pee9bvDvbGwwnf3e0M94ZDnH0OLuPTYJo1fFGd+heppVUJS00CHvlLIjrmYHsSgCYvQ5LbfUA8vsD+CJgC7VLNKC/z8rPfAcT9/PAN6w9YyvU0p/t8umYE3Tw/xbDO05SP8RaiTNA8MH5t1VTpbaJInc+xZTh68fLg/NUZ3Dl58d/zF6dwhbw2GgcogUoLDEsQFWJhZj6FtiEo8Ik75mQK5pCixZ5Grk9BIa5dmVCFX27hMP2FnPA89TAizr5lRJk1m1gzr6QS5c1nzx6rlmztsDHem3OfzNgYypxg4EIkf4pFJ/PNV9GST9kM2g5pn0CNEkKhkjxlVFygP+ILYMS4EJi6gcEkh1QGYRR0Nrln2niVyKovVqasemMF5V6VnYLJAZLfHScHic9BOFKznIXLaIkiRv+AzMFyVenOSkYjky605wlowdN0AWa0FizMYBmCZsCxWI7QXQ4Kjy7olhULS2ChFpW734IwR97Qs4Tn7gvy7k0K5adJqi0fXMqYfBAGJlYj8kbhpliR4CGqTYMj1dJdReJDoypTUedunbt17n5h7q4/LNBZfErQp7sJfc51sesDSmxAH0vRo83a1lBw5A4Dg0SI9OvbM0jsj4AagV5+znDr5Bvio7CUb8GZhT/C/THCj6WzKr5AAcmOQYMJVCIpRiT3SmIyVDDV7uZsL40dK4HIeBMiQtW0bGFyxsFkNtcaJeFuhwkjnX7k2YxfLrdtqALirFo0M6P0gzZcaiRZI8l6NapXo+9zNaqRZJ27de7+mLl7K5KsvruIOMnl8zm3i7jlGp6jtpwBwXIbkC1TLu4GVtEKMmNLjNWoIofGuNcddyeDRPYF74v93eGkl+z3+N6gO+iO+71Bo7zWX6zyeJlk1Zwq+Tv4MbzSk/YScFyuIbicN0ZUt/9y3PyfYFnD0rPEzWDzVrHBSNixv4kdfzcedAPGgB3tDduL5yevkD9MTezRbrTVizA7mA7IuSdIiTEMllbO19Cxho718lMvPz/N8lNDxzp369z9MXP3XtCxfxd07N8DOvYZQqwJQqx/EjoKwB0IzSbgFNAhycG89M1IBqrAVdx9jGnvuZ1KvwR6ZRS5t+099TE4x2LAnobZbnhhHXZtuQYgKz9nIYGWIKgGizVYrBecesH5ORacGizWuVvn7o+Zu/cAixEN3QwWgeCLwSLQtjpsiaVeYnD93zEjpUqUgMKbmYTQolihQMIVeOYD6Kf07SedYhg12uEQBpq7Gb/dh7LSvlLiuu3iURP4iecSrtvhpXNTxUMnAagGqXObAreZ95kbtdtX4Exw4nWLZ6pVHAnQ5lMrMfP2GCy4pTjh15AhEZGAHbw5jki4Rea3CiM8lENiHpxBCmMsg1PoBfitnPHbT/TyAkAyC2x28NRDjDa6DSJmXC8eOaJuUXRt6Ad6ndv0+ut1CYxu0GWb+W6dDegZSLqmIqrwDt0FUUFfhoO/zkGew1DLDnKMhIt3ZZpTxO5Bwg3K1XqE+9a9DYFeI1mPPZfcQmMRPuV4/OvbsydsioiVKkbuECxLhS0G5NwbCCOqiAfFZw04iBYpa/LpjJQ7qHw4ghnIJikYhf2hT6VkF8WX77/DUnECtZ3MjoMklRMc9e5x4UEhL2WKq2hrZW0MTiV0G6zY5pVxT2jFpNZCabic093WH7rJjhQWMoUrP9JEFembDXaRFXrxkl4PFeJfBbdmzEPi5p6sSRFMe5GED5ETKAPIgqeOrPXgyQO/Zokf9mFwB7muy4CWiHJUP/dJCq89WI4Kvybyq8rxh347U7AcV4cVJ96gnOWpYMcsmRnj5L8Zw9DBVLmY5pBpDxbrE07apIxo9jolkZphyqZqArgk+V5BYugQTHyMizthGxMafUrb9+RZqAvvofUW7H1FZ7p9AWswUgqTuAfLjBM2ccJmqBMuyh+WOAwsyG3UgepACIDDlf+pEkRBS7Ux8Npa+Yl9m8bg8oGnAomLy0bhx2hVBONVODuI1EsaKNWN4iQSvd5KUxZ54TpXMVaxq7BuwU15UwPL65rdgrzLt3O45H5v+qLGB6vNl9c6XXzrKn1DJfl+6u4/VPHqSvMzVpqIljHcaNrYVpSD/HnEdJubgdAxgN7wLzylXCVgDm0PNXKEYsqMspR7jGrK6mSGR7Fxf1dyj/hwByPLzCkToePH9IdmkRhNLdBA2jrArTycC2uxs9XMnBImgE/0K/52eXzxbyAkoS2VLfYWOjudgFuwq8NPTuHZBxPbu1PwzBt0LDsqnA2gaz7PNZ5CA7HzOR4KvysihHJJHgoXNHlaFrYwBP2Wo4osxlBDFVrU39i5ez3BHWpofkuOv2Mu8LuL29NgevRiPPO1UuREphSZSFeF9nfxhmhrzmSaYV8JVVfGU2txht+OzzY4AjMdd+WNnbbjINdGWmCCLVQIn91Wt9VpUksB9zPjPHTCJea/SP+tTuqvh+7VajP/u/4LAXFNw2akneE+HFoqDw1U6GgvGls7Whg7Cn88oGhq8U48bl/pa6ELmoHpkdPVFW7qYKN3jbfDaXvsniAYMEOhm55AeVo/01815tYj9lv1+ChxPyJSFMc/6ex90TLec/LH0driCRaHtT99sFWEYuNTL8oiFKLBOOyFHyzAxt85eIAMNJJOkYYdNTJJeBT23EqDNt5KoS2X+yC/vID8u/4bCFl05g==
|
|
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 'Gets the list of identity access items at a given date filterd by item type' (list-identity-snapshot-access-items)"
|
|
---
|
|
|
|
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"}>Gets the list of identity access items at a given date filterd by item type</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/historical-identities/{id}/snapshots/{date}/access-items"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This method retrieves the list of identity access items at a given date filterd by item type Requires authorization scope of 'idn:identity-history:read'
|
|
|
|
## 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={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The identity id","example":"8c190e6787aa4ed9a90bd9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"date","schema":{"type":"string"},"required":true,"description":"The specified date","example":"2007-03-01T13:00:00Z"}}></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={{"in":"query","name":"type","schema":{"type":"string"},"description":"The access item type","example":"account"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The identity object.
|
|
|
|
</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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"AccessItemAccessProfileResponse"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"accessProfile","description":"the access item type. accessProfile in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the access profile name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AccessProfile - Workday/Citizenship access","description":"the description for the access profile"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the access profile will create"}}></SchemaItem><SchemaItem collapsible={false} name={"appDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"AppName","description":"the name of app"}}></SchemaItem></TabItem><TabItem label={"AccessItemAccountResponse"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"account","description":"the access item type. account in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"dr.arden.ogahn.d","description":"the native identifier used to uniquely identify an acccount"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementCount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":12,"description":"the number of entitlements the account will create"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemAppResponse"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"app","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Display Name","description":"the access profile display name"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"appName","description":"the associated source name if it exists"}}></SchemaItem></TabItem><TabItem label={"AccessItemEntitlementResponse"} value={"3-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the access item type. entitlement in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"attribute"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"groups","description":"the entitlement attribute"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Upward mobility access","description":"the associated value"}}></SchemaItem><SchemaItem collapsible={false} name={"entitlementType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"entitlement","description":"the type of entitlement"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"DataScienceDataset","description":"the name of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2793o32dwd","description":"the id of the source"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Entitlement - Workday/Citizenship access","description":"the description for the entitlment"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Dr. Arden Rogahn MD","description":"the display name of the identity"}}></SchemaItem></TabItem><TabItem label={"AccessItemRoleResponse"} value={"4-item-properties"}><SchemaItem collapsible={false} name={"accessType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"role","description":"the access item type. role in this case"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"2c918087763e69d901763e72e97f006f","description":"the access item id"}}></SchemaItem><SchemaItem collapsible={false} name={"displayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"sample","description":"the role display name"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Role - Workday/Citizenship access","description":"the description for the role"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Source Name","description":"the associated source name if it exists"}}></SchemaItem></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {},\n {},\n {},\n {},\n {}\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Access Item AccessProfile Response"} value={"Access Item AccessProfile Response"}><ResponseSamples responseExample={"[\n {\n \"type\": \"accessProfile\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"name\": \"sample\",\n \"sourceName\": \"DataScienceDataset\",\n \"sourceId\": \"2793o32dwd\",\n \"description\": \"AccessProfile - Workday/Citizenship access\",\n \"displayName\": \"Dr. Arden Rogahn MD\",\n \"entitlementCount\": 12,\n \"appDisplayName\": \"AppName\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Access Item Account Response"} value={"Access Item Account Response"}><ResponseSamples responseExample={"[\n {\n \"type\": \"account\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"nativeIdentity\": \"dr.arden.ogahn.d\",\n \"sourceName\": \"DataScienceDataset\",\n \"sourceId\": \"2793o32dwd\",\n \"entitlementCount\": 12,\n \"displayName\": \"Dr. Arden Rogahn MD\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Access Item App Response"} value={"Access Item App Response"}><ResponseSamples responseExample={"[\n {\n \"type\": \"app\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"name\": \"appName\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Access Item Entitlement Response"} value={"Access Item Entitlement Response"}><ResponseSamples responseExample={"[\n {\n \"type\": \"entitlement\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"attribute\": \"groups\",\n \"value\": \"Upward mobility access\",\n \"entitlementType\": \"entitlement\",\n \"sourceName\": \"DataScienceDataset\",\n \"sourceId\": \"2793o32dwd\",\n \"description\": \"Entitlement - Workday/Citizenship access\",\n \"displayName\": \"Dr. Arden Rogahn MD\"\n }\n]"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Access Item Role Response"} value={"Access Item Role Response"}><ResponseSamples responseExample={"[\n {\n \"type\": \"role\",\n \"id\": \"2c918087763e69d901763e72e97f006f\",\n \"name\": \"sample\",\n \"description\": \"Role - Workday/Citizenship access\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</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","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></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 \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</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={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</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","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></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 \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</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","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></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 \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"404"} value={"404"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error - Returned if there is an unexpected error.
|
|
|
|
</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","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><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={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></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 \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |