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/update-task-status.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

135 lines
47 KiB
Plaintext
Raw Blame History

---
id: update-task-status
sidebar_label: Update task status by ID
hide_title: true
hide_table_of_contents: true
api: eJztHGtTGznyr+jmPmyS8wtDwuEvVw6QPbLZwBpTqTqgbuUZ2dZmRpobzUB8lP/7dbc0L48NgaUuuyl/AXvUanW3+m1p7ryUz4w3uPTG3HxmP3PFZyISKvWuW14gjJ/IOJVaeQPvIg54KhhnfpYkAMFwxnnK08ywqU5gIEUUk4X9f3LU8VqejkXCEcFJACgyQlHOA4CYJzwSqUiQiDtPwRcAlAEMSVw15uncWyVlbBdgesrSubDr3c61EVWaUs3sejA9Ef/JZCKAhjTJRMsz6SLEdYyM4hABxJc41AE8mvLQIIA/FxH3BndeuogJMk2kmhEkpzkDjyNTy+W1RS9M+lYHC5zia5WiCOEjj+NQ+iSB7m9Gqzbw48//hh9xuLGMnvwm/LTB8JC9Pz/9eIZzWaD9DHeIccMCMZVKBCj0y9G7Q/bmoNdnbQJmBH39Yp6msRl0u6nWoelIkU47Opl152kUdpOpjzNe4j4kuFWpFAapKbaNvtVpOS3GUMQT0AjkUeCOOSZ4kvAFbmAqIvM45grkz8tduf+XwBupHajVdZPtdTu+onugcIV4nATgK1hARDIQKotwGR4EtHCkb6wGxiH38ZN74OsYZZSC3iAhpVrlkEtH5YMUDZkdcILRErQvYYAmEQb0BEeslSQzkTLEiWRzxURIpp5v43QKu2PFnVaZrCl9t7o2kHjDw0yQ7JQ4nZINb7aYj+KWVecD+zINK8DLVjEduZiJpDp/t9crZ+TjlSmFfuUwxYMCBVhkCktNstTuuPM38VyGMgZjrmDLtThHZr8vG34RFYKk4OSYGZAhOsSaEFss10Eau0L9uPJgFwL47LYcvlcM7z7BAZ0FXe/Bl5A1FLZDfFRmX14pxu6u1FXKYDEdX3mD6qKtfARVw45Vd7kCQGxaiCFTdZquPFxleaWuvTW0WZLqbpgemBh4tXvR7/Wa3mZEEIFhtxL1FkRqnXqwGn7KQJADzuSNUNVgdI9frjvjOglHIuUyNLRXeewzdmEIQJyZWPhyKn1aasXZyMIttrxMSQgTH1Hj6jpEURCwuqGKhgLNiUBuyW8EsAp9DHmmgNjKx4TYw/22wO4zYC8ibSSMgeBurLOfgejpo0h8WPrQzSXy0ywB/btuNeyq7i2Bt4aszhcGnH57JhTqIuySZXo1WKdzaaobWDgrU0aRNf5DBjv93b3X6Hcs0OryY3hKCz1+Eee2f7kYjsb/gge/nJ0e4r+L44vjo3+Ph+c/1d20A1zW9rVBED59Ds7fyhnNwvVqKzSVtfj2HOsO2UjwMFywKgEVbb2XYQv3HGSc8SLjRAIKpW/qn0hupE+uWHwRPhjR717b3AoR46q5KTYWPcQBFDglyE9mF1MIDt7JQzTtVEaiRke/1++1e/vtnZ1xf2fQ3x3svO70ej1SwcI3NGj7wE3K7LD/jYksvNYaInHk21FWes7m3haO9JuTVzrz+6gsI9MTFd85wvPM922I+MQTZceOk0RjpBmLJJLKxaWxiGI7UPOP+fxlJfI06P7ZjUC2b7QvKWIU8furaW/UG81q0c12660E6c8CZ4fa56H8rwjG4ktaRu1KgfpgRHwgKAFPUUHAJrmffHx3ikIfjj6ixEej01FdsASwXKW3aVP5MGZH0cb1C06qAiHUoswZmpWSg9i0oazAcE9ogQIE1YbNodTTPmVWwV8q+rIZe1rZobW4j9chruTMhXByhYAx1ILGij+JxVdsXdkSQCTLeldjExMlDOWvVLUpctFIWl55fV1JXU33yy6Krc2W11XOS2MoWF+WOd+a9BsHbH0DdCY6enbTZHZxqCUozV5RRbWSE1PW8aAhqrW5yZE0UPIsmKrkKEiBZfKoWH/z/oZ8IkKUdp2exkrDfHj9GkzSnj+Q62Ltni4OdQYly+oW1kleLlsrde0Gch4fFwoBQ70qrXKeVURt22mV8rpO9qCHpBXlRjNuuXIqh3iOXBGgE4xMy2Zxs3l9C4hmWQbbRxOzpmWx0+uttz4siGFgb13NexhKJMo6sTazew2OXFp6XLeRTXSwQE2SCsxTBo+qcO83H2uKh9QQfaj79E4q0Z4lnDp11qH7MBG39EYG2HyKdCKcdeciJbhObdtAEp0d9pYHwK/l79Axg/JLuP8ZcJ0EDxN0YSvOfAqTZTdmzbJiX/DJm95Bf2/6Zo/z/t/3dvZfTw6mfHe3d/D64GA1f1nxa/Wlf8SyV/qsCM2wVxxkTwQIlzxt7IpuirAP9yMtbMFmVAmTLcbZ28MztrfPQq5mGT3nsxUhqPbFOTxRWQgeDh+5/oxFfJrImVRrm+EuaTk6fje8+DCGJ6NjqJjP4RPiavTKIOZLFaBaAqmgC3N9SxQ7Bm4hYBsRUhuyw145rK+AIY7d5hJQ2m+Gug3YJ+ZZmMIMt/qaGVXUZRzLTYns5kvKXsiO6LTYBJ9F1JCecGznYacXwF8NIaeN0/YHJ8lXbC54IJKXHTYs3GMeLCOINNhWDQI0XYtgmoEpC0pxdZYypVMoVut7UYqyvhsryUu+KWgcLv97oEvspxkQR2xWrbDQFkei2x+g2UquTt24IjQS6QK8pg9cUJPA1+BOffBMwJtMDXPuCLfLgONROVzhsaq+kdydS0qOUk1jPs/MV9jdWQjup02sFQM3whkf/UxhvRHtRr5NziPBIDl5nOygiu3KDZ9BbR0GW9vd2u7Wdr/SdlcHR67T70Yp9dlppj4Ximcg34SCZyP1SUh7lGY5kO1o2Y1sMayirHTefxqDYX8WCuHFlxiriWfMj2wob6bZxX7Y55P8p7c89Jd7gQSSHC0HU/BEIhgQ3SXFJCgrqt3mau90MpGgoGpNigheM2ELnTEOIksyhf0bxk2LBVoY9UMKpTH4R04dGusBcVUVtGP89XCbSW4zyW002kaj7ycabTPJre1ubffPabv3ZpIFVWQtLk8yWRTxZOF+Y7Dj9qgGALD8zAkrTK44w1TNVhAZK3Isr545eJP+zmRnuu+LvYDvBW92D6Z9/02fv97f2d+Z7PX3vWqsvyztuDCyuk1V9tvuI4kYkrgbyOMyBcplUq2DevsPxJuIKbo1Os+V580g8w41/fPccW/Nr/Q6Bd4AMeSOyYb24sXoA+LH3ycQPcpNZ4kvMM22ogNwnlJKiToMkpYm3aaO29RxG3624ee7CT/b1HFru1vb/XPa7qNSx72HUse9R6SOewxTrCmmWN8ydQwg78DUbAqbUrm5U/x47bqPxfFpuiGQJ3q1LLJ/sOb0htZ4Y2iRJ0um1olUpbjQvQFshLBJDgsA3J3RBq8lIbtFrZKRwJwUj9qFMpJkx8gQ4E0W7eEUrzZYm8n1rVhFKj/MgEJyCqHG3qsGHZOgTmKK6R9goD7oDBz1M/Y4Nx5XekQ/mI2Q4w/IMTv+4guBNl/0f1+vOyVwYg8Mhezc7vWG4wK2Z84VlBHiS2zdV5GCblP1baq+DffbcP99hPttqr613a3t/jlt9xGpusuGNqfqAPDVqTrAdnqsyKXeoXL93zN2MhVHAal3cWy9zMFBCEbAQ5kuaJELSPEPrSoPM7wmjJcN1QAPq7aj4hr/4BYmCO8ar61GAjQR+aE76F5+vdjr0hx7b6R7J4Olh0thTmnZyZIQoPKb1newy7C7yw6PZSc/7av0bcfXUXcCol3jtaTJrRgB2PDsxBUoHdqXRKLqWz9JyO0ukSRQyWG36FzCvZjzQ90LqF2YRdNiYCZODekxnu2FGuQHQ9Add993hT/g6yIJl7+fF4toAy/rxHfvagDPgNIVFpGF61IzzjFht6s39KMMQvhTQb+x2CmC9dlbwROoJuzpmRfvP41fssptToMZspBYV4ChnYGKkBsc5idJcBJFpkRnM3uNZ1g7q4Nmx6YhMMyu1LkQ7PLECeEjxIcROHQSKU4S5ENwVnnPPxA3IsTQ2SkliYoHqt8FCXV5bd5LCpNUT0hlL2DB086VarMjid4LL1oTjGORykN2Ged88QpfTyXirzm2tsXWJmzm5QoVVrSXvj377YPtIwoeGpLWkxe3+NoVfFh8wRPEukoDSsLRUT9h5ee79mQ6avjaiK9Ox5X6NJcQg+vTmPVZzEAIDQN2wvy51kb8gzFUHTSDy1kGVvRksm5x0TZZRLvfq5DUtku2ZRsySqLvAxiGssrEJxjRKaHRtrdCJvkr7SzY/K90V/zXGs/0+BICL0IG2jdPphkXbOOCbesDjKPfXaABYsG2kQfyA1YBDsv9J0/gCK34PYtrrVcn9F2ag6HBB1IJi4kH9sugdHDuE6MBhC5gwA1jQl6cOYPvzOGi+ytVYeWthFUJNukNNcTUFblZeosfRDHO/tH4RY6HZcflVIWL5/bSGzzJH8fvfiOPt/U036OncSkydi5H5duYjr/hO1BQ80kCrqyp2ttblzo2m5GGrgzCXxglt0GFAZRd5b3oKiIgP6X7vehg/LkU1MaIBU8xDW2hkuuInEKcaPREwr1JZUYvM0hAehwKTxkCPmq05ytzsl2b46KK4XeTuWMfGqwDymLRYZ+gslQ+aAhWlXjgGMZ+0668PAclodcRsaNc7yD/i6JMwWroIrKIcdDuB5QzkMbPrA+FIlOJXBaastBiVu5QUOuRhQ7VV0lkTqfurRAVHXxgLVBB49rjIPryRqlXMjISYfGinnoF8RBuUPz2XIT0TgkIAJALisoKP5+MGxgBmXK/yeDbrdwk00VYfAcTMG/VZ7ez0+m1qXLB64/apFAKVpC7d7jRjUb3ooDJgp0creph5R1mT3vvmwtiWH10Y+y20YtSbDVky85Lr1J2woyBDPBe7xxoxsG7O+zGYCG2xMdg0VjqX16XNRbVpiBT/BwUL27byMaLkbtV/JI9+vVxa7nJO4xqUTYXPM/dI8eX40DlDvxQ04hotQPuV4r22L5eIJ9434visEi1k21P6p5pXq3QPxuOD/8J0BP3YrrI9jwSfgsP8e/AA5eFROvY6jIA0fM7L+8gAoxFnCdp63IU9wH2B8D+ByMk+tI=
sidebar_class_name: "patch 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 'Update task status by ID' (update-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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Update task status by ID</h1>
<MethodEndpoint method={"patch"} path={"/task-status/{id}"}></MethodEndpoint>
Update a current 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 task whose TaskStatus to update","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"anId"}}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>operations</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Operations to be applied
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
The value to be used for the operation, required for "add" and "replace" operations
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
string
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
integer
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Responds with the updated 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 - 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