mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
67 lines
18 KiB
Plaintext
67 lines
18 KiB
Plaintext
---
|
|
id: get-pending-task-headers
|
|
sidebar_label: Retrieve headers only for pending task list.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztWm1vG7kR/ivE9sMlglayZSeuDRSF4yQ9H5KL65emgGMg1C4lMdkl95bcOKqh/95nhtS7nLhJgV6uug85a5cznNeHM7O8S7wcuuToOrmU7qN4LY0cqlIZn9y0k1y5rNaV19YkR8m58rVWn5QYKZmr2omBrYUUhXZe2IEg+gsvfRNeVMrk2gyFx2PXSdqJrVQtidVpDmZD5c/CCqL7OXDEqkrWslSefhxd3yWaNv6tUfUY7wze4KcdDJzyyap4b/ix0MZb4UdKDJqiELVyTeEFXnTElWtkUYyFq1SmB1rl4lb7kWgVutS+JUBWyaE20ivQ17YZjphPYOE678yFUuL6H3vi+OxUQFOTyzoXJ7YoVEYyiLOZ7DePRt5X7qjbzWGwglTvOKmLykK8TmbLrs5NV1a66yKfNJvxSec2eMymLG2toBf+LNmAZM1a/dboWsGUA1k41U7UZ1lWBeyz005cNlKlTI7uEj+uyGTYVQ1VDbrAJDza6+FBqY0um5LpcjWQ0BV/TybtzcZnY63Z/rX8LExT9lVNkRAtRhatlW9q88PYrvfkO6xXys/hb+YysyV+3WvNzDZm3ZqnA9HydaNaQnvEKMK4slVThMBUovXP9NJ6WaQnRN0ic1fWuGlehqimhRs8MpLgaJsiF30VnYM80INZFsCiohUyrCVuFRlvaGDDHD6EF7XJiA5qOE/ZLeFkiCJYEZFJI0YSCCGR/jUbi9brspKZb5M22oEaPgTC5NjYWE9R4hTt2mImf2HNWyQTS/tJFo0KVqDVELtxU2l+iJgifTYEVd/aQkmTLEQKU04mN8QtuNQRQW9nh/63Csa0InfB24uI/OpBeDxpg+/+Ot9fLXyJeIc3U+iY6wxh5yIQstvFrXTCNVmmnAPGin7j6TWZxMFFM3L4dSnGzBRNWTOWYH+TZieFJvIXdQ2pU3G+EKSLUvRtPqYdtUGE6Jx8EHcmlrKqChIdLLsfHPG9W3eB7X+Ah+nQqSkivA72zpVHaJzYXC2sdTj7zHAtVV9qo9JhLTVJqFjkDIQCHD9ptjcHS2BJXiEVeB0JPIsRskRnVzyTOfQN+p1EZWAmX8vsI3jRwfk1ga6MBr2Ykgids/fv2VYdKNl/unPY2x883Zey9+f93YMn/cOB3NvbOXxyeEi7l/AzagK3sLesazle2/pvyqhaZ6KwGTzyLxikVhK2ZwF4c5Bor0r3dR8wjwfY/xJ6hbUzNaO8wqvPwBwpnp2cif0DUUgzbPi5HK4YwaRXF4TJKBhkf5qy0DwwflProTabRFGG0P46ef7i5fHVq0s8OX/x96sXF/iLeK0VUMdmmlGWUXlkb1niqADnlSLQAb6JVuTagkLSuMWFOvxyYwdjiggfoIi7b6BYZC0GtS2XUonz5rMXj3RHddrIWjwDsmUj0ZfAWmFD6raOkfOVT19FS7Yi7DzuiOM816QkTgLGawf6MaW/zPN57g8apLJixLIADcC5ztSyL+amXPYGkkB7XvFq0SmUHJD863FynHkUfxwTS1k4i5Yo4hTx8mi5ZekuV1FwbDxONlBQXZnZGmebZ0DUOGynQKjJ9jgJp+tmiDWZzNViuHsdhHnuLb/LZOMekHdnBeAnZdVmLz6pmHxchQU0Ym9M3RQRKdbKTBxXzdw1TXyBWrnIt7m7zd1t7j4wd1dfnseqJ77l0mdvvfR5aeu+htXNhroHUFCLsW2EhBvqxhguv11b5FY585OPhTeXZSGtITtqvjTUuNvyaFsebSF2C7F/GIjdlkfb3N3m7o+Zu18sj2ZScbbEOsk1ZSnrcYi0+J60lQIL5hPQWcqxq1arFWImZjVWslw5JP3ebn93cJCp/Vzu50/3Dge97GlPPjnYPdjt7/cOksWz/nqex7MkW86pBX8HP7KJUcR9Qh3XGBrXeWvz5ZkWzFurAcEaQY9sEE01SgXYHCa9mYT/2olTWVNrP2Y5rsDzJIT5MQgoa3VujmjOl5azzzlHwLs8uaHhYqnAljSmGOdPLkSVdJnC8cSwG6eFKU8LE9qR5A6KN3VBxHGgeodAQABMOrLSHeAjYsGPjb3lqWof1t8AbDS2C0lMC3h+GzbosOtqTdkRoJSZB0fGKWkyG9x+kTNN2ClCUDIDPJlNWyCTYqTyY4hYSTP+yfHqDkfmmn7Q66ouJt+vS2B0jy6bzPfF3bBeQNIVFUmFm3mAXFBNH3ZfC5P5OUVx1lv/nkbLeuKZQsMB9vYj2pJHv7y9fCyGVMkykjSOimilaf6LXDxDiDBSHk/bECLiw2v+Pe04RjV3H4IyUwwKKCziQP80GuFXHCHnwHw2KREphhmievg4Xy7R3TO+f2dS8VzXYdofpuVRxfCJ47qa6iUX9PpWIf405ZYGbilzc49XpAimvc7CNDyrFZtFFo6t9c2bB37pAj/qz/CEuK7KQJaIcsglr2VTr32zHEv8UuK3LMc783akcUwvk4mAXcKN+BvWqchG1jr1VyEodCgNrocNsuibxbqlTVPOiLS3syBSGrZMdQp0ZvleITFMCCbZp0Ofax6LctDkISXfs2eR8+/5s9r7JZ358TXOZlqZ2+w/+Ea1IjNtmNKGacAAF+UPRx8FFn25hA6MAyEATub+ZySIgi7gXuC1EdWZfZdp6GjIICpzcdVR+HE0B7j4l+AXtHq2BjBMNftsYIHfIvKiM27JWNNpw6oF1+UtLE7fFbsFeWenKZ3Ivzd9SePj+VDmjSnG/22UvgdJfj+4+z9CvC3S/BGRJlbKFG68bWw3FoP8WazX1oeEji9a4F+85VylGyDoFfz8bsUio6qQnqKaszob8R2pWlVKeqr92hRZtuRMrGpL6a/iZ/shinIwhsgSDaEuwK8jLuc7S06YUFiSX+m3a7jHob2yEdpV1RFv0fGZDG6hbo9GxHj3wca27wKeOSPHiudTZ6PoKsvGYDfKy6YUEiH1lYjItcuaAFxo/oya2sJy6TejmmYxhRqp0OH2py7dm8EFqmI0xQuO/8pe8LuLY2uYnrwYb83MFTlXBUcmrVsu27/GG9GWjlRRUb8J1EUBphZ2eH16ucYRzIyDXujrbT3sRiLXpbVgQu1RCJ+9zm5nJ+V2Ac8r6zzasAXma/foLNB+7Y4G36vrrMbm3XyK/7338eK5Qg1Bt6IZGUnbhAYltITXyUJLSI3iUlOINmME3WjZ3R1NU6hLmtDjcMmJWkVYm1JgfivmXmX+v27vbbT9R0XzjdntxjjCSBLqSR9uyB/rKt4XDDG9afiNdtheovvxLtF9IRqmNyXn0XAzH68Aa26wMriOgScQhanuAtXad8+ledjPL46fJ6Hz2FR4xz9or8nk3/e2/Vc=
|
|
sidebar_class_name: "head 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 headers only for pending task list.' (get-pending-task-headers)"
|
|
---
|
|
|
|
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 headers only for pending task list.</h1>
|
|
|
|
<MethodEndpoint method={"head"} path={"/task-status/pending-tasks"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieve headers for 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 headers for List of TaskStatus for pending tasks.
|
|
|
|
</div><div></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> |