LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/get-notification-template.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

83 lines
32 KiB
Plaintext
Raw Blame History

---
id: get-notification-template
sidebar_label: Get Notification Template By Id
hide_title: true
hide_table_of_contents: true
api: eJztW/1z0zga/lc0PmYWmDpN05Re+8PdhFK47hXotekwd6EDiq0kAkfKWjIl1+n/fs8ryY7TuC0LLLe7E6ZDG0d6vz+eV7avIj0TObdSq6M02o/Gwr7SVo5k4q71xXSWcSuijcjysYn2B1H9axNdbESpMEkuZ/QZBPoTaRioGMaZDbuZnXDL5rpgE/5JsKlOQUGkbKRzupozI7FoOGdHaQucZjznU2FFTvyuIoUPICxTfCWJxYzbSXST71HK9AiMBKsLyGoK5OKXQuYCWtq8EBuRsfOMCBuJJbRAfJ5lOsWlEc8MLUgmYsqj/avIzmdupc2lGruV3O3Zj5Kt3aHg2zze2e2mcXdnO4n3RLsbd7ef7IyGox0+ag+j6+sLYm9msJgwRLDTbtOvZRV6C4Pp4QeR2GUDgW+ilRXK0lY+m2VByc0PhvZfrQrM85zPyWwgbGrXPXkydU7ut9JL9VHM79E200X6bspVwbN3lzr/+I4ovzPFdMrz+YpP+vAGaJaOKbWLrjeCU+/i1efmI3vJFR+LnJ0VwwXhJjZEr+Rz+04wnopUFtMm1qtEp8IYEGF+T4u91Hn5wbApn7OhYDxNEclSOc6jwha5oBgWipgMosOXvaNjfD75x+tXh/h99vKM/j/uHfwTv/uHPXy+qKvtN0DQTCc8a7TRqqB+rQsXW5Pbis92A3n49OCEdXdZxtW4cNf5uLVka+FMYwofFne65d9lFj+AhkORvx6dCJViFVndsAcWv/yfVrNE0y7EM+zz4Ordu3GmhzxrIerSIrGv4LPrVqNCQRSWSSVK49bDZyJ4KvImSVWRZXxIovosrySnL4jVLBdIm0UZWGXuibNPPCvA3DClL52FsYldSjsJ8gx1OmeoY1naYkcjSJlkRRqWYI+KiaOnYjZwFR9QA4rMkkKcddvtFqlCZO42+UkmuBFsrMmkzhIU4FMf4I3mc6I1mG2ktf3NzOaJ/yizjXLdmMULsz2o4g1FUWbPsaGXpqBlGm32NqIV+28jSmla1WTAXMyyeV9/Z8anRJX1NXjfFvBL2+5i/gwc5yyVY2Esi5lBu2ByxHyyUoXUhTWWu5R1gWR82aCQ0pcKa/7G2o1y1q40SYj+/O2dshFN4IcXVsdjoQiqiNQFQJILH4+rTKHQlKOORSlWxFZORaNC9AW7nAjSBTyq5ou/A/EWu02Aumaddqcdt7fw02+3991Pq+3+/cd1nAB3fgNJL7lBVYejSx7fQeDrOlIaOExQdc2qK6FlWWl9nw7CPLMam69pf7cJ3RxkkmLxMM8RbjE7FWiVilqnb9rEk0LWly5KPpQA6QT/tajnFnSTCovcOHAI776m+hxpGI9zLklC4UROsJGB4ifpUmdKWMCTLHGHW7dsaapWW+wpT6Gv1+8gKAMz2ZwnH0HrqDE0lgU6VxL7WbmFybTq9g1sxa7gwyftvU539KTLeeev3a3dneHeiG9vt/d29vY8EHIgwTTAxWXWLyiIZOJBhvwvDILkgO2dAI75lyPMHwtq4vOzldZWIavXuRzL5mIasNuzw+e98+M+rpwe/uv88Ax/Ea2VkadH9TClsNSuwk7Q+OxCAUpSIzKYg/LzcaD6GApxZeoLpf9k5gbGRGyNOLoedgTuDTvqpBl1xKVUcnnz2bKHsiVaGwCrVCi4TSZsCDyBeckX8ce9JBEzGx8HSz4OAOhRi6FtSVKSlw35DtTrGjiaC3q4lYlY9sXClDeBRllGjutOoeSA5PfHSS+xGEVcTCxlYRUtQcTgH8jsLbcsXb9mNGfSubI8gRY8Qy9NdJ4TFh1CN4m5NpQjcpdB4VHluqpiUQks1XLl7qUXxldI1DNemC/Iu5MM5Sd2qlVffBIh+Ry89tXIeaN0U6hIJVCkzWFV5a4y8T0IW+fuOnfXufuFuXvzy9NwplNiH4I+W6vQ51wBjU107prnCvTJw7TEykX+5Mo7coPBIAEi/fymj8T+CBSI9eLzjCDad8RHvpU3nEqV/vDXh25wKJ215AsS0NnRazBCJRLpvpN7IbEHic5U26vcnut8KBGgqgEiomq64zDGYbK8UIok4RgSUy2M+sn6cwmOjDDGV0DiqtJ4pqWyayS5RpLrbrTuRn+ebrRGkuvcXefuHzN370SSlVQuWwJOKm+yuUgL35O2dCS+zcq7i6xKOeeqm2iFiLEKY0XLyCEadraGW6PdRHRT3k2fbO+NOsmTDt/Z3drdGnY7u1G91w8WeVwl2XJO1fzt/ehv7Yj8E3BcoRBcxmqdLh//wby5GFFZo9JT4WbYHCa9qLBjZ28VO/a1ptt+8xIhmSUMqRY2opqGtVNam5dr3d2FMeqiYihVUvv7yXTwGjM6Q2WZnMpwJiyIbj6PeyO64xHuF4Ugq7iEOxvGVYJME2rWCCwJJcWIMB8oOAQ7RnX+jug0uOibkDw7JY2PSWN2+DkRghK9Qu47Tee7RxA+pxpx5h18y0Gvn3a4QgBgIPA1q8Kda3y+xufrHr/u8X+OHr/G5+vcXefuHzN3fwU+D2jodnyOBV+Mz3foVjyrsNRzCq4fDtNdqgQJXHgznSRF7o6bSwzucAVCKTw0SjWEHsvcjzZV7fnLuHxUwWxeyfQaqzz894IVeYYNE2tnZn9z8wr+gp+uW3wmWyhjcJmdK33ZSvR0cwgj3fp0iHusCAtY7+QozBctZ+FcUhD7iueIe3s7nShcYXd3Nnwn5fLRQvcgpiezwRDwIaDcZXrQDdPET8atbrkAWtEPep3n2fW36+IJ3aJLk/nu5Ib1DJLeUJFUuCB3wfEg5Px1DnkOfLnqFeTswUV9zRnBcy/hyspFy6GRrrMi0Gta1mFPBc8xO/i7HA9/ftN/xKpnWFhhCA8LSVME0uoEYeSKXq888adNrg/luhhPnHK9pXsqlGRslMEo7K06E4INjoKhXqEbnKJ8O7PTJuEqBu26eFh6MBWfREaNsrWwNgWnTNUmrLjJl/Y9ck3RTQ9S+Qd9cLX1VsXsmaRaRQ9QuzVBRTcMssGs1IvX9PpaIf5SUos9tdhRM49uSOFNO0j8MzoJMp1I8Mw4a301c08vrtGjUQtXiOpNGcgSQY7lO2FJ6bWvlmOJXkz0luV4q95MJDru8jbmCxwzaJhZyo5YMtHaiL8zRqFDqTIYF8i0rxbrkpjGLiPiTrsmUuxZxjIGfnTyHSMxlA8mPqT+7eCLBrJTqU/b986zqAvvMV2n7P2Szu7yAG2WVqY6MV8tMzGMiWHs64QJ8vsuRoFFj7VBB1cHfAAcLPzvKkEQtFYbPa3Gyu/Ib7o91D4SiOqomNm+/7C/KILhL+a+oNXVGpRqgt/VvUF8ZoEWtbIlY5UHBzctuCpvptFBb9jNy1sdXFFX/b3pSxr3Fucrr1U2/95V+pZK8vupu/+nireuNH/GShMAMYWbYxsmh3qQPw2YbvW8jw6kJwL/41uXqw57Y7Lxj8QTiqkTIjhNUe2yOplI4U4KZoJbwocb7sHfqctEDPWU/pgHHaGxe6Y5h8gcs53MQM+dZZecuUsYDz7Jr/S5fA+D3uWYYPIULfYGw5tK4BYa3OhpDHz3QYcJ7gyeOSHHsmelswG6ptNCgRvlZTFlHCF1T0Sk0iSFCa+QKCVKW2gH/apdZRZTqJEKLTfC5FPzekSH0Jhva46/hxf8bsIJNPfvwIT3zhaKnIosvPW2cQPa30cb0RZPRDZz7/VALAyCNQ4vj/orFEFMGeiFEV3n482wyWzSWhChEcqHz3Zrq9WO3UiB6zNtLIbdGvEXwja/Ecee0vt2N8PxanEG/z1e5QvthOaAzRmdcpGQhZ9d/Lw4iJrnRWzelyk9aD6BTrTu6ooORGiCuqbLvxSCpu3BxWI4ckMKbE5/p9VrfLfq9/A0POf+iN3/9mCjJuWpnpovBvoIf7oX6eiNCEzLi5eVBuENu8gf5dS2rNzsoLGqGq9fHMLn1/8DUesgXQ==
sidebar_class_name: "get api-method"
info_path: docs/api/beta/identitynow-beta-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get Notification Template By Id' (get-notification-template)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>Get Notification Template By Id</h1>
<MethodEndpoint method={"get"} path={"/notification-templates/{id}"}></MethodEndpoint>
This gets a template that you have modified for your site by Id.
## 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={{"name":"id","in":"path","description":"Id of the Notification Template","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
A template object for your site
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"key"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"cloud_manual_work_item_summary","description":"The key of the template"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Task Manager Subscription","description":"The name of the Task Manager Subscription"}}></SchemaItem><SchemaItem collapsible={false} name={"medium"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EMAIL`, `PHONE`, `SMS`, `SLACK`, `TEAMS`]"} schema={{"type":"string","description":"The message medium. More mediums may be added in the future.","enum":["EMAIL","PHONE","SMS","SLACK","TEAMS"],"example":"EMAIL"}}></SchemaItem><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en"}}></SchemaItem><SchemaItem collapsible={false} name={"subject"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.","description":"The subject line in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"header"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The header value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"body"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Please go to the task manager","description":"The body in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"footer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","nullable":true,"example":null,"deprecated":true,"description":"The footer value is now located within the body field. If included with non-null values, will result in a 400."}}></SchemaItem><SchemaItem collapsible={false} name={"from"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"From:\" address in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"replyTo"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"$__global.emailFromAddress","description":"The \"Reply To\" line in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"Daily digest - sent if number of outstanding tasks for task owner > 0","description":"The description in the template"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b","description":"This is auto-generated."}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template is created. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time when this template was last modified. This is auto-generated.","example":"2020-01-01T00:00:00.000000Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"key\": \"cloud_manual_work_item_summary\",\n \"name\": \"Task Manager Subscription\",\n \"medium\": \"EMAIL\",\n \"locale\": \"en\",\n \"subject\": \"You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.\",\n \"body\": \"Please go to the task manager\",\n \"from\": \"$__global.emailFromAddress\",\n \"replyTo\": \"$__global.emailFromAddress\",\n \"description\": \"Daily digest - sent if number of outstanding tasks for task owner > 0\",\n \"id\": \"c17bea3a-574d-453c-9e04-4365fbf5af0b\",\n \"created\": \"2020-01-01T00:00:00.000000Z\",\n \"modified\": \"2020-01-01T00:00:00.000000Z\"\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink