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

97 lines
36 KiB
Plaintext
Raw Blame History

---
id: list-trigger-invocation-status
sidebar_label: List Latest Invocation Statuses
hide_title: true
hide_table_of_contents: true
api: eJztXOtz27gR/1dQ3oe7aERZr8SxOp2O4zg3ziSXNJabTp1MDyJBCRcSYAjSturx/97dBfjSw3Z86fVyVT7EEgks9r2/hUBeezoVGc+lViehN/FiafJpJudzkZ2oCx3QndOc54Xxul7O58abnHtuhPE+dr1QmCCTKY6D+T+K3DDOkAzTEYt5LuCTrEgxQ7SE6X1wZIXBgaYIAmFMVMSNwUApE4xfcBnzWSxYpDNWpCzXbDhmC11kpseaRCIYKMJ7ERg/dQQ+qOlCGiZUmGqpcpbwJdMqXrJI5MGiXK7f7zfJdhlXITNAIQ6Z0jmbCZZnAoQNGUf5M5FmwgiVW6GBt3wByxdxzGC1XGdLvNag2APtpjzjichRr5Pza0+iPj8XIlvCPQV3yDyJzL1Vpb/mV0wVyUxkSBUWLmKwAvCdibzIFKpaCHb+9xE7fHuCGlMhz0J2pONYBMTg22rpjz8s8jw1k729UFyIGL2jZ0B/pJ1eoJM9Gao9nso94+j4QUXHr0V4RMpONOhfKviYkJwoZiY+FzIT4G0Rj43oeuKKJ2kM4g0f97ueCRYi4d7k2suXKcoM6wpwNphpydhLoyFcSKSSSZF4E5iX8Cv7maiEIuKgBfp2c9PdrE0dRUasq/MNXQa2QYOV2axWGdzosTNT8BhcxKQikJEEo1/KfME6ZJ0OKj7lc6nAHWB+pov5gug4w3wz5vgVxqjUv135gS7Uuu5PItbJs0J0mMxBq6D4VKdFbFUpWOcf/lTnPPaPcHYHVZpC9Ai2EDwE9yc74MAN4bDgQJEidiZcZGCyiCq7YUx3rE902KVAVc0VaCwEi4HNpApwHohhcqnmEOU5ssJIEBZwxRb8ArINAxuRcnC8TFIe5F2UBrJMJsBiCeQaYdMGeAokCVi1Q0T+QpJ3kCfi9oLHhbBacEkGMp3j5pvwIJRngxPNtI4FV17DT2jmVl+JZExpccNaa8RNnoF1vJtVz3pBNCp3KAzaEF2lFJuZJeTrK2anzaiQ/MY6/s4KCpz5js9HaOwX5VX0IVOkqc6w0qA9KD8BKX2JtyEXxaEhR7ZlXWdmghQ6EFS2qIedzoR1xOeOvWyKWaWk+p7XsKFXzWTiM/vggSQTTsXad8Hgh0uwkwx8nqaZvhDZB8/bZkmDrH+ZJRupBqOH+0agxkAD60Y+BfK/cxOjBlYNfGqv3c+8YKLaml3WtOBPsEiXBRaJwAeNJoSPnbZF3QDv5iOawWZQg4oHnIN/2jp9dTeWA+qBhsoACR2mgxvE0g7Z+8Ugjet14/Is4+gXMheJaVzXs19AZy3/OAefQ/BZygyf226LF3Ke5TViPVFpgUSIaHs46gj5dToAFYDTgjVzaXUAa21wwZUqVevg5HlLtf1oMIiGfOzvBwdjfzyLRj4fzkJ/fzx8/LQfidEsFOi2tTB3LubA9upK63FoA2JFNXeSP22Mf7A0tMJdKz0XkVTCkFM3NIiTejYbTY9Pp1D/pguE01bqS8DTzuVKcI1u2GUCSj3cv5CcCJJvNmVnsyLP4Q9EON4/O2G6Hk3uwlb9GbKAY+Td8eGrf01PXh+vcNNaAKI1lljxId222ZwtqQcAcAC5QuEa7CSEDzJf/qQvMVyEQqQEnRRIDF+r9dAfa/27uzCPvq52ZFNU903ty7elzhBG+Lkk39/qzI4Qw3GgoiTtsZPTN/7TJ/0BynA2Peq1/GPYH/b9/sgf7k+H/cm4Pxn0e/ujp/8kpsrk8xXYKknVjP2ZiSTNl2XFA5gFeLxhSonm8KNYzhc5Gh7xU0Xmy6QaTgbjSqqNeWYtZT7nOdo/tsrUzt2wC3R+VHPaK7NUI/W1E9J/L1XIkvtVBqqpmA6t39LuwLA/GA33o5APgvF4vz/mQX8weDoQB09G4fjJKFgvyNNKYFgK2qJlrDnqH8qzLQloqZASQ1iGaqkkuiytkm6qCvPSVZRbeL7U2acIaibyPBiOxmtcvTx98xN0+mm7CWdQoTk4JPdubuqgO91k8YZ/f7EzIOB/oCvEMDKW/xbhcZbpbJMWVkp3OZ4JnAACGsPnArmQKsQajf3K2rYJBoydAJ0IV8veSjkmNjBiHb31IupGrOnitWOgorDqz7XTHirHwwJSqw6CIoPV/4SaL1fdSj0XV/mttI83EW7YvNKbo4ir6iK/O1ocAi5B7dZwsMRsl9fIbgvRdIcHRElDhqMt/tkcs7bFd4P/ut54Ew48iiXWMqs7n71rdNB2d4MyC5vpcGnTL7SvMnwINtzi/SGEp4yPdHgPrPECVOXPM04as34UwESG5pEhgmnqZC3Jcn+OxrVrAWiiN2DPeAjyWvmOnDAE4njwCWjdJzWfKQnzWTmFyRrgb1hW7As+e9I/GI6jJ2POh0/Hg/3Hs4OIj0b9g8cHB40wMBtA9eqerILuMWBV9kBoAronBmjx23D4tsC+oxItyiCvxEwa0dmFtPPs6C0b70NboeYFXefzFSUo/+wUW8cipu1bu58AklvCbyAApNrESgmunh+/ODx7ZfHV384ISyGttU3rQ1WmQ01bRgt9SRw7ARDbGYGtHEKHjqPaAYG4Ms2B0n4zSyiwCXN7GzDDrb5hRpM0izKdtEKJ4uYqZz/Inuh12QyvAWwKFmzGDUzQNhN0DqG2p7n/ymmy43bDHvXYYRhSagAkSptJhva3Z5D1w7BOJVEBoSxo8wwSE2IlGYi2LWpVtq2xkjNLo2BwYBK+008Og7wA5kjMZhRW3uJYLMtV6DTX5m7aUBqpFNt86LwD2qYNNGT4IMeGgElIqS4dUbcNiUeV46qM1UyRlO5cGXiea7oX8MLcI+7expB+fBKtunEhXPDR/rzNRmSN0kwuI7mtZ5rsRlXmKgPfgt9d7O5idxe794zd1Zvv3O6Xu0vQZ7AOfc4UL0C/GRXPNeiTkfcozcpBFkRbQ3aZhdGoiJfvpxDYnwS1p+IqRTz9FfGRKJuCFTNV9nDbnuWuaFn6a1sgg6RHK4FtDCbEd82xBYmkqtH6ai90NpPgoGoDRISsmbGlLuhX2axQin5GMV0WamHU97n7AYU6VZsB7S+zvt1k3SHJHZLcVaNdNfrDVKMdktzF7i52v83YvRVJVlxRtDicZIok4dnSbW3a+ygtZzCgPslShRyZahWtIDFWYSyvjRy82XAwG0T7gRiHfBw+GR1Ew+DJkD/eH+wPZuPhvtes9ed1HFdB1o6phr2tHUnFAOIuAMcVCpzL5FqH7e2/An+Aj+hIXl5DYrAdALibjxV2HB6sY8ep1uw1V8sSIZkWhlS1jjCnwdgEx2blWBjA2RzyosITOFLbXXaZCKCCxwUYHfPB4EUpgG629A8jPBPiDg85J6tWkSqIC+CQMkGsETVrcCyJJ3EixHxAgRDsHLLzV0SnW/e3vwDJs3co8SuUmB1fBUJgoFfI/fGm/d0TYD7DHHFqDbxlo9d2O1yBA0BDYHNWhTt3+HyHz3c1flfj/xg1fofPd7G7i91vM3a/AJ87NLQdn8OAe+NzGNvrswpLvaDjzb81TKdQcRyQe1fnHGoMjoeZBFyU+ZIWOQNcf2Rd+RBAO0amSSfulIGPoB/cza+PJ/j29OcEkhwdwLzPWDAjHRfBg6eJAD9GbczpEYyU45reXkmk8WzMnimfP7Kth1VKkcUwvjyUew2+Aj5y0+Op7JVnlpS+pJO5MzDQhtyHhxRsnOMAOgNsF+iRdTOJAWSzLRG3tnYH1r3q8O+tlPHYMzrRUheQX4lMF088Omemy3gABDqZ7w2N7pHzrskHcp1l8c2vl8US2iLLJvXduhqMZ8Dpiogowsfav04R9tvV17ysLmXYKg7XFnuDw4bsmeAZ9CT215MfXr6fPmJzBLuUbOxBb3cglLO34CKUTA/LXxJwEtW3+mGcw9ZvNRi8DI+M9Zh7tqJxXpO9g7JAKsVJgjIRzrr/kXDemrflSYoPymfPZWZPjBsa40S0T5ucp6VcvCHXQ5n4rqTmu5OBRA2Po7e4sKo9D+zZnwAyCJLgsSFtPXhxS89v0MMWDq4g1VUe6Kk9y0f7F7agtNqD+WjR85Fem48P6v1CQiVvT2M2d5UPAJ6wYKG1EX9lDF0Hw+B8XkAUPZitS1zUp4jwh/0GS75d0pc+4FLi7xUEhrLOxGeICwgWaUCMKrQh+TNZFmL+Zzqp/HNLZrp8DuUbR4Y6+ILnHFZ4xgV9XNC3OcA4/m11RMeC2EYZKA9YBziq7U+ZwDHayHuW1sasTuT3aA6WhgBYJSpQieyXSZ3g3CdGN2y1cmMgDSOsr35zhO/M0cIS2VJWuSGxqsF1fmMNlXlFb5bfakMMq/XvTV6U+LDet3mj4uXXztJbMsnvJ+/+jzLeLtP8ETONA9robrRsee624eTPHF5b30c09Mwr/A93jT2zDZgeOqb6MdcmoTTmOXo1RXWwkIJ2IFLBc8R+XfQsnVAkppnG8Ic+kwjN6amPDFjm0DPKGOjRHnm5MqeAscAS7YrfTUFtEK4VLKCjFT32HppCFYBZsCHEUx5w7xftOsNTsMxbesD+eWlsAF1JUiiJT3HorEgYB5e6wyNCaYLCJi7oD5UodaEJ+lWzyihGV0MR6GS9yBLzJjq1zUnD8HesBXY3bmcbVI9WdI8y1oK8w8P9mDxgXBu230UbvM1fiDjFlhSyLgAw0Vjh9cl0jSIQUwbkgtZfZ/M9N8ns4Vgggu2RdZ9Rb9Dr+9QuwPVUmxy6rwZxeqzvlX2mr/GsTfk+hVV3vK739ncvefgVL3lwdRQboL0Utw3ROoVtyGwPfO5t6IE9evQIu2DoqxZgTBx3fY07TNgW3uBl+6gt9sbgXqiK+tnarab8tl4dsVF5nwTu2ZRvxnC7MvYJ5Pvr4f/rnQ+36LF6J8YDFbl7gcO39wKHW9yhfEvHA71h99KFL3rpwi2GqF+B8UBT7F6NsP3VCLfovX5hRa33j/WWKpTbjzDWZi+qvXaa/bGnMWvtOERrD/zHY0R6fEuv7T7gUjc3/wFZKqkv
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 Latest Invocation Statuses' (list-trigger-invocation-status)"
---
import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
<h1 className={"openapi__heading"}>List Latest Invocation Statuses</h1>
<MethodEndpoint method={"get"} path={"/trigger-invocations/status"}></MethodEndpoint>
Gets a list of latest invocation statuses.
Statuses of successful invocations are available for up to 24 hours. Statuses of failed invocations are available for up to 48 hours.
This endpoint may only fetch up to 2000 invocations, and should not be treated as a representation of the full history of invocations.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"count","description":"If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.\n\nSince requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.\n\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**triggerId**: *eq*\n\n**subscriptionId**: *eq*","example":"triggerId eq \"idn:access-request-dynamic-approver\""}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"sorters","required":false,"schema":{"type":"string","format":"comma-separated"},"description":"Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)\n\nSorting is supported for the following fields: **triggerId, subscriptionName, created, completed**","example":"created"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of latest invocation statuses.
</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={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Invocation ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"triggerId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger ID","example":"idn:access-requested"}}></SchemaItem><SchemaItem collapsible={false} name={"subscriptionId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Subscription ID","example":"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"InvocationStatusType"} qualifierMessage={"**Possible values:** [`TEST`, `REAL_TIME`]"} schema={{"type":"string","description":"Defines the Invocation type.\n\n**TEST** The trigger was invocated as a test, either via the test subscription button in the UI or via the start test invocation API.\n\n**REAL_TIME** The trigger subscription is live and was invocated by a real event in IdentityNow.","enum":["TEST","REAL_TIME"],"example":"TEST","title":"InvocationStatusType"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Invocation created timestamp. ISO-8601 in UTC.","example":"2020-03-27T20:40:10.738Z"}}></SchemaItem><SchemaItem collapsible={false} name={"completed"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Invocation completed timestamp; empty fields imply invocation is in-flight or not completed. ISO-8601 in UTC.","example":"2020-03-27T20:42:14.738Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>startInvocationInput</strong><span className={"openapi-schema__name"}> object</span><span className={"openapi-schema__divider"}></span><span className={"openapi-schema__required"}>required</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Data related to start of trigger invocation.
</div><SchemaItem collapsible={false} name={"triggerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Trigger ID","example":"idn:access-requested"}}></SchemaItem><SchemaItem collapsible={false} name={"input"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","example":{"identityId":"201327fda1c44704ac01181e963d463c"},"description":"Trigger input payload. Its schema is defined in the trigger definition."}}></SchemaItem><SchemaItem collapsible={false} name={"contentJson"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","example":{"workflowId":1234},"description":"JSON map of invocation metadata"}}></SchemaItem></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"}>completeInvocationInput</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Data related to end of trigger invocation.
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>localizedError</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Localized error message to indicate a failed invocation or error if any.
</div><SchemaItem collapsible={false} name={"locale"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Message locale","type":"string","example":"An error has occurred!"}}></SchemaItem><SchemaItem collapsible={false} name={"message"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Message text","type":"string","example":"Error has occurred!"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"output"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","example":{"approved":false},"description":"Trigger output that completed the invocation. Its schema is defined in the trigger definition."}}></SchemaItem></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\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"triggerId\": \"idn:access-requested\",\n \"subscriptionId\": \"0f11f2a4-7c94-4bf3-a2bd-742580fe3bde\",\n \"type\": \"TEST\",\n \"created\": \"2020-03-27T20:40:10.738Z\",\n \"completed\": \"2020-03-27T20:42:14.738Z\",\n \"startInvocationInput\": {\n \"triggerId\": \"idn:access-requested\",\n \"input\": {\n \"identityId\": \"201327fda1c44704ac01181e963d463c\"\n },\n \"contentJson\": {\n \"workflowId\": 1234\n }\n },\n \"completeInvocationInput\": {\n \"localizedError\": {\n \"locale\": \"An error has occurred!\",\n \"message\": \"Error has occurred!\"\n },\n \"output\": {\n \"approved\": false\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>
Reference in New Issue View Git Blame Copy Permalink