---
id: approve-approval-items-in-bulk
sidebar_label: Bulk approve Approval Items
hide_title: true
hide_table_of_contents: true
api: eJztW21z4jgS/isq7sO8VMw7CfDljiFkljkGcoTM3F42VStsAZoxFifbmeFS+e/X3ZLBBpIQbmr3dotPGFvq937ULcv3ObUQmkdSBV0v18zxxUKrO9GiH+53IzEPu8G72P+aO8lFfBrmmje5z0p/ZfQod3uS80ToarlAEkBgNJMha1122RjmMEsO7liCZlqedWQ0E5rxgHFvLoMTpjSDO0x9C2QwLbix1iKIWBzCoHkcRmzOvwoYAcS1+HcswigPAi245nMRCY1i3eckCrDg0QweBfAA/kkPrkN3JuY817zPRcsF3g0jDVxyDyc5JCa1ANUjHYttZQTrnjM1Idm+odoS5AeS4jufL3ykJSaV+qRRrVTPRKNaOy2Pa+NxvVqu8tpppXHm1XMPt8gmXKggFCEKUS4W8SfLqrUmHzJPRFz6IVPjL8IlTV0VRGAQnAc29aVLLit8CXHy/baGZiaaSKODI2lYgzm2rLCp9HMKl91GqV6sV2peWdRKp/ViqeZVypN6o+jyUq1eSswKPhK6+yKGq2mHMzyX4cLnyz65/znO6F/PTMB4eVqMD2oWsKs5BC4yhEDdT7tsDNG0F2tHs/ZXKa3LNsMPHIJmrYirBY/ETkUmSs85xFzOgxFOJIF/RvJi6cwpnjml0qhUb1ZrzcpZvtio/wupzpUnJ/JQsnWneOqUa6NysVkuN8v1fKlYJbIZXffy7vrO01HdJjMw7roqBuCB4aGKtSvYq9b5K2QdRvB8F1MRxHNExYtuv3v1U+ccbg07Hzrtkb0cXQ/7dNn552V3SFeXnf55t/8ertqtfrvTw5tB7Pu3aYlS9Lb1ImlQI57RJ5IRzUWERqS9IqFBeiP048Jf9//eH3zuw533nX5n2G2jbJ3hqHvRbbdG3UGfVPnYOe8m/85B7PfJn9bl5XDwqdWDy0/dQY9uDzufup3PcOdiMPyISg963fbPq8fI4KdWr9fpv+/AdffjZas9avVbvZ+vuldw46r7vj+4uEC7fer0R/D7sdW/bvVglJk96lyNchmLrUXfNhgqvisCNi02QgMRoMyFJ83CSCvdD8HWLBi4OHlisfzFoBBxPRXRyyEow5UZKgcyPwySnhXgCyBtPkwAygw4FNdfxhkWUem3PA/W6xB5p9baw3RNL9YGUDL8Wm4k7wQ7hxLEjZReEs8ISI/jSBzIMZnOxgLGJzoLL8N4MVOB6MfzMSwOaZ6DpBrcj/GqeNxtYTRyWqSMCPHCs+C0ev6J+/GeKt/h0JfpXCuVnVqt5pTKpTKyDTgav+tBXSWj5b6WJodJOykRYFcQ4zJrohi4PayRZphFlnNT69loW1fdPw5wErIEea9CgIIXp7tdFvfkZ9dQLSYCqnhXeGy8TLJhLckTKZ/Kmt8k5YK9M20VaWBHmvUUeqiXJVOa9nrq7pS52z9T0mTNtDRJ/rdx3lXzP3qFk8qvdO+aSq79fbxit+3hlg1tUy1S+azw0cEFdN0pFZ1SY1SqNKsNLKAr9RpVumDyTRiQ0AJOqZjfkQAE5Wgu00HK4PFat9QA+kJrpdPUudZ8CcPkBtd1r7wicLNhJqgtohmP2DcesnAhXIJe+heoiE3AYl4+d5v2UeI98MwD3q/uaonbvsQ9gA5Kyhw2FFGsAyAsM10aGytvySSqDE6X3g/slk0b3lbeHoFzIQPhTDWXKCEZl7kwkWEsSg8XpbnSwnb2CVTRuHwmJsAS+RJ7xz3Q1+jXtsqg+TR3vwKtfYq+60DCfJZMgSULPKEfYyvOBB+fFhvl6uS0ynm5Xi2d1caNCa9Uio1ao0E9HcAan4pdQZNl/V5Azyld5isXPPIfMAikCzadKAAx3xFnj/iAaOyZuGbsSk0rL4vE9+gEYORd+5JVz5jPg2lM9/l0wwiBc42tBwIVH+Mt3BQCzQ3hgZZTuRPLE4A871y0rnsjAsV/XGN/koDexmZPANHqYVgqytmZ+kYSWwUoj4QP5hBenr21VN+CQjwI0wOl+RcuQ0xDT0x47Ecww3LfMSNNmk20mmdSifLme8Rey7zIn0AxRRtvkTtjYx7CBFvPvQUYFIvI6VlLvmUzwT2h3+QZrH4SlYQ1ntaaEOYvgRDjnoepawhMYkhlEAaWexVHiBLSFVlfrE2Z9cYaQ3ppp2BygOTPxwks/zEIR2qms3AVLVZE6x+Q2VguK90oZTQy6TKIOBQWMNJfghk1FhcMFl0AyJBZOEJ3hQA8QTJuhVhpaCS4+2iEOY8UPXN5HO6Rd5c+wI9Dqq0e3AmbfBAGyqIReSNxk0UkeEiFLE62o1buShKfAa773jF3j7l7zN09c3fz4dC+CLBPqfSpbJc+F0qPJVg92FH30DuRpYoZBzfoOMAXJoyHJ8xTIgxeRWzG76gJAzlMWoPsIvCchYIK8lgeHcujI8QeIfbPA7HH8uiYu8fc/WPm7pPl0UoqyhZbJ4XxfM710kSafW52CWEAS85ZsFXKrTZK09UKEmOrGiuXrRxy43JpXJqcuaLq8ap3WmlMyu5pmdfOSmelcbV8lkuv9TfrPF4lWTanUv42fjTbm0LfQR0XBxBcYaSUl93Timn7HGENoYfHEE0aSgWwOZj09uEhqR2r27VjX0WgGxCG2lE/smd2PeyZ7XlDHu1m3nZj0pLpzI4elpS0iSe+yzA6lo7H0vG4/ByXnz/N8nMsHY+5e8zdP2buvqh0rD5XOlZfUDpWWT95rfl7lo4e1B30fhWcAjokR6a1WIAqcGWO4CRpb06orAq9dRVJ5QdEHIq/UFTk0RHqZq6Ab3gdQqQCnuZ27Gnuwr30HmCYkcMoEmsfZsyiaBE2C4V7cCw49CHPFzKfnJUJ1Dc8aVAYgzV3ABW+wTVJiQPoCLlhkCdXaInRbqCRiBvHUG5jXIODaH/zScrJMZEl2IAZMid4MtBGHt3GF/o8WNrzHXmKtC39QK9r7T/877oYQo/osst8T3KD8Qwk3VARVbhFd0GI0EEn8Nc1yNM2uNaK0ds3t+kxV1jHGwm3Rq7XJmxLylsCDXBYmb0TXEOURuqrCNjrD59Hb9gUq1dCjzjEwlnYjwDYJYQRoWMr2bXGSRS5WsXTGSnXsk2QiWvMRjbxwSjsl+BKCHaTHOTqw7IxBJwns+MkQdCCs25fJx70xJ3wcUXNr62NwSm9oABWLPDMvDeURtRmyMAc6oC7+V8Cx54jklgF4BirIm3Js5tFohdP6XWoEH9JqDmGmkPUwjcbUhjT3rjm8ISrBZmF+yFZ62Dmhp6Tooc9GdxBqpsyoCWsHDzjNTfx2sFyZOg5SC8rxy/B55mEpTk7jRmIYyGsrL7HusydKRWKvzKGoYOpcjONIdMOFusbMnUoI5xyMSWSY1g60oFCk+TrQWIEJpj4GBd6qnOUwXFK21/Js4ALvzIO937N6Ey3b2A9xpGecsODZUaGDjJ0DE6EVn779QkIi0eYQAfCARMA7bX/CQmsoClsNLR2Ij+RL9AcXD5cEJWohIum+dNcg6C9YvQAR6/GAFRjnb56vwX/maWFi1nGWMkOw6YFt+X1Fay4G3Yz8q42X3AV/n/TFzVurTdiBoG//NEo/QiS/P/g7u+EeEek+TMijS2JMdyIrW0x0kH+ztZ02xuDIX6iCMU3PqVcxSOb0B9E1NRRFZMmtPB5hFFNWe3OpKAthYXgEdaHJxhZak6ZCHU3pj80jkRoSsdPNYjMoQmUPtDLs9GaM6eEMcUn+hX/h7Hd11UQktCiijz7DF1e4IJbsMPDEwXw7Iuyrd4VeOYSHcvOE2dD0TWfxwGeewex4znjEFLPRIQnQzc2wAUNXyASWygq/VazkizGUEMV8tTy6Hk4mFxB5QyNcMrxz/ACv4d2qxpMj160H4OuFRkKnyITx2VL++doQ7Q5M+EvsMcE1IUCTKQ4fOyOtigCscA2XUpPC3ZSWMCxeJIblDfhU8mX8kWHWgq4j70YdMUp4u9SX9RufFC7GYr364363/aLXLvoYLdQWOCmGaoSmw7HtJU3uXVbCRPSjSX8bUoPv+maYSMKQ+/vcYsFW60HvA1ssH+/uV13UdTNgHPwGlrYCcDF5me8aWO8HtoPft9gvjzyce9OJZL9wWC53hrIweVXgTsKIDY01CA4bfmQUOaB2RRKTdl6bYJ916oDvxxcQVQ8/Bd9c0gz
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 'Bulk approve Approval Items' (approve-approval-items-in-bulk)"
---

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"}>Bulk approve Approval Items</h1>

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



This API bulk approves Approval Items. 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 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>