LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e8c6d4aad70eef6d6870aafd342c04847f4cdba0
developer.sailpoint.com/docs/api/v3/submit-account-selection.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

109 lines
49 KiB
Plaintext
Raw Blame History

---
id: submit-account-selection
sidebar_label: Submit Account Selections
hide_title: true
hide_table_of_contents: true
api: eJztHGlv2zj2rxDaD20HkeMzif1l103S2RRpms0xXWxaYGiJttnKlFaUknqD/Pd975G6LKWx02IueAaYcSTy3bco3TthJGKeyFCd+M7I0elkIZOx54WpSi5FIDy85ew4CZ9pZ3TjfAjjL+wkEQvtfNpxfKG9WEa0ZuRczaVm4/MTZqBoxg0cpjNAusWOZTIXMeOKcX8h1Q4LYwZXWHinpJrtemkcC9iSali0SHXCFvyLgBUAOhb/TYVOWkBOxGO+EImIkah7RyL6iCdzuKXgBvwlffitvblYcGd07yTLCK/qJAYszsOOg8BkLIDpJE5FnRXBTo5YOCXa7pBpCUwDSPGVL6IAYYlp72A67Pf6+2LYH+x1J4PJ5KDf7fPBXm+47x84D58MGqD5degvkYxVrF6oEmAXb/EoCqRHqtj9rJGK+zr94eQzSBLI4L4vcSkPzmNUYSKFNkAfSjTeO1MpAv/MiIR+/8KDVDgPDw+rLFuls1zr7IgnHMQf7bAvYil8BpcKcCRCHYFOEfG902238X8rMAvRaeaLhMtAM8MDavHZ3Eclnu9R1TUNr3L3lDK73rBz0D7oDfyuGHT2Dtqdgd/rTg+GbY93BgedzGRAlyI+2Qhhvm0zhGDJaRDwCa62es0hHUkdBXxp9PoUJWjLvtmAvvFtst6Gc8UuwXvnTQSAk67HfdV/aNt3c09Q1me5zGudgLccjMwyCrC9WPBENDI2DeMFBxt1fFjhJhLwVzhpd/bd9r7b6Vx1Dkb9wai332oPD/5Tpwl2sru5UFUrZHdcsww9ULIIfQle9kxSDtz2ntsdXHXbo2531D1oddr9zUgJOMTcNPKJngYtVCCtZXrFlW+74CEJIU8asFyHaewJ9mJ89AJFoxO434RUqHSByemNVFLPie4LgaHC/kzSWNHP468RRd8d51wo32w+5MqDkOdjPiuIKYGqs0SEIDO8wkoiE9qLORJT5CUue8dVyoPskkY+DPmPs/GzAGuVHtKGQW5q4yKxshC+zP46ArJn2R/jCILiLQ/g5y8yDOjyhbiV4g6uvAHDQaZDiLFLvB1m2w7nPAiEmqElnSwi7iVjyClLLTVcuJQzFU6nKLhbjNM7juFmnFUFVxBAqnIraK+LDfltMoFVuV3BugaxxQXz5lohQh7HfFmz1h1Hrqz7jgRSjWjeimI2SyQJj2ci2TyOVrAyA+WZyJ8XR58k4DOkj5bOoqpZ8NxktRlmqBRkMPZ9KErIWkoFxfN4LVckJhBV8KEP3Ap2BPHES8J4STgTAD1JE/FMjNl2NhGwPuOZglCBOJqHSpyliwlktDLO91khvx7ivO5vlnCoqiRVSDDpoYLdlJVrYb7FpZvxPOh03cFg4Ha6nS6iVRyFf+JDUJLJcl1Jk8Kk3ZQR0GTEWBsYKwZsD0WAuqhGoCNT0Dr1UpoFErIoYCjFLFMFW9OkUP07RbEMPRH0QkN82TiG2By9Jj6b0GMxFdDbedBJTJaZixWUPBZHGmqQkmv+Jn6t1nbn3JxBrrTr0RDVVOBu5sFlXMXWZj+9Xd89y2DNtjJI/o9JywsXTeTn5RlUFO+n1Jc/WqidnJ1c/vMYDe/i+O3x4ZX9eXV9cUY/j/99fnJBv86Pz45Ozn7GUmV8dnh8ihcRdbVaK+B9X7UGsrpf5exTOQSMS767hv+bzjeZ84QpAYafhBDnrN2ben992yrq9JplZb27KaGblAM6g6XPbnEO3E7b7QyvOr1Rf4gtTu9g0NBXYDzF3gLYvZtLb77SXxRENFAIprEaEKVKxIwat5xCuNTrNvs4pcRC6FI93mt0hg0EII5G8/0hY4epKcG/rwVez1jOStGuhnZ1tsdsb1DDZS1+HctEJMysb7LKAhcsZDhhaB2FFJZ0OtkUTbalVUF1HgiuhR00smkcLiz3QRDe2YmfyfTXGgxq46RB40hyYz0P08BHL4Zfd8pMJmtSfsuVyJm0s8+GTP9oZl/XBjc3CFT3yWq6fYNjvU6l1snWFUHuKVrAfETwNDGnuCyjRucD5oKYS2ssVGlMLRkbSK8Wjk9tMM5Y0q3iJ/O4QmVapJZbxpW/C7ZKcskkUKLxBnICTnczYVV31ymw93XFK1elXZZ0LQUB8jgO43XEUMy4C3pXEgiEJTJmHPjoSHhUcdNfKgT3Aa/1W/X5/lgxwolcGGoMlJCG9j7zU0S8EnXLXJbaeRpA95tmxoeBxAcAx4iAuSyb3jBZGVuySegvmcQwD9lY+j9wnGzm1Iehv4ZnvZFKuLOYS6SQZAJJzhcM87vEARNbhLGwo+9M+7SuGr9AEq0Oe8194Nfwd2iZQfHF3PsCsNYZGFwrCftZtgXaHQq6j6AV+4JP9trDbn+61+e8e9Dv7A8mwynv9drDwXBIA0moVvlMNFleFbUd/bAg9EAj/wOBQDWibdQn5N+KeCuxBGGsmRbM2pxNSy9LxNdkB2q+14fnrL/PAq5mKV3nsxUhKPf6sikDGsDvYzmTjSV5Vs0eHb8ZX59eUQX7r+vjy6u8Qq35j1Q+mmVIdQrkD6LYMkDOSAlM+C32k4X6EzDElS4vlOYvvdToy76Y8jRIYIfF3rCjDLrIjpkrkd98TdhL2RKtHYiG9NQtgfJtAknVz2YBP0E+F1HinlpJ/sTmgvsiftVi4/xplGkZNOxfUqXr++i6BsA0BVcGYqCrC9MEQ430VvJ4IcrVJjiLIadlpaBzAOVP2wl0dSkQR2yWvTC3Fkui1Q/QbCRXpe6qJDQS6VIlHCI7rAyWIMYYe0YGvRPDp582HKG6NAQela3LI1Y5NFK4e2eIOUpCuufxVK/hd+cBhB+XWMtv3ArrfBpbDhONSBuZmmxEgps0BMHNdlWurszxzUO/re9ufXfru2v67urNC/uk3N6l0qdTL32uFU9BvjElz1rpE5P1qJBli8xY0SiSzlHYEunthytw7C9C4XphHnn9wPrIpPKGZ/2ZPsz1SVYLZqm/1B0BgSRHw8EUIpHwR0R3QTEJyoiqV8cGBfNEgoGqhhKRmrVlmEK1CjpPFR4sYVzvMD8UWr1I2Jzf0lgS6DURELEq341CqX7kwYRtJbmtJLfZaJuNtpXktpLc+u7Wd390JZlTRd5i6ySdLhY8XhpLs/fN0y9YwLIzmyx3ufzRYLlaQWAsr7GcauXgTLqdSWe674m+z/v+Xm847Xp7XT7Y7+x3Jv3uvlPO9TeFH+dOVvWpkr6NHs1jOxHfQh2XKjAunYShXx3/pfRAGcMahp68bgaZg0g/FbVjv147noUJ8AaAoXaMHxkvXl+cmgfWBjzKzRxGQ6cl0ZnZJ5aUNDQVX6VOtqXjtnTcpp9t+vnLpJ9t6bj13a3v/jl9d6PSsf9U6djfoHTss7PsMfLvWTr6UHfQ82xQCvCQvVoWiwhYgV88P5NSHATNC71KFdkd1qvIqzBk77haZsWSrkwiVSEuDG+wdoFr42wtLOBsBiFSMYhaEqpbtCo8OwU1KZ5XC+RCkh8jQwA3XrrjaQJcGZ/J7C3HIpUXpEAhBYUgxNlrCDYmwZzEFMs/gEBz0BkE6h8447Ta+q55MLtAjk+RY3b81RMCfT6f/w6aTgmcAPExhotLo+tHjguYmTlX0EaIr5EJX3kJui3Vt6X6Nt1v0/1fI91vS/Wt725998/puxuU6rYaerxUhwVrl+qwttVmeS31Bo3rN6/YyVUsBWTeLPTMidKiBqe6AkwJCYpCGrTS5x5Gzi4eNXUp1OzeS/9h13x8wrVvHbm69BEL0xcYMtM4gN3zJIn0aHf3HrQHWnto8Ui2slfEVHiH77rs3vYaYhEePTV+B9HMT82RZfr4BSFpkcxjiWZtYiAhMBogLtGAQRN05uCb8LNz6EvoS5gBs4Pv0loTo8v4ZgX0F/atoxaZVI1H4O06Dh6e4ueX3rf4MEAe4aNJfN/EBesZULnCnmNOV2sBZkDv94G+8Nz+oQle4xQ1f/OpvOYSi3VDYW1lkYDwMUH97ZH3uKzLXgse4yl/Ojnz8u2Hq1dshiUqhYhUY3Us7MdL2DmYEYXAcXaKBDdRVorDdGZefBlXzumgy7FpAEJhH9WlEOwme3/xDHLDBQRzEjtuEhQ/cNenl5n2fHErAkybrULaaJzSV7sgxV1e2feKUiT1ElKZl2fgauujcu2bbXQaHddYFqk1ZDdRxhcv8fVcIv6WQXMNNJeg6VcrVBjR3njm3LcHfo8geKBJWs9GbuC5JXjYeMEVhLpKA0rC0lE9XeVlWns2HRV4LsKr0vFRfaBXparbmAl32esmJ8ybh6EWf2cMTQdd5WaWgqc9myx6P8slj3C77RJJrkHpSheqSaLvFBxDGWPiE8zmVMyEZq5CbvsraRbiwq/45gT7tcIzXb6BpIsr/dDTz6YZEbqI0DVxQlv67ZdlgFjwbeSB4oAxgMNC/xQJLKGluGhgNUZ+Ar9LezB9eEAqQdHRyPwxKoKg/cXoBq7O10CYxmI8P28GfzMLCxNbRVjZGGFVgnV6gxDy6YrcDL35w1DMsX80fpHjcTFtea+C5Y+O0o9Ekj9O3P2dIt420vwVI40tj3FqeVF8bOw4/wQY3ENTJJJsj1F2AFPt1eeCOLieC/gv3CUvphodOiDq6ai+KYOJAp6Y10DB3725FDRRiARPsHLcQZsLF+SjUC5jYIC+kQDN6JXlGJjh0APKAOC12Ado2RTU7zG2a3iSF6B+Dm3fdgkaOEcFsqNMqVBcLRapws86ABHpAl9AfkrzvtReagIUdG9KZJyFVOLluzJvRZNCUbSocYkX+v0UR8/Q1ZYU/AQu0K+2c2cQZPH+plMwciHMp3twXbV8fwo2WJU7F0GEDSNEVyi0RAnDu5OrGkQApuzDjjCe7dpNehfX4jcDgHljDL0WtIl4CVsv6G5LcC+p22K1V331qkXdF+P23/JDgTanYDOwG+HgC9lITQNjOsgbp+ggYcPIfDjwsSYSWo459p+w7f4eRybYUT3gZUCJ/fjNp6JhosYF9IO/oXOdQmRY/dJgWSwvL+zXAV/RQ5/mT9Y1MpTN+9SyaPUd+PlF4IQAOKI3SM0Ih4gyN+wzAxc/uFTaWHsYgr2k2WHGQt9c+6nUqp+/xwGZM7FfP1yYqUPM8ZtU+N+R8xH+dfDTF/kr0nQd3yY2kydYY+DiP/8Hjs6urQ==
sidebar_class_name: "post api-method"
info_path: docs/api/v3/identitynow-v-3-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 'Submit Account Selections' (submit-account-selection)"
---
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"}>Submit Account Selections</h1>
<MethodEndpoint method={"post"} path={"/work-items/{id}/submit-account-selection"}></MethodEndpoint>
This API submits account selections. 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><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
Account Selection Data map, keyed on fieldName
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></ul></details></TabItem></MimeTabs><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","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"requesterDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The displayname of the requester","example":"John Smith","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581","nullable":true}}></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","description":"Time when the work item was created"}}></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","description":"Time when the work item was last updated","nullable":true}}></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={"WorkItemStateManualWorkItems"} qualifierMessage={"**Possible values:** [`Finished`, `Rejected`, `Returned`, `Expired`, `Pending`, `Canceled`]"} schema={{"type":"string","enum":["Finished","Rejected","Returned","Expired","Pending","Canceled"],"example":"Finished","description":"The state of a work item","title":"WorkItemStateManualWorkItems"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"WorkItemTypeManualWorkItems"} qualifierMessage={"**Possible values:** [`Generic`, `Certification`, `Remediation`, `Delegation`, `Approval`, `ViolationReview`, `Form`, `PolicyVioloation`, `Challenge`, `ImpactAnalysis`, `Signoff`, `Event`, `ManualAction`, `Test`]"} schema={{"type":"string","enum":["Generic","Certification","Remediation","Delegation","Approval","ViolationReview","Form","PolicyVioloation","Challenge","ImpactAnalysis","Signoff","Event","ManualAction","Test"],"example":"Generic","description":"The type of the work item","title":"WorkItemTypeManualWorkItems"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A list of remediation items
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={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><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"}>approvalItems</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__nullable"}>nullable</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
A list of items that need to be approved
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={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","nullable":true}}></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","nullable":true}}></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","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED",null],"example":"FINISHED","description":"The state of a work item","title":"WorkItemState","nullable":true}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></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","nullable":true}}></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","description":"The time at which the work item completed","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"numItems"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of items in the work item","example":19,"nullable":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>form</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":"ID of the form","example":"2c9180835d2e5168015d32f890ca1581","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the form","example":"AccountSelection Form","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"title"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The form title","example":"Account Selection for John.Doe"}}></SchemaItem><SchemaItem collapsible={false} name={"subtitle"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The form subtitle.","example":"Please select from the following"}}></SchemaItem><SchemaItem collapsible={false} name={"targetUser"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the user that should be shown this form","example":"Jane.Doe"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>sections</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Sections of the form
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the FormItem","example":"Field1"}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Label of the section","example":"Section 1"}}></SchemaItem><SchemaItem collapsible={false} name={"formItems"} required={false} schemaName={"object[]"} qualifierMessage={undefined} schema={{"type":"array","description":"List of FormItems. FormItems can be SectionDetails and/or FieldDetails","example":[],"items":{"type":"object"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></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."],"description":"An array of errors that ocurred during the work item"}}></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 {\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 ],\n \"approvalItems\": [\n {\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 ],\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"form\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"name\": \"AccountSelection Form\",\n \"title\": \"Account Selection for John.Doe\",\n \"subtitle\": \"Please select from the following\",\n \"targetUser\": \"Jane.Doe\",\n \"sections\": [\n {\n \"name\": \"Field1\",\n \"label\": \"Section 1\",\n \"formItems\": []\n }\n ]\n },\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={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><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><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><p> An example of a 500 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink