developer.sailpoint.com/docs/api/v3/get-report-result.api.mdx

---
id: get-report-result
sidebar_label: Get Report Result
hide_title: true
hide_table_of_contents: true
api: eJztW+lz2zYW/1cw3A9OMpasy4f0ZUeR5FYdx/bKcrNbN5NCJCihoUCWIO2oHv/v+94DeEny0SSz23bkmTYiCbwL7/g9ELx3Ej7XTu/GmYgojBPNhjzhbPQ5ibmbyFA5H/YdT2g3lhFd9pzvRMKShWAxTYB/dBrAPD+MGc9uJguesDuuWZwqBg8k/VJSzetsIpI0VpqJZZSsqlSYVMzlWiD9WDAO/6mQoSC3cI/rT8wTvlQSJdHsTiYLlmrh4bSIr4KQe+ujmOJLUXf2nTASMcc7Yw90mIvE6DshvvBcCzeNZbICU9w711rEg1Al4nPST5MFmkdHPSNqzYgKV9xzPjyAeSIeA5NExJomSzRSxGHavoPc4QqFMpyAO/ByF2LJnd69k6wifK6TGEzjPOw7sfgtlbEAGZM4Feumv1byt1Qw6QmVSF+KmIU+rQVpbW14t5Dugi248gIwjREamIrPfBkFyE347RO/22l3jkW3c3jUmh3OZiedVocfHrW7x94JyGG1AGbxqlDDDZFCIrbqMAvDQHDloMw+R6P2fB5oUVGK7qxrpROeCNKkpEUC6x5FwQq8xxNoHdBLqNzb0DV8kbgLfOLH4ZLMMHxbVhQtiOsDcyLwF6FR2lajgf9UJRiKhMsAqM7CNHmBDwMXF91DJUgL5ZQuOdfBrxoJ3m+aJ5z9KtzEWdd9K2drAuAJPhkDF0YmQrZRjI6cSKOMGT8lDuvOBIZQ6RJdtz8YXFyfT6/g1ng4Op+Op+PR1cfhaNofn1VvFhf/+Xg5uTgdn40+5jdGk8nFBEZcTC6/759/rMy6GvUng+8/jv59eTGZwvX1+eBiMhmd9aej4cec/0YquaZQB8NatVa47BS8Apab5wbRizANPDYTONAV2sY8LvlkOGIQrbfSJfsUXr5FVXBFdLGh8M/JoTdNVhUPR1UirJRXTJSB6LA0MYQESm6FY+jvQifomkaBOrvWKQ/Am5GURrLoV0Y5Cq6K5BTeuMYscw+TrFAB6T0vt00T6yIXaaNqKd7qnLjNI1+08G/Wmnmd7lHzsHPSbDfxD9m6kO4w8J/lbSTNTIEmIAMxD6bDYKgSSw5R4+B1LZFrqrcarUat0a01jqedVq/Z6TUa9fZR5ycUAWMg1U85+tX1YDC6Qn88hfW+nozg1/v+5Hx8/h38mo4m78bn6JGbjmilroQbxp+NRMO6arWMGUjmpaa0lGSTkB3mIi5rDLeOOi+wFxoFvXtZZdjutDCVhnf6K9ho+TvRRjJV6sdAnN+Cs/FZIE6JWJkRj2OOlUAmYvnkGgyufoSry+Ep1MZ1IS7SJCqynC8DwYzYus6mmAYoq5s7hCdciBk0CZRrJpQXhaAcRg5nVJlYXnnZHlIzYu/VGRtbHGFZ3YVqL4GSeGvTDY/n6RIX2uCMOxkEmFxu9kD6vX22B+LvfUBGtpRVTGV0/PCA2UQm5AtlLKHRI+xgspQJu2RlY9mGMtaIdLnkUF+fiHjrgMj/lgepWE/62xN6Jck9kU5MNnGaotH0Wset2UnjpON2fN5s+a5/4vOT7kmz0cJqn4c/Rmi7GqGH9War9ZNTBGgpDovIaB+dNDP3bXbb25wtNyz+7TudbZV6EEhct1Ecg3vULJbEauBbTEqZl81Cb4XJWSowm/S+qmBXS65HJhyE3gvqxynUsdo85hIlFCSyCxMx2G+lh469DMH9DMms0NC4aqoBS9Sb7C2g24nVb2CVQR8EoP4JaI3/QGGwU6AiUJg9wlYcCz47anRbHf+ow3nrpNM8Ppx1fd5uN7qH3S5yX0LS4nOxLVWsdw0KYJzLghCCGrIQIlMOticBiPmW7PLIGhCNF9h/CnqZsbmaVl6G0H4f8sjbwSXrHLOAq3lK9/l8zQiqdo2erNKAvNXCyn0rxEUs51I9lRCHo9P+9RmCosnoX9ejK/iFtDZKUB8KtPLQLUOC9YvwjiS2CiAQ1SIAcwivzt5Yqm9AIQ6tUGmgNFd6pcGYeQJjbyz3LTPKpAssnYWSa/og9krWRX0f0iTcg3gF8DPjiMNCg8Pe9F1XREntzFryDVtAgyTi13XW9zwCIDxglMQ0zF9hvuWeVwA5P4VQFtTUIRRWYbIB6QpTVlejSMRn5UXB4ADJn/eTvpsAOiOfqERh7i1WRLs+ILOxXFW6acloZNKVSrB1dQn4uSFACxcyE+gmobzZdEQIEhKPysblGatcXyjdvTPCDJOQnrk81S+Iu8sA0k+NVMsf3AobfNqiVshGtBrZMtmMBA8J+uJkOypfrizwoYyLwNvF7i52d7H7wthdfzix+xP2KUGf5ib0uVY8BfvGVDw3oE9M3oO7ZXYQwRu7kPu0f2Gs88P7KQT2J6FwvPgc4cbMN8RHppRvCN/P18Pcn1Gnky1WZS1QQLKj0cCHTCS8HsldSOwUKLG9yQ0g5UyCg6otEBGyZsxWYUrNht3QAai/z7xQ6LxN4C518pQBkavyatR97JDkDknuqtGuGv19qtEOSe5idxe7f83YfRJJVnchLU4q9hzB0+xz1JYzGMCyN2UsD7l817GMVpAYyzGWU0UOzqzVnDX9Y1d0PN7xjtpdv+UetfjhcfO4Oeu0jp1yrb8p4jgPsmpMldbbrCOZGF/5AI5LFTiXTsLQq27/0S6zj2mNXiRmuBlsDiYtdhhb3U3sOA1D9o6rVYaQdAVDqsJGmNNg7BLHxtlYGMDZHPKiYpCqJMiFroQ7+jUW40uFQC4lBS9qAXTjVa3v4w62CZTMyXIuUrlBChJSJghCRM0hOJYEJYWPmA8oEIKdQ3b+hujULtFXIXk2QY3PUGM2+uwKgYGeI/fDbfu7YxA+xhxxZRb4kY1e0+1wBQ4ADYHJWTnu3OHzHT7f1fhdjf971PgdPt/F7i52/5qx+wfwuUVDj+NzGPBifA5j6w2WY6lTbs44/m9hOoWKlYDcm4UuHbDxCgxOuAJcyZ7JxByCByd7zoE55aAP7stnJx8O4uK8JuJDI1oaBzBlkSSR7h3ADKFgpR7qPJL17PCFCu/qbrg8uG1vyT94UMDEGmQwL6Vzr6x/ObZdhjl9EUt0ZZP3iIGxuj3q6GiwPu0QP0lf2RNlqzCFTEdk9hm4vXUruo2nLKGn2NP27CpaaUNH0O06Dh6e0+fH9lN6GCKP6LHNfE/ygvEMpFxTD8X/UByvvULwbbhvHLItCgo2bK0NZhc4rMXeCh5DZ2DeYbz64f30NZsj5KSQT+kIlZDYI0DQXIKLUErrZ/v5OImqTBym8wUJ3q+8McEQYn4ACrOf1ZUQ7MYeoFmdQ66fQHImk+IkQfkAZ314la2MJ25FgGWwXlgSHU966gAsdMAr815TyaPeQCpz8gnu1n9WNTaUmInooDOOsSpSq8duokwvXtLrS4X4R0atZqjViJp+vSaFMe2Na07guBDHSIIHmqz1xcwNvVqJHjZScAeprsuAlrByVN9zudmqfbEcFXo1pFeV42f1no58Vqcxk76yE6pj5i7CUIt/Moaug2FwM08hir5YLDpnWqOIqLUaJZFqhmVN1gAdknxnEBjKOJM5TkzgJATcpjwTkr/QykLM/wK9s8d+qehMt2+giOJIL3T1F8uMDGvIsGZygLbymxqFjoUHFgN7lNE4wKBYf8oEVtBSzjO0tmZ1In9Ac7A0uCAqUdFRz1z0igRnfzF6gKPzMZCCEVznb/7gmllaWKgqxsq2BdYtuClvEEJ9XLObkTfflsKa+WfTFzXuF7snFypYfess/Ugm+fPk3f9Txttlmr9jprFwF92N2Nq+oOzkBq1t7uWZD6Lg//CUIpVwNXQt5hMoxDBlMlHAE/Rpiml3IQXtAkSCJ4j89tGvwiXFYfY1hf2Wak6nfGMQmEPfJgOgV2fvoc1SLpgYWyw8NwFUfw1tr3UFVr6kU9nDbOEAQC2XqYK5GGPpknFwj2dW15PaTU0Sgo5LiUyzkGBcPiuLSHQbNEWdmo14qS/8K/MJSGkRn+EFa6jtXjEYElfEfuRUKDIRAXkZjqvC7+dog+fUFiKIsMmDDApgSpQ4vBtPNygCMaVBL2imw3h+YCfpAxwLRLDVMc7QrkNrh7eiUCfQkZbo4od59th4/llbxZPui63xv+hXfLb0YM9wEOF+F1oiNT2M6Rxv7Pl4XLTe2nd3tnmEdmQBxsOx9/e4PYKd1APeNt+7YUsJK4nB8sgna2VDfuOv17Zq+EngjkD58zvb9zsONldZU/cHJX81sd/lvWZf82HhVomznUq1KgubaVJZlwf8UMRsQ5ECZojZqCpN3niVg5rnmwffjTCm+CMIxf7o3eC2w38BQ3GOUQ==
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 Report Result' (get-report-result)"
---

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 Report Result</h1>

<MethodEndpoint method={"get"} path={"/reports/{taskResultId}/result"}></MethodEndpoint>



Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name.

## 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":"taskResultId","schema":{"type":"string"},"required":true,"description":"Unique identifier of the task result which handled report","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"completed","schema":{"type":"boolean","default":false},"required":false,"description":"state of task result to apply ordering when results are fetching from the DB","example":true}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Details about report that was run or is running.

</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={"reportType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`ACCOUNTS`, `IDENTITIES_DETAILS`, `IDENTITIES`, `IDENTITY_PROFILE_IDENTITY_ERROR`, `ORPHAN_IDENTITIES`, `SEARCH_EXPORT`, `UNCORRELATED_ACCOUNTS`]"} schema={{"type":"string","enum":["ACCOUNTS","IDENTITIES_DETAILS","IDENTITIES","IDENTITY_PROFILE_IDENTITY_ERROR","ORPHAN_IDENTITIES","SEARCH_EXPORT","UNCORRELATED_ACCOUNTS"],"description":"Use this property to define what report should be processed in the RDE service.","example":"IDENTITIES_DETAILS"}}></SchemaItem><SchemaItem collapsible={false} name={"taskDefName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the task definition which is started to process requesting report. Usually the same as report name","example":"Identities Details Report"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique task definition identifier.","example":"a248c16fe22222b2bd49615481311111"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"Report processing start date","format":"date-time","example":"2020-09-07T42:14:00.364Z"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`SUCCESS`, `FAILURE`, `WARNING`, `TERMINATED`]"} schema={{"type":"string","enum":["SUCCESS","FAILURE","WARNING","TERMINATED"],"description":"Report current state or result status.","example":"SUCCESS"}}></SchemaItem><SchemaItem collapsible={false} name={"duration"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Report processing time in ms.","example":342}}></SchemaItem><SchemaItem collapsible={false} name={"rows"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","description":"Report size in rows.","example":37}}></SchemaItem><SchemaItem collapsible={false} name={"availableFormats"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`CSV`, `PDF`]"} schema={{"type":"array","items":{"type":"string","enum":["CSV","PDF"]},"description":"Output report file formats. This are formats for calling get endpoint as a query parameter 'fileFormat'.  In case report won't have this argument there will be ['CSV', 'PDF'] as default.","example":["CSV"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"reportType\": \"IDENTITIES_DETAILS\",\n  \"taskDefName\": \"Identities Details Report\",\n  \"id\": \"a248c16fe22222b2bd49615481311111\",\n  \"created\": \"2020-09-07T42:14:00.364Z\",\n  \"status\": \"SUCCESS\",\n  \"duration\": 342,\n  \"rows\": 37,\n  \"availableFormats\": [\n    \"CSV\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"identityDetailsReport"} value={"identityDetailsReport"}><p> Identities Details Report result.</p><ResponseSamples responseExample={"{\n  \"reportType\": \"IDENTITIES_DETAILS\",\n  \"taskDefName\": \"Identities Details Report\",\n  \"id\": \"1e01d272b8084c4fa12fcf8fa898102d\",\n  \"created\": \"2023-09-07T42:14:05.122Z\",\n  \"status\": \"SUCCESS\",\n  \"duration\": 3681,\n  \"rows\": 193,\n  \"availableFormats\": [\n    \"CSV\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Client Error - Returned if the request body is invalid.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Generic localized reason for error

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"detailCode\": \"400.1 Bad Request Content\",\n  \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n  \"messages\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ],\n  \"causes\": [\n    {\n      \"locale\": \"en-US\",\n      \"localeOrigin\": \"DEFAULT\",\n      \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><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>