mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-11 04:19:42 +00:00
77 lines
28 KiB
Plaintext
77 lines
28 KiB
Plaintext
---
|
|
id: export-role-mining-potential-role-status
|
|
sidebar_label: Retrieve status of a potential role export job
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tz27YS/isYnocmGVE3y5LllzOK7XTcSWof2Z48OJ4TkAQlJBTBAqQT1aP/3t0FSFEXX+Km57QZvSQWASy+ve+C4J2nMqF5LlV6GnmHnviaKZ2PVSLeyVSmk3OVizSXPMFHFznPC+M1vJxPjHd47Z2OThkOMDvZu2l4kTChlhkSBHKXU2mYSKNMyTRnWuRailthmExjpWe0LeOBKnKWTwULC61hN2ZoH6ZixllWAmAaN7L4moAh45rPRC40IrnzJG6X8XwKQykMwC8jjLF8NTwTTsWMe4d3Xj7PaBCgAOKGZ4HAk6KQkbdoeFr8VkgtQBq5LsQmR8IimRHLzG3CJO4ivvJZliD5g7AzbIv+wD8YcO73RDT0+bAd+NEw2t/r9fa7e3EAm23FndVl/n3Rj9blKSPQBYh5C0sr/HQHB3v7Q973271g4Pf6/aE/7PUP/GG3F8b7B+1hv8fv48fq7PurAbBbE9HiVqrCJHOmi9SZCPukAgZEwbDABFe5XuGsN+y14zjq+Qd7/djvHfA9P+gGbb8f9YYH4V4cxb22t7hBQCZTKQgH4XfbbfxvFdRFEYYguyYbi7zQqbnHqAmRRQlIQpUiNqTGsyyRIXlF65NBknc1ifEkOYvJ1p3sVPBJhEgi0+jEubTQQIsnwGueiBnQPVdZkXAt83lN6uCMYiK0t02qaASzYgYiKxcyPlNgFjJCEeIuaDJ56QdfpjKcMg5yX27KZoXJ2ZTfCpYrFoCq0jApIhFVK4XjvtJDG1TuZh2pGWw4IlnWQAcKtuPpBujTmMU8MaLBIsVSlZeb1QGhKnjOuBZsKidTsBTHnuMNMeF0GFd6AhL4nbRQB4hWuFjUHjwk6fY9zBARiJ+4BqDfE2dPbBAGBxAmJ696WOOVgz3qVxuyO2aFAbWAlrSIBRhqKNbsc+kp7bAfRsGg73e6XYgBnMc+j7sdvzPsRkEUBzFv99BzraVvugda131esNzlP1cnVyfHmGTWOBFpMcOkU004/fW/5+Ozn8cnFxfw6+Lq6Mj+dTIen40xFz1JzJjUhLdYoIvXdLuU6dP4XrK9BPhX24eNR4gd1vS2RaSjRKI7nmgNkdB3cQndMHZuSCbGAhXNmUS/vuWJjJrfEpYeNs1I5FwmRyoS24xzFewbmQp/orlEhIIgh7AQ4ru6lRFmppkCB7UkrQkJO6+5GtHb7WaHveYRcy7EjhwzKFrNw89Aa7u3rAK6SiWsZ+USTDg2o2zdVgwED/ptyIgxJEPePeh1BvvBMOZ7e+3h/nCIu89Ay3wi6mGNa83nG1v/LFKhZcgSFYJGfgeBaMFB9gSANoclMhcz87gOiMYT5I/+aedWbDq8LBdf8wak2tdH56w3YAlPJwU955M1IaT+FfpgWiQJD6q42XAgzrScyHQblNK7j0/ejK7eXsKT8Qk40gX8hbQ2KssRlFxphGYJUMEWpuoLIXYMfOEG6pgExCGiJnvlqL4ChrjLy26itL/M3IAwwbZiXiQ5rHC7b1lRJ81irWYrrkR+8zVnL2RTNBuQ++AZBGBIkQHHSKtsAnyFHp/l/lsnyVdsKngk9MsmG0WRRCahWAFvBKKwfo5JlEe1DBoX4MoARuZTLJ8h78lQrOpiKcpVbSzjy9u6UtA5APnjdjIK8wLAEZt1L6ysxUF0+gHMVnKr6C5rQiORztOch8AF1DlzECNUTSFEJuBNQvp24QjVZSDwpOW8KmItamGTwt07C+Y4VzQW8sI8we/OEwg/PrFWDdwK53wG86SNRqSNUk0uIsEgsk2L3axKXaXjs1iKJNr57s53d777RN9dHyzrHjdKpU9ns/S5SnkB8tWUPDdKH03WkypWTrJnEVaRDWgCyhLpl/eX4NifRcpsuYot6Xesj2wq3wA/qvRhnweybFJc6l/qAgGSHC0HMUQiER0S7iViEpQV1d7mbm+UDiQYaLqlRISoqdlcFdQ7QXtNJwTcYLMlTPqT6/I41a82AtoTH5+OfHaV5K6S3GWjXTb6cbLRrpLc+e7Od/+ZvvtgJVmhIm9xdZIpZjOu59bS3Lh96QATWPlGgFUuR6par1aQGKtqLG+1cvCCbifoxINQ9CLei/p7w7gb9rt8f9AZdIJed+DVc/310o8rJ1v1qZq+rR7tsavQt1DHFSkYl8mVilaP/wp8NxdjWMPQU9XNIHMQ6U1ZO+5vO2E8BY1otNILu8U9R4223uYpQICS1HpNVfnsKsRdhbjLMrss82NkmV2FuPPdne/+M333GypEVw3dXyHChCdXiDC32WZVLfUGjet/XiiSqzgEZN5MhXR7JVpWgVRXgCkhoImgGIJ3fQ69Fl4G8e0NIt/dIDKtu+oO1qJV3cHxcSqMrd1zWrTsO3efg4rD1l35Bn6B79apuLR8FTqB/aZ5npnDVusOaICaF02eyaa7ojJP1ZdmqGatAGS8JXzhm27rqjiBjc5PXYHcJAVpiT5gAyYRt+oikaC1g9rocPNBynj3Ce1grgoIkUSmwcBfnD3SY4CY8XT+k6HZTbK/Df6AryudLP48L5bQPbxsE9+Du8F8BkjXWHT3KIwAu6GLDqCvK8BzZKPdqEBbub6pz7nA6t4i3Ji5zFjYk3Q3AJ3htC57LbiG1sMe07/45f3lSzbBmpZiSmGwnBYSmxDwynMwI4qZo/LIGhdRGtOqmEyJudHKSwH0URYnIBT2Ib0Qgl2fOkH9CslkDNGfxI6LBAUcXHXzotRgJG5Fgnm2uZQ2GqeM0hZIscVX1r2knErNR+2SZPND6rNjiaEO/YrmOBbpPJ5dZyVfvMbXc0H8q6TmW2o+UTMv11BY0V6H9pJJCIHC+rMhaT17c0vPr9HDTg2eINV1DCgJh2P1VU5Yau3ZOFbo+UhvFceH9L29+7ayjNn4yAzk2yRipyycKmXEvxlD00FXuZ4U4GnPhkUX7nzyCL/brkHy7Za+9KH8JHxvwTFSa0z2li1VPwoKwzSybvuRNAtx4SM05xH7uMIzPb6GLI0zIxWaZ2PGDX3c0Ldxwjj8NgmiYeFVNeCB4oA1gKOl/ikSOKC12GhpbY38RL5FazB9hACVqJjs0P44XAZB9xejAZxdzYFQjdV79XILfjNHCzPhirDKc4d1CW7iTRQk4DW5WbzVyQsm5b8bv8jxaHk8c5Ym8+8dpe+JJH+fuPt/ini7SPMjRhpXT6O50bau8agb+WtX020eFxq8pyvgXxglX6XSHRojavWoiqkTyhKeo1WTV4dT/AoDL2ELnmN92EDLUjPyxEwrdH9oJ4nQRMMccFsDdSsPZAL0muxyuTMnh7HFJ+oVf5uCuh3cK5xC4yqa7D3erw5BLdj34XUCGPukXAN4AZo5py9EjktlM7wXW6R4+xxgFzPGwaQesYhImrCwgQvawFSUslBU+lWrSi9GU0MWmtQB6Zk5i/EMG9rjmuIf2Qv0btwBNogetei+eVgyMhYJWSbOWy3tH6MN1uZPRZJh5wlRV+Bd3+UO704vNygCsdQAX9DhKz1puUWmhXOBCLZQ1nz2mp1m26eWAp5nyuTQK9eIj92XOo9/ioPfWaxb593yRP+v/ALIZR1sF1oZnqUhL4VtcWxXeu1t60ph6WH926C1xhSHNz/BqfemOKO6Hw6tzBTkh5vd3eHZDXZrC3z8WyHwYOD6ZtmIUUME+sW/oYW23y3cL7wXY/cRzEv24HdHWyVRnj2m8+Wxgwd/fhZ4WrEUAPacz4L0jR8TPQPkuhqeDfXPfi70DOyVgSxuYK49tSP122F7rldbuPHmC5vk6qzl5xPw4MUfmxmAAQ==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Retrieve status of a potential role export job' (export-role-mining-potential-role-status)"
|
|
---
|
|
|
|
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"}>Retrieve status of a potential role export job</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint retrieves information about the current status of a potential role export.
|
|
|
|
## 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":"sessionId","schema":{"type":"string","format":"uuid"},"required":true,"description":"The role mining session id","example":"8c190e67-87aa-4ed9-a90b-d9d5344523fb"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"potentialRoleId","schema":{"type":"string","format":"uuid"},"required":true,"description":"A potential role id in a role mining session","example":"278359a6-04b7-4669-9468-924cf580964a"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"path","name":"exportId","schema":{"type":"string","format":"uuid"},"required":true,"description":"The id of a previously run export job for this potential role","example":"4940ffd4-836f-48a3-b2b0-6d498c3fdf40"}}></ParamsItem></ul></div></details><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Success. Returns the current status of this export
|
|
|
|
</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={"minEntitlementPopularity"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The minimum popularity among identities in the role which an entitlement must have to be included in the report","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"includeCommonAccess"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If false, do not include entitlements that are highly popular among the entire orginization","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"exportId"} required={false} schemaName={"uuid"} qualifierMessage={undefined} schema={{"type":"string","format":"uuid","description":"ID used to reference this export","example":"0c6cdb76-1227-4aaf-af21-192dbdfbfa04"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"RoleMiningPotentialRoleExportState"} qualifierMessage={"**Possible values:** [`QUEUED`, `IN_PROGRESS`, `SUCCESS`, `ERROR`]"} schema={{"description":"The status of this export","example":"QUEUED","type":"string","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"],"title":"RoleMiningPotentialRoleExportState"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"exportId\": \"0c6cdb76-1227-4aaf-af21-192dbdfbfa04\",\n \"status\": \"QUEUED\",\n \"minEntitlementPopularity\": 0,\n \"includeCommonAccess\": true\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={"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> |