mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
81 lines
28 KiB
Plaintext
81 lines
28 KiB
Plaintext
---
|
|
id: get-access-request-approval-summary
|
|
sidebar_label: Get the number of access-requests-approvals
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW2tv2zgW/SuE9sO0QeTYzqsOsFi4T2TQ1+axBTYJtrRE2+zIlJeU2nqC/Pc995KS5UeStlvMdAp/mI4jkpf3fc+lqOsonyorC52b4zQ6ikaq6CeJcu5E/bdUruhPpzb/KLPTcjKRdhZtR04lpdXFLDq6uI7OnbJPclOoz0W/LMZ4FunUHEkmEVtPI5aBiIudJ3NklUyjq5ur7aiQI0fL/K4ibCuqfV2EOalyidVTYhIsno21E8qk01ybQlhVlNY4UYyVMOVkoKzIh2KKcW1G28JvrVIhTYq5H1RS0B9+s8CfEzWDLXGqlLiM8k9G2Vinl5HAFDsTU2nlRBWgPlBZ/kkMcyskJM6t/p21J7QZ5i3op57pWEOaWGYaGDMYwZ8VddJmMlYTGR1dR8VsSmOusGA8ulmVWgmdkmwkKVMQxIOXz2JMmQJmqWY0RDqGPqxyGN/mITwtVa24aqIItmHRaJqbqkQPNdRV0W5dGiHElnhz8uI//aevjl+LEvZ3IpEG/2UZlsE0n3Qxhrpnc5aOn/o916/n5WA0F0NVJFjKhBoSQLVeaAuDfhorc2kqDQrsZ/KC6KQV9dcwxjoOc5PNglAzsTVRW6S/qXTsO9qSTi/NKs8wkvosJ9OMrNNNep1H7Uf7B4+S/W4vOWh38CuRB8NeO+nsdnYxmZxKW4VgGoJ3dbO93geGNp/EqSzU1zjBcywStIjkJpXwb3LtQk+UIJpQkIYSaRA2L7OCDAKNDmDQMUSEOxT0q8xSegbVShIUqjw+fRM/gkTkABNZLMhdc/v3brvbjtu7cad31ukd7feOOp1/r5H6ih65aW6cciRYt92m/y2K8/r2eN2+LVgbjo1tE8o9piDSeJ7phGNx54Mj+teris0HRJSi1FLeK7TnLmzfmIjUokbKRuvCcCXN3JFPQCCok2nudptqbcPAlcBfvfc8s3375pWOv3rzL8ik92yO3RFn7FzLNebmhkb31nnMk0zD3OKZtYjdGNWCchhlKJ/0lnO1ptzB3v0dnSVVhdTZkzxVqxG7ErDaqHhkpSYmFXOdYKEggTW7ziS3CGMmWaVunreYd6CMVkc8lmldIJ8EYUiPVia/gdZxej9D50ZjvaiWUEmp8v2abdWhkoODdq+7NzzYk7L7aK9zuD/oDeXubru33+vR7hPYX468asLe0lo5W9n6hULO1onIctQK/buieiyhe2aAN8cSXaiJu98GTOML9E9e6+fWYgZ+BWEW5Bvx+MlbsXcoMmlGJT+XoyUlmPj8lBJ3mWVyQI8KWyKvBybeWD3SZh0rCvFC0Obps+f985dneHLy7J/nz07xi2itAJs+gYiU3DLnIEO6Zo6DAJ+kE05lHHctsRWobkEgGfBPmBhqg5s5KBO+NZQoA1gRdl+zoknaVxFfP7yrJR7giQe6pVrbqBp4hrhGlRlI1F0UVp6+RRBuWsQvgya3xBgoT9mHLdFPU01CAmVwUXVYP6PyI9OUotcTGJaIZsX4IS8Lqus6Waq/c1UuWmOeTF42jULBAc7v95N+UpRgjsVsRmHtLYHFYB/w7DW3yN1ZQ2ms0pkpZAIpAGlmUKO10LAYQDaNVBnSEZnLIfGYal6dsZo5kjPeK8/M0yLnsUSW7gvi7m2G9BOzaPXARxWCD26Qh2zE1qjMFDISBklsXhxm1eaqAl8AI2bpJnY3sbuJ3S+M3eXBkwCVwyijn84q+jk3VcsJIVbQj1W+G1rqS70ht6nZCSjp13dnCOzflKH56vOUcPt3xEe+lK8w36/t4Z8PCH7UxlqwBTHIevQSDJGJVHrEfM85ZkV5Ve2u7vY8twMNBzVrUCI3nbO8FBIqs6UxDOHdtkhz5cwvhRhL5MeAbDkD+gOHmE8cNkhygyQ31WhTjX6earRBkpvY3cTuXzN270SSNVccLQEnhWN+72lhnM8TBSaI6tBW1CHHplpGK0RM1BgrWkQO0aDbGXSGh4naS+VeerDbG3aTg67cP+wcdgZ73cOoWesv5nFcB9liTDXs7e3IKgaIo/cepYFzuSLP0wVvJfVaNaS0Rqmnxs3QOVR6VWPHbm8VO57luXhFLzBOqlPNJoY0cx1RTsPcCc2tT0D5RH2EvGgEUpXO/TsbOp6PhaXj+kxPNAcvSQG6dhb3h3Ra6QOlcrJ6F22SrASHnAmynFBzDsfSEFINCfOBAiPYEbLzd0SnwUT/F5IXJyTxS5JYPPucKEWBXiP3/XVHvMdg3lKOOPUGvuWs13c70sAB0BD4nFXjzg0+3+DzTY3f1Pifo8Zv8Pkmdjex+9eM3a/A5wEN3Y7PMeGL8TnmttqixlLPybn+cJjOoRI4YPcWeZKUlo+bKwzOuAKuFC6f8QUqukgW7dx2iWyn+lXdJuNLaYQVPZulzbB8XBRTd7Szcw3rwWo3LTnVrep2j8k/tZJ8svNxd00uoksDPu6wTVomfAbdf3scOo4W69xqcmufA3kDbwGWkhwYluDT4jvp01UgMu0sL5H1mMy2QAgEF+PHYHOK/uIXx7Nb7FIrMkK2c5vd3CfPv3bvksMTuUWOdeq7cy/MF+BySTxi/2p+h/CUgLjffeUm4by4UPPWXdnsDU3risdKWnQJ/n3Gg1/fnT0UI4KfHP6lI+SrNPULCKC3cBFOb/3qbJ8WccWxeTnyt6b6C29PKJzEMIPA4tLQ3cCL46CE18j7J0jUrFJapDg30KqrB5VlUvVRZVQSW3NNkuPp1MCN9Y5cWPeQyx/3CXSbkC7P4Gnr0sTiqaaspKmM05wgIrd94mJaySUbcn0rE3+rqMUhAJmae7jEhVftReIv5CSIaSJBt/VIW9+8uacXN+hRU4UnRHWZB9JE4GPxnVdSWe2b+VigFxO9RT4uzTu+Z7e4TPhUVt2vOxbJOM+d+ofga6UUBhejElH0zWzx5b6YIyLuthssxX7LWMdAiszfSwSG8c4kB1SpGajkwHAm9SH5ni2LmH/PVwjfL8jMjy9QUGlmmifum3mmDWPaMPY5wAX+fb0ix6KrYpCB84B3gCdz+3MmCIw2cp6ntTarM/kdXkOlIQGrTMVNj/wfR/MEF34JHqDZ9RykYALa9VtAupYaaFHRWlBWdUSwrMFVfrMctXJJb57f+oiK6uePJi9J3J+fpLwx2ex7Z+lbMsmPk3f/pIy3yTQ/Y6YJ0JfcjbcNPULTyT1aWz3Xo4PnscK/GOVIZYyNDsbfvCcM0yQzzWRBPs0xnYy14hOBqZIFIb9t8qt8wnEIuEvBr8IV/pHFHAStAxqVA53RBwDiHVouk0DF1G7RHQpQ/ZCHvusUWn7LX2U8rQwHADWZlIZu1IOJciIk3OMe66baJaVPQui+jKokyxnG1auqiCS3IVW0uPGwE/dmSEfH6EobRrxnL9jQhXNjKJIsEq7pzwU5URl7Gc1bhN/30YbnxGOVTanhQwYFmFKNHV4dn61QBDHjIBca69yOdsIit0NzQYRaHe8Muy20efRomrsC3WmD7gtVLH0Us9hQuXlHtexj1/MD9B/9a5tQfaht2JnS8Rcpo/RtjG8kL6LbGsmoun3faCXRnIyhSlp2fU0HJ9RX3dBj//0GNZiwK4VO9a3DncrbfLTzZ320s9YzflN0sNL4/iqcnkQRddVfbtg/+EOcO2Rpfkc0F+Zq3tvDZa8w25/ysf/6hf4csLFq5U0ZUanPZl48ozQlbwF94QdtdXPzPzWmwEQ=
|
|
sidebar_class_name: "get 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 'Get the number of access-requests-approvals' (get-access-request-approval-summary)"
|
|
---
|
|
|
|
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"}>Get the number of access-requests-approvals</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/access-request-approvals/approval-summary"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint returns the number of pending, approved and rejected access requests approvals. See "owner-id" query parameter below for authorization info.
|
|
|
|
## 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":"owner-id","schema":{"type":"string"},"description":"The id of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity.\n * ORG_ADMIN users can call this with any identity ID value.\n * ORG_ADMIN user can also fetch all the approvals in the org, when\nowner-id is not used.\n * Non ORG_ADMIN users can only specify *me* or pass their own\nidentity ID value.","example":"2c91808568c529c60168cca6f90c1313","required":false}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"from-date","schema":{"type":"string"},"description":"From date is the date and time from which the results will be shown. It should be in a valid ISO-8601 format","example":"from-date=2020-03-19T19:59:11Z","required":false}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Number of pending, approved, rejected access request approvals.
|
|
|
|
</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={"pending"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of pending access requests approvals.","format":"int32","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"approved"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of approved access requests approvals.","format":"int32","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"rejected"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of rejected access requests approvals.","format":"int32","example":0}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"pending\": 0,\n \"approved\": 0,\n \"rejected\": 0\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the query parameter 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={"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> |