mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
83 lines
28 KiB
Plaintext
83 lines
28 KiB
Plaintext
---
|
|
id: post-external-execute-workflow
|
|
sidebar_label: Execute Workflow via External Trigger
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tz27gV/isY9mGTjKmbZbvWS8dxnI53kib1ZfLgeGYhEpKwoQCWIO2oHv/3fucApKhLLnUz7e5WuzMxRR4cnPuN4ENkc1XIUltznkajKLeuPPtcqsLI7OyzSqpSfbDFp0lm76O9qJRTF41uovqWi273olS5pNA5oQCCq5l2Qpk0t9qUQmYEJaRwqrjTiRK2Kp1O8XcizlNlSl0u/mbvRWmFNrrUslQAvg/oRTmTpaiccrhS4mNUUyauCj2dquJjJFyp8o4QV3iu6qf1Zvc6y4D3zn5SQNCm616XM8apTV6VIpWlFBq3pSkdEeMASX8JpKFGG/49tumiA2E4SKcA/RDIQ3SNPU+tKUHDSVXOSEguH9VLY+VFOapJjG4fIblcFnKucMcxDoMfkKBOgVyTLHMJTOsCPk9JeG3CAFKof1S6UNBgWVQKtJWLjHA5Pc9xsRepz3lmU9yayMwRQDJTcxmNHqJykTNkWWgzZUjJa0ZR0j8aK7kv44OjYRoPD/aT+Fj1hvFw//BgMp4cyElvHD0SI7S9cuVLSIZQLqkJuyUkGVPSM5nnmU7Y4Lq/OuLoYZMYO/5VJSWIyQsyz1IrR09ZWdvA1k2w1uvEFuuSath7iJLKlXZ+UoLzMZTTx9I7mVW42Ft/NqifDcAw/0dMu9wa50kb9Hr0Z5OQ2lVEQ+wPEkbNk/fS4L+b6tykqLFnVa8UbHJLxfdUv5+oiYyPD9VRPBwfHsXHvbQX9w4Pxkk/lQdHB/sRJDBXzsmp+va2J0aoooAywgqhJ0Kahb/phE3gSWQvbSIawd1LJ4wtA7kqbfw8W3TE6Uwln+DXcpzhySSTUwF+GhZTNeG4AipqtQ23aeo001CJOGMiY3GhyqowQKi9pwX7ZtcXiCOIKTLTaefHaTNVpdTZKbvot6T5WhsVTwupiUIv1wQLBTDe6RQrxNwWSniUdbBguM6KhCGJTl+8lCn49fydBmYgprKQySfg+h6rujYa60W9BObUeN6WbdWRkuPD3vFgODkcSjn487B/dDA+nsj9/d7xwfFxy7Jca29ZFHKxsfVflVGFTkRmE2jknxBIoSRkzwTw5hRMSzV339YB4/gO+ZMTediGzdquKf7vIYO9PH0vhkcik2Za8X05XROCia8vccdUWUa26wM3OPeI3yG/abM1PJtqTtnl1dnrk+s3V7hzcfb367NLXBGujXwM19MmJbMEqbCFGafVhgFyLqcyiEOlHfEiYH0BhqRxbUDtf7kFEu6c/EpWWYkVYfctK9qoxaSw8xVXSnyyFM90R3X2xJjuzWWZzMRYOiywPtm+OEkSlZfxmyDJF2KmZKqK5x1xkqbs2Uj4HJod1i+ASMg0Jdf1CCYVXFlxwkftQYEElcGqLpaiXNUGnECXDPGmrRRyDlD+HVEvKSsQx2y2vXAZBU2oQVg/oNlLbpW6q5bQWKQLU8oEXFAAhBgROBNEJvCmUbuEcETqcgg8poZrIhaFwJotDndvPTGvSsvPElm57/C79xnCT8ysNQ/uVHA+LqF8NGJt1GoKESnUVbw4QDXqqh1fTLTK0p3v7nx357vf6bvrDy9CfRqecunT3yx9ro1Ew2ILTp4bpU/B1mOsqIG4vAmK3BMQSCiRfv5wBcf+pAzBo9ug+v8H1kc+lW8Qf9Low98fU/nRKGtFF0Qgy9FzMEEkUumI6V5S3KoS9zd3e22LsYaBmi0lIqJmIRa2EhIiKypjiBLp9kRqlTM/lWImER8lPMI5HwF9PxpzQ7qrJHeV5C4b7bLRHycb7SrJne/ufPf36btfrSQbqthbQp3kqvlcFosw6vPPiVspACDqSelyBsqqWq9WCJloaqxotXKIxoP+uD85StQwlcP0cP94MkgOB/LgqH/UHw8HR1E7198s/bhxslWfaunb65FFTG8OUMdVBsblSmvT1fEfxFuoiX8hsSyJoTsUcI+3Te04ON4yC7ZWvKWZZ6iQ3EoNaZYyopgG2DnBFjUsAKSYIi4agVClrX8HoOcKWAp6aZLpuWbnJS6At1jEJ5MSrHhHqY2s2UWbJKtAIUeCzFLVbGFYGkyqCdV8wMAV7BTR+QdWp62R8ZMreXFBHL8hjsXZ50QpcvSmcj/YNt89N+HV0KVX8BcGvb7bkQYGgIbAx6ym7tzV57v6fJfjdzn+j5Hjd/X5znd3vvv79N1/oz4P1dCX63MAfHd9DthOTzS11Gsyrv96mc6uEihg826ODyxrcK4rYEr1iSYKInSWZhR166MBrhvOE3Tr4wTdB50+8rkeKhE9dVWRYdGsLHM36nYfoDQo67Ejc93R4fiSsfedxM67Y0hqSxCi0wLe4QhAnLw/D01Gh8VcaLJkH/YYuRc6M0Y2C+HzgPirmOngEGlzYSsEOkazJ2D1war4NkjM0VL85Bi6w1a0wR/4ui6yx/+cF4/oC7xsE99XdwO8AKVrLBILt8tjWJdUf/vdNw5jLXMK9WyDjc3eEdhAvFSyQHPgX2M8+/nD1XMxpaqTvb5yVPAqTW0C/OY9TISj2kk90qdFnGgKW0396bKTlZcm5EWCbK8jPppLpcRN+wjcBeIzi5QWKQ4JtOr2Wa2dVN2pjDJhZylJMjydmi4k1JUr655z1uP2QBtczvlu56OJxStNwUhT9iaYwCJ3e+Imr/mSLb6eSsSfamyxxxYzNvd8jQov2pvEH8JJ4MqEQmaOpfXkzT2+uIWPeincIazrNJAkAh2rr7qSWmtPpmMFX0z4Vun4aD7MNFLq6jLhI5hwyIhZKs5FMrPWqb8IQaZDbnAzreBFTybrnjaN2SPiQa9FUuy3jHWMApHpewPHMN6Y5JgS9Myf2ZwgKXqX/IU1C5//Be1zKn5Z4Zlv3yCPEmRqE/dkmmnDmDaMfQxwgX6fpsiw4Nv+ZCod8GMDOF3qnyNBILQV9zyurVGd0Xd5DaWGBKQyFpeP/I/RMsCFK8EPCLqBQRim+rp5+YffIuCiXLUirHoysC7BTXozixS5JjdPbzOZorT5W+OXOD5ZDlDemWzxo6P0FyLJbyfu/o8i3i7S/BEjTah4aRB5sTyIfbY86Nycm37qiWc6jz6xzFPoO9oe9DIUg5vTQhpnzxT+xVPnD/mj1kZftDyA30aUZ7Ikl+GQkcy04jlDrmRJheUema2ds5vnhaXYgm6SEU0LwCAmOBS8cqwz4ONJeL2zZG/0VSsZDf12FTc7tFcyQ9+qOuIDWj+TQOfU9tFZDjz71Yb+7xJqf88fD7yqLQkV3XxeGexGTl/NhYS9fsPcUu0gaRYGukCjallYriubVXWIIDsmFjrcABVz925y6b9uaFnVN/aCUbkwv4boSYvhS4MlIxcqY7MnuNWe4Fu4YcrxTGU5NZ4I6ajuVGuHt+dXGxiBzDjwhQbfFtNuWOS6BAsk1Ht589nv9Du9mHsR3Kc+Dq1yC3n4PmV5xP5OS7H+ici6UT4s5/j/R9+qhMRKHVE3p4EeSbTyHZrvjG+aDwocDzZYtHwVvljZi0Y6pe99ZtRQA/7hgWZA1C8+0m0EHhow3NwuW0FuoWEofDi/+Rjki+p4dhG+G3kutn7kspWJenZpFsuxRYTLT4qmHaD48RZQfhzF9PgH4f1HfLXg0qVeuPFih5pkv8KPuL4Ke9saO7x/R8O+aBw+iZn7CUoh+Wsd/DuKPuJ//LC5dzz6bobuP0T1PBIwHm9dI24rkcIF5A6wfwFChuLE
|
|
sidebar_class_name: "post 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 'Execute Workflow via External Trigger' (post-external-execute-workflow)"
|
|
---
|
|
|
|
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"}>Execute Workflow via External Trigger</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/workflows/execute/external/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint allows a service outside of IdentityNow to initiate a workflow that uses the "External Trigger" step. The external service will invoke this endpoint with the input data it wants to send to the workflow in the body.
|
|
|
|
## 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 workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}}></ParamsItem></ul></div></details><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></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"input"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"The input for the workflow","example":{"customAttribute1":"value1","customAttribute2":"value2"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The Workflow object
|
|
|
|
</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={"workflowExecutionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The workflow execution id","example":"0e11cefa-96e7-4b67-90d0-065bc1da5753"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"An error message if any errors occurred","example":"Workflow was not executed externally. Check enabled flag on workflow definition"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"workflowExecutionId\": \"0e11cefa-96e7-4b67-90d0-065bc1da5753\",\n \"message\": \"Workflow was not executed externally. Check enabled flag on workflow definition\"\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> |