developer.sailpoint.com/docs/api/beta/approve-approval-item.api.mdx

---
id: approve-approval-item
sidebar_label: Approve an Approval Item
hide_title: true
hide_table_of_contents: true
api: eJztW21z2kgS/itT3Ie8lAVIgA18uSMYZ8kR8GGc3J7XVTtIA0wiNJxenHAu//fr7hmBBNjGXGr3dotPCGmm3/uZ7tHovqAWIuSxVEHXKzQLfLEI1Z1o0Q/3u7GYF04KMZ9GheZN4bMKvzK8FxVuTwqeiNxQLnAuzBzNZMRal11mSESMByylQ5OKrCPjmQjxAffmMjhhKmRwh6lvgQymJTcJQxHELIlg0DyJYjbnXwWMAMqh+HciorgI0ix4yOciFiHKdF+QyH3B4xk8CuAB/JMeXEfuTMx5oXlfiJcLvBvFIXApPJwUkJgMBSgch4nY1kSw7jlTE5LtG+ostR3Edz5f+EhLTCr1SaNaqZ6JRrV26oxr43G96lR57bTSOPPqwGWnZDxj2O4PlDKlS5IWc6Lajm2PXc4r8OuMXTE5tR2He2PHhmubu4WHW+QVLVQQiQglccpl/Mnza60tETFPxFz6EVPjL8Ilp7gqiMF3OA9k8aVLMVX6EuHk+2019Uz0ZogRGEvNGjy3ZYpNzZ/zjeM27Hq5Xql5jqjZp/WyXfMqzqTeKLvcrtXt1LYQTiLsvojhatrhDM9ltPD5sk/x8BxndLKnJ2AAPS3GBzUL2NUccgwZQk7tp10+kGjai7WjWfurlNVlm+EHDkGzVsQNBY/FTkUmKpxziLmCByOsWAL/nORl+8wqn1m2PbLrzWqtWTkrlhv1fyHVufLkRB5Ktm6VTy2nNnLKTcdpOvWiXa4S2Zyue3l3fefpqG6TGRh3XZUARsLwSCWhK9ir1vkrZB3F8HwXUxEkc0Tvi26/e/VT5xxuDTsfOu2RuRxdD/t02fnnZXdIV5ed/nm3/x6u2q1+u9PDm0Hi+7dZiTL0tvUiaVAjntMnljHNxZUEMfCKhAbptdCPC3/d/3t/8LkPd953+p1ht42ydYaj7kW33Rp1B31S5WPnvJv+Owex36d/WpeXw8GnVg8uP3UHPbo97Hzqdj7DnYvB8CMqPeh12z+vHiODn1q9Xqf/vgPX3Y+Xrfao1W/1fr7qXsGNq+77/uDiAu32qdMfwe/HVv+61YNRevaoczUq5Cy2Fn3bYKj4rgjYtNgIDUSAMhee1Cs3rcg/BFvzYODi5InB8heDQszDqYhfDkE5rkxTOZD5YZD0rABfAGmLUQpQesChuP4yzrCISr/lebBeR8g7s9Yepmt2sdaAkuPXcmN5J9g51CFurMIl8YyB9DiJxYEc0+lsLGB8qrPwcowXMxWIfjIfw+KQ5TlIy9X9GK+q290WRiNnRcqJkCw8A06r55+4n+yp8h0OfZnONduxarWaBRWbg2wDjsbvelBXyXi5r6XJYdJMSgXYFcS4zOooBm4Pa6QZ5pHlXNd6JtpW1esPBJxc8foqAih4cbqbZXFPfmYNDcVEQMPhCo+Nl9tl9BMpn8ma3yTlgr0zbRVpYEea9RR6qJclU5b2eurulLnbP1OyZPW0LEn+t3HRVfM/eoWTya9sc51Jrv19vGK37eGWCW1dLVL5rPDRwQV03bLLlt0Y2ZVmtYEFdKVeo0oXTL4JAxJawCkV8zsSgKAczaU7SBk8XuvaDaAvwlCFWeo8DPkShskNruuGeUXgZsNMUFvEMx6zbzxi0UK4BL30L1Axm4DFvGLhNuuj1HvgmQe8X93VErd9idsVHZSUWWwo4iQMgLDMdWlsrLwlk6gyOF16P7Bb1m14W3l7BM6FDIQ1DblECcm4zIWJDGNRergozVUoTGefQhWNy28ngCWKNnvHPdBX69c2yqD5Qu5+BVr7FH3XgYT5LJ0CSxZ4InyMrTgTfHxabjjVyWmVc6detc9q48aEVyrlRq3RoJ4OYI1Pxa6gybN+L6DnlC7zlQse+Q8YBNIFm04UgJjviLNHfEA09kxcPXalppGXxeJ7fAIw8q59yapnzOfBNKH7fLphhMC6xtYDgYqP8RbuDIHmmvAglFO5E8tTgDzvXLSueyMCxX9cY3+Sgt7GZk8A0ephWCrK2Zn6RhIbBSiPhA/mEF6RvTVU34JCPIiyA6X+Fy0jTENPTHjixzDDcN8xI0uaTUI1z6US5c33mL2WRVE8gWKK9ghjd8bGPIIJpp57CzAoFrHVM5Z8y2aCeyJ8U2Sw+klUEtZ4WmsimL8EQox7HqauJjBJIJVBGFjuVRIjSkhX5H2xNmXeG2sM6WWdgskBkj8fJ7D8JyAcqZnNwlW0GBGNf0Bmbbm8dKOM0cikyyDmUFjASH8JZgyxuGCw6AJARszAEborAuAJ0nErxMpCI8HdRy3MeazomcuTaI+8u/QBfixSbfXgTpjkgzBQBo3IG6mbDCLBQypkcbIZtXJXmvgMcN33jrl7zN1j7u6Zu5sPh+ZFgHlKpU9lu/S5UOFYgtWDHXUPvb5ZqoRxcEOYBPhuh/HohHlKRMGrmM34HTVhIIdOa5BdBJ61UFBBHsujY3l0hNgjxP55IPZYHh1z95i7f8zcfbI8WklF2WLqpCiZz3m41JFmnutdQhjA0nMWbJVyq43SbLWCxNiqxirkK4fC2LHH9uTMFVWPV73TSmPiuKcOr53ZZ/a46pwVsmv9zTqPV0mWz6mMv7Uf9famCO+gjksCCK4oVsrL72kltH2OsIbQwxOIphBKBbA5mPT24SGtHavbtWNfxaAbEIbaMXxkz+x62NPb85o82k2/7cakJdPpHT0sKWkTT3yXUXwsHY+l43H5OS4/f5rl51g6HnP3mLt/zNx9UelYfa50rL6gdKyyfvpa8/csHT2oO+j9KjgFdEhPd4diAarAlT6Ck6a9PqGyKvTWVSSVHxBxKP5CUZFHZ6qbhRK+4bUIkUr30nsomaPnpfv8MesHmKJl0koloQ+zZ3G8iJql0j04GZz7UOQLWUzPzQTqG546KI3BsjtAC9/m6gTFAXTsXTMokltCiZGvYZKIaydRnmOMg7Nor/NJyumRkSXYg2kyJ3hK0EQh3caX+zxYmrMeRYq6Lf1Ar+vQf/jfddGEHtFll/me5AbjGUi6oSKqcIvugnChQ0/gr2uQp60xrpWg529us2OusKbXEm6NXK9T2KI4WwINcJjD3gkeQsTG6qsI2OsPn0dv2BQrWUKSJMIiWphvF9glhBEhZSvdwcZJFMWhSqYzUq5lGiId45iZbOKDUdgvwZUQ7CY91NWHJWQImE9mx0mCYAZn3b5OPeiJO+Hj6lpcWxuDU3oBhLws8dy8N5RS1HLIQB/wgLvFXwLLnCmSWBHgGKMibc+zm0WqF8/odagQf0mpWZqaRdSiNxtSaNPeuPoghRsKMgv3I7LWwcw1PStDD/szuINUN2VASxg5eM5rbuq1g+XI0bOQXl6OX4LPMwnLdH4a03DHIlhlfY91mTtTKhJ/ZQxDB1PlZppAph0s1jdkalFGWE45I5KlWVrSgqKT5OtBYgQ6mPgYF32qeZTGdErbX8mzgAu/Mg73fs3pTLdvYG3GkZ5yo4NlRoYWMrQ0TkRGfvMlCgiLx5lAB8IBHQDttf8JCYygGWzUtHYiP5Ev0RxcPlwQlahEi6b+01yDoLli9ABHr8YAVGPNvnrXBf+ZoYULW85Y6W7DpgW35fUVrL4bdtPyrjZicEX+f9MXNW6tN2UGgb/80Sj9CJL8/+Du74R4R6T5MyKNKY8x3IitaTeyQf7O1HTbm4QRflkJhTg+pVzF45vQK8TU4FEVkyW08HmMUU1Z7c6koO2FheAx1ocnGFlqTpkIpTemPzSRRGhKR1FDEJlDQyh9oFdkozVnTgmji0/0K/6PErPHqyAkoV0VRfYZOr7ABbdgt4enC+DZF2XavivwzCU6lp2nzoaiaz5PAjwDD2Inc8YhpJ6JCE9GbqKBC5q/QKS2UFT6rWalWYyhhioUqf0J59FgcgWVMzTFGcc/wwv8HpltazA9etF8KbpWZCh8ikwcly/tn6MN0WbNhL/AfhNQFwowkeHwsTvaogjEAtOAqXBaMpOiEo7FU92gvA6fStEuli1qKeA+9mXQIWeI60POYusj4M04vF/v2P+GnxCb5Qb7hNICt85QiUT3Nrq5vCmsm0uY0KRPio1c+H/jQ15oR2bYm8K8+3vcdcGO6wFvA09s6W9u180UNTXgI7yGrnYCqLH5eW/WLK+H5kPgN5g2j3yavFOjdMswWK53Cwpw+VXgJgOohN3iDxBk6+vjA6TZMCh0/2BS2p8ic+lBegcrM33rHQ82hqvtgsvBFYTtw38Bo6G2pw==
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 'Approve an Approval Item' (approve-approval-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"}>Approve an Approval Item</h1>

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



This API approves an Approval 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><ParamsItem className={"paramsItem"} param={{"in":"path","name":"approvalItemId","schema":{"type":"string"},"required":true,"description":"The ID of the approval item.","example":"1211bcaa32112bcef6122adb21cef1ac"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

A work items details 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>