mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
93 lines
36 KiB
Plaintext
93 lines
36 KiB
Plaintext
---
|
|
id: get-source-health
|
|
sidebar_label: Fetches source health by id
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW2tT27ga/iuanA+9DElICFD4ciYbwpZdtvQEsp0zLFMUW0nUOrJrybRZhv9+nleSHTsJ0LI7Z3c7+dIaW3rvl0eKdFuLE5FyI2N1EtYOaxNhzuMsDcRrwSMzrW3VtAiyVJp57fDytjbUIu3Fyogvppvh8+FlTYbqUNsp+jAVPKxd3V1t1QyfaPrqiOkaXoVCB6lMiBUYXUylZkKFSSyVYWNhgqnQzBFiU8ucjeb+xTPNZAhZEp7ymTAi1VYaSYQSbsVU+IC/3PgTGpyKT5lMBbQyaSagCDjMeO3wtmbmiR1rUqkmtbtV0QRzcoNrA5TEFz5LIprSDg5ar7Zf7eyGrYMWf7W33doN2686u7ujDm/vtA9qpHsqdBIrDa3Bq729Tf9VORxbdcMldXUWwFR6nEXRHFwDsrMyNJsnSSQD66XmB00kblfViUcfRGBqy9ocmZiN43SJV8gNJ4Om5H4jnayw8Yp1SB0enimI5O1YJW+mZCUWj5kpzLbOZLt7r4Ld9kEAk+Ep4Hvjg+2gtdPukP0dy1XWVVbniQjkGLJaVjSW2Oq5NmLGRgJT2IwrPoFhRWPSYN3AyBvBjhAEgYnT+RZ7F6cfQ44H2L/RYCdjNo8zxlPBAmhpiAJnRyKSM2lA5VhGwttty46cZdowLYwV4BrGu5EasnHd0zfX7FMm0jkrYpTB8NdksusGq1jkLBHq9Kj7ltW9bGQCF7+PmYD40sjc3nrV3s4FrfaOtWycTh6nWiQZjS7TCoXikawHH6ZES2rK+RjFgJNhS3RHcRwJrspzxzzSK8FyoktSM16hZhn0IlhYpH+YtFRwZOCJgfI01uY+Cy/UnYkJT+KwnmnBtWnVUfpSYer55IbmMrL1qhHEs/utWDADY5D7BvvT6AcEsjb6dC7SGxmIX1EFpSsFD1OncnbjBudhUxCpcJOfPE0ED7HS8Eym15pMZTNb3c+Gg17//flF96L/vj8YnA3e906H5xf9AQat+eherf/2a3f5/XH35HQ46N9HMv+8nujrfvf04vV/l18P3/Re93s/94/uo7oy4P2bM8/i/P6x62VY/k6kur3e2fDNxflqR0S9VygG5CYjUGfQRrLIVHP7Qe53VEmlKVUB18TRAfCNvnbWNaNeJNFmWD9N0SXqbCBMlipUP+lihdooiTOKwzlDz5bqBjXB9sUnd6hq2wmFQWL14vArCuCxVKI+SbkkCYUVOcBEZmtxaFtAjHLuSObhbsdVGzks0WixH3gIfZ1+Pa8MGTHlwUfQOvmK3B0qifksn0K9kLrtPWzFvuCjve2Ddme81+Ec0KG1vzs6GPOdne2D3YMD4j4DBkATKyceT1M+X2H9o1AilQGL4gAe+R0GQROD7a0AljmmoJHN9OM+sDS+wv5UTNzYQk0vLyNQuIWy+0PvLevss4irSWbf88mSEVR9SLmkAHT4iF5Rl4TmjvBZKidybV3Ly85R/7g7PL3Am0H/P8P+OZ6I1kpGdRWiNaSwhKiIhWn82UrsFfjMAThFBHOIsMFeeqovoRBXujxQ+t7ikEYoxhyJiRme+5oZZdJsnMazSioFDkGz57IhGluALng344CEbMQ1JlAFwPCXXeDBxNRPvSVfEngLRfoC0CYMJSnJI4ZsBFHMn4MQ42FIqesIjDOkMoSR6LOZYSo2KPlVXyxMWfXGopKclp1CyQHJH48TYK8Mwlk1y1lYRIsX0fsHMjvLVaW7KBnNmnSuDEeJxMhoDjOmhJ7YCLpJo5kvR+QujcKj8nFFxSoXSFvufnHCuAKJesYz/RV59zZC+alb1YoPN8InnybY56qR9UbuJl+R8NGCV5rsRxXuyhOfAeNG4SZ3N7m7yd2vzN3ljwO/BC9Dn9Yq9Bkqvwah5rkCfVIbPSrOFyq/W3jjHbmFxVIOkX56d4HE/igUjRdfEtp1+BPxkWvlK8J3C3+49yOCH4WzKr4gAa0dnQZjVCIRHlq5FxJbQzlT7azZsojTkUSAqjUQEVUzLVbSaaaUXUjrLRbGQqtnhk056iO3uxuuArq9n7pbTG2Q5AZJbrrRpht9N91ogyQ3ubvJ3X9m7j6IJAupbLZ4nKSz2Yyncxdp/jtpyxkGsPzHIFaknHXVMlohYqzAWLUqcqiN2q1Ra7wfiE7IO+HezsG4Hey1+e5+a7816rT3a+Vef7nI4yLJqjlV8rfzozUxQNwNcFymEFzaxHFY3f7LaEdyTGWNSk+Bm2FzmPRqgR07q9jxTWygGwgDO6b3bC8OB6dEH6wtebKb28qnpLWmw3BuLKSkGIalpTYb6LiBjpv2s2k/30372UDHTe5ucvefmbvfBB07j0HHzjdAxw4jiDUmiPVXQscQuIOg2RhOofMXGcyrCDYmUAVPfvfRp73h6USYAuhVUGT7YBVFXsQx+4WreQ6WdGUnUi3MReUNY2c0Ns3H2hMhE5RIxVC1ZOyOLMmZIEyK+GH+0E+DkUKgm87r3TEd43E5k8dbwUWqIMogoS0KUUx7rzFiTCKcxJjgHyjYfdAJCvWfuMfpvfWH9oPZgDQ+JY1Z/0sgBOV8sf+7u+6UwAmET6lcnDtf33NcwO2Zc4VlhPiSuPJVQNANVN9A9U2737T776Pdb6D6Jnc3ufvPzN1vgOoeDd0P1THgq6E6xja2WYGljrk74fn/Rew2VbwENrxZHFisHi4wuMUVCCV/J4RqCN2zOKw1/V2P5m1+1eLOv6pPF1dGCCI66bI0wqypMYk+bDZv4TQ4667BE9lALYPfzFzFn+lAdfNmZ00JohOnLt1QxMLMnY/tvj3xa46GNXUqKZpd6bMMnOGtchS3+bntB+nn5+rn0IY5Mlt0y8BHln0NMRMsK55pO7phI2lFR+g2TKO7x/T5dechPRyRe/RYZ74HeWE8g5RL6pH4V4sbPueEvx33lXs+i55CO//tFWZnNKzNfhA8tTcf6DDM85/eXbxgE0KdNuszTYBXSFomIG/eIkRsVevmB0Nokm00aZxNplbwbuXoDWURG0dQmP2mzoVglyfeCG9Q7geoz9akNEnYkkCzrp7nngnFjYioE1ZP8jdlqJqwUJNX5r2wXc8uD6TC48y+bfym8msbkro3jfEquusjl0muFy/p9VQh/pVTqztqdUtNv1iSwpn2MnBHuQOkMpHgkbbWejJzR69eokdrKbwhqssykCW8HNUDU0HutSfLUaFXJ3pVOX5T76YSLbU6jbkKxjQ6YhSyExZM41iLfzNGoUNpcDnJkEVPFuszMa3bjKi3t0si1R3LuqSbG1a+UySGcsHER9SgLT6J3VaJTclr61nk/DWWzyG7ruhsX1+ij9LIMA70k2UmhnViWHc1QHv5XZuiwEJukw62DrgA6C38byuBF7RU8xyttVXdkm/aOdQaAohqqejk0P1xuChw/onZDzS6GIMSTPi6OEKGv5mnRb2qYqx8Z2DZgqvyRjFa5JLdnLzF75vUNv9u+pLG3cUGCl3O+7Or9D2V5O9Td/+iirepNN9jpfGIl8LNsvVLg3KQO7S2up1H+81TgX/x1WaqhdZYuNilmMUwZTJJxA3FtM3pYCqF3QhIBDeE/LYoruKZzUPAXUp+LPcsoQldUEXSaqBRPpIR6DXYO6y0VAAT0yqLDuCC6ofYL7fOYeW39nb1Ue44AKjZLFOYSzmWzRhHeDzi3VDqIHNFyN9QcwLFFsYVs/KMpLAhUzTseiOd6bNxftdw4cRHeMGH2m8Xw5DkEX+7e6HIQEQ2ymhcFX4/RhuRg5VKlNA6DxUUYEqUOPxycrFCEcSU/40iTidNP0k3aSyI3OQXMWs7Dazu3K1PbbAoLdE9vu+Cu73XXomp28U++dNuyfseQOC9mdDeE4mUucWEW8Vd+iunZL3D0pX56kLuyt2bpeG3t7RbQauaO3ptbzrj/dVi0WIXe7AxPYfr7+iWFXs+8LfzX9jfWyrX7dfKn++wqflicV3D40dBa/JCB6xfIbXdOrESuc9uc6U0ceXnB1oHFQveH/sUBPyeluofoD2Kxv8AZVC1AQ==
|
|
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 'Fetches source health by id' (get-source-health)"
|
|
---
|
|
|
|
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"}>Fetches source health by id</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/sources/{sourceId}/source-health"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint fetches source health by source's id
|
|
|
|
## 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":"sourceId","required":true,"schema":{"type":"string"},"description":"The Source id.","example":"2c9180835d191a86015d28455b4a2329"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Fetched source health successfully
|
|
|
|
</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={"string"} qualifierMessage={undefined} schema={{"type":"string","readOnly":true,"description":"the id of the Source","example":"2c91808568c529c60168cca6f90c1324"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Specifies the type of system being managed e.g. Active Directory, Workday, etc.. If you are creating a Delimited File source, you must set the `provisionasCsv` query parameter to `true`. ","example":"OpenLDAP - Direct"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"the name of the source","example":"Source1234"}}></SchemaItem><SchemaItem collapsible={false} name={"org"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"source's org","example":"denali-cjh"}}></SchemaItem><SchemaItem collapsible={false} name={"isAuthoritative"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"Is the source authoritative"}}></SchemaItem><SchemaItem collapsible={false} name={"isCluster"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","example":false,"description":"Is the source in a cluster"}}></SchemaItem><SchemaItem collapsible={false} name={"hostname"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"megapod-useast1-secret-hostname.sailpoint.com","description":"source's hostname"}}></SchemaItem><SchemaItem collapsible={false} name={"pod"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"source's pod","example":"megapod-useast1"}}></SchemaItem><SchemaItem collapsible={false} name={"iqServiceVersion"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The version of the iqService","example":"iqVersion123"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SOURCE_STATE_ERROR_CLUSTER`, `SOURCE_STATE_ERROR_SOURCE`, `SOURCE_STATE_ERROR_VA`, `SOURCE_STATE_FAILURE_CLUSTER`, `SOURCE_STATE_FAILURE_SOURCE`, `SOURCE_STATE_HEALTHY`, `SOURCE_STATE_UNCHECKED_CLUSTER`, `SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES`, `SOURCE_STATE_UNCHECKED_SOURCE`, `SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS`]"} schema={{"type":"string","enum":["SOURCE_STATE_ERROR_CLUSTER","SOURCE_STATE_ERROR_SOURCE","SOURCE_STATE_ERROR_VA","SOURCE_STATE_FAILURE_CLUSTER","SOURCE_STATE_FAILURE_SOURCE","SOURCE_STATE_HEALTHY","SOURCE_STATE_UNCHECKED_CLUSTER","SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES","SOURCE_STATE_UNCHECKED_SOURCE","SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS"],"description":"connection test result","example":"SOURCE_STATE_UNCHECKED_SOURCE"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c91808568c529c60168cca6f90c1324\",\n \"type\": \"OpenLDAP - Direct\",\n \"name\": \"Source1234\",\n \"org\": \"denali-cjh\",\n \"isAuthoritative\": false,\n \"isCluster\": false,\n \"hostname\": \"megapod-useast1-secret-hostname.sailpoint.com\",\n \"pod\": \"megapod-useast1\",\n \"iqServiceVersion\": \"iqVersion123\",\n \"status\": \"SOURCE_STATE_UNCHECKED_SOURCE\"\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={"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"}><p> An example of a 404 response object</p><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={"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> |