mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
85 lines
29 KiB
Plaintext
85 lines
29 KiB
Plaintext
---
|
|
id: get-role-insights-requests
|
|
sidebar_label: Returns metadata from prior request.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tv2zgW/iuE9mHaIrLlS+I4Lws3SQcZpJNsLiiwaYChJdrmjEx6RaqtN8h/3++QlGzFTtvtFLszA78ksnR4+J0rz6Goh0gvRMGt1Oosi46iqbBXOhdnysjpzJor8a9SGGuivSgTi0Kk3AqQ2aIUe5HlUxMd3UU0gFUjonsiNWkhF8QULG9m0jChsoWWyrJC2LJQhmXCcpkbpieMs0UhdcEK4iMDHxC6qVsMcy94wefCioLme4gksV1wO8MjhQf4JTNcm3Qm5jw6eojsckF3jS2kmkaPexFxk8UK+1OIYvvszPEVn/h8kRPDw7QzTMTBID4ccB73RTaM+TAZx9kw2+/1+/vd3mQcPd7TfGahlRGG0HSThP4157wu01SITGQtdrVFJ4oJXuRSPKcWwEq1skJZYs0Xi1ymzoztXw3xf9jUhh7/KlJL6izI6FZ6dBBxQ2NPFRT8gJ1lbAJL8QYoNhUq+FAF7xuUBnkKQe51gj/bEGHiOYe0UQaC2ErYfZsd66fPWPQjNyzM1GrA7CbdJE6GcefgpnN41B8e9bqtzn7yT4KWc2N/9FKKrer6nuA0AfoCvP3kqLOCp8r5WBQXk9sFTWDWACLkxFQUm2C05Tnz48jfSj/SWddSwNbhd215AYQfpZ2xBH6Z4TLP2Yx/EIBaICfYis/HmVCryDHs+OLt5fnpzelJQ5KEwpFyTGY2o6KOxLMTAyDcMl6QnpqgwC7Ix4uCL/FTWjE3WyIfcxnLbbnl2XM+HuiBGGJRfju+Oh1BCNw5+5ldXl38eHV6fY1ftXi4fjM6O8fFPU1YS+pjK0qHnCfdCfz/YJzE/XHajw/74yzudToH/KDT64jBIHri/s9744Yzfo50wzGSNd3fRd102DlMDsWgm4hhf3KYdAbd/V73cJAmvN+f9MEhkAwG3R5Pu4dJIOkMO/v9RCS9mmR4eCD66eH+sJt0DsTBuLMvuJj0+4OUloTKCLUyoScrrfPs5oLj8yYsR6rsb8ucx0iLWElOiwLOGofsKTImJ/ASUTvgWGdL8kKpPvBcZt8xY/o8fayzrXmqCfaNVCKeFlwSQuEgpxiIJU9/kBlGsLmGh3uWFIkkgqNrhj800eqw1zxjlZ8eB2FIkwVPfwOvs69I5bdKYjyrhmCFC0G/dVoxEHx8kAy7/clBn/PuYb8z2B8PJ7zXS4b7wyHNPhfG8Gkj7VRh2ZzaOa1MWa5TWOTfUAhcHrp3ANzkWyL5GRs4Hl+hf0oonrYWM+BlVnyye1jLXh9fsv6A5VxNS3efT58oQcW31y6a8pyP6RYVEbQsOMYXhZxKtQ1KlUFOTt+Mbs9vcOfq9B+3p9e4Il4bpdJIwVszckvtsvJMf3SIgwC0OhiRQx1UNbwKXF9BIK7MOqH0v8zSQJnwrQkvc6TyV2H2LSPWWbNJoeeNUHJx88myF7IlWntsTPew3KUzNuYGA7Ry5K9GKGkWNj4PmnzFZoJnonjZYqMskyQkFh1EI5hi/BKMGM8yCl3PYFIilIVba3SJZUVbmYqmLVaqbFpjlU7O141CwQHkX/aTUWpLgHNirkdh7S0BYrAPMHvNNdHdrCnNqXSpLE8hBc/zZb1cjiGbtIaFdETmMkg8qqKrM9bjWpZ06e6tB3NitXuW8tJ8Rdxd5kg/sROtfvBBhOCDG+iQjZw1KjOFjISHJLYbHKhqc1WBzyZS5Nkudnexu4vdr4zdpw+ruic8daVPZ7P0uVW8hH4Lt3hulD6F8x6lWUXkezJvyD0GhYQS6ad3Nwjs31CtU2v+aUGd8Xesj/xSvgF+VNvD3x9T+VEbq2ELAuj06CWYIBOJ7MjhXiF2ivKq6m3O9kYXYwkHVVtKRGTNgi116ZqLolSKkHCzxzItjPrB+u6GIyKM8RnQb2HEbg9jV0nuKsndarRbjf46q9GuktzF7i52/5yx+9lKskbloiXUSaacz3mx9J4Wnvv3MCBg1ZsLVoecM9XTaoWYsbrGipqVQzTudsadySAV/Yz3s4PecNJND7p8f9AZdMb9Lm13rtb6u1Uc10HWjKk1e3s7OhWjiPuAOq5UcC5jtc6a238lvWyaUFqj1FPXzdA5VHpf147d4ZZdaK3ZW66WVYVkGjWkWumIchpo50RbVLQg4GyKvKgYUpUELnIl2vSPGe3ZslzOpQtekgJ8i2U8mliI4gOlcrJ6FqnSvARClwlyTVWzhmNJCCkmVPOBg6tgp8jO37E6DSb6XZU8uyKJz0lidvrJv/FideW+v21/9wzgC8oR197Az2z0+m6HKzgAGgKfs+q6c1ef7+rz3Rq/W+P/Gmv8rj7fxe4udv+csftf1OehGnq+PgfBV9fnoG0lrK6l3pBz/c/LdBcqAYFzb6bTtCzcdnNVg7u6Aq4Ujp9RDqGjXUdRm04qxNUZmXZVX7cfZPYIKl/+e2BlkWPAzNqFOWq3H2Av2OmxxReyhTQGk9ml0h9bqZ63x1DSlvxDBwV8rBEBG12ehf6i5TRcSHJin/Ecc69vJxO5K/Tu9oY/y5nOqpEhl7pEjnNs9hgcPjiUu02nf9BN/GAcdcs50IZ8kOu2yB9/vyye0TOybFPfZ2cDPQPSJyKSCHQCRMDwYOTsdQs8xz5djUoy9t39Os01lece4Qblasmhlq67AeiCyLrsteAFegf/luPFT+9uXlbH1JAUSkP1sJDURSCsLuFGLumNqh1/GuTWoUKX05kTbtR4p0JBxiY5lMLeq2sh2N1ZUNTPWA2ukL6d2mmQcBmDRt2/qCyYiQ8ip4WytdI2OafMVBtabPPGuJduUXTdg1T+pBnutt6rmJ1IylWSFneiqU7iUTPI7haVXHxNrm8F8beKW+y5xY6befkEhVftXerP6KSIdGLBc+O09c2Te37xGj9qtXCHuD7FQJoIOJpvwtLKat+Mo8EvJn5NHO/Vu5nEitscxnyCYwYLZp6xM5bOtDbi74yR61Co3E1LRNo3w/pIk8YuIuJusgYp9lPGMkb96PCdIzCUdyY+pvXblS8alZ3KfNj+4iyLvPCLO+73S0Nmd/sOyyxRZjo134yZJoxpwtjnCRPwh1OwAIvYJhlcHvAOcLyyv8sEAehabvS8tmZ+x77txtDykQKq42IWR/7H0SoJhivmHhB1TYNUTeV3/W4Qv1ngRUtZQ1nVxsFTDW7izTVW0Cd683jrjStaVf9o8pLEo9X+yoXKl987Sz+TSf44eff/lPF2meavmGlCQUzu5qYNncO6k78ONd3mfh9tSM8E/uKpi1VXe6Oz8ae3qYpZZ7TIuSWvdlGdzqRwOwULwS3Vh3vkWXruIhFNPYW/CMfAp+6kcgHIHL2dzMHP7WVXM4cj2674JLvSb1O6doXmSmfoPEWLvUPzplKYhRo3Oo2BZ7/q0MFdwzKX7ouRk8rYKLrm81JhNorLcs44XOoLHpFJk5Y+caGPU6LShXalXz2qimJyNRLBnTAXxdxcTGgTGv3tmuG/MBfsbsIONFRPVgzfqKwEuRK580yia5b2X+INb4tnIl+4jxIAi45Kr2Z4e3azwRHMlIFcaNF1MW2HQaZNtGBCLZR3n16r00pi11Lg/kIbi2Z3jXn1lQoyDM/gI34DIny6szqY3/DJh9VG/Pf4DiisKdQMtBe01UVIS9/A+KbxLmo0jZH/8id8wnQkMzqLPoNoRPnwQPsi1Eg90m2QUdN9d7/qkVyvAtXTNdrTCZLB02+H1iV8cRW+MnrJvvBF0VZBqp09tVw19REufxO0F4Bx6JiB3m3WOGT+gd/OWRuy8cKDWqu6xf7xFHZ//A8LosVk
|
|
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 'Returns metadata from prior request.' (get-role-insights-requests)"
|
|
---
|
|
|
|
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"}>Returns metadata from prior request.</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/role-insights/requests/{id}"}></MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
This endpoint returns details of a prior role insights request.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The role insights request id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Succeeded. Returns details of an earlier role insights request.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Request Id for a role insight generation request","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></SchemaItem><SchemaItem collapsible={false} name={"createdDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time role insights request was created.","example":"2020-09-16T18:49:32.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"lastGenerated"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date-time role insights request was completed.","example":"2020-09-16T18:50:12.150Z"}}></SchemaItem><SchemaItem collapsible={false} name={"numberOfUpdates"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Total number of updates for this request. Starts with 0 and will have correct number when request is COMPLETED.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"roleIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"The role IDs that are in this request.","type":"array","items":{"type":"string"}}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CREATED`, `IN PROGRESS`, `COMPLETED`, `FAILED`]"} schema={{"type":"string","description":"Request status","enum":["CREATED","IN PROGRESS","COMPLETED","FAILED"]}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"c9aa02f7-86b0-4bc4-84bd-3116a6131e77\",\n \"createdDate\": \"2020-09-16T18:49:32.150Z\",\n \"lastGenerated\": \"2020-09-16T18:49:32.150Z\",\n \"numberOfUpdates\": 0,\n \"roleIds\": [\n \"2c91808e720e94f8017253287c0a44f4\",\n \"2c918087723ac2800172532191540e03\",\n \"2c9180986e4c8592016e6b15eaef447c\"\n ],\n \"status\": \"CREATED\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><p> An example of a 403 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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> |