mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
87 lines
37 KiB
Plaintext
87 lines
37 KiB
Plaintext
---
|
|
id: list-non-employee-approval
|
|
sidebar_label: Get List of Non-Employee Approval Requests
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztHGlz4kb2r3QpH5KhLAzY+KBqa4vB2EvCGBbweGc9LqeRGuhESIpaGg/r8n/f9163Dg5jx5nNZhK+2KKP1+8+Wt16sIJQRDyWgd9xrYblSRVfBn57HnrBQohmGEbBJ+5Ze5YSThLJeGE1bh6sKyWiVuDH4nPcTOIZtFnS9Ru+8OaNSHDXun283bNiPlXYBQDtFCLryolwFo4n2Dvu86mYCz+2YLArlBPJEDEBPEYzqdhUxIpxhjixYMJ8ACNSMNxgxiLxSyJUrMqAY8gjPhexiBRhKRES9EYL6BOfOcwV0MKdasWtVbh9clgVdlUcu/ZJ9eTQPqi5NVGrOZXq8SlM8AEUjDbwhWtPggj54MzEnFuNBytehDhAxZH0p9bjOgmCSReoA6YxmMvuZ8GcxdBqQLJ7rticu6LMSnNRYtJ3pcNjoWgQcDuCySwBViNtOElGAoQ04Z4Sj3sr9Bl0PTmXsbWKyzv+mfnJfCwiZGQkVOIBa+MAHuMk8ssf/SHw9Ob9AWv2O2wYc9/lkctagecJB2Gwfsba2+9mcRyqxv6+Kz4JD/WnrLj0wkD6cdkJ5vugCvs8lPvKwLGdDI6di+gNMWUeRMAmHx7npIUbSC3IrlavbJAArCumAoWjweimgxo0zKUv58ncasC8Of+snwmKKyYcuEC/Hp/iZjCZKLHOzh41A9rAQZTVJPE8w1UGHWV2pRLueQumQuHIiRQuu5fxjJVIOiVkfMin0gdhw/woSKYzoxgkmK9GHL9BGBn7n2a+EyT+Ou87E1aKowTtBSxIAuPDIEw8zUrBSv+yR0HMPbuFs0vI0jDwlWAzcEug/iQHHLjBHGYcIAaJ57KxMJYBkpOTTG7AP1bSOlFi9wJZNfWBYy5IDGQmfSczbnAJ4LpiRIURIczhPpvxT+C6GMiImIPj5TzkTryH1IDLiwRIDFyiCwv7QYyaogSuWiIgfyPKS4gTYQsOMBGaCzga0AZ3YbD5KjQI6dmgROMg8AT3rYKeaK+3pisFt24iAhAbJ4qJX9hHq9++POtcXny0cq2aSI8CxK/w5Oc0JdOTRKFwUYdSfjC18GNwsXraGJXG/52Z/42mCzCzDZ5vUAvO01ZULpWEYRBBKCNBkeMCUME9doOT8lxFGq4zgiBSDYRQKi0ztlRqsJL4pWRtEYUDOQAskzNd4bJbmV5wF2gB3FYCiUMoa/IYArQ/uDSQ4FVZDHXbyyTRQJPXbNwDm3IpipSA67doTtqnKWRjrVLBf8sc6pqUKcuSZCzmlCI5mLWBW4Up0OlhwgFT9n9SOO9hXTw8ijgKlwDQLM/rTSi9MiOC8U9AP2ZfEfIrlhov6W4V8tVV52zNty8liku4Qya1pGE1pyoOTk7GkL7V6/bhGLI5Pq479snp8aRaqxxW66cOKo4GAuFojUUDMQEHjh7YBHGuVOBIZDjrmLQNltxOpO5dJ1P4GOZurGar1bu6HN21eoNBu9scdXqX8Hx53rmAQdDZHg7v+oPeeafbzhsG7X9etYeju2Yfut43u7oH4eBTv9/ttAgS/Go13/WbnYvi4x0AG7UH2NIejDrnhcHdq6Hp6V1etluj3uBu2PpH+10TmtqXo86o237XplUueu/bg8vmZat9dzHoXfWhqXNGQz4UHguoZ00GeWjqds7brQ+tbvtuOGqOcFC/ORxe9wZnd/0e0ICQBj2aPbiif8NeoWvYuxq0sHXUvNB/74CS9kVv8IF+Dn+AtYZXXVxq0O73BqP8NwJ63+l1U8pTMTRbo857TQPg8YMmba32aPoM5WfKIjQjVA8UscIfZ6Ne0YAxoQD/gkNStbkM7jECRhz0IXEgjRDlJeUtsBKGU9NZHIxQh0BlNxvOShKU1hUrZlGvHp1UqnX3oDY5Oa04vFo/qdac0+pJ5eSgDtWNBQE0WzMFklnCNZDSIX/LHUo3Lsl7P4fMIK2Q8nLHzGfk/osIQnUTl01vbp9pbNlqSmQN7TMS9/egvfRoAjw8XfZQAZpnH8gWQHO7XRixJtw2gIPYEYIPRVxN6FgqLdPyLHNASiOXc665jHWBjl7kamdjyNBZ5hrLUgAsoPEFDlUf9yydAsbPc94MzD09wIL5abjY6oBd8HR2LEk+y1CvZ8Jfq1M9UOYsDi2rc61SPbUrJ3btYFQ9adRrjfppuXpU+zeikmYCXxATA3IbDoeVxkG9fHyMOBQUfsPGRgdiy1uuBGUz2329n882Gl+g6n8VBFPCJdD7uJdtRkTPL70LTbvQ9KcLTQWAGR4FlBE/ywA9OqoeHY3r40qlCk/HzkFNTA6q/Ogor0quoW6WfM6GUNzPYP3NrsIYexfSUBxz+6w/wVEI63BTZt7yJHrsdhRB4m+zQWGXoejoxoG7wEJB+gBUuq/J3J/wC66IoaBpBe4LIvu59IU9jbhEDAWh7MBEhrRKF4MnVfsaZKqNNG5Zq4AT5Sp7y11mmMlahhhkecSdnwFW5wXKdeVLmM/SKaBjWQG1YVlxLPj4qHJaO5wcHXJeOzmsHtfHpxN+cFA5rZ+eUqwUSvFp0WVmJc/y0hfCh0LaYV7ggET+AwyBOAS8JwRo8WKVtF0GBOMF/MctZD02I9Pgy3DrfY9x9rbVZ4fHEJ79aULtfLrCBN++GqLOJ57Hx+meC1CuAfciOZX+tkBx1j5vpr7MOFCEtck3mR3sgLbVZuBq4pwADN1KYKkMsZuVDNQSEMR9VRwo9S+1UFj3mf0fmGFW3zCjCJpNopVddke/p2DfybIo77ExtkH4dWZsDIHfZYH2kKWm44gwtruGkyWzY/imzJquK5FIyNdoww137Re42cZdV+8u6E1gdKfkdIMkxv046ax415yVy9LIXUq3KBQ0DsD8eT1pgicH5IjMohVm2mJQTN8wuIZzy9iNVhIt2kZxgAraynaCKAIOszHQJmPFjDui3QxwPH46LvNYRXdK7u6dRgbiCfU5PFEvsLu+B+7HJtKyjk/CGB+9w9DeiKSRisl4JFPZ02QzKhNXavh6v2Vnuzvb3dnuC213tXNg9iNNL6U+1fXU58rnCfA3ouC5lvpEpD1+wNJBOsXVgtyDQjlNkb6/HoFh/wyVIYwXn0N8sfAF8yMdyteQb2byMNvK6dZBGvpzWSCCxEdNwQQ8kXAbhHeOsU4SiVUH66udB9FYgoL6G1JEfCHMFkHCOLAsSnyfXjWpPeYGQvnfxuYlE1iEUtoD4qq+a+tN7F0mucskd9FoF43+NNFol0nubHdnu1+n7W7NJDOsyFpMnqSS+ZxHC7MXqvvp/QeDAflpn8zkSFSr2QoCY1mOZS1nDta4Vh1XJ8eOOHT5oXt0cDqpOUc1Xj+uHlfHh7Vjqxjrb3I7zoxs2aYK8tZyJBZDEvcJ8rjEB+VScRC4y9t/CR5wmKBbQ9eT5c3Ac2DpbZY71k7Xc8dREODRykWaIamlHNLPeYQ+DcbOcWx6ihIHcDYFv+jjKSUJeKEqybkAKHgcg9FRKDRepALgRgu7OcHjMeaAlUzf2JhVpO94CWBInsALMGsOQLEknlaaYM4HECiDnYJ3/oLZqRHRb8rk2QAp7iLFrP3ZEQINPcvc65v2dzuAfIQ+YqgF/MRGr652uA8KAAWB9llZ3rnLz3f5+S7G72L8nyPG7/Lzne3ubPfrtN1fkZ+bbOjp/BwGvDg/h7HlCstyqXM6Av57p+lkKgYDUm8WOHQrx81zcMorQJUQoSndFAk53oey9otHyuz0eBidgKbEUOOURB6MTc8cP4CoQESPZR7KcnqWzg/u6eDxGPizwfXgGQFtZjiAjjjrBcrE3Eii/mpnR8A1q82Zeis727wVMh6XQBkuggTcG4HZw0MnRpeoGVAMoZD4VtHoMunOGn1A11XkPf52WjSgJ2jZxL6tq8F4BpiukGgOe6T33oaYdevV126/5ZEEK7Xa2mI9HFZjbwWPoCTQLy+++/569IZNMdckW9fn2IXE4gCspQ8qQr6smW7k4yQKL/l9oebSqxK0HTbxgGBmrn8UT/0MwCsTS3GSIEeAs15+4p0vzXvissdH32ZnMtIH4hWNMSTqCzE3YUoXL9D1WiS+SaHZGppN0PC0/RIWmrU3jj5644ABIwiwRuLWqxfX8OwCPKygoAWhruKAnDB4LL/gclKpvRqPJXg2wlvG46N/PZMQSJenMe23mJrRjacOc2ZBoMTfGUPVQTO4mSZgRa9G6x4Xtcki7FqlgJKtl7SlDWkh4dcFw/C1MvExhmXKSgJI2HxXm+SPJFmw+R/pisqPSzRT8w1ETxzpBs6vuMaxgjMuaOOCtvYByuCvgxMqFtg20kB+QCtAK5c/eQKDaMHvaVgbvTqB36c5GBocQJWgqLChfzRyB2eeGHXg6GwMuGHMqrNXfvCbGVgYoZaYle4HrHJwHV8vgMC4wjeNb7YfhcHyj0YvUtzMt016vrf40l76CU/yx/G7/yePt/M0f0ZPY/JcVDdaduWMLir5W5OvrW/jKbqWC3+hl2yVUmooWPKbuEVAocdj1GqyamcmBW0AhILHmPvtoWYFc7JESKjR/KHMI0BTuhUQAcocSjbpATzaok5X5mQwOrFEueJvlVAVgms5MygoRZldQ03mOyAWrMfwkAX0/RSYwmwIkumjYNlZKmxIuubzxDdX/JM546BSz2iEK5WTaMcF5ZkvUl4ElPpls1IrRlVDEspUmURz1Zvg3jKUrQXBP7MWyF2ZjWVgPd1m0Eegc0IGwiPNxHHLaftzsEHb7JnwQqwIwetCAiYKK7zrjNYgAjBfAV1QeQfRdN9MUvs4FoBgeaTV56BcLVdsKhegPQxUDDVsAfiFiFl613Hp3kR2wSZ9CbKqmQ/5LvsrPzZhgglWAfshbl0hiomuSnQReGM9UQRCWTEL8P7IjfXwgPsbWBU9YrO+S4ulIXAXVT6/M70F/S/6oYmNdP0ssKRf/RaGKd4tuj3zcoS/rq9RbOFH+rGNV/Lhr/UZiS18zD6z8UpG7r4J8fV9E2KLOqQf/nilNuw+17Dpcw1bOZ5/FOOVPP8rf5JhK2fzL1/knL3NdzMh1N/CWO2IKO7rafo1R2HW2kEAhJJtPV+0McniT5S55gGXenz8LzQlXdE=
|
|
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 'Get List of Non-Employee Approval Requests' (list-non-employee-approval)"
|
|
---
|
|
|
|
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"}>Get List of Non-Employee Approval Requests</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/non-employee-approvals"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This gets a list of non-employee approval requests.
|
|
|
|
## 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","example":"ac10d20a-841e-1e7d-8184-32d2e22c0179","name":"requested-for","schema":{"type":"string"},"description":"The identity for whom the request was made. *me* indicates the current user.","required":false}}></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":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","example":"approvalStatus eq \"PENDING\"","name":"filters","schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**approvalStatus**: *eq*"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","example":"created","name":"sorters","schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **created, modified**"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of approval items.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approver</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the associated Identity
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name","example":"test.account"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"ApprovalStatus"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `PENDING`, `NOT_READY`, `CANCELLED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","title":"ApprovalStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalOrder"} required={false} schemaName={"number"} qualifierMessage={undefined} schema={{"type":"number","description":"Approval order","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"comment of approver"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nonEmployeeRequest</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee request id."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>requester</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"DtoType"} qualifierMessage={"**Possible values:** [`ACCOUNT_CORRELATION_CONFIG`, `ACCESS_PROFILE`, `ACCESS_REQUEST_APPROVAL`, `ACCOUNT`, `APPLICATION`, `CAMPAIGN`, `CAMPAIGN_FILTER`, `CERTIFICATION`, `CLUSTER`, `CONNECTOR_SCHEMA`, `ENTITLEMENT`, `GOVERNANCE_GROUP`, `IDENTITY`, `IDENTITY_PROFILE`, `IDENTITY_REQUEST`, `LIFECYCLE_STATE`, `PASSWORD_POLICY`, `ROLE`, `RULE`, `SOD_POLICY`, `SOURCE`, `TAG`, `TAG_CATEGORY`, `TASK_RESULT`, `REPORT_RESULT`, `SOD_VIOLATION`, `ACCOUNT_ACTIVITY`, `WORKGROUP`]"} schema={{"type":"string","enum":["ACCOUNT_CORRELATION_CONFIG","ACCESS_PROFILE","ACCESS_REQUEST_APPROVAL","ACCOUNT","APPLICATION","CAMPAIGN","CAMPAIGN_FILTER","CERTIFICATION","CLUSTER","CONNECTOR_SCHEMA","ENTITLEMENT","GOVERNANCE_GROUP","IDENTITY","IDENTITY_PROFILE","IDENTITY_REQUEST","LIFECYCLE_STATE","PASSWORD_POLICY","ROLE","RULE","SOD_POLICY","SOURCE","TAG","TAG_CATEGORY","TASK_RESULT","REPORT_RESULT","SOD_VIOLATION","ACCOUNT_ACTIVITY","WORKGROUP"],"description":"An enumeration of the types of DTOs supported within the IdentityNow infrastructure.","example":"IDENTITY","title":"DtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem></div></details></SchemaItem></div></details></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\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": 1,\n \"comment\": \"string\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\",\n \"nonEmployeeRequest\": {\n \"id\": \"string\",\n \"requester\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c9180866166b5b0016167c32ef31a66\",\n \"name\": \"William Smith\"\n }\n }\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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"}><Markdown> An example of a 500 response object</Markdown><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> |