mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
79 lines
28 KiB
Plaintext
79 lines
28 KiB
Plaintext
---
|
|
id: update-recommendations-config
|
|
sidebar_label: Update certification recommendation config values
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW+tv2zgS/1cI3YdtC1tO0qS55MvBTdNFFt1tNg8UhzS40hJls5VILR9JvYH/95sZUrL8SNrLFXu7PaNAalPkcJ6/maHou0TXwnAntTrJk8PE1zl34kxkuqqEyumBPdKqkOOklzg+tsnhVXIyPGFLc5LrXpILmxlZ43cgdUmkLMtotQ+bMO6ckSOPD7wVORtNWSaMk4XMwgSzSDeFbY34zQvrXup8mhze0VdpBLDrjBe9BDZwQjl8xOu6jIQGHy2ycZfYbCIqjp/ctBbAmB59FJkDurVB4Z0UNpCNGwvzWnDnTRiOi7gxfAprpBNVd9yCOGqczJalfyOtY7pgMgfWpJt2BXcaZWeFNizjZeZLYFiNH9YDbC0+86ouBRrgox5dSAefe0mpwwKURwjzr7HRvk6QnZobV6FiegnPnLwRyfUsTPoR55wKk8FTPhYXE5B1osu8I5fy1UiYZFmsi4lgdVjIbnjpBXMT7uCPWGJ4Lhl8rjwow3pTc0vSg+JznwnG2T+Pz5cWwpaVVLLyVXK4BZ/55/B5u5eAwioOdk6KUnPX1chWugeiGa+G3ulzUYJ936pMdOQZaV0KrlYEOikYeREzvhT2bO4DwenZrSxLNkLpClQSeOytdBOmxC1KMTYcOAKTleWUWdoXZrSmZlzloJuo3aAwy0AhqC8lPjtWy1qUUgF9H3gruC9BxIKXVnQEpO8golbl9MKrtSb7I0X8hkKBVI58+TBZxJTA3iunk9kMZ8GONURCCMudrS38b1HSI4igFT+8D3544YRhAfCSDYpsUGSDIv8PKLK7FjhKib54bAxEUx9qGwhcBQzKIjolFSBsBBUIk5ZJBfzKPP12sJELx2V5pHOxigrLlngNSumDQiVyKIjlDBaimm9kjhhQaSNYIInogSLQvLTr7aiJdJu95DnIG+Q7isKgMg3PPgGtk/zLDF0q+RvGcFwCaEWodM+2Yl/w0Yutg53d4sUu5zt/393e3xsdFPz5862DvYMD3L0S1gKkrIPOxa1/FEoYmTHEr1L+DgoxgoPuiQHafA3a3mMDovEV+kf0CnNbMSO/zIHj9gCQXh6dst19VnI19jTOx0tKUP3LcxhRviz5CIcwuGa9yMRbI8dSrWNFKISxq+TV8evh5ZsLGDk7/vXy+Bw+Ia2VKnyowFtzdEtgFXxhom+J4yjALbdtOKbsWaT6DATiynYnyvDNTi0ok8VghBVx9zUruqRZYXS1EEoUNxDlT2Qq0h4AB4wBQmQTNuLYF0QkeDbMMlG7/puoyWdsIjiAztOUDfNcopC8bNCj4lNEIJ7nGLqBQOExBxMWae+Y0gBCYtEWc1UuWmOOKG+6RsHgAM6/7CfDzHlgjsTsRmHrLZHFaB/gOWhukbuLjtJIpVPItlkDpZk2kPgAmUA26SyLcITmsgA8qpnXIlYXKAnufg7MBIAEPOPefkXcnZYAP30SrX1wI2LwNdkZ0Iis0ZgpIhI8RLFpcZzVmqsJfFZIAWlpE7ub2N3E7tfF7vLDs9gudUuf7dXS51JxD/o1lDxXSh9D3qM0ayaFUjwYssdAIbFE+undBQT2J6Fwvvhc4wHNN6yPQipfYX7Y2iOMj7D8aI21YAtkkPQYJCgAiUR+SHzPOSZFBVU9X93ttTYjCQ6q1pSIgJqGTbVn3FDFqpATbnss18KqHxybcMBHDhERmhc3wV1V3q+1VG5TSW4qyU022mSj7ycbbSrJTexuYvevGbsPVpItVxQtsU6yvqq4mQZPi89RWs5gAmsO7lkbcmSq5WoFibG2xkoWK4dktLM92i72M7Gb8938xfODYid7scP39rf3t0e7O/tJN9dfzeO4DbLFmOrYO9iRVAxF3A2+FMBzTeu0zheP/zy+XSgQ1hB62roZdA4qvW5qx711J4wnYBGDXnoetrjnqDHU21wBC1CShqhpK59NhbipEDdZZpNlvo8ss6kQN7G7id2/Zuz+BxVirIburxBhwldXiDA33WJtLfWa3gj/0YUihUrkgNyb6Szzhg48myoQlGAFDEo3pU0uLb0oRwpDKBth7Hp2jYyAuyHTtSec4fgoGSzd2hhkzQW8UJ8Gvr0pYe7EudoeDgZ3YE4w4yzltUyb6yJK36ZAaTACHa6BJ3yTHUIRJ7Dh6UksgFMygJHo4wEQiXgwR3wNn1gwCx1ePkhZ8YrsPNUeIJDI9BjEQ/Q3GgYWa66mP1ianZJ/rcgHcl2acvbfyxII3SPLOvU9uBvMZ8DpkogowvXcBc6xMg+7rzjCPNtgP7GzstlbnLbDXgpuoG0IR+xPfnp38ZSNsR4lPPAWS2EhsYGAiDoFFyG8GzbHzbiIUpDRfjwhxocLB/oYX6woQWD2Xp0Lwa5OohJ+gURwBshNKsVFgsACV10/aayTixtRYo5M55pEx5O5GoCGBnxh3VPKh9Q4SBWu48Bo+l712SuJMIVOT3OiiHSWzq7qRi7ekeuxTPytodYP1PpEzT5d4iKo9ioLF0QyCHIkwUtL2nr05oFev0MPuywYQarLPKAmIh+Lr2GyxmqP5mOBXh/pLfLxXr2bSEi2i8tYwC1mIVeWOTth2URrK/7BGLoOhsHV2EMUPZqtW9y0TxHR39nqsNQPW/ZlH0pH4u8NBIYKzsRHmLqpctFQ1Kk8hOQHsizE/Ae6SfVhQWYavoIMizNzndlH84wb9nHDfsAAG/kPCQwdC2IbZSAcCA5wNLc/IUFktIN7gdZaVCfyA1qDqSEDVomKrQ/Dl8M5wMVPjB7g7HYOwDBW3u2LKfjOIi3MYgvKas4MljW4ym+pIXku6S3w256aYEL9s8mLEg/nRytvVTn91ih9D5L8eXD3f4R4G6T5HpEm1sJ4RHk2/xXHcdO13HNf+vFXk790M3kr3Vt7wzdeKl1zMba5M4sRQ5qLfU83Tl/GknP1tNLi1WYBf+EpwQ11DsBtuB2LhViXUF1yh4FJwJRNpKBzjhoUg+VrD4NDVwQmtdGIYNDNEqGxgTmAPBbKaj6SJdBL2cV8Z04xH2pjdE38bj01W7hXNoG+WaTsHbSeKgPPwrYTbzPAs4869p/n4Fyn6JvsVeOvUDdWlVd4Mx3Y9hXjEBVfcOpc2swH7IW+RolGF5qq13ZVA0QYLShCSg2YqezbAo/QJVot+cq9wHVtPD8H1aMVsdHA3q4V5EyU7RX5xc7jS7QhYPoTUdbY+ELigBpSdHb4+eRihSIQUxbkykSqzXgQF9kBzgUi2OEF93mebqdbfep48M69tg5a9Q7x8BOrB6/8x98/xKOPZQe9m79T+Ia/14qpEnucQY2Hd8i9Dz1XaHGvktUfJsQmF0J4AoLinLs7POPBrm+GwwAfeIBwdT1v6KiPhgV01kNd8SeBZwzx5UL/YkrZPx4mrL41wT4zrAjnRw/O7fbrp5do1lH8RVoVTicMv4VB/HuYvId/8EXXQTxEOhy/S5qzPpgTyDZV1roiI35AKWezfwOsoqlN
|
|
sidebar_class_name: "put 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 'Update certification recommendation config values' (update-recommendations-config)"
|
|
---
|
|
|
|
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"}>Update certification recommendation config values</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/recommendations/config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Updates configuration attributes used by certification recommendations.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"recommenderFeatures"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"List of identity attributes to use for calculating certification recommendations","example":["jobTitle","location","peer_group","department","active"]}}></SchemaItem><SchemaItem collapsible={false} name={"peerGroupPercentageThreshold"} required={false} schemaName={"float"} qualifierMessage={"**Possible values:** `<= 1`"} schema={{"type":"number","description":"The percent value that the recommendation calculation must surpass to produce a YES recommendation","minimum":0,"maximum":1,"format":"float","example":0.5}}></SchemaItem><SchemaItem collapsible={false} name={"runAutoSelectOnce"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"onlyTuneThreshold"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run","default":false,"example":false}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Cert recommendation configuration attributes after update
|
|
|
|
</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={"recommenderFeatures"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","items":{"type":"string"},"description":"List of identity attributes to use for calculating certification recommendations","example":["jobTitle","location","peer_group","department","active"]}}></SchemaItem><SchemaItem collapsible={false} name={"peerGroupPercentageThreshold"} required={false} schemaName={"float"} qualifierMessage={"**Possible values:** `<= 1`"} schema={{"type":"number","description":"The percent value that the recommendation calculation must surpass to produce a YES recommendation","minimum":0,"maximum":1,"format":"float","example":0.5}}></SchemaItem><SchemaItem collapsible={false} name={"runAutoSelectOnce"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected attribute and threshold values on the next pipeline run","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={false} name={"onlyTuneThreshold"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, rulesRecommenderConfig will be refreshed with new programatically selected threshold values on the next pipeline run","default":false,"example":false}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"recommenderFeatures\": [\n \"jobTitle\",\n \"location\",\n \"peer_group\",\n \"department\",\n \"active\"\n ],\n \"peerGroupPercentageThreshold\": 0.5,\n \"runAutoSelectOnce\": false,\n \"onlyTuneThreshold\": false\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={"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> |