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/list-work-items.api.mdx
darrell-thobe-sp e8c6d4aad7 merge main and fix conflicts
2024-03-06 16:17:34 -05:00

93 lines
45 KiB
Plaintext
Raw Blame History

---
id: list-work-items
sidebar_label: List Work Items
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2zYS/1cwvA9JPKYsyXb8mLm5U22n54zj+Gy56ZybmUIkKKGhAJYP27qM//fbXYAvkbIlJ9M0PfVDKpMA9oF9/LAA+NnRkYh5KrU69Z1DJ5RJ+kHHn05TMU2cTSfl48Q5vHHwGTMPP246vki8WEbYC/oMJzJhY5EmjDNPh6Hw8AXTAbvDXhJ7sZEItRpLNWapZkKmExEz+IclkfBkIIXPskTEL7k/lYrF4vdMxsJ/tcm0aeZlcSxUSo06wFfEYz4VqYiRu8+ORD5+z0Q8g3cK3pAoU5k688y+4/dMZdMRkAcGY5FkITAOPMUizWLV+UVdCcFuftpmg4tTdpVy5fPYZ0elXBcF6Y8vJ2kaJYdbW764BflAk52EyzDSUqUdT0+3pK+2eCS3EjuOW+rHLUV4xQIQc6pjwaSCn1OaDxQzV4RzGPAwEZuOuOfTKATx+rvdTSfxJmLKncPPTjqLUGagK8Yihp5mGPNouw8PQK9ymk2dQ+g35ffmN43ii4CDFuivh4fNdm3qIEhEU53v6TGwDRrEeQqyMLRaZfCiw66TjIfhrDLPdzD5bINmZwMVH3EwC54K6B/rbDyhcezEfDfT8QWTUah/sfI9namm7k8DtpHGmdgAFwOtguIjHWWhUaVgGz+7Q53y0D3C3huo0kirRLCJ4D6YP80DNmxxhwmHEXUW+uC31jNg5mRQzBvoj20Ym9hgdwJVNVagMR9mDOZMKk+QF4skRZ/nMNHACiNBmMcVm/BbAY9hjkg52F5OI+6lmygNBJRYwIxNhfKBsNIpWkoikOoGDfJ3knwDeSJub3mYCaMFbA1sQ6iw3HwXFoTytBjRSOtQcOVU7IR6LnbUOyViiOUtYyVpDJPhPDQM6RgnH02hCNiMhnmcY6fX7/VGHufb8P/+yBPB616/z/1Rvwe/e9xzHj5if2N2CTLS73bxf3XyZ5Bz6tkCyHoavAeMHlrzKAqlRyrc+i3BLp+bsvE45qgF0798rke/wfRgxohxOlNpGJF+Uy9LqMWpit/3Dnr73f3tXb8vdnuv97u9XX+7H+wfdD3e293voaKtD9CMrECw6LYaQTACiL98lNtTlYFjmUQhn52TlTzFyRB48E0HNKvH2XqrJ4pdQViYtDGQ2+NSNEsNULcvlp5GWV7kqqxNBt5yMD4rKIztxQJCbatgRbz3oYWbSqBfk6Tb23O7e26vN+ztH+7sHm7vdboH+/9p8gQ92d1EqDnnvOMJy8kDJ1PtU2p9Hiv7bve1298d9ruH/f5hf7/T6+6sxkrIwYGzyCd+WmahNtJSplc+edwFj0gJjHsmsUDzRGcx5JIXg+MXqBqI02nr5AuF6ffGeQOZOJkQ35cCQ4X9aVIe/Dy5jyj8bToXkH5M5yPMVyE8/FhlpjJUUyRiBIXhNVFSmVLfHHNfYbN3XAFoKmE4yGHYXyzGjwKsVXrIGwa5wMZLEmUqfJn/dQxsj/M/BhEERUic8PMnqUN6fClupbiDJ2/AcFBoDbF3hq913u1oAohOqDFa0inl7IHi4SyRGLevEAcEASruVhBoMdIMPNt7CAGkrreS96baUN42E5jX2xDatagtLoU/nUsMecKoW+tXTSD1iObNTcxqiSTlMSyxVo+jNarMjPJM4s+Lo08y8Bukj06SR1XT4LnJajXKgCBkOPB9gChkLRWg8TxZq0jFBKIaPfQBQL3HEE+8VANoQ5opDD3KUvFMinl3QLwItK3MFIRKwtFEK3FOML9G832+9l+OcFEqaNewVnWWaiyY9FCj/hNC9uUoG3S/ksy7vb67u7vrAkjtI1lYYoLyT30ISjKdLatpmjBpO+UMtBkxYgNjxUDtoQxQl/UIdCxSsLmkicEHLLQwuBKzLBo2pkmh+htFsZw8MfQigfiycgyxOXpJejahxyKAtSUkW1iIznIXKzlZFEdaMEjFNf8Qv1ZLu3NhzqBX6rUwRLUB3NU8uEqr7Nrup7fLu2d1WNOtOiT/5wjXzm3sF/AMEMX7gEp5C4Ha6fnp1b9O0PAuT96eHA3tz+H15Tn9PPn54vSSfl2cnB+fnv+IUGVwfnRyhg+RdB2tleN9GVpzcCU+J9nHaggYVHx3Cf839VIqaigBhp9qrGYYuzd4f3nbKnF6w7IG1sUMhG6bHJgzaPrsJc6+2+u6vYNhb/tw5wCXONv7uy3rCoynuLbAitNEepO59UXJRAuHYBrzAfGRoluLjxeVL6N0qRavNXoHLQwgjVbz/Splh8BA8C9bAi9nLOeVaNcga03lSuQVM7s2aNCyFr+MZSIRZtq3WWVJCytpWGHoHGsKS0k2WpVM3qVTI3URCp6AqxMlFsR6aqUPQ31n62Qm018nYFArJw3cqjBunEzyUir8ukMbk0lTy2+5EoWQRvi2TL8wsy9rg6sbBE736Xy6fSNF6PdqWCdvVwa5p3gB8xHh08ycYbOcG6ubGjNX1lgIaQSWjRW01wjHeU0yFynplD+pfg2TaYlaabEkvgW2SnrJNVDh8QZyAtZDc2XVezc5sO+TmlfOa7uq6UYKAuJxrONl1FBWhkt+5xIIhCWzLcCT6mYO/IX19gC81u809wYHihFNlMJwY0bRtKHnMz+LaU+wFnWrUlaW8/jfprPT7TVLyNeKZ+lEx/K/MKbLLis7FrjTKHBDQWmWNzLg2uyD0BajacfefhhCuv0kFLYXpvDTeUYxeoG1kwKazA/YFNAdH+d1r1GuEdO+FiOAQUAS0jcSBDD5wj8kvkuOjaZIVdtNamA2I+nDiqapJxOyZjqDORMszpSivZtkk/laJOpFandtPA/4ZbTjh1SV75oNkq+nKZ/s+kj7S0SqN1IJdxxziYKQygA0+IIhXpJYsDMbMWbI3JuoXT0f7HS7nR77gfugFipzsyMrDJpjzL1PMNYyBZhrJaE/y7vA8pGS2AKyYk/w0evuQX8neL3DeX9/p7e3OzoI+PZ292D34IAKvMY+2jy5TtqW0lioPbASdAZAd4nNork5Lbk2pDGWTLOmbSFmbs+puE83AUP/cHTBdvZYyNU4o+d8PKcE5V5ftSEKM/D7WI5l6xInXx0cn7wZXJ8NaUXw7+uTq2GB+BvxSCofzVIT7oN8TBxbASi4ESAAx2cbdtQNEIirpNpQmr+SWYKx0W7NQQ9LvaVHdegSbdgdFUZ+c5+yl7IjOpuQXeAZoFeAwyMAKX5eW9kAfCSi1D2zmtywQexVh8EiUaKQsDSmJVgC/We0cvBxC9VC2yADjxe096uzFEO39OZwUanK+aJCHpPPqpOCzgGcP20nsErOgDkSs+qFhbVYFu38AM9Gc3XuhhWlkUpnKuWQKT06ZeDpGNfgDNaikEoSZsMRTlcCgUfl7aSiKNqppZoT5OadYeY41fTO41myhN9dhBB+XBKteHErrPNRqDTRiGYjnyYbkezJCepsWxXTlTs+CxBVrH137btr313Sd+dfXtpzCPS24Iq8xeKkJJtOeTwzlmbfmxoQNCiPzxQuVxTIqmgFB2MFxnLqyMEZ9XujXrDniR2f7/ivtw+Cvve6z3f3enu90U5/z6nm+pvSjwsnq/tUZb7NPJrilYhvAccBIBdxkmrt16wV1RuLAMMahp4CN4POQaUfS+y408SO54D03yDSB+wYz2HHfPzryzNTtjXDo97Mliw6LanOrAAQUtLSQdzDWmsNHdfQcZ1+1unnL5N+1tBx7btr3/0+fXcl6LjzFHTcWQE67rDzvJj6LaGjL82Z6wAmBS912MsXsYhAFPjFi52Z8jhEAfRqKLJ/0ESRQ63ZO65mOVhKapVIVaoLwxu0nWLbOG8LDTgbQ4hUeHhcArpFq8IdRMCkuGtLJ9TRj1EgGDeeuYMgBansuXdrbwUVqbwwAw4pKOAlFaR7xyUeIg8Q/sEIVAcdQ6D+ijVOO1tfVA9mlyjxGUrMTu49IdDni/rvbttp61NgPsZwcWXmmix8Uc2cK1hGiPvIhK8Cgq6h+hqqr9P9Ot3/NdL9GqqvfXftu9+n764A1S0aWgzVocHSUB3adrqswFJv6GbeH43YyVUsB2TeTHvmXEWJwQlXgCkhQ+bQcsTTCfyxhect3Py6nQH+ho8sDuF9fhPyM0wPTMtDh0eyk5+EVvqOrkPebrcEG5hK63wQrvzMnMzBy5eGSIeUGku0WxPkiIBRsb3i6BS3Lh8dPz9uNYOFBzPDbOKVEWtD9BgPEMICwh6u7ZDNNGQE2a7j8OEpeewl0gVymEEWyNGmvkdpQXsGXM6J55hDRImAeaZj7DBfeDztyESnQYZze/Ox2uYK0bjhsNGyzDC4D9A8JPkem/XZD4LHeJiNjsa8fPth+IqNEYNSDMgShL/2Sj9nF2BGFOMG+TER7ERpp7zePagdxEGfYkEISmH2tm5+TP8cgv8lRGtSO3YSFCCw1/J3dXmt34K7ub8o1x7gpkNX2MaKaO4v30S5XLwi13OZ+Fs+mmtGc2m05NUcF0a1N14oMUR64Ng4BA8T0taziZvx3Mp4uLKCJzjqPA+oCctH/fiUl8/as/mojefieHU+flEf6ERwvRsz8Sw/VXnKvInWifgHY2g66Co34ww87dls0TFklzzC7XcrLLmGpCtdgIvE3xk4hjLGxEeYrgmtaFM4Ibf9lWYW4sKvdGf+15rM9PgGsiq29LW3wgX0OZ6RoIsEXRMnEsu/SVpoWODbKAPFAWMAR+X8UySwjFbiohmrNfLT8FvUB9OHB6zSKEl0aP44LIOg/cXoBbYu2kCYRrRdHCiDv5kdCzNXTVl5nWBeg01+Qw0Jc05vht9itxOT6J9NXpR4UJZT3qtw9rWj9IJI8ueJu98o4q0jzV8x0lj8i+ZGZO1CoWrkBtE1i3sJfUMF/oW35KkEtGEZU342pTpMFPLU3GgAn/YmUlBZIBI8RXS4iXalp+SHAInR+WHxRwON6fZNDAxzWMjJEMbrsA+w7lIeqBjXXHgcF0b9TdvF1xVo+QIniR3nEwcAajrNFN5QBCayKd6leWp2fZl4mQlCsARTIpdME4wreuUeiWaDqujQ6iOeJu8DrB/D0rQyiU/QgjnMv+wBiiyvIjilIJfC3ELHdnWI/tTYYDnuRIQRrvogggKYEhUK706HjRFhMGV3LHQ83rKdki1si9ffQHhjDNsdWOvho0gnKSxRK+PSNYHKt7Ea3zooKuXf5CtZNm0g3t+KsHiFUmRmjWKWgTdOZRkIi4YJiIhPP3/GqgauiR7wsfnGDC42QN9o0uXnYBYK/H19aatVVZ8E1gnyD4nZSoBDty2W18P/1yeyHtFj8QmxZypy/b2r7+97V4+YQ/5Rs+daw2MfrXrMCovvY5WEP5aVHKqeQBwkm6GIZ7qZsm6lV2PjE0cpSm0/nkASefgfKLhOXA==
sidebar_class_name: "get 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 'List Work Items' (list-work-items)"
---
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"}>List Work Items</h1>
<MethodEndpoint method={"get"} path={"/work-items"}></MethodEndpoint>
This gets a collection of work items belonging to either the specified user(admin required), or the current user.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"ownerId","schema":{"type":"string"},"description":"ID of the work item owner.","required":false,"example":"1211bcaa32112bcef6122adb21cef1ac"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
List of work items
</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"}}><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":"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><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\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 }\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