developer.sailpoint.com/docs/api/beta/get-account-aggregation-status.api.mdx

---
id: get-account-aggregation-status
sidebar_label: In-progress Account Aggregation status
hide_title: true
hide_table_of_contents: true
api: eJztW21zGjkS/isq7sMmFIMBYzv2lytik6y3HDsH9qXqHNeumBGgzSCxksY26/J/v+6WZpgBHGezuduXomprgxmp1a9PPxKah5qeC8Od1Oo0qR3VJsL14lhnyvUmEyMm9GTouMtsrVFzfGJrR9e1MISVxtjaTaOWCBsbOce/QdblVFrWe3/KjHCZUZa5qWCWZDE9ZlyxulTR3GgQYm2d8SCVL6U2GE+1mrA76aY03WnHU6ay2UgYFFKvn/c/1OsN+HD8fe/8bf+kDoJUAn+f9M/6l/5vL9iyMfyTMCtVLEja3IhbqUGd6pIwBp8uV3FTbcVSjJtyx6b8VrCREAqk6BgMECBZszE3zY/qo+qtD1basXjK1UQ8pwPjxg+HUWmWwHgJzqqT8bngws5i+dKTsLZ3PEwfLWAtH40mo7jAf4m0DhZwbGz0DAQVKg9jrmAWyLFTfadwcdS0FG12ddpgd1MZT+FhImPuhA2xKbxkvRSGc0ySgoroyrupAFkGBS4Kb2iD1pLfhsExoJ9QyVxLSAgj5tqARK2+KoUqbiOnrbmMzXiuDcTU3WFYY56maFRVGVKyfqHSBeO3XKZ8lAqWzXEcaDPVmWF87LyBlZDGejZPBfipyd7BYqDvXIMqlNn1bqvLziHebzBB64UE7pp1SiYQ/wlUosEXg7c/9k7enZ432PDianDcX/lrePWavkCvnvSG37++6A1OGM8giY10C4y8Eb9k0oDjQWs0c5kcUORzbvgMFDVY6g81iaU8524KjxQ8gL9kAp9tPBUzXjt6qLnFHL+1zkg1qT02arn42pEzmViHBbEpToykinuOboJhnfiw/ar1qntwwPdHrXi/1YZPr9rt7v4I/t8a1R5vcCX0ohUW9ei0WvhPdbWe2rhYnkOjn0XsYN1YKyeUw/l8Pk8xo2HYzs8WhTysG1tMhFQCAHXSqwBijVv3SaM21mbG4UktgVKJnAQ/VoxtddpRqx3tti/b3aPd1lFrr9ludf9TW3Xeh6lQa6lFq4qkib73hm1SQQCeIXgPL3sDwEX4pnd8fHF1fjn88fji7Kx/7L88vnj3noATP/fOj/vwCD8P+peDU/p02R9AevVwyE3ZiI3iquqHtVlUAZOgf4ONMgcYmpl4mSHShfYEGGo9hIZCSjzOri0KwodPySjm+rUw9Qu8KjB6IdwKsNNKhWNWtC9kshf1ubZWjgAbqFKFMdrY+ks/Pffl6nQOgJemHqQzK3z7CN5eGQt4biSOFDGHoQiBkLgKMlHe+tK2GQBx0S3/LY3LAJN7mNK4Dslexm9F/IybTyAd/DwGZMNPhEO7DFe14a/fvCBmZQWCS8kJgComwpRrYa/T2oQYa40f+n6DhZ5PoJ73+5U+rYTHuZEoNWooR495pTIKjTHRwpZ774q4OwGtOVNf1seDSAgxLv+rMJpJZBMogwQpDfrdNcqNMBE+mZZ99JklVpvRHUJEwDdE9fUCgVWKZG7WMT5rDfHzMWrvbYzRV0TnMyzK+86IcQrpZlcY2fNS4GsijAC1nsIJ4qLY7jzFw5YPrjWCYyWBy7KRhcYlkNeGgRY5TirKrGOjR79FELBKpPNA+hQDf3zEYd1We73PXanQ4X8F2yM2yJlfkW8SszqnAb8GSBU8EaaBuvhx7IcPl4FrIOe5n2Mbb367/kiIuKFJsxkEjQP58t+PoGOROn58ucmggrc8lYm3wAPVEem91Jgc5V21u77aG21GMknAxjU/EQCzhc6IgZtMKdSE2wbBgvoupBpkH9LZEjeMPDn8dp5KhAPTjnUiNvXyFYOkEtHEcImGkMsApRPCu1uZoAUzbdC3KDIvBhrXrPi222o12+w1T8AtUAjWseNgDCan4fEnkIXbxOcUulIS5rN8ClC7gLgblxUHgo/2W4ed7ni/y3nnVbd9sDc6HPPd3dbh3uEhrh7yo4xL3Bi+WFv6rVDCyJilGgqYigELHDMFFMjTCQjBzD4fA5LxBf5H7PNjCzPzfHbi3gHcsNfH71n3gKUA8xl9zycrTlDR1RApdpYSgnjuDJZ7wRdGTqT6HK076b/pXZ1dElP711V/CJ9Q1tquvKfyLZsmJIUdHmkcDLiD7m8FQi4UPqsHqXUwiIcdfBgow35+YcGZkFtjnqUOZoTVN8woi/Z7TnxoQqpR3dw79kI2RRPoGX4HlBl2mCOOeB42f7hLFXMXnQVP1gOIvWyyXpJINBJ4AiAE8hKEeGi8PAlbaBQwzqDiBVEWDRQQOr0EmlKJxdKV1WgsEfqsHBQsDtD8+TzpxUSOyMxyFRbZElTMt9RJ8FxVu8uS08ilC+U4EDJsWLCJ1caAh4neSuiPAY4wXBaAR+XjpCIUbVYaTx+1eeeVOXGanhHTfL7u3qcAPxGZVjy4FaH4CCo9GlE08jAFRCIc9bWSjyrClRc+G0uRJtva3dbutna/sHZXHw7CYQk9LbSiagk8yWYz2AMufKaF58S2GQxg+WHL8tSEQrXKVlAYKzhWrcocaqNOe9QeH8Sim/Busr97OO7E+x2+d9A+aI+6nYNauddfL+u4KLJqTZXi7eNILgYSdws8LlOQXNZpnVSyFd0L2wqENTq2y3kz+BxcerPkjt117lgc0gF3NCvcMZd/NThD+bA0iUe/+fMILFpynd+1FDtNcS/tNzyE2lLHLXXctp9t+9lSxy113Nbutnb/19Sx+xx17P4G6uh/B6Uf6v9I6pgA70BqNoaggA1xBu71v0SDKfApnD6GsnfcTIQriF6FRXYO11nkpdbsHVeLnCzZykmkWroL4Q3GznCsycfCAM4mAJGKAWpJYLeYVXjODZwU8oelciapjtEgkGsWUY9+u/E1k+dbsUr4pcMSKNB9C1j3jkv8GWyM9A8k0DnoBID6G55xhmj9rvNgNkCLz9Bi1r+PhcCaL85/9zb9JHwKyhuEi6GPNWX4U2fmXME2QtzPPXwVFHRL1bdUfdvut+3+79Hut1R9W7vb2v1r1u5voOqBDT1N1WHAF1N1GNtssYJLvcHk+r8zdiqVoAGlN9MxcfVkycGJV0AqhevNiCF4m/GothMukUSl6zR250Emjzs2v/HstwNeu8ykMGvq3Nwe7ew8QNAgWI9NPpdNwDKIm1sofdeM9WxnBJ7aAEL+3i0mEA6gayZ+gSa52UjMZA97JNw7nQzDnAXn0zWDz0rGO5oYzQVeRfViGgyyPmQVfY1X1mBL8Z2l0U3KojX7wK4rkz7+flu8oCds2eS+z64G4xloumIimnCD4YLogyCK1xXoc+wxq5dhxK9vymOGyNG9hmsjl30Hfx3orCl0gcM67LXgBi/q0oWZFz98uHzJJshMCRkyi6RYSLruzNl7SCNCvl5+eQQnUTMyOpv4+3O9yvUcrDQ2TsEp7KMaCsGuT4OjzqElDADDye04SRBs4KybF3kEE3ErUuyWzaW3MTllonbAizu8Mu8ldUbaQkjlr6vi9bKPKmInEgELq4PGBBNpR8iu57ldvGTX1yrxj1xa5KVFJM2+XNHCu/Y6TiUCZwzljiJ4aslbX724lxeV5OF+C75Bqas6oCeCHtVLVXEeta/WoyIvQnlVPT6qD3T1vjqNeZTDO/tZmrBTFk+1tuKfjGHqYKlcTzKotK9Wi+77R1QRUadVUinyS0YyAhJJ+p1BYSifTHyETZw4jPbHKVS2P1FkARd+ost4P1Vspq+vodfiyETH9qt1xgUjXDDyOGGD/r6VYWJBbaMNhAM+AY6X8SckCIqWsNHL2oj8JH6H5mD7iEFVfzN8fuT/OFqCYPjE6AGOLsYAVCMHL66Z4UXlIAv7WcVZ+enBqgfX9U01tNEVv3l9i99AsbX+2exFi3vLQxa8afmtUfoJJPnz4O4fhHhbpPk7Ik1gxZhutGzYPpST/HXgdOuHfpauQ1u6TU21SgQctjfLtwDKguYpd5jVVNXxVAo6LpgL7pAfNjCz9IwqMb+6HV4nAErO8czaAm/lI5mCPDrQzlfmVDCefGJc8W+bhesVOtyob7IPsINTQPMN7t7wYi88+1mHbdwQIvOeXjE7yYMNpGs2yxS+3ABqZzO8R/5cRiTSxpkHrvB2hDdBE/UrZuVVjKmGJjRpH2Nm9mKMJ9GwyS0F/pm1IO42HEOD6zGK4d2spSEDkYY3Mxsr1P452ZBt0VSkc9w/AuoCAROlFd6dXq5JBGEq/PahzWQnTLI7OBaE4BbKp89us91sRbSlwNcOtHWw4y0JP12+zcc2vGXKio1ZJSsflufx27dOt2+dbt86/eu9dRqYHG7Bd+Z4yoz4kPljA39ec13bdF4DU4/8+6geGWCDD2XjcPjDA55L4hnGI379Sybw0Ov6Znk8QccEkJD4OakdjaEPr76uWoaWF4NgwUv6ZfXJl1g32pKfq6vF8kitBh8/CTyJg3mPNzDKH5WSXv6BP0wtTVn7uRHPNIoDrrd9ANzH/wJfEVE2
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 'In-progress Account Aggregation status' (get-account-aggregation-status)"
---

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"}>In-progress Account Aggregation status</h1>

<MethodEndpoint method={"get"} path={"/account-aggregations/{id}/status"}></MethodEndpoint>



This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.

Accounts that have not changed since the previous aggregation are not included in **totalAccounts** and **processedAccounts** counts returned by this API. This is distinct from **Accounts Scanned** shown in the Aggregation UI, which indicates total accounts scanned regardless of whether they changed or not.

Since this endpoint reports on the status of an *in-progress* account aggregation, totalAccounts and processedAccounts may change between calls to this endpoint.

*Only available up to an hour after the aggregation completes. May respond with *404 Not Found* after that.*

A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN or DASHBOARD authority is required to call this API.

## 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 account aggregation id","example":"2c91808477a6b0c60177a81146b8110b"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>

An account aggregation status 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"}}><SchemaItem collapsible={false} name={"start"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2021-01-31T14:30:05.104Z","description":"When the aggregation started."}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`STARTED`, `ACCOUNTS_COLLECTED`, `COMPLETED`, `CANCELLED`, `RETRIED`, `TERMINATED`]"} schema={{"type":"string","enum":["STARTED","ACCOUNTS_COLLECTED","COMPLETED","CANCELLED","RETRIED","TERMINATED"],"example":"ACCOUNTS_COLLECTED","description":"STARTED - Aggregation started, but source account iteration has not completed.\n\nACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed.\n\nCOMPLETED - Aggregation completed (*possibly with errors*).\n\nCANCELLED - Aggregation cancelled by user.\n\nRETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance.\n\nTERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance.\n"}}></SchemaItem><SchemaItem collapsible={false} name={"totalAccounts"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":520,"description":"The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*"}}></SchemaItem><SchemaItem collapsible={false} name={"processedAccounts"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","example":150,"description":"The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.*"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"start\": \"2021-01-31T14:30:05.104Z\",\n  \"status\": \"ACCOUNTS_COLLECTED\",\n  \"totalAccounts\": 520,\n  \"processedAccounts\": 150\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={"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"}><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>