mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
81 lines
30 KiB
Plaintext
81 lines
30 KiB
Plaintext
---
|
|
id: get-non-employee-schema-attribute
|
|
sidebar_label: Get Schema Attribute Non-Employee Source
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW+tz27gR/1cw7IdLMqbesix96Sixc9WN82hsN20dzwQiIQl3JKAApBPV4/+9uwuQokT5UTe93t3oSyKLwO5v37sQeBPopTA8k1pN4mAUzEX2VquTdJnolRBn0UKkfJxlRk7zTAQHgRVRbmS2CkaXN8GFFeaVVpn4lo3zbAHfXd1eHQQZn1v4HAChsKDETuVMRKsoEewNV3wuUqGyABbHwkZGLhEAsD9fSMvG7ycMcFjGmSUAjBcI2HTFJjGbacOyhWB2KSI5kyJmG7zOdG4iMYkb7IP4kksjLDMaOEcOK9Mz9lnGaqSENSMjePyZeYI5SMTS3GZsKhhXjEeRzlXGUsJscCfxJQYN0MeSG56KTBhLGpEoxJKDLg4CBQ/grxI76Bf0RwIFo5sgWy3xsYWnah7cHgTGYQUrZCYXB4H4xkEgXCNm3aPZsNftDcSw1z/sTPvT6VGv0+P9w+5wEB8FdTWCEpzqSuOh3p5dXEyOnwOznUitV9uvC5OYMhkH6DpgqqVWVlhk3Wm18L+HRQPCZFrwKFjPl8tERuTSzZ8tbrqpy6OnP4soQwMaDIBMOpYAoybzQQDulnKgHaD6gqrIPGq3W61WPxy0+4dhu91vhUftQTvsTzvDjuiKVuuoVxN7h2VQsXZlM5FW+E81OC1XdbWB3plET4RgqUUIfAfeGvNMmxXT4MJJwhREh/DRYb332kZVErQlYEh1TPF0rxaAtggzmYoaso8LoVyAbKP6yi1LOMRVwWGDO5i6PQxbR2Gne94+GvU7o/6w0T7s/BP1EkGEZv8jSJ72fWB6rVG33xgMHBiHoI5EqDzFnHd+8vdz+PN4fH4C/02OT96eT87/UU90J7CeGbEEhwe3BRqEEalijgFx+K7sB+lILLNNyxUsM5nRn3en73PEDDIkfCqSXUJsQjzFZSyWdpnwFaRY7fR4MfHpd4fzbQIb++T5FtML6k5ECwWRmdAXD/LHSC+3MMxRRfpd82NvfK7OlfwCUQGhXEnO1TglKA3loSxEsjyHUvAwClzJqGqsNQFF6GKyZYRFiUHGaFHwcVPWKc8eOQOJSCx0EgvzMPO/SFAfMc8WPGMzmSQWDTDV3zbZn0D2M+AxHgKVMdJYaapCA5sp/MFcMwGNY5rfHUJAt6BFnOq5RqpKwawlnA0slw7Ltp8U/nr1GBcPbm+RaG9X5XiVSDAMOzEGkIbQGmS5UQBcOqdCIAKdSccrFEyqa55ISg3fqbjEIuMyeaXjRzj/a6lEODdcIkJBkCPYyIDitYwxX6TaCOZIFnFB6zYdAzTRaLOXPKZWCOV75YXBgDQ8+gVoTXYm101AF86zii3g5aV372ArBoJPD1vDTm922OO8c9RrD/rT4Yx3u61hfzhE7qmwFpoqW+HNjeGrGusfhRJGRizR4BPyX6AQyNqgewJAzGGLhNppH7YB0Xhk8nFrSzE9XorHA4i1l6/es94Aqpqa5/Q9n28pQYUXZ9he5Qm4cKXKOsLvjJxLdV8xOT55Pb44xeT+4eSvFydn8Alp1YrJWIG3xuiWmlrUhf5KiL0AWOisSEAdUOnYC0/1BQjEla0ulO4v14iAb814nmSww3PfsaNKms2MTjdCqei3n8mGaBxAmsb6z7NowabcrivKizGVtfDUa/IFW0BPLszzBhvHsUQhoQBANAJR2L+i3jyOMXQdgVkOoQxgZLbQeQYZKJPbBWCtyk1rrJPKadUoVK0eUx7GUZYDuGKsKMOh9BYP0dsHMDvN1atHoTRS6UplPMowByYrUKMxoGEGCY5JGIt8OkJzWUg8qlhXZixMgYVYlO7eODDHmaZnEc/tI+LufQLpJ3S1r3hwLXzwgRton43IGoWZfEaCh9TQ4Ga/qjRXEfhQz0QS72N3H7v72H1k7G4//ODnZf+UWp92vfW5UDwH/RoqnrXWx5D3KM2KRdTeeEMe4NGIb5F++ngOgf0LDFSwXnxbYt/2HfsjV8pr4MelPdz302JaKkr/2hYIkPToJJhBJhLxiHCvEZOinKq6dW6vtZlKcFC1o0Wktnqlc8ZBZSZXCpFwe8BiLaz6IWMLfu2GNGtdBkSuKg6XWmLrve8k953kvhrtq9EfpRrtO8l97O5j9/cZu/d2kiUqihbfJ9k8TblZOU/zz1FazmABK365YWXIkam2uxUkxsoeK9jsHIJppz1tzwaR6MW8Fx92h7NOdNjh/UF70J72OoOgWusv13FcBtlmTFXs7exIKoYm7hr6uFyBc9lM63jz+A/Ua8QM0xqmnrJvBp2DSq/K3rEz3PHblNb46+aq6JDsRg+p1jrCnAZrU1xrirWwgLM55EWFx9gScKEryVQAFQNOwxKZSgpelALomlU4nuG5rwuUwslKLlJFSQ4IKRMkGrtmDY4l8cB8hj0fUKAOdg7Z+Tt2p95E/1Unzz6gxKcoMTv5FgmBgV527v1d57sTPAPHHHHmDHzHQa+bdrgCB4CBwOWssu/c9+f7/nxf4/c1/o9R4/f9+T5297H7+4zd/6A/993Q3f05LHh0fw5rGy1W9lKv0bl+9TadQsUjIPdmOopyQ8fNRQ9OfQW4kr+1iDkEb7ONgmb1BkLoLzs1b4rbbbdN18WF5TUGeFi5pHcb4C1H7CAd+NwkQHSRZUs7ajZvwKZgy9sGX8qGu+mRrZT+2oh02rzu7shQeJXARSPkuDiP6GQarzg6Jg2yhJHo7C4zEgNnF5Id3RrsQ2fI99IvrsisQFLmyBzglSLvePQ1wFzC1PGDpdUNcrSajCDbhUluH5Lnb9375HBE7pBjl/ru5QXrGaDcEg/hX60vpdJlEMe9djV1XXJwpOvUmL3DZR32UnADs4P7lePZTx/Pn7M5NqWUFHKL/bCQOEVAWL0HF6GkNy5O/HET1SGj8/mCgI83flPBIGOzBARmn9SZEOxy4pXwFqrBB0jfpFLcJChj4K6rZ4VlYnEtEiyUjbUm0fFkrJqgoSbf2PeciiJND1K5q3LwbeOTCtmxxFwlsbjjGi8iDYPsclnIxStyPRXEnwpqoaMWEjX7fAuFU+1l5O7oRBDpSIInlrT1ZOaOXlihh6MWfINUtzGgJjyOzV/CosJqT8axQS9Eeps4PqmPCwkVd3MbcwmOWSiYScwmLFpobcWfGUPXwTC4nOcQRU+G9RWZhhQRYadVgRQ6lqEMoX8kfKcQGMo5E59i/ab2RUNnp2IXkp/JshDzn2G6jtnnDZnp60sos7gy1pF9MmZkGCLD0OUA6/G7KoaOBbGNMlAecA7wam1/ygQeaCXnOVo7szqRb9IeLA0RQCUqdjlyf4zWCc5/YvQAV5drIAUHdA/R/zaIV+U8LSxlG8oqDg62NVjHm2iooFt6c3jLgyusqr81eVHi8fp85Z1KVt87S9+RSX47eff/lPH2meaPmGl8Q4zuRmz95FB1ctet1U/78Dh6IeBfeEqRSp03zDU0qVEPUyWzTHiGPk0xHS2koHOCpeAZdn4H6Fc6pTiEdheDH6ZBIjSnq/YGAHOY7GQC9BrsIwxiKgIV4xCGNyuA6s/aT2NnoOX3aCR2XBgOGqg0zRXsxRjLU8bBPR6wbixtlLskBDOZEoVkmtq4clcRkeg2qIoGjSMmte9meKAMs2rFiA/wAhtaf5oMikSL+Fds1oJ8EAl5Ga7bbL8fog2eE+KtdLrKD7BgqKtweDM5r1EEYsrfitdm3vSbbBPXAhEcdZwzdBsw/NEtdW0zmFkrdH8UWf2Voh1vXW072M36TP3393aXL0ZItrnEMzLUTe6mGjdtXga7pk3YOqq9TVUZOPF59b0wmGEWoHEkd3ODpy44ft3i119ygSP95dV6uqKpFJwBP8PwO4NUI+5R+jOvpfg5/W50z2thd8hbnByq1frQIICPvwg8a6iKgaPk04GVL4I9CUep7tsrer+D0wsWoCn32B1eVTbWft7BQbI8UPjxBKOI39GT+A/4uuPt7b8B9/P9Ew==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'Get Schema Attribute Non-Employee Source' (get-non-employee-schema-attribute)"
|
|
---
|
|
|
|
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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Get Schema Attribute Non-Employee Source</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/non-employee-sources/{sourceId}/schema-attributes/{attributeId}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API gets a schema attribute by Id for the specified Non-Employee SourceId. Requires role context of `idn:nesr:read` or the user must be an account manager of the source.
|
|
|
|
## 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":"attributeId","schema":{"type":"string"},"required":true,"example":"ef38f94347e94562b5bb8424a56397d8","description":"The Schema Attribute Id (UUID)"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"example":"ef38f94347e94562b5bb8424a56397d8","description":"The Source id"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The Schema Attribute
|
|
|
|
</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={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","example":"ac110005-7156-1150-8171-5b292e3e0084","description":"Schema Attribute Id"}}></SchemaItem><SchemaItem collapsible={false} name={"system"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"True if this schema attribute is mandatory on all non-employees sources.","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the schema attribute was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the schema attribute was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"NonEmployeeSchemaAttributeType"} qualifierMessage={"**Possible values:** [`TEXT`, `DATE`, `IDENTITY`]"} schema={{"type":"string","enum":["TEXT","DATE","IDENTITY"],"description":"Enum representing the type of data a schema attribute accepts.","example":"TEXT","title":"NonEmployeeSchemaAttributeType"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label displayed on the UI for this schema attribute.","example":"Account Name"}}></SchemaItem><SchemaItem collapsible={false} name={"technicalName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The technical name of the attribute. Must be unique per source.","example":"account.name"}}></SchemaItem><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"help text displayed by UI.","example":"The unique identifier for the account"}}></SchemaItem><SchemaItem collapsible={false} name={"placeholder"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Hint text that fills UI box.","example":"Enter a unique user name for this account."}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, the schema attribute is required for all non-employees in the source","example":true}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"ac110005-7156-1150-8171-5b292e3e0084\",\n \"system\": true,\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"type\": \"TEXT\",\n \"label\": \"Account Name\",\n \"technicalName\": \"account.name\",\n \"helpText\": \"The unique identifier for the account\",\n \"placeholder\": \"Enter a unique user name for this account.\",\n \"required\": true\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"}><p> An example of a 403 response object</p><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={"429"} value={"429"}><div>
|
|
|
|
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
|
|
|
|
</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={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\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"}><p> An example of a 500 response object</p><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> |