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

---
id: get-task-status
sidebar_label: Get task status by ID.
hide_title: true
hide_table_of_contents: true
api: eJztG9tS20j2V3q1D5ukkLENhMUvWw6QKWaSwBhTqVpCbdpS2+6J1NJ0S4CX8r/vOadbN8uGwFCV2SlewFafPvdrq33nZXxmvMGlN+bmG/vIFZ+JWKjMu9ryQmECLdNMJsobeD+JjHGGYOcZz3LDpomGBxnumyzs/5OjjrflJanQHHedhLBvJrJqE6ymXPNYZEIj2TtPwReAkiEsSaST8mzurRIfW+wsmbJsLupcZAkDCrBBi99zqQWQzHQutjyTLSLEbGScwoctT9ymURLCoymPDAIEcxFzb3DnZYuUIDMt1YwgOe0ZeBxlWC6vEL1JE2WEwQ39bhf/NXkcEURo2I3M5m1VId+kJFrGbzN5LVRdcUGiMtQ9oOZpGsmAtLj9m0H8dzWGm4SPRMZlZBhXIQtyrQEFM5Yw6Iszk4pATmVApBqaurR6J/m3vFzJ33PxCQ3S1D8ZDbC6JZ6BoiZ5JtCcgRY8E4glTkKgQh8jnitgtvZRk3ioVQvsPgP20jFiYQx4H/mITmagcPoodACkD91eYj/LtTLooc5wyeQ3EWR2H8Bn0loJZGvp6nxhMhH7M6HQR0XIrNA13yJ7ZHNp6gbUIgV+gA/jbd3jLjLs9Xd297xlAbRKfgxPidDjiag8RoP9ejEcjf8ND349Oz3EfxfHF8dH/xkPz39BjVS8OMBlw64thvDpc0j+Ts5oF9JrUGg7a/ntOegO2UjwKFqwOgM1b71XYAv3HGycWUwFA6XTt/1P6GsZCExb4lYEEER/mLa5ESJFqkUotoge4gIqPIT1p4sLWSzmkJ08RONnMhYNPvrdftfv7vu93rjfG/R3Br29TrfbJRcsc0OLtw/cZMwuBz+YyTJrrWESV34cZ1XmbNu2TKQ/nL0qmd/HZVWZnuj4LhGe50FgS8RnrpVdO9Y6wUozFjqWytWlsYhTu9DIj8X+Za3ytPj+6FYYNyYJJFWMsn5/N+9ca77A/gZKzxoitd2O3kqR/iZwd5QEPJL/FeFY3GZV1a71Uw9WxAeKEsgUlwxs0vvJp/enqPTh6BNqfDQ6HTUVSwDLVX7bMVUsY3cUb6RfSlJXCKEWVc+ADDQldRCbDMpKDPeUFsUEug2bc3DXgDqr8G81f9mMPatZaC3u43WIsWuQGa2XyikcAtbQC1oUfxGL7zBd1c8ikmWzCd8kRAVD/auE3lQrStHIGned4SYXb5pvWWOiavqveZSDaFd1yatgKEVfVj3fmqYbFxhhAj51Ej97aDJLnIW2zV5xRbXSE1PX8WAgqrW9yZE0acQXTNV6FOTACnlU0t9s34hPRITabvLTojQsltfTYJJs/kCvC5qU2eIwyWFkWTVhk+XlsjE1bGbn8XWhVDAPQ2md86ymajsLllzfrbA96CJr5bjRrltunCognqNXBGiNlWnZHm4207eAGJZVsX00MxjCMxrFSm563e766AOb4cLuukn3MJLIlE1iPrO2hkQuLT8YHgK6ukkSLtCTpILwlOGjJtz7w8eG4iFN8+3xvcnse6mEP9NcIoc2oQewEU16LUPYAd2nFi66C5USXKdhNtBEp8fe8RDktfIdOmFQf5oH3wDXSfgwQxd24iy2MBmW5wNryIp9wSdvuwf93enbXc77/9zt7e9NDqZ8Z6d7sHdwsNq/rOS11TMcGHtlwMrSDLbioHtiQLjmaUMK31xh7xd3PC+qbSlmXCuTW4yzd4dnbHefRVzNcnrOZytKUP7FOTxReQQZDh9hXBc9hjjVcibV2pMc17QcHb8fXnwYw5PRMUzM5/AJcbUOuaDmSxWiWwKr4Avz5IY4dgLcQME2IgJ1iLDD3jisb0AgrkwdUNpvhk4bwLemPI8y2OGor9lRR13VsSKUKG5uM/ZKdkRni03wGXTrMJNMuIENYEIEfzOEnjbN/A9Ok2/YXPBQ6NcdNizTY1EsY6g0E8Egb2LoWgTTHEJZUIub5BlTSQbDatMWlSqb1lhpXgqjYHC4/u9+PxkGWQ7MkZj1KCy9xbHo7AM8W801uRvXlEYqXUDWDEAKOiQIEkinAWQmkE1mhrl0hOYykHhUAVdmrHpupHTnmpKjLKG1gOfmO+LuLIL045No5cK1cMFHZ5g2G5E1CjO5jASLlORxs4MqzVUEPoPZOgpfYvcldl9i9ztjd3Vx5M733Sq1Pr1263OheA761VQ8W62PJu9RCSuA7ImWNeQWwynKaufnz2MI7G9CIby4TXGaeMb+yJbydptd2sM+n2D7URqrYQtkkPRoJZhCJhLhgPiuOCZFWVXttKm9T/REgoOqLWaP29E6YU5nnxwSRvANfcUImH+hH2fgcvOMjmN2u7v3HpKsvECB/gm9BfwdklSu0PKAo3+wBkeS4CuuRdHBmYYFFSve8VDOBdgYYXUBCwDckQRVyyQkV5cwqvkM3yWwSMaSkgs6MuDVC384haHZ2b8IgpKKVEGUA4eUqaIEbZGAKBJ8XEyxJwUMaCE+g+rxjN6x8fjiEf7BRijxB5SYHd8GQmAiKv1hb93UcGIPECKGZ+Cgjg3jg40hrliuwM1sTi374pf54WV+eOlBXnqQv0YP8jI/vMTuS+z+f8buvfNDyRVFi+uGTB7HXC/cmyW7bi/oAEDVFZYhZ9+OrHQriKzTZWUv9R6dy2s2EN6k35v0pvuB2A35bvh252DaD972+d5+b7832e3ve/WSf1mFcxlrzdCqmd2a04aK44Dcu3yN1aHXOa4NLHp7InJhhD60rjyE6chePlIDPLz24/Le2QByWuhd4Y2rWIAjuhtk9J4TN3nbtMG+RN6+k+HSQzrYUFpZch0B1DzLUjPY3r4DE4Nplx2eyk5x9K+Sm06QxNsT0OualCVNEcIIwIZnJ8wS6JBRtES/t0mSkFsTkRrQw8FUaQLauRdz8YZnkeSQFgnNFoMYcT5Ij/GgHwaQfxiC7pDPteQDuS50tPzjslhEG2RZp757qQE8A05XREQRriq3OMdu3VJvOUdVgXCU7reInSJYn70TXMMoYUfpVzCdvma1q10G22MhcaiAKDsDF6EcOKQX/24TlSWd5DM7Ug4bgzvGHJtGIDD7os6FYJcnTgmfoDiMIJuTSnGToASCu65eFdYJxbWIsG52Kk2i44Hfb4OGtnlj32uqkTRMSGVvY8DTzhflsyOJqUtirUcYJyLNhuwyLeTiNbmeysTfC2y+xeYTNvN6hQur2svAvggKIPARBY8MaevJxC0+v4YPJy94glhXeUBNOD6axy1BYbUn89HA5yO+Jh9f1Oe5hALc3MZsxmIG6mcUshMWzJPEiH8xhq6DYXA5yyGKnszWDRL1KSL8frfGkm9J+tKHdpL4+wCBoawz8QmWc+pmEmj0VGhD8itZFmL+K10c/dqQmR5fQtVFyDAJzJN5RoI+EvRtDjCOf/c2HZjFu0cgA+UB6wCHlf0pEzhGa3nP4lqb1Qn9Nu3B0hAAq4TFpAP7ZVAlOPeJ0QJClzCQhrEbLyKKwXfmcNHL7LqyinOEVQ22+Y0SKKgrerP8lqeKWGT/bPKixMPquOVURYvnztIbMsmfJ+/+oIz3kmn+ipnG9cfobkTWDRJ1J3/n+rX28Z+hSzvwF1YpVqkVh0GnOhivI0ojntENO4zqYC4FHRykgmfY+22hZyUxRSLM+Bj+wp2wz+g6sQaWOYx6MgJ8dLRdUOYUMLaxRLvid5PT9IK0gjkMoqLDPsMspwIwC85xYB5c+y1xA905WOYMDcuOCmND0xXHucJXAsB2HjMOLvWAR4TSBLlNXDDWKVHoIqHWr9xVRDG6GorQoYlGx+Z06u5l1wz/AC2wu3EH0qD66k6XVwkyEhF5JsI12/aHcIO3+XMR0a1uyLrQgIkahY8n4xZGQKYMyAUTe6Jn226T2UZYQILjkXWfnU6v0/VpXMALSInJYPiqIcef+dCFIndPd7JwP05ZudVfnsQ/4odBrlhgl7+d4pEW/TrBTh12vLv0auMd7BjIEC/TzYFNXLy7wyMPHHiW+BhGfZynL6+qWYZmQFAjfg7Ln/ps5P3VyF3le82+4ydGa/kvDu7UoprZPc9d18TfoMBADBLQWQxxZxfsaU1tS+t9RmMG/ukYbc43VF33ATQBeeV/ANHeVA==
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 'Get task status by ID.' (get-task-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 TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Get task status by ID.</h1>

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



Get a TaskStatus for a task by task 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={{"name":"id","in":"path","description":"Task ID of the TaskStatus to get","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Responds with a TaskStatus for the task with the given task ID.

</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the task this TaskStatus represents","type":"string","example":"id12345"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`QUARTZ`, `QPOC`, `QUEUED_TASK`]"} schema={{"description":"Type of task this TaskStatus represents","type":"string","enum":["QUARTZ","QPOC","QUEUED_TASK"],"example":"QUARTZ"}}></SchemaItem><SchemaItem collapsible={false} name={"uniqueName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the task this TaskStatus represents","type":"string","example":"Big Task"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the task this TaskStatus represents","type":"string","example":"A Really Big Task"}}></SchemaItem><SchemaItem collapsible={false} name={"parentName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the parent of the task this TaskStatus represents","type":"string","example":"Parent Task"}}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service to execute the task this TaskStatus represents","type":"string","example":"sweep"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Launch date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Completion date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} schema={{"description":"Completion status of the task this TaskStatus represents","type":"string","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Messages associated with the task this TaskStatus represents

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`INFO`, `WARN`, `ERROR`]"} schema={{"description":"Type of the message","type":"string","enum":["INFO","WARN","ERROR"],"example":"INFO"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>localizedText</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Localized form of the message

</div><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Message locale","type":"string","example":"An error has occurred!"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Message text","type":"string","example":"Error has occurred!"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Key of the message","type":"string","example":"akey"}}></SchemaItem><SchemaItem collapsible={false} name={"parameters"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"Message parameters for internationalization","type":"array","items":{"type":"object"},"example":[{"name":"value"}]}}></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"}>returns</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Return values from the task this TaskStatus represents

</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Display name of the TaskReturnDetails","type":"string","example":"label"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Attribute the TaskReturnDetails is for","type":"string","example":"identityCount"}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attributes of the task this TaskStatus represents

</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"Attributes of the task this TaskStatus represents","type":"object","additionalProperties":true,"example":{"identityCount":0}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"progress"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Current progress of the task this TaskStatus represents","type":"string","example":"Started"}}></SchemaItem><SchemaItem collapsible={false} name={"percentComplete"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"description":"Current percentage completion of the task this TaskStatus represents","type":"integer","example":100}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"id12345\",\n  \"type\": \"QUARTZ\",\n  \"uniqueName\": \"Big Task\",\n  \"description\": \"A Really Big Task\",\n  \"parentName\": \"Parent Task\",\n  \"launcher\": \"sweep\",\n  \"created\": \"2020-07-11T21:23:15.000Z\",\n  \"modified\": \"2020-07-11T21:23:15.000Z\",\n  \"launched\": \"2020-07-11T21:23:15.000Z\",\n  \"completed\": \"2020-07-11T21:23:15.000Z\",\n  \"completionStatus\": \"Success\",\n  \"messages\": [\n    {\n      \"type\": \"INFO\",\n      \"localizedText\": {\n        \"locale\": \"An error has occurred!\",\n        \"message\": \"Error has occurred!\"\n      },\n      \"key\": \"akey\",\n      \"parameters\": [\n        {\n          \"name\": \"value\"\n        }\n      ]\n    }\n  ],\n  \"returns\": [\n    {\n      \"name\": \"label\",\n      \"attributeName\": \"identityCount\"\n    }\n  ],\n  \"attributes\": {\n    \"identityCount\": 0\n  },\n  \"progress\": \"Started\",\n  \"percentComplete\": 100\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, generally due to a lack of security rights

</div><div></div></TabItem><TabItem label={"404"} value={"404"}><div>

TaskStatus with the given id was not found.

</div><div></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>