LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 20:37:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/list-work-items.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

75 lines
36 KiB
Plaintext
Raw Blame History

---
id: list-work-items
sidebar_label: List Work Items
hide_title: true
hide_table_of_contents: true
api: eJztHGtzGjnyr6jmPiShPBgwxI+qqzuCsZccxj6Mk931umrFjAAlw2h2HnE4l//7dbc0L4NtzKZuN3vkgwMaqd/d6u6RuLNUIEIeS+X3XOvI8mQUf1Th514s5pG1Y8V8GllH1xaOMT14s2O5InJCGeAqWDOayYhNRRwxzhzlecLBB0xN2C2ukriKjYWn/Kn0pyxWTMh4JkIGf1gUCEdOpHBZEonwNXfn0meh+C2RoXDf7DClpzlJGAo/pklVoCvgIZ+LWIRI3Z0lkY7fEhEu4JkPT4iVuYyth8Se8a/MT+ZjQA8EhiJKPCAcaApFnIR+9Rf/Ugh2/WGPtS967DLmvstDl3Vyvi4y1DevZ3EcREe7u674AvyBJKsRl16gpB9XHTXfla6/ywO5Gxk4di4fO2fhDZsAm3MVCiZ9+DgnfSCbqSCsown3IrFjia98HnjAXqNV27EiZybm3Dq6s+JFgDwDXjEVIazUYPTQXgMGQK5ynsytI1g351/1Z4LiigkHKdC3+/ud1dJUk0kklsV5TsNANkgQ9TRJPM9IlcGDKruKEu55i4Keb0H5rELaqaDgAw5mwWMB60OVTGcExyjmu1HH71BGJv7Hhe+oxF+WfW/CKnGYiAq4GEgVBB+oIPG0KAWr/GiPVMw9u4OrKyjSQPmRYDPBXTB/0gNOXOEOMw4QVeK54LfGM0BzcpLpDeTHKtomKuxWoKimPkjMBY2BzqTvCPJiEcXo8xwUDaQwYoQ53Gcz/kXAMOiIhIPz5TzgTryD3EBACQVobC58FxD7KkZLiQRirRCQvxPnFaSJqP3CvURoKeBsIBtChaHmu7Ag5GeFEY2V8gT3rYKd0MrHHfXWFyHE8hWwojgEZVj3S4Z0jMpHU8gCNiMwKyi+v8EhbUkRwm7UavhfGWIftpHyBgCQHAUOAXYMs3kQeNIhqex+inDJ3TK5PAw5MqbX5+Nq/AkkjptAiBqKpSZEususrsGpVdCB1XAO6we1g72W2xCt+tuDWr3l7jUmB4c1h9dbB3WUnTFrEvILEGbLNkd4LKPA44sBKfo5zCPA6eoFaBlPk/FezXx2CZ49Q4SpCa2FI+eQlr2YO1q1PktFXpYRvudgTDkjTiggGq5kJAvJLsywYwn4S5TX6vt2bd+u10f1g6Nm62hvv1o7PPgZoc6VSzvZZmAP7Npbu9EaNWpHjcZR46BarzV/XvLJtbSbjzxt1R0SA+OODr8wPVJJCBH3Vfv4FaKGaBavlL/wcZO6tk56g97lD91jGBp233c7I/NxdDUc0Mfujxe9IX266A6Oe4NT+NRpDzrdPg76kBXcFCkqwFvmi6hBjniJn1jGtDZNTy+JaKBeE/048VeDfw3OPw5g5LQ76A57HaStOxz1Tnqd9qh3PiBWzrrHvfTbMZB9mn5pX1wMzz+0+/DxQ++8T8PD7ode9yOMnJwPz5Dp836v81P2GBH80O73u4PTLnzunV20O6P2oN3/6bJ3CQOXvdPB+ckJyu1DdzCC/8/ag6t2H2bp1aPu5cgqSSwnfVlgyPgqC3gosREKiALKXLhSJ/3fLraWg4GDiycmxr84KMQ8hILi5SGohJVpKBsi3ywkPUvAJ4i01SgNUHrCpnH9ZZhhc5Ve23Vh944Qd2EP3ozX4iauA0oJXxuyIsjxjiF5cGIFKQrijAH0OInFhhjT5ZDfYVppeBZuCXEwU74YUFJbwnmeVrrrIc4K49USRiEXSSqRkASuCU7Z8w+YoK6HWeeyL+K5VW/YrVbLrjfqDUQLBRUIv+dCviXjxbqSJoVJsyglYJUR4zarrRiw3eeRZliOLMciBptLrS1UwNg3DjgpWAp5ryIIBS92d7MtronP7KGhmEDRA1ULVEiL1BtySp5w+YLX/E9czl/b0zJLAznSqqeih3qZMxVh50tXu8yX9T2lCFYvK4Lk/xxj0fa9ZzgF/2oXvKjgXOvrOC/wljTcNqats0VKnxU+2jiBPrDrNbt+OKrvHTUPMYHeO2hRpgsifxgG8l7JCgfI+hO6lSj9x3Pd+iHAF2GowiL0xyrJvCDOAFw/EBPkFrobwqNiDwu+YZthAhJzq9ZNUUd5+/Qe/+1YzVUVcseT2M/sIqnMZsNCj6VQprGxchfYDZE+aF261Q3K6EcirEvm01HuGpZzIn1hT0MukUKSLnNgIUNjlC7uStTr0CDTWEXzqiWjAElU6+wdd4FfzV/HMIPyC7nzGWCtk/Vd+RLWs3QJ7FnUcXkErdgXfPy2dthoTt42OW8cNOv7rfHhhO/t1Q5bh4dU1EFc41OxymrKqE8FFJ3SYZ5yQCP/AYGAv2DViQQQ8vVbFgRjTc/VczM2Db0sFl/jHYgj7zoXrLnPPO5PExrn0wdC8O0rrD0wUvFx2nECzjXg81BO5cpgnkbI4+5J+6o/oqj47yssUNKoVya27YO1umiWipx2pm6JYsMAOZLAnplwq6xioFaAIe5HxYlSf4sWEfqh6X7BCoN9xYoiaDYJ1bzkSuQ3X2P2WlZFdQeyKRiDCObM2JhHsMAkdBWIgyKI7b6RZMX0S99UGWx/EpmETZ42mwjWL7DVyF3sUpq4NEnAlQW1V1USY5iQjijrIhdlWRt5EOkXlYLOAZQ/byew/ydAHLFZ9MLMWgyJRj9As5ZcmbpRQWgk0oUfc8gsHGrkOyrE7ILBrgsRMmImHKG6Igg8fjovi1jF2Ejh7kwTcxwreubwJFrD7y48CD82sZY9+CKM89EbHB2NSBupmkxEMi8naLGZlakrdXwGgd1zt7679d2t767puw8fDs17AfOUUp+95dTnRIVjCVL3V+Q9+H6XLVTCOKghTHyf3h5FO8xVIvJfxea9Eag5irRbA+3Cd239imabHm3To22I3YbYv0yI3aZHW9/d+u736btPpkcZVeQtJk+Kkvmchwttaea5bhPChPwAT+ZyWae0mK0gMJblWFY5c7DGjfq4Ptl3RNPlTfft3uGk4bxt8NZ+fb8+bjb2reJef537ceZkZZ8q6FvrUfc3RfgF8rjEB+OKYqXcck8rof45hjUMPTwBawohVQCZg0hv7rO2WXM5dxyoGHgDwJA7ho/0zK6Gfd2f1+BRbvp1NzotiU639DClpC6e+CqjeJs6blPH7faz3X7+MtvPNnXc+u7Wd79P331R6th8LnVsviB1bLJB+l7zj0wdXalPfU9AKXitxFz/CEUArMAnfQYndXt9RCVL9PIsktIPsDgkXx9iCXg8gy+7+IbXTk8ma6Sa6iT04Hl6DvwOtAjau6/yQFbTkzG+uqXD4GMQ3YqohK9rtQfiBDp2rhFUSe6hRNPWcZCAay2Yw91Wdt78ScjpoZAFMMw0mB08B2jMjIbx9T33F+Y0R5XMaok/4Osq9O5/Py8a0CO8rBLfk9hgPgNKH7CILNygusAe6FgT6OsK6OnoINZOULfXN8U5l5i0awqXZuYbEdYgjSWCznFag70TPMTbSuqz8Nnr9x9Hb9gUU1UKFUmEWbK50MTZBZgRhcJ22qLGRWSm+eWWtql4tBGj67GJB0Jh5q5CemxrAHvEEII6iR0XCYojuGr9mwq8tO6Rmwm/+LY5NSRxy8c5hkV9e+M6SPniBb42JeJvKTRbQ7MJWvTmARVatNeOPinhhILEwr2IpLUxcg3PLsDDAgxGEOpDGlAShg5e0pqTam1jOkrwbIRXpuMX/+NMwj5cXsZ0PGPRjK7n9JgzUyoS/2AMTQdd5XqagKdtTNYtIrXJI+xGrUCSrVHa0oaskujrg2P42pj4GHd1SmqUDtrktr+SZiEu/Eo3hn4t8UzD17D54kxXOS+4fvOAZkRoI0Jbx4nI0K/3NjQsPLAEPFAc0AbQyfVPkcAQWoiNGtbKyE/gd2kNbh8OkEpQouBIfznKg6D5xOgBzs7mQKjGpDx7mQXfmYGFO1dJWGk74aEEl+n1FGyvD+Sm6c06Lbjl/tn4RY7bedfl3PcW3zpKPxJJ/jxx9w+KeNtI81eMNCb/RXMjtKaeKBr5O5PTLXcBI7pDCn/hKfkqHtCEYiDOr40WAQUej9GqyaudmRTUPwgEjzE/3EHLUnPyRCj10f2hSiRAUzpsGgLJHCo+6QG8KhvlmDk5jE4+Ua/4PUpME1eBSUI9KqrsI5R0vgNqwXIOjw/As0/K1HWXoJkLVCw7TpUNSdd8nvh4yh3ITuaMg0k9YxGujJxEBy6o7nyRykJR6petSr0YTQ1ZqFJ9E86j88klZM5Q9RYU/wwu0Ht6cRJEj1o0lzxzRobCI8vEeeXU/jnYYG32THgBFpQQdSEBEwUMZ73REkQA5psKS4XTXbMo2sW5eG4bmNfms1etV2s2lRQwHqgohhK4AJyuhxZ+UmDp8lvWif9DflzA7DdYKOwG2BxDLhJd3Oj68doq1I9QbcyARRy9u8OuCRZU9zisr+ZilQJCR0/I7/0+yvD39QMFK0X1WWAfIv39BdNpsCysPteXw//XLws8Icfslxc2FOT2ZwK+v58JeMIc0t+C2NQanrrr/5QVZj8rkCO+yVtA1HaBOEg2QxFPL9Nt48KqpRerCCXr0Z12YSe5/y/LEn+V
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to '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 Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
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}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><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"}}></SchemaItem><SchemaItem collapsible={false} name={"requesterDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The displayname of the requester","example":"John Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the owner","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"ownerName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the owner","example":"Jason Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2017-07-11T18:45:37.098Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-06-25T20:22:28.104Z"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The description of the work item","example":"Create account on source 'AD'"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"WorkItemState"} qualifierMessage={"**Possible values:** [`FINISHED`, `REJECTED`, `RETURNED`, `EXPIRED`, `PENDING`, `CANCELED`, `null`]"} schema={{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED",null],"example":"FINISHED","description":"The state of a work item","title":"WorkItemState"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"WorkItemType"} qualifierMessage={"**Possible values:** [`UNKNOWN`, `GENERIC`, `CERTIFICATION`, `REMEDIATION`, `DELEGATION`, `APPROVAL`, `VIOLATIONREVIEW`, `FORM`, `POLICYVIOLATION`, `CHALLENGE`, `IMPACTANALYSIS`, `SIGNOFF`, `EVENT`, `MANUALACTION`, `TEST`]"} schema={{"type":"string","enum":["UNKNOWN","GENERIC","CERTIFICATION","REMEDIATION","DELEGATION","APPROVAL","VIOLATIONREVIEW","FORM","POLICYVIOLATION","CHALLENGE","IMPACTANALYSIS","SIGNOFF","EVENT","MANUALACTION","TEST"],"example":"GENERIC","description":"The type of the work item","title":"WorkItemType"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>remediationItems</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the certification","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"targetId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the certification target","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"targetName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the certification target","example":"john.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"targetDisplayName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The display name of the certification target","example":"emailAddress"}}></SchemaItem><SchemaItem collapsible={false} name={"applicationName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the application/source","example":"Active Directory"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the attribute being certified","example":"phoneNumber"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeOperation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The operation of the certification on the attribute","example":"update"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeValue"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The value of the attribute being certified","example":"512-555-1212"}}></SchemaItem><SchemaItem collapsible={false} name={"nativeIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The native identity of the target","example":"jason.smith2"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvalItems</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The approval item's ID","example":"2c9180835d2e5168015d32f890ca1581"}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account referenced by the approval item","example":"john.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"application"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the application/source","example":"Active Directory"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute's name","example":"emailAddress"}}></SchemaItem><SchemaItem collapsible={false} name={"operation"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute's operation","example":"update"}}></SchemaItem><SchemaItem collapsible={false} name={"value"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The attribute's value","example":"a@b.com"}}></SchemaItem><SchemaItem collapsible={false} name={"state"} required={false} schemaName={"WorkItemState"} qualifierMessage={"**Possible values:** [`FINISHED`, `REJECTED`, `RETURNED`, `EXPIRED`, `PENDING`, `CANCELED`, `null`]"} schema={{"type":"string","enum":["FINISHED","REJECTED","RETURNED","EXPIRED","PENDING","CANCELED",null],"example":"FINISHED","description":"The state of a work item","title":"WorkItemState"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The work item name","example":"Account Create"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","example":"2018-10-19T13:49:37.385Z"}}></SchemaItem><SchemaItem collapsible={false} name={"numItems"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of items in the work item","example":19}}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"example":["The work item ID that was specified was not found."]}}></SchemaItem><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 \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetId\": \"2c9180835d2e5168015d32f890ca1581\",\n \"targetName\": \"john.smith\",\n \"targetDisplayName\": \"emailAddress\",\n \"applicationName\": \"Active Directory\",\n \"attributeName\": \"phoneNumber\",\n \"attributeOperation\": \"update\",\n \"attributeValue\": \"512-555-1212\",\n \"nativeIdentity\": \"jason.smith2\"\n },\n \"approvalItems\": {\n \"id\": \"2c9180835d2e5168015d32f890ca1581\",\n \"account\": \"john.smith\",\n \"application\": \"Active Directory\",\n \"name\": \"emailAddress\",\n \"operation\": \"update\",\n \"value\": \"a@b.com\",\n \"state\": \"FINISHED\"\n },\n \"name\": \"Account Create\",\n \"completed\": \"2018-10-19T13:49:37.385Z\",\n \"numItems\": 19,\n \"errors\": [\n \"The work item ID that was specified was not found.\"\n ]\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><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"}><Markdown> An example of a 404 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink