LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-task-status-list.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

111 lines
46 KiB
Plaintext
Raw Blame History

---
id: get-task-status-list
sidebar_label: Retrieve a task status list.
hide_title: true
hide_table_of_contents: true
api: eJztHGtz2zbyr+DYD200pizLTnzRzM2NYjsdt0ns+nG5OSdzhUhIQkMCDEHa1nn03293Ab5Eya/6mianL4mMx2Lfu1gCuPEyPjHe4MI74+YTe8sVn4hYqMz7uOGFwgSpTDKplTfwfhQZ4wyHnWY8yw2LpMm63oanE5FyHHQYwrCJyKoxb2AIjEh4ymORiRRXuvEkgvuci3QGfQp64M9IxhKHNtd8y6+ZyuORSJkes1SYPMoMyzT8zPJUdT+oUyHYxT+22fD4kMGaKuRpyPZ0FIkAYbDjcumPP0yzLDGDzc1QXIoIse4aLqNES5V1Ax1vylBt8kRuGgfHD0o4fkXCMzbWKYt1KphU8DMm2pERqficy1QAF8Y8MmLDE9c8TiIgr/+8t+GZYCpi7g1uvGyWIM2wrpiIFGZaMLZpuw8NsVQyzmNvAPNifm1/E5RQjDlwgf6azzeWc1OPx0a02XlEzYA2cDCbCjbOo8hxlUFHl52bnEfRjJlEBHIsRciuZDZlHZJOBxmf8IlUPBMwP9X5ZEpwnGC+GnH8DmGU7F/N/EDnqs37wzHrZGkuOkxmwFVgfKKTPLKsFKzzT/9MZzzy93B2B1maaGUEmwoegvqTHHDgEnOYcoCo8yhkI+EsAyQnx6XcgH+sY3Wiw64EsmqigGMhSAxkJlWA84AMk0k1ASvPEBVGhLCAKzbllwKaQUbEHBwv44QH2QZSIw3MBomB3whhYaUz1BQjcNUOAfkbUd5BnAjbSx7lwnIBRwPauSmw+So0COlZokQjrSPBlVfTE5q5UlfGMiK3uASWyVIQhjevrQqqhT8QPeeDxWf2wTvNg0AY88FbhnJTC1/TeqXq5AbljWpVsIiZmcrA69ppI9Qj9QfL4zvLFMDMd3g+Q8V4XbSivpk8SXSaAXooO/JlAEpfYTf4rSg0pPQ2NOnUDBBCpyPDTmfAOuIz6K3q2Daj8zQQh0t6FrndHoGiqrd6q+RsENlb5VzzO2hK3DcCWQIkNlXAD1JBrXfK+hTW/JNLGtmyKOdT23Y/KQ/Qw1iGdID7H5Ep1nEaZHG/18P/mnw5oRGgIeRTGylNsUyGyVDpcifyUijbdriPfiHQECzAxwNoniSRDMhjbP5mEP5NW8Q8TTkqg8xEbNoI7YsMmGc1NsjTFECjlBAhcPO8iMYBodCQ+4UnURFomQ0vVxLU7h1qXFMXKAMDqK6LZ6ByozwTqI+VOsU6pJgPPyOeKyCi9jMlsskeqHnRNnA++CDIHvFnkuoJCIJ+CrAule25uYQ+RiiDGabjjx79Brph58H4TFrpAW0tXp3ODDDRnwglyDiYJRoEg7wqZZdNQX1qgk1FAvgAHsbbaBleZVwy3Opv7zxHi7ODFpc/g1Za6OGLKMwgLrxfzocnZ/+Chl+Oj/bwv/OD84P9f58NT39GjlS4uIHzhlxbCGHrU1D+Sk5oFq7XWKGtrOVfT7HukJ0ISjnrCNS09VaC7binQOPYQioQKJW+rX8ivZSQ/kCCI65FkLv07fesba6ESHDVwhRbi+5hBzI8xHTx0eSWAQbB+JkkZ1Dh0e/1e35v19/aOutvDfrbg63n3V6vRypY+oYWbm+4yZjtDr4wkqXXWoIk9nw5zCrP2ZZt6Ui/OHqVM78NyyoyPVLxnSN0WSu0vOepsn0Haaox0pyJNKZtZkh/xIntaPjHYv68FnlaeL91PYwbowNJEaOM6/fG/Y74XZvt1lsI0p8Ezo50wCP5HxGeieusitq14sidEfGOoAQ0xSUCq/h++O71ETJ9ePIOOX5ycnTSZCwNmC/i27apohuzpnjl+iUldYYQaFHlDIhAk1I3YpVAWQnhltCimEC1gd0rqGtAmVX4l5q+rIae1SS0FPbBMsCYNciM+kvmFAoBfagFrRV/FrN7iK5clyOQebOitoqIagzltVjgSBW5aESNu8xwlYo3xVffglzcFLsa2sZD1l2nvDKGkvR5lfMtScaxwxYEAM9Ux09umq4kAhsdSrMXVFEt5MSUddxpiGppbrIvTRLxGVO1HAUxsETul+uvlm/ERyJCbjfxaa00LLqXr4GbpzF50ttyXeCkzGZUcPIWRdhEeT5v7BpWo/PwuFAymIehtMp5XGO1LbSUWN8soE1luGq70Y5bbjtVjHiKXBFGp25bvri5Wb2+HYhmWQXbByNT1ShLbLZ6veXWBzKbY8/Osi3wXiQRK+vFfHZSqxnaei7VAtlIhzNUJanAPmX4mK3vCvuxtrinQ7GsErJYs1LCn6RcIobWowcwEWV6KUOsBVDtzoIseErjug25ASe6W+wVD4FeS9+eIwYZmPLgE8A6DO9G6NxuOYspTFb1iSXLil3BRy96L/s74xc7nPf/urO1+3z0csy3t3svn798uZjALDi2xY8wsO+VAStjM8iKA+8JAeGypxU+fHWIvZ3cs2kRbksy41qc3GCcvdo7Zju7LOJqklM7nywwQfnnp1gOyyNwcUUFtUgyxFEqJ1ItQ6XIWvYPXg/P35xBy8kBbJlP4RfCan2lgqAvVYhqqalIPtVXhLEj4AoithFYiRJhl3Uc1A4QxJWpD5T2L0PlBuaquTDDrb5kRh10FcgKUyK7uc7YD7IruhtshG2QrsOmZMQNTAAR0meAISS1Sea/cZzsuPr/sy4blv6xiJYxhJqRYOA4bfHOftIBUxaU4+o8w+o67FabsqhY2ZTGQvZSCAWNwyWAt+vJMMhyQI7IrFthqS0ORScfwNlyrondWY1pxFKsUgZABVUJAg3+NADPBLTJzDDnjqhYCI5HFeNKj1V3juTuXFayn2nqC3hu7mF3xxG4H59IKzsuhTM++iJpvRFJoxCT80juYxtNdqNKcRWGb8uZa9td2+7adu9pu4udJ67w73op9dlqpz7niufA35SCZyv1SUl7lGbFIFvSsoLcYLiNstz56f0ZGPYnoXC8uE5wO/GE+ZEN5e08u5SH+2pTfNQpQn8lC0SQ+GgpGIMnEuGA8K4wtkkisWq7vdprnY4kKKhakiKC10zZTOeMA8vSXCn6cGw2WKiFUd9n7pMxlWisB8RVVejbb0TrTHKdSa6j0ToafTPRaJ1Jrm13bbtfp+3emkmWWJG1uDzJ5HHM05n7yGD77VkNGFCd3StNzhbKF7IVBMbKHMtrZg7eqL812hrvBmIn5Dvhi+2X437wos+f727tbo12+rtePdZfVHZcGlnTpmrytnIkFkMSdwl5XK5AuUymddgs/+V4fmiMbg1dT5k3A8+7VPUvcsedJZ/pdQa0AWDIHdMV5cXzkzcIHz9QIHjkG53FwjTbss6eFsSUks4Jimt7nnidOq5Tx3X4WYefbyP8rFPHte2ubffrtN0HpY47d6WOOw9IHXcYplhjTLG+ZOoYSnvhYwxCARqK48vl12tXfSzPVacTkZWJXiOL7L9ccnxDa7yTNiuSJdOoRKqKXejeYGyMY9NiLAzg7vA2eC0J2S1qlYwF5qR41o6ux6AdI0EAN535wzHej3CXbpy+latIFUQ5YEhOIdJYe9WgYxJvsIwx/QMIVAedgKN+whrnyvNKD6gHsxOk+A1SzA6uAyHQ5sv67/NlpwQO7YmhiJ1aWa84LmBr5lzBNkJcJ9Z9lSnoOlVfp+rrcL8O999GuF+n6mvbXdvu12m7D0jVXTa0OlWHAfdO1WFst8fKXOo1XQv+ozN2MhWHAal3eW69ysGBCUZAo8xmtMg5pPh7VpWHeTa1tw3VAE+r+nH5UMQAfFrofcSrl7EARXRvQKAH4jjJ26QJprglaPcNlow8jWBAcZf0BqQLUp13eSK7xTFfpa/oQukIWLrEW0lTWC8OoKurdoEuySOVqPLWPxJwKx13Ndsr76zeCrk4zT2DPQuzYDYYmIdTP2rGQ72w9/je0OguqVuLPqDrPI3mv58WC2gFLcvYd+tqMJ4BpgskIgkfK404xUTdrt7Siyr44CeCfmuxIxzWZ68ET2EXYU/N/PDT+7NnrHaNk+4nC4n7CTCwY1ARcn/D4gQJTqKIVD07MWyc0UFzY+MICGbuFYFDx4R3EBdOwJETS3GSIN+Bs+5/k5k35q14M+CD8tm+TO1FZ3vtwpFo31W4SAq6eI2uxyLxXQHNt9B8goa3qBtYWNZeBPbMdwA2jyB4ZIhbj17cwvNr8HDTBS0IdREH5ITDo3myKiik9mg8GvB8hNfE44N6P5UQe5vTmHVWzEzp4YxDFky1NuLvjKHqoBlcTHKwokejdYWL+mQRfr9XQ8m3S/rSh0yS8HsDhqGsMvERRnJKZLStqZBJ/kqSBZv/lS6J/9qgmZovIODiyFAHD7iev4AzLujjgr71Acbh727OALJg20gD+QGrAHuV/MkTOERrfs/CWurVCfwmzcHQEACqBMUkA/vHoHJw7hejDhxdjgE3jIl4edYM/mYOFl1cqTOrKCEscrCNb6Qhli7wzeJbfgjF+PpnoxcpHlaVliMVzZ7aS6/wJH8ev/uFPN7a03yLnsalxqhutKzbQ9SV/JXL19qVP0MX9OBf6CVbpSwc9jjVLeQ6oCTiGd2mRasOplJQzSARPMPcbwM1S8dkibC9R/MX7hWTCT0dkALKHHZ5MgJ4VNUuVuZkMDaxRLni3yZ3Zyw0qCTsQUWXvYdtnApALLiFw9O90Pebdnu5U5DMMQqW7RfChqQrjnMFq6Fd5jHjoFJ3aEQoTZBbxwU7OiUKXmhK/cpZhRWjqiEJXdrMpLE5Grs3GGqCv2MtkLtxtWhgfXV/06sIORERaSaOa6btd8EGbfOnIqIXHMDrQgImaiu8PTxrQQRgyn0A0elk000ymzgWgOD2yKrPdner2/Npu4CXDbXJYN9VA46fLEhHuL1DaJoP8y2841GW4lc/5eciBKb2mwmWsOj5EbvVsNu5C6++nYMNwhSwwuabGyxu4P5mjs32/SPc5AGfUHlXvFJUR+vreu1vKa/ojnf5mKErCHj0LNT9+fD/9UzfLXwsnzF8JCPXb+59fW/u3aIOxcOKj9SG9dt3/9u3726VXfXQ4SOl9//3mt2t/KweFKz4+bEqE0Lk/QhjrSOjMGyn2U8OtVmtj/KNQu6PB5i98BX7R/cDl5rP/wsT6PGK
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 'Retrieve a task status list.' (get-task-status-list)"
---
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"}>Retrieve a task status list.</h1>
<MethodEndpoint method={"get"} path={"/task-status"}></MethodEndpoint>
Get a TaskStatus list.
## Request
<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":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","schema":{"type":"string"},"example":"completionStatus eq \"Success\"","required":false,"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq, in*\n\n**sourceId**: *eq, in*\n\n**completionStatus**: *eq, in*\n\n**type**: *eq, in*"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","schema":{"type":"string","format":"comma-separated"},"example":"-created","required":false,"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created**"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><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"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\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 }\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"}><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>
Reference in New Issue View Git Blame Copy Permalink