developer.sailpoint.com/docs/api/beta/complete-work-item.api.mdx

---
id: complete-work-item
sidebar_label: Complete a Work Item
hide_title: true
hide_table_of_contents: true
api: eJztW1tz4joS/isq9mEuFXMLJMDLLkPIHGYJZAmZ2bOZVB1hC9CMsbyynRk2lf++3S3b2EASws6eW/GEkaW+96duIe4Lyheah1J5PafQKthq4bsiFJ+U/toLxaJwVAj5LCi0bgo4xHAsKNweFRwR2Fr6uBCWjecyYO3LHkvWB4yzb7hAwoIi68pwLjTjHuPOQnpHTGkGI0x986Q3K9mR1sILWRTApEUUhGzBvwqYAVS1+HckgrAIkvhc8wUQ1yjPfUEiZ5+Hc3jlwQv4Jh14Duy5WPBC674QLn0cDUINXAoPRwUkJrUATUMdiU0tBOudMTUl2VLxgaT4zlEvmCOmx41ps3ZcOxXNWv2kOqlPJo1atcbrJ8fNU6dReLhFNoGvvEAEKES1XMaPPKs2SywcMDX5IuwQuNjKC8EMOJv7vitt8kvpS4BL7jf1Shf6Gr0YSsMQjLCh+7qqz6lZtZuVRrlxXHeqol45aZQrdee4Om00yzav1BuVxJjgGaF7L2KYLtuf4ZkMfJcvB+T05zijVx2zAKPkaTE+qLnHrhYQrsgQwnM37fKRQ8terB2t2l2lrC6bDD9wCJqVIrYWPBRbFZkqveAQcwUHZlihBP45ycuVU6t8alUq40qjVau3jk+L5WbjX0h1oRw5lfuSbVjlE6taH1fLrWq1VW0UK+Uakc3pupN3VyNPR3WHzMC4basI4AamByrStmCv2mevkHUQwvttTIUXLRAEz3uD3tVP3TMYGnU/dDvj+HF8PRrQY/efl70RPV12B2e9wXt46rQHnW4fB73IdW+zEmXobepF0qBGPKdPKENamyDIFQkN0huhHxf+evD3wfDTAEbedwfdUa+DsnVH4955r9Me94YDUuWie9ZLvp2B2O+TL+3Ly9HwY7sPjx97wz4Nj7ofe91PMHI+HF2g0sN+r/Nz+hoZ/NTu97uD91147l1ctjvj9qDd//mqdwUDV733g+H5OdrtY3cwhs+L9uC63YdZZvW4ezUu5Cy2En3TYKj4tghYt9gYDUSAshCONLsfbWw/BFvzYGDj4mmM5S8GhZDrmQhfDkE5rsxQ2ZP5fpD0rABfAGmLQQJQZsK+uP4yzrCJSrftOLBLB8g7s9fup2t2szaAkuPXtkN5J9gZFB52qPSSeIZAehKFYk+OyXI2ETA/0Vk4Ocb+XHliEC0msDlkeQ6Tkm83xmmFuN3CaOSsSDkRIt+JwSl9/5G70Y4q3+HUl+lcr1Ster1uVaqVKrL1OBq/50BdJcPlrpYmh8l4USLAtiDGbdZEMXB7WCHNKI8sZyKEmEuiTStQ7AcDTkKWIO9VAFDw4nSPt8Ud+cV7qBZTAbW7LRw2WSbZsJLkiZTPZM2vknLezpmWRhrYkVY9hR7qZcmUpb1auj1l7nbPlCxZsyxLkv9tUoTO7I9e4WTyq53Jokxy7e7jlN2mh9txaJtqkcrnuKvdu9KtlK1Kc1w5btWaWEAfN+pU6YLJ12FAQgs4o2J+SwIQlKO5JDWO0nu81q00gb7QWuksda41X8I0ucZ11SGnBG7WzAS1RTjnIfvGAxb4wibopW+eCtkULOYUC7dZH6UdLngOx2vbGuGOK7Hz76KkzGIjEUbaA8Iy16WxiXKWTKLK4HTpFH9ct+xQ9HSUs0PgnEtPWDPNJUpIxmU2LGQYi9LBTWmhNPYjSDKBKppXzMUEWKJYYe+4A/oa/TqxMmg+ze2vQGuXou/ak7CeJUtgywJP6MfYilPBJyflZrU2PalxXm3UKqf1SXPKj4/LzXqzST0dwBqfiW1Bk2f9XkDPKW3mKhs88h8wCKQLNp0oADHfEmeP+IBo7Ji4Zm6qZiwvC8X38Ahg5F3nktVOmcu9WUTjfLZmBM+6xtYDgYpPcAiPgkBzQ3io5UxuxfIEIM+65+3r/phA8R/X2J8koLd2xONBtDoYlopydq6+kcSxApRHwgVzCKfI3sZU34JC3AuyE6X5FiwDTENHTHnkhrAi5r5lRZY0m2q1yKUS5c33kL2WRVE8gmKKjttCe84mPIAFcT33FmBQ+KHVjy35ls0Fd4R+U2Sw+0lUEvZ42msCWL8EQow7DqauITCNIJVBGNjuVRQiSkhb5H2xMmXeGysM6WedgskBkj8fJ7D9RyAcqZnNwjRaYhFj/4DMxnJ56cYZo5FJl17IobCAme4SzKixuGCw6QJABiyGI3RXAMDjJfNSxMpCI8HdhRHmLFT0zuZRsEPeXboAPxaplr64E3HyQRioGI3IG4mbYkSCl1TI4uJ4VuquJPEZ4LrrHHL3kLuH3N0xd9dfjuLj//gtlT7Hm6XPudITCVb3ttQ99EvIUkWMgxt05OHPJIwHR8xRIvBehWzO76gJAzlMWoPswnMsX0EFeSiPDuXRAWIPEPvngdhDeXTI3UPu/jFz98nyKJWKsiWuk4JoseB6aSItfm9OCWECS25XrC5OpAel2WoFibG0xirkK4fCpFqZVKantqg5vOacHDenVfukyuunldPKpFY9LWT3+ptVHqdJls+pjL+NH83xptB3UMdFHgRXECrl5M+0Ijo+R1hD6OERRJOGUgFsDia9fXhIasfaZu04UCHoBoShdtSPnJldj/rmeN6QR7uZX7sxacl05kQPS0o6xBPfZfAD76EcSsdD6XjYfg7bz6F0PJSOh9w95O7/u3SsPVc61l5QOtbYIPlZ87csHR2oO+j3VXAK6JBclNbCB1XgyVzBSdLe3FBJC71VFUnlB0Qciu8rKvLo4nSrUMJfeC1CpNK9dB7gjWFtZI+0C5PmYegHrVLpHnwJPnwocl8Wk+sxnvqGlwtKEzDgFmzCH21NHuIEuiRuGBTJ+lpigBs0JOLGF5TOGMrgEzrSfJJycjNkCWozQ+YILwPGwUbD+Bs+95bxlY4iBdeGfqDXtXYf/nddDKFHdNlmvie5wXwGkq6piCrcorsgKuhuE/jrGuTpGChrR+jgm9vsnCss3Y2EGzNX2xF2ItUNgYY4rcreCa4hMEP1VXjs9YdP4zdshgUrAUYUYK0s4tv+7BLCiACxnRxU4yIKVq2i2ZyUa8d9jwllTEA2dcEo7LN3JQS7Se5uDWCnGAG0k9lxkSA0wVW3rxMPOuJOuLiJFlfWxuCUjlcCK5Z4bt0byhzqLKRn7nHAaPGzZ8VXhyRu/DgnVpFO4dmNn+jFM3rtK8RfEmqWoWYRteDNmhTGtDe2uS9ha0Fm4W5A1tqbuaFnZehhGwYjSHVdBrRELAfPec1OvLa3HDl6FtLLy/HZ+zSXsBvnlzGDaiyAzdR1WI/Zc6UC8VfGMHQwVW5mEWTa3mJ9Q6YWZYRVLWdEsgxLS1pQW5J8fUgMzwQTn+DeTqWNMtBNafsLeRZw4RfGYeyXnM40fANbMM50lB3sLTMytJChZXAiiOU3OxwGFt5aAh0IB0wAdFb+JySIBc1go6G1FfmJfInW4PZhg6hEJfBb5ktrBYLxE6MXODudA1CNpXn6kxZ8ZzEt3L9yxkoOFdYtuCmvq2CTXbObkTc9b8GN9/emL2rcXp29DD13+aNR+hEk+f3g7m+EeAek+TMiTVwFY7gR27iryAb5u7im2zwLDPC/iFBv41vKVbylCS1BSH0cVTFZQr7LQ4xqymp7LgWdIviCh1gfHmFkqQVlIjT8mP7QKxKhGd041SAyh75PukCvyMYrzpwSxhSf6Ff8HkTxUa6CkISuVBTZJ2jsPBvcgk0dXiKAd19U3N1dgWcu0bHsLHE2FF2LReThVXcQO1owDiH1TEQ4MrAjA1zQ43kisYWi0i9dlWQxhhqqUKQuRy+C4fQKKmfofTOOf4YX+D2IT6fB9OjF+F+fK0VGwqXIxHn50v452hBt1ly4PraVgLpQgIkMh4veeIMiEPPiPkvpWSleFJRwLl7eBuVN+BwXK8WyRS0FjGP7BY1whngnvl0MlWX6H9v1GLxfHcr/Sn+2jbcZ7A9KPp6MofCR6WlM73hTWPWOsKAlHfyn1hzbS3h3f48HJ9hNPeAw0MWu/OZ21ShRwwL2x2doTKeACOt/yc2q/XoU/3n3DabEI3/U3Sp1curnLVcNfwEevwo8JwCxoU0Gwekgh4QyL8xRT2bJxo8h2FqlffXl8Aoc//BfY34twA==
sidebar_class_name: "post 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 'Complete a Work Item' (complete-work-item)"
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";

<h1 className={"openapi__heading"}>Complete a Work Item</h1>

<MethodEndpoint method={"post"} path={"/work-items/{id}"}></MethodEndpoint>



This API completes a work item. Either an admin, or the owning/current user must make this request.

## Request

<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

A WorkItems object

</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the work item","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"requesterId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the requester","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"requesterDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The displayname of the requester","example":"John Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the owner","example":"Jason Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"WorkItemState"} qualifierMessage={"**Possible values:** [`FINISHED`, `REJECTED`, `RETURNED`, `EXPIRED`, `PENDING`, `CANCELED`, `null`]"} schema={{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED",null],"example":"FINISHED","description":"The state of a work item","title":"WorkItemState"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"WorkItemType"} qualifierMessage={"**Possible values:** [`UNKNOWN`, `GENERIC`, `CERTIFICATION`, `REMEDIATION`, `DELEGATION`, `APPROVAL`, `VIOLATIONREVIEW`, `FORM`, `POLICYVIOLATION`, `CHALLENGE`, `IMPACTANALYSIS`, `SIGNOFF`, `EVENT`, `MANUALACTION`, `TEST`]"} schema={{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item","title":"WorkItemType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>remediationItems</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"targetId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"targetName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the certification target","example":"john.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"targetDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the certification target","example":"emailAddress"}}></SchemaItem><SchemaItem collapsible={false} name={"applicationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the application/source","example":"Active Directory"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeOperation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The operation of the certification on the attribute","example":"update"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}></SchemaItem></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"}>approvalItems</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The approval item's ID","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account referenced by the approval item","example":"john.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"application"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the application/source","example":"Active Directory"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute's name","example":"emailAddress"}}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute's operation","example":"update"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute's value","example":"a@b.com"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"WorkItemState"} qualifierMessage={"**Possible values:** [`FINISHED`, `REJECTED`, `RETURNED`, `EXPIRED`, `PENDING`, `CANCELED`, `null`]"} schema={{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED",null],"example":"FINISHED","description":"The state of a work item","title":"WorkItemState"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The work item name","example":"Account Create"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={false} name={"numItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of items in the work item","example":19}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n  \"requesterId\": \"2c9180835d2e5168015d32f890ca1581\",\n  \"requesterDisplayName\": \"John Smith\",\n  \"ownerId\": \"2c9180835d2e5168015d32f890ca1581\",\n  \"ownerName\": \"Jason Smith\",\n  \"created\": \"2017-07-11T18:45:37.098Z\",\n  \"modified\": \"2018-06-25T20:22:28.104Z\",\n  \"description\": \"Create account on source 'AD'\",\n  \"state\": \"FINISHED\",\n  \"type\": \"GENERIC\",\n  \"remediationItems\": {\n    \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n    \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n    \"targetName\": \"john.smith\",\n    \"targetDisplayName\": \"emailAddress\",\n    \"applicationName\": \"Active Directory\",\n    \"attributeName\": \"phoneNumber\",\n    \"attributeOperation\": \"update\",\n    \"attributeValue\": \"512-555-1212\",\n    \"nativeIdentity\": \"jason.smith2\"\n  },\n  \"approvalItems\": {\n    \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n    \"account\": \"john.smith\",\n    \"application\": \"Active Directory\",\n    \"name\": \"emailAddress\",\n    \"operation\": \"update\",\n    \"value\": \"a@b.com\",\n    \"state\": \"FINISHED\"\n  },\n  \"name\": \"Account Create\",\n  \"completed\": \"2018-10-19T13:49:37.385Z\",\n  \"numItems\": 19,\n  \"errors\": [\n    \"The work item ID that was specified was not found.\"\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={"403"} value={"403"}><div>

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

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

Generic localized reason for error

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

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

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