mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
105 lines
48 KiB
Plaintext
105 lines
48 KiB
Plaintext
---
|
|
id: complete-work-item
|
|
sidebar_label: Complete a Work Item
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXFtT4zgW/iuq7ENfioRcgfCymwF6Jl00zUKY3lqGqlFsJVG3I3ktG8hS/Pc950i+JaZJ6N65VV66jS2dm87lO7Kch5oORcRjqdXQrx3WPD0PAxGLTzr6MozFvLZTi/nU1A6va3iL4T1Tu9mp+cJ4kQxxIkwbzaRhg/MhS+cbxtkdTpAwocFOZDwTEeOKcX8u1Q7TEYM7TN8pqaa7XhJFQsUsMTBonpiYzfkXASOAaiT+kwgTN0CSkEd8DsQjlOehJpFzyOMZPFLwAP6SPlwbbybmvHb4UIsXId41cQRcao87NSQmIwGaxlEiVrUQbHjM9IRky8QHkuKeo14wRkw6B5N+t9PdF/1ub6897o3HB912l/f2Ov19/6D2eINsTKiVEQaFaDeb+F+Z1YClFjZMjz8LLwYunlYxmAFH8zAMpEfrsvvZ4JSHVb2yiWGEqxhLyxCMsKL7sqrPqdn2+q2D5kGn57dFr7V30Gz1/E57ctBverzVO2ilxoSVEdFwI4bZtM0YwhonQcDHOBoXryjAsTRhwBdn5ATPSYKr7NsJ6DVfF+u9nil2OZfWyZYFAPddT/uyZ9G0b9aeqKyvclHXVQHec3AypyjQ9iLBY1Gp2ERHcw4+WvNhRD2WwL+kSbO1X2/u11utUevgsNs77Ow3mv2Df6/KBDPZ3UyosheyO25Yyh4kmWtfTuRLRTmoN/fq7d6o3Txstw/bB41Ws7uZKAGHbJSEPslTsQolSmu5Xn7n6yF4REZg3PN0ArkRhhudRJ5grwbHr9A0JobnVUyFSuaYsd9JJc2M5L4QmCrcZZxEii5P7kPKhju1c6F8O/mIK08EcPOmKEyB1KpKJAgqw0uqxDKmuWmmu8RhH7hKeJAlP9TDiv+0Gj8K8FbpoWyY5CYuL5Iqc+HL9K9jEHua/jEIISne8gAuf5Y6oNsX4laKO7jzDhwHldaQYxf4WKfTjmY8CISaoicN5yH34oHiwcJIAzcu5VTpyQQNd4t5eqdmtRl4bvYIEkjZbrnsq2ZDfatcYNluIxhXYbYoV97ey03Io4gvVrx1pyaXxn1DASlnNG9pYTYrJDGPpiLePI+WuDJL5YXMX5ZHnxXgM5SPhkmzqh3w0mK1GWdACjIY+D5AEfKWAqB4ma5FRGITUYkfxsCtYMeQT7xYRwviGQPpcRKLF3JMp7OxgPGpzpSEcsbhTCtxlszHUNGKPD+muHY9xhkMrrawVmWRSiLY8lDi/jMPkjVVvsWhm+nca7XrvV6v3mq32shWcTT+0IekJOPFupamBZNuUipAlRMjNrBeDNwe8wR1Uc5AxyIGnyNvWwa7gYQqChwKOYvJNJFxl6p/pyyWsieBXhnILxvnEFej1+TnCnokJgK6Hk/4bLxIQyyX5Kk8UoFBCqH5m8S1WjucM3cGu9KsJ1NUFcDdLIKLvPKp1XF6u354FsnaaUWS/B/jBvS8VeJn8AwQxccJdaxPArXh2fDypxN0vIuT9ydHI3c5uro4o8uTf50PL+jq/OTseHj2I0KVwdnRySneRNZltJbT+za0BrZ6WNbsppgCBoXYXSP+KXTB7XjMlADHjzXkOef3Fu+v71s5Tl/xrIELMQuhqxYn3ad4cV/RatZb/VGrc9jtY4vTOehV9BWYT7G3AHXvZtKbLfUXuRAVEoJrLCdEqWIxpcYtkxBuddrVMU4lMTe6VE/3Gq1+hQDIo9J9v8u2w8RC8G9rgddzlrNCtlth61zlEnoHQvHM9QYrvJzHr+OZyITZ8VVemfOCgQx3GBrHmtKSScabskmnNEqszgPBDYQ6cWKTSM+d9kGg79xemK30VwYcauOiQRt1FMZmppPAxyiGqztl9+xWrPyeK5EpaZWvqvRPVvZ1fXBzh8DlHi6X23dSBH6rhHXScXmSe04WcB8RPC/MKQ5LpXG2KQlz6ZyFkMbEibGB9VbS8alLxqlKppFfMo8rXEzH1GnLuPJ3wVfJLqkFCjJeQ03Afc/UWOXZqxK456YUlcvWLlp6pQQB8yjS0TpmyHd/c3mXCgikJXJm3PAxofAIcdNfSkP4QNT6jdVN74FixBO1sNJYKpq2s33mJ8h4KesWtSy08494v1u1U3wUSNwaP0EGrM7S3RsmS9uWbKz9BZOY5qEaS7/x/baTfVqHI+2vEVnvpBL1acQlSkg2gSLnC4b1XeIGE5vrCPfAkGS6+jSunL/AEo0W+4H7oK/V78gpg+aLuPcFaK2zYXClJMxn6RRodyjpPsFW7As+3mv2293JXpfz9kG3td8b9ye802n2e/0+bUgCWuVTUeV5ZdZu64cF2oMV+S8YBNCIcVmfmH8t4y3lEqSxZlmwYzM1nbwsFvfxDmC+H47OWXefBVxNE7rPp0tGUPWry6oKaAl/jORUVkLyFM0en7wbXJ2OCMH+8+rkcpQh1JX4kcpHt9SEU6B+kMROAQpGKmDCb7C3jupbUIgrUxwo7V9mYTCWfTHhSRDDDMe9YkaRdF4d01CiuLmP2WvZEI0dyIb0PioG+DaGouqnewFvoZ6LMK6fOku+ZTPBfRG9aTBoaiQqCa0ctQwG5i8I6fo+hq4lMEkglEEY6Op0EmOqkd5SHc9NudwEpznktLgoGBwg+fN+Al1dAsKRmsUozLzFiejWB2S2litLNyoYjUy6UDGHzA4jgwWYMcKekUHvBKnPMJeOcLkMJB6VjssyVjE1Urr7YIU5jjU983hi1oi78wDST51Uyx7cChd8BlsOm41oNdJlchkJHtImCE52o7LlSgOfTbAKbmN3G7vb2F0zdpcfXrj34+4pQZ/WKvS5UjwB+0ZUPFegT0TeozRLB9ltRbuQdMLAQaT3n0YQ2F+EwvHCvvL6jvjIlvKKN/zpetj74xQLpqW/0B2BgGRHq8EEMpHwD0nuXGIylDVVZ5UbAOaxBAdVFRCRmrWFTgCtwponCo9cMG52mK+FUa9iNuO3tC0J8toMiFyVXw+1VPEWSW6R5LYabavRX6cabZHkNna3sfvnjN2vIslMKooWh5NMMp/zaGE9zT23b79gAEtPauaHMLNXg0W0gsRYhrFqZeRQG7db49Zk3xNdn3f9vU5/0vb22ry339pvjbvt/Vqx1l/ncZwFWTmmCutt19G+thPRLeC4RIFzmVhrv7z9l9ALZUxrmHoy3Aw2B5Pe5Nixu4odz3QMugFhwI7RE9uLVxen9oW1JY92s4fRMGjJdHbvEyElbZqKe2m+45nWLXTcQsdt+dmWny103ELHbexuY/f/DR27z0HH7gbQscvO0tfIvyd09AF30PtsWBTQIf3oKhIhqAJXPDuTkh8EzYBeCUW2+6socqQ1+8DVIgVLprQTqXJzYXqDsXMcG6VjYQBnU0iRikHWkoBu0avw7BRgUjyvFsi5pDhGhYButKgPJjFoZWMm9beMi1RekICElBQCjXuvGnxMgjuJCcI/oED7oFNI1N9xj9Ot1jftB7ML1PgUNWYn954QGPPZ/m+v6pTAEISPMF1c2rV+4riA3TPnCtoIcR/a9JVB0C1U30L1bbnflvu/RrnfQvVt7G5j988ZuxtAdYeGnobqMGBtqA5jG02WYal36Fy/OWKnUHESkHsz7dkTpTkGJ1wBroQChZo2WumHEA5ru3jUtE6pZvdB+o81PHCNkNBKk0QBDJrFcWgOd3cfYJFgcR4bPJSN9Eswpe/wk5bd205FysETpja8IGn5iT2ZjD/8YJk0yLSRRO+1qY4YWEOTMuinYHA6WvBV+ulx8wW0H8yS2cFPZp0n0W38gALaCPdxUYM8Z0VH0O0qCh6f0+fnztf0sESe0KPKfF/lBeMZSLmkXs0eojYCVps+44P1wuP5RzZHDRJc4Oub4phLxORWwpWReZ3BtwGrH4l8xGFt9oPgER7mpwMyr99/Gr1hU0SilAkSgyBYuF/vYOfgRpTpBulhEZxExSfSydR+3zIoHcfByGKTAIzCflGXQrDr9DPFMygBF5Czyew4SVCawFk3r9PV88WtCLA6NnJro3NKX+2CFXd5ad4bqoTUMkhlv5GBu41fVN19wEaHznGMU5E6QHYdpnrxgl4vFeJvKbW6pVYnaubNkhTWtNeePd7tQXgjCR4YstaLmVt69QI97K/gDlJdlgEt4eQoH6Ly0lV7sRwlenWkV5bjF/WJvogqT2M2q6VflQyZN9PaiL8zhq6DoXI9TSDSXiwWfYZVp4iot5sFkeqWZV3WATSSfKcQGMo6Ex9j0SbMou32CYXtr7SykBd+xQ8k2K8lnen2NdRWHOlrz7xYZmRYR4Z1myeMk9+WLnQsiG3UgfKAdYCjfP0pEzhBC3nR0qrM/ER+l+Zg+fBAVKJiwkP7x2GeBN0Vowc4OhsDaRoxd3asDP5mjhbWr5Kx0t2CZQuuyhtoKJtLdrPyZu88sZT+0fRFjQf5pspHFSy+d5Z+IpP8cfLu75Txtpnmr5hpHApGdyO2rl0oOrlFdKtbfLgHPRPwLzylSCW4Dc0MtWeEYYpkwoDH9otOiGlvJgVtDoSCx4gOd9Cv9JziECAxBj+0gERoSl8fRyAwh3ZOBkCvwT5B96U8MDF2XngoF6h+1q4FuwQrn+MiseN04QBAzeeJwl9oACGSOX5L/Nzq+tJ4iU1C0IgpkWqmCcZls9KIRLdBUzSoB4nm5uMEd5GhQS0s4jO8YA2N20IGQ+afYtZyRS6E/RUeHFeG6M/RBs+pz0QQYu8HGRTAlChw+DAcrVAEYsq9t9DRdNdNMrs4Fj//B+WtM3Qa0PHhLeyioFEt0D1yX2cDQMx++m7ZmR7yTfPf6DfwXLVAmL8b4s4VCp/Y1sS2gNe1vAWECYeSfspphl0iPHt4wI0NbIge8TbQxa75+ibvd6jvANPjNfSXEwjs5V/KK6r9+sL9pt4bejVT/cNylVKnu3JqkTfkNbj8IrCPB7HpO0+70UJC2Qd2K6YwZeVlBXZIWXt8/vES1vzxf7I7CyI=
|
|
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 'Complete a Work Item' (complete-work-item)"
|
|
---
|
|
|
|
import ApiTabs from "@theme/ApiTabs";
|
|
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
|
import MimeTabs from "@theme/MimeTabs";
|
|
import ParamsItem from "@theme/ParamsItem";
|
|
import ResponseSamples from "@theme/ResponseSamples";
|
|
import SchemaItem from "@theme/SchemaItem";
|
|
import SchemaTabs from "@theme/SchemaTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Complete a Work Item</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/work-items/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API completes a work item. Either an admin, or the owning/current user must make this request.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the work item","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
A WorkItems 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> |