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
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-pending-tasks.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

83 lines
30 KiB
Plaintext
Raw Blame History

---
id: get-pending-tasks
sidebar_label: Retrieve a pending task list.
hide_title: true
hide_table_of_contents: true
api: eJztG21TG7n5r6jbD3fxsMYYEhpmOh0HyA29JHBgmk45pifvyrYuu9KetBviMv7vfZ5H2jevDYTLTC4tX8BeSc/7u7W3Qc5nNji4CsbcfmBvueIzkQqVB9dbQSxsZGSWS62Cg+Bc5EaKj4JxlkibMz1leOYi53lh2VQblgkVSzVjOTy2/WAr0JkwHI+fxABgJvIztwPPWVjPuOGpyIVBCm4DiWh+K4RZwJqCFfiqp1Mr8mCVmFN6zKTKNcvngk2LJGFG2CLJGSz02aUteJIsmM1EJKdSxOxG5nPWS2Qq8x6DYxmfScVzAeeNLmZzguNA2P7P6kIIdvWPXTY6O2HAo4q5idmhThIRIQ3srKL9+vt5nmf2YHs7BvEkyHTfcplkGsjrRzrdlrHa5pncth5OGFVwwloGz0iIqTYC+IKPKYkO5WjEb4U0AoQ45YkVW4H4xNMsAfkMtgIbzUXKg4PbIF9kKDLAKmbCwDkHxD3aHcKDVCqZFimdi8WUA6/webncWi98ElZH9m/5J6aKdCIM2oCXGErUiLww6puR3fD575Beyj+5zwSlkiV82yjNSBeqK82TKevlphA9JnOwUTDjTGdF4gxTsN4/w7HOeRIe4ukeijvTygo2FzwGDZBV48Y1GplzgKiLJGYT4ZUDfiCnlReARFnPeViP3QgU3kyBDGPQIWhRqgjPARs2R7/moGQghREjLOKKzTnFA9AaCQv3yzTjUb6F3EgLp0GHEE9iQKx0jlZiBWLtEZC/Euc9pImo/ciTQjgp4G4gu7AlNd+ETSE/a4xqonUiuAoalkInl8trhOZUavHAcDDAf6uhF3fE1mn74fE30mDMYHMAkGdZIiPiYPtXi1Bvu2RyYzgarMxFartkHIkcxGjJbKLCGADNrEMPxPAy1kZEQEtMV4GM4QGh2QoKJcGm3qFXtL2BMgJA9Us8h4wzKXKBuSIyAnwCoaQ6pogOHxNeKGCi8dEQ26gMt9l/BuhOUHheWAtZjhKQ0TMQP30UJgLUh/4skY8eYzETevnoya9gJe4c7M+l0xnw1pHVxcKCEMOZUJgCwfod0+zkCGWFDotCgg/gJA01GpEBPUCHDSqsFqSgZkHDygDjznB373mwLDetoh/DU0L0+UgURrWr4KfL0fn4X/Dgp7PTQ/x3eXx5fPTv8ejiR5RITYvfuGzptUMQPv0SnL+SMzqF+FoYusZaffsSeEfsXFBB0SSgYa13Muz2fQkyzhykkoDK6Lv2J8xHCeEYAq74JKLCp5Pfg9veCJEh1tIVO0gPcQEFHmP6ejS7VeJFMGEuKRjUdAwHw0E42A93dsbDnYPh7sHO8/5gMCATrGJDh7Y3HGKmW46+MpFV1FpDJK58PcrqyNnVbRVIvzp5dTC/i8o6Mz3S8H0gvCiiyKWI99wot3ZsjMZMMxYmpSYipi9p5hZa8bE8v2xkng7db/0K49bqSFLGqEq7B9N+T/5unPb4VpL0B4GnEx3xRP5HxGPxKa+zdqNZuzcj3pOUgKe0ImCT3E/evT5FoY/O36HEz89Pz9uCpQ3LVXq7PlUuY42UbsRfcdIUCIEWdc2ABLQ59Ts2KZRVEO5ILYoJNBuopsFcI6qs4j817GUz9LyhobWwj9cBxqpB5rReCac0CFhDK+hg/FEsHqC6Ci9HIMt2h7+JiXoPVbHYgBlFIRpJ474y3GTibfUtG0Rc3ZadF7UVwfK6yXntDBXry7rmW1OC44JrUIBOo9Mv7pq+RWOxK7NXTFGt1MRUddzriGptbXIkbZbwBVONGgUpcEweVfg36zfhE5GgtNv0dDCNyuX1OLBFnFIkvavWBUnKfEENcLCqwjbJy2Wra9hMzufnhUrAPI6lM86zhqhd41dRfbtCNg1Z6najm7d8O1Xu+BK1Iuw2mJmW3eZmM363Ed2yTrafTUw9Q6mo2RkM1nsf6GyJK8PB3poiWjPfw7IQAkOMpZuwflJHcwl2A7HNuhQ7LRIGysVl7NktU/VxqINbQxBVjvuo9e6jkPbWtd6HicTjLo6G7LwxRWlSMdHxAjFKBRFCxo9pvjd4sIsGhzoWjb2VttvEvpZKhDPDJVLockoEB9GqPkoaDdA0w4EstUr7+i3LAUn0d9grHgO/jr9Dzwyq0PDoA8A6ie8n6NI1veURJikJb0Ir9gWfvBi8HO5NX+xxPvzL3s7+88nLKd/dHbx8/vLlagm1ElrbqH/AzltGrKoOQFccZE8ECF+/bcgim5P83eyO52XCr9hMG5l6i3H26vCM7e2zhKtZQc/5bEUIKry8wKFhkUCQLWdKZZkjTo2cSbWOlLJuOjp+Pbp8M4Yn58fQtF/AJ4TVmedD2eE9StPYcK5viGLPAPmVwKmYiPus56H2gCGubHOjdN8sDTyYn2/BCY99zYkm6DqVlq5EfvMpZ9/Lvuhvgddi38ZzaIsm3MIB7Vy3NwKfz/LwjZdkz09En/XZqIrQZb5OIdmB+0Porn1/WoArC6qyNQQNpXPol9u6qEXZ1sZK/VQqBZ3Dl6B328koygsgjthsemFlLZ7EMuLFXnJt6sarUXABgTsCLmhOEWmI6FFOAVHmtgqEEmWfclXuqyJWMzxTuPN10VGuaS3ihX2A350lEH5CYq1a+Ci889HPBC4akTZKNfmI5H/MocN+V6Wu0vEZtPdJ/OS7T7775LsP9N3VxXNf9fhVKn12u6XPa20mEqSu1tQ9EAoMW+iCcVCDKZSi34fsFou1sOq73P8yRGWZc2ugXag4dD/CPJVHT+XRU4h9CrH/MyH2qTx68t0n3/02fffO8qiiirzF10m2SFNuFn5279bdFQjYUF/RqVzOzZ9XqhUExqoaK2hXDsFkuDPZme5HYi/me/GL3ZfTYfRiyJ/v7+zvTPaG+0Ez11/Vflw5WdunGvp2eiQRQxH3Eeq4QoFx2VzruD3TAvEaMcWwhqGHF2BNBkoFkHmfhul+cmdFVBiZL4iOS4B56Mx8BAfc1Q91gKPDMK1uFx5AvIuDa7z9kgoA668H0q9MeCjYpgPuJ7xtf68lzP21QUe247swCWwvL/zcgh2A/pd9nsl+OYFV+oZu/UxA+GvimrSln+MGul/kEPRJc0aic7hISsCdHv0tnqC6WHQn5HLQDhUzxE4Cs8XAkbyh0mOct3K1+M7S7j4ZZoc/4OvSJMvfz4sDtIGXdeK7ExvsZ0DpCovIwnVtHxdY0jvsHSup0xSa2bCD7BS3DdkrAf0GgNcfoCv5/u/vx89Y44aNxRpaSBz/giuegYlQoByVXQgeotxV3/cceaN2NwLQMdk0AYaZv3B24oXwDjLIOYR8EikeEhRl8NTDr5vx1rkN18t+ViE7ksbdRnO/iHkW3RW8q6zkizf4eiwRfy6hhQ5aSNDssxUqnGivIjcMj4wgsfDEkrQejdzBCxvwsD2DJwh1lQaUhKeDt7QWlVp7NB0teCHCa9Pxs3o/l5Cl28eYC13MzumO5QmL5lpb8TfG0HTQDa5mBXjRo8m6QaQheUQ4HDRICh3KUIYQnIm+N+AYyhkTn2DOp5JHQzWoYueSv5Bmwed/oft7v7R4psdXkJpxZ6yjz7hDuUIzIgwRYehigPX0+x81gVi8AgI8UBxwBnBY658igSe0EfccrLVRncBv0xlMDRGQSlBsduC+HNQBzn9itIC7qz0QhrFkr+YV8J15WPSbYlNY5bBhVYJdehMNyXdFbo7eKpliQv6j8Yscj+qZzKlKFl86Sm+IJH+cuPuVIt5TpPlfjDS+UEZzI7S+22ga+Stfr3VnhJbuTsBfWCVfpQsy0A3VF8SagLKE53TRCb06mtMbO0ZkgudY+22hZemUPDEzGt1f+GvlM7rVaYBkDv2gTABen41rzJwcxhWWqFf8bgtqcRBXNIduVfTZe2j4VARqwWYPJ8Sw9qv2Xd8FaOYMFcuOSmVD0ZWmhQJs6JdFyjiY1D0WEUsbFS5wQe+nRCkLTaVfdar0YjQ1ZKFP3Y9J7enUX49tKP4eXKB366fWIPr6ak1QM3IuErJM3Ncu2++DDdYWzkVCl2sh6kIBJhoY3p6MOxABmLLAF7T12sy2/SG7jXsBCLZHznx2+zv9QUjtAt4D0TaHLqwBvPFWV/P1AXrFoL9qjLf11P4xr4P55IFV/3aGczC6NO66ENf3XQWNvg+7wVbnB73EHBjAbbe3ODHBVmiJj92bNtgPgkjRzutXMzYy8P/1Ctla2dNNv/oVOz+mCAJsPB8uyG/rfbA7BFG+7vZIOTy9yfXtvcl1hzWUr+vV1nBdz1Ag1lzDTqc6CjzukJvcNk51fttszbx+OMbQzjcU1/4Dolou/wuFvAAu
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 'Retrieve a pending task list.' (get-pending-tasks)"
---
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"}>Retrieve a pending task list.</h1>
<MethodEndpoint method={"get"} path={"/task-status/pending-tasks"}></MethodEndpoint>
Retrieve a list of TaskStatus for pending tasks.
## 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":"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":"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":"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></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
Responds with a list of TaskStatus for pending tasks.
</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"System-generated unique ID of the task this TaskStatus represents","type":"string","example":"id12345"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`QUARTZ`, `QPOC`, `QUEUED_TASK`]"} schema={{"description":"Type of task this TaskStatus represents","type":"string","enum":["QUARTZ","QPOC","QUEUED_TASK"],"example":"QUARTZ"}}></SchemaItem><SchemaItem collapsible={false} name={"uniqueName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the task this TaskStatus represents","type":"string","example":"Big Task"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the task this TaskStatus represents","type":"string","example":"A Really Big Task"}}></SchemaItem><SchemaItem collapsible={false} name={"parentName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Name of the parent of the task this TaskStatus represents","type":"string","example":"Parent Task"}}></SchemaItem><SchemaItem collapsible={false} name={"launcher"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Service to execute the task this TaskStatus represents","type":"string","example":"sweep"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Creation date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Last modification date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"launched"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Launch date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Completion date of the task this TaskStatus represents","type":"string","format":"date-time","example":"2020-07-11T21:23:15.000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completionStatus"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`Success`, `Warning`, `Error`, `Terminated`, `TempError`]"} schema={{"description":"Completion status of the task this TaskStatus represents","type":"string","enum":["Success","Warning","Error","Terminated","TempError"],"example":"Success"}}></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 className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Messages associated with the task this TaskStatus represents
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`INFO`, `WARN`, `ERROR`]"} schema={{"description":"Type of the message","type":"string","enum":["INFO","WARN","ERROR"],"example":"INFO"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>localizedText</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Localized form of the message
</div><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Message locale","type":"string","example":"An error has occurred!"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Message text","type":"string","example":"Error has occurred!"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Key of the message","type":"string","example":"akey"}}></SchemaItem><SchemaItem collapsible={false} name={"parameters"} required={true} schemaName={"object[]"} qualifierMessage={undefined} schema={{"description":"Message parameters for internationalization","type":"array","items":{"type":"object"},"example":[{"name":"value"}]}}></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"}>returns</strong><span className={"openapi-schema__name"}> object[]</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Return values from the task this TaskStatus represents
</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Display name of the TaskReturnDetails","type":"string","example":"label"}}></SchemaItem><SchemaItem collapsible={false} name={"attributeName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Attribute the TaskReturnDetails is for","type":"string","example":"identityCount"}}></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"}>attributes</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Attributes of the task this TaskStatus represents
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"description":"Attributes of the task this TaskStatus represents","type":"object","additionalProperties":true,"example":{"identityCount":0}}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"progress"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Current progress of the task this TaskStatus represents","type":"string","example":"Started"}}></SchemaItem><SchemaItem collapsible={false} name={"percentComplete"} required={true} schemaName={"integer"} qualifierMessage={undefined} schema={{"description":"Current percentage completion of the task this TaskStatus represents","type":"integer","example":100}}></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\": \"id12345\",\n \"type\": \"QUARTZ\",\n \"uniqueName\": \"Big Task\",\n \"description\": \"A Really Big Task\",\n \"parentName\": \"Parent Task\",\n \"launcher\": \"sweep\",\n \"created\": \"2020-07-11T21:23:15.000Z\",\n \"modified\": \"2020-07-11T21:23:15.000Z\",\n \"launched\": \"2020-07-11T21:23:15.000Z\",\n \"completed\": \"2020-07-11T21:23:15.000Z\",\n \"completionStatus\": \"Success\",\n \"messages\": [\n {\n \"type\": \"INFO\",\n \"localizedText\": {\n \"locale\": \"An error has occurred!\",\n \"message\": \"Error has occurred!\"\n },\n \"key\": \"akey\",\n \"parameters\": [\n {\n \"name\": \"value\"\n }\n ]\n }\n ],\n \"returns\": [\n {\n \"name\": \"label\",\n \"attributeName\": \"identityCount\"\n }\n ],\n \"attributes\": {\n \"identityCount\": 0\n },\n \"progress\": \"Started\",\n \"percentComplete\": 100\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"204"} value={"204"}><div>
No content - indicates the request was successful but there is no content to be returned in the response.
</div><div></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></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink