mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
87 lines
31 KiB
Plaintext
87 lines
31 KiB
Plaintext
---
|
|
id: list-workflow-library-operators
|
|
sidebar_label: List Workflow Library Operators
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW1tTGzsS/iuq2a06ScoeAyFh4WXL3FKkSGDBbB4IVZFnZFthRppIMxAv5f++3S3NzTbBh5PaPSflPARbI/VNffla1jwEOhOG51KrkzjYCxJp80/a3I4SfX8qh4ab6RlN0MYGnSDnYxvsXQflFBvcdIJY2MjIDGkAhcFEWoZkLMsngt37mUyXZBi/4zLhw0SwXLOpLoCuFVFhZD4F2g/BlRXmQKtcfM/7RT5BfjbbKwntGcHj4GYGjI2wmVZWgEgPwdbGBv5pC3MKcjA9WiIFMI2Qh8pxFc+yREZkht5Xi0sfAhtNRMrxUz7NBBDjxvAprJO5SIllLvMEH5TWYKWp0FJujR5+FVEO3zODrHPphJVxg67NjVTjYN6QJTF2chjCQ/GdpxmxA2NEOs24Ed2h1ongKph1AsVT8TuIjowUKk6mjNY1yR842mzf0Wb/5kkBUs9KneZtXJGkx50FAWrKZ+dHF/3B2QXSatF4SurD+hvuJvqVrk29KHp+r5k3Dbsj8RlXMYtFJGNwyQnP2QS2XCjLhtyKmAFdJAoOVSR5iPKNtEmPpUhiu8QD5gygQBzDUg2cpcoK8nxg0RST8SgSWW5b7vNDF5mIJBtACKxqnaFwAYeCsxFKDsLQyNVJy0gDGMJNx+gbyzv6m2PQRsh85MOARTCfy7Eia0C4iuRpSfpsUqRgcwxRCnDiM0LfQAZPinbgebKP6JQrO3WlkfcN2gTGc5g9LPK2dytP2YhvhTSiGYdlMC3aV+kcrCtHXg2nAfgUK6ksZzbiiRWPxg1KjU9KqWvrAA1VJJQig73cFAJoqiLFRIhJEWMM/oCjc/hYSw3ZSibwtzAJUUiHAsOD8hlku4mIbof6ux/JOGRWTLyJc74UHF8OXATHhasIyEiPxwmOQeAoyHfTcxndEtmxvhNGcRWJd0YXWTVe7VHl12XUQJI3AgduxZSSyjmXlIhJ8IoAj++QajxwrG+au0fqz9Ckc6nX16rjOmpnjXXX87Y/gsxvyOrvL88+noMtMAq4SxaQG3XacCR4EpWJRUM6NJJ8ex+zch2lQVCFSVDN6QelDwd3fqwf/j1oup/bX++CTr9OM/qDS9oiSGCsKtVhg9dZOVizauRGTRpbMkG54uhbAY4JD0lbGPCZ3o+7yrpUPO8tKODPt2d/BXvuL9pzf86eFHSLBl0m7wB0w8x9jEueyf1J3jcz968TbC9DKAcJ1OGcHRkDgnTZhcgLoyChyJGvSN+geuVQzeIpphypwKQyDp8BXx6pM7HIIfoOdLxCoj2WSnTHhkuUUJDIESxkQPFOxrDCFUFHssxrNK+NYMAS4Sbb5zHo6/Q78MpgaBse3QKtkxUw0pWSsJ6VS5iMfbVZylbsCD58u7G7tT16u8351j+2N3feDHdH/PXrjd03u7vIPRXW8rF4uuq/E0oYGbFER7Aj/wGDQD4G25MAxHz1Wk80Vix0bm6lppeXobN1IOL2D87Z9g5LuBoXNM7Hc0ZQ3avLhQqDNZ4Inxk5lkshWVmCDo+O+1enAxi5OPrX1dElfEJaC41AX4G3xuiWICr4wgQAcl4rcM8tc/lExCF75am+AoW4ss2J0n2zUwvGBN8accRo7JXnvmRFk3SdfMpQilxrwV7IUIQdNsSxlOfRpI0FX/UJsXVPvSVfsQmgGmFehqwfxxKV5EmJLlM+BUKMx7GosM2ogFAGYWQ+0ZD1AEPISLT3ojblfL0v69tpc1NmrvCvgMOiHFI5+UQrCitv8SL6/QGZneXa0g0aRiOTTlXOI9CCJ9A3RNoYrEsAepgEyOvTEW6XhcSjynlVxmqWbUp3H5wwh7mmZxEv7Apxd55A+umSatWDO+GDz2JFcdmIdqPcJp+RCOm6WClnVdtVBn4Fwdaxu47ddeyuErvzDy/8uYx/StBncxH6XClegH0NFc8F6GPIexSgSD/JtaVuIzsI2zxEev9pAIF9KxTOF98zhGI/ER+5Ur4gfL/aDzc+RPhRbVZrL1BAsqPTYASZSMR7JHctcVCjxNeL3KCvGUpwULUEIkLWNHiMxhBQm0IplITbDou1sOo3POqA/IjnD9ZWvb5QcTfTUuVrJLlGkutqtK5Gv041WiPJdeyuY/evGbs/RJKVVBQtHifZIk25mTpP889RW85gAit/IWRVyPkzzzZaQWKswlhBGzkEw63N4eZoJxLbMd+O377eHW1Fb7f4m53Nnc3h9tZO0Kz113UcV0HWjqnGfrt9JBMDiLsDHFcocC6bax23j//AvEaMMK3RwWqJm8HmYXXECNhxa3fJ7wxasw9cTUuEZFsYUtU2wpwGc1Oca8q5MIHTz0SKQaqSIBe6kkwFUDHgNCyRqaTgRS2Arpl2+yM8XXWBUjpZxUWqKClAQsoEiUbUrMGxJCgpRoj5gAIh2DFk55+ITv0W/SEkzy5Q41PUmB19j4TAQK+Q+5tl57sneNKMOeLSbfAjB72u2+EKHAAaApezKty5xudrfL6u8esa/2vU+DU+X8fuOnb/mrH7O/C5R0OP43OYsDI+h7nhBquw1DE61/8cplOoeAnIvZmOosLQcXPjZ/5UgCuhQGO67EIXbfaCXnkFsZu4qyq95lVEh/6dXHh9Zy+Y5Hlm93q9B9gu2KZZyDMZlpdwlL4PI532hmCjJekH7wm4UMMJrH9+4tuLkAzsbi64hEfEnblJJfRWMDsdDf+QcnnfaqoLSHFEpoPXmbw/0TDd8lDT3yzNDsl/FvQDva5MMvvjujhCj+iyzHw/5AbzGUg6pyKqcFNfV71E5O24L1xarasJdmtbC8zOcNoW2xfc4NUZ+gHjxftPg5dsjHiT4r2wCHWFxAYBIuYcXITyWb88zMdFVGKMLsYTErzf+rkE44eh24Xss7oUgl2feCN8hER/AZmZTIqLBCUDXHXzotydWNyJBB01rC2Jjidj1QML9Xhr3Uuqd/4eJF5nc5eVPqsuO5SYhvAqEs3xKlKfx66zUi/e0Ou5QvytpNZ11LpEzb6ck8KZ9jpy128iCGIkwRNL1no2c0ev26CHXRSMINV5GdASXo72j1xRuWvPlqNFr4v02nJ8Vp8mEoppexlzuYtZqIVJzE5YNNHain8yhq6DYXA9LiCKni3WPTLtUkR0tzYaInUdy67sAjQk+U4hMJRzJj7E0kzIRANoU7ELyS+0sxDzX+h275eWzjR8DRUUZ8Y6ss+WGRl2kWHX5QDr5XcFCh0LYttdhoegdw5wUO8/ZQIvaCPvOVpLszqR79EaLA0RiEpUbLbnvuzVCc5/YvQAZ1dzIA0jsq5+9oPvzNPCKtUyVnkmMG/BRXkTDcVxzm5O3upMCgvmn01f1LhfH52cqWT6s7P0I5nkz5N3/08Zb51pfsVM47EuulvzTZimk+97vLZ4lIdnzRMB/8NTilWC1dC0UBtGKKZJKEt4TpfjMaqjiRR0CJAJniP266Bn6ZQiEfp1DH9o9YjQ2MAcCFsLmJQPZQL06Ji65MwpYBywxH3F77agToQuKU+gqRQh+wR9mYpgW7Anw4sW8Oyr9s3ZJV5dx41lh+VmA+hK00IBN4zLImX4uskTHhFLGxUucUGLpkRpC03Qr1pVRjG6GqoQUndiUns2wvNlaF0bG/8EL9j38i0oMD3uor/bXCtyIRLu7o935mD7U7TB27p4m5peHgGxoMdrcPhwMligqPF1HNALum9txj2/yPZwLhDB9si5z+twM9zoUrsA45m2OfSxDeL0zlf1SpZ/MaB6NcvOu+NDfbz+vHfXGre9exkeWaFYhetEXPN3Hcw3f0GnuqRPr9BNQAuc9/CApxvYD81wGLp6bJ2vb+pWB7/N8KY6nnJQv3grqLumc5C6gV78pQAbl6o3fXeEO8AfqYH+A7Kazf4LInOqFg==
|
|
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 'List Workflow Library Operators' (list-workflow-library-operators)"
|
|
---
|
|
|
|
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"}>List Workflow Library Operators</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/workflow-library/operators"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This lists the workflow operators available to you
|
|
|
|
## Request
|
|
|
|
<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of workflow operators
|
|
|
|
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operator ID.","example":"sp:compare-boolean"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Operator friendly name","example":"Compare Boolean Values"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Operator type","type":"string","example":"OPERATOR"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of the operator","example":"Compare two boolean values and decide what happens based on the result."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
One or more inputs that the operator accepts
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the input attribute","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Denotes if this field is a required attribute","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`text`, `textarea`, `boolean`, `email`, `url`, `number`, `json`, `checkbox`, `jsonpath`, `select`, `multiType`, `duration`, `toggle`, `identityPicker`, `governanceGroupPicker`, `string`, `object`, `array`, `secret`, `keyValuePairs`, `emailPicker`, `advancedToggle`]"} schema={{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></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 \"id\": \"sp:compare-boolean\",\n \"name\": \"Compare Boolean Values\",\n \"type\": \"OPERATOR\",\n \"description\": \"Compare two boolean values and decide what happens based on the result.\",\n \"formFields\": [\n {\n \"description\": \"Enter the JSONPath to a value from the input to compare to Variable B.\",\n \"helpText\": \"\",\n \"label\": \"Variable A\",\n \"name\": \"variableA.$\",\n \"required\": true,\n \"type\": \"text\"\n },\n {\n \"helpText\": \"Select an operation.\",\n \"label\": \"Operation\",\n \"name\": \"operator\",\n \"options\": [\n {\n \"label\": \"Equals\",\n \"value\": \"BooleanEquals\"\n }\n ],\n \"required\": true,\n \"type\": \"select\"\n },\n {\n \"description\": \"Enter the JSONPath to a value from the input to compare to Variable A.\",\n \"helpText\": \"\",\n \"label\": \"Variable B\",\n \"name\": \"variableB.$\",\n \"required\": false,\n \"type\": \"text\"\n },\n {\n \"description\": \"Enter True or False.\",\n \"helpText\": \"\",\n \"label\": \"Variable B\",\n \"name\": \"variableB\",\n \"required\": false,\n \"type\": \"text\"\n }\n ]\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> |