mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
101 lines
42 KiB
Plaintext
101 lines
42 KiB
Plaintext
---
|
|
id: move
|
|
sidebar_label: Reassign Certifications
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXG1v2zgS/iuE7sO2Rez4LXHsLwfXcXteJE3Ocba4S4OWlmibW1nyiVISb5D/fs+QlCzZTpx0i30pjAJFTJHDmeG8PEOJvHeUcJNIxgunfXXvXCoRdcMgFndxJ4mnaHOkF7RdEcVyLF0eyzBo36K7cK4frveccC4i3dj3nLYzC2+Es+fEfKJoZDc/inX5bM7lJFAOxnlCuZGc0wOMG06lYp3zPosEV4r6sHgqmJoLF+OFxwrzKzaOwhkLA8GkJ4IYvLM4ZDwIMSgqsw5+fRUBu5XxlJ0N3n/uHJ/2P7AwYt3eYGh/cUgXktgMU0fif4mMMA/IuNz3MbthqAxp5jziMxGLSGkNSWJ4zqGbPSfAA/ySHv5W7lTMuNO+d+LFnFpVHMlg4jzsOSl5px1HiVgXXhTlAwtGU6x/DMLiDj99oijG9aNxq1FvNEWrcXBYGx2MRkeNWoMfHNZbTe/IoRWhyYSK34begphZndulxQ1iesTnc99Ouf+rIl7u16UIR78KNyY1RLTWsRSKnhYY7nu6rSjWiVQxC8crovWPFSk5XWcyFjMPjyK+wE9Y1kxt1OJMBn3zsIof/M7+qB1Ucjq6cjiUdNBqHDaazVajWa1Vq0sl8ZFbxRxbutS2d6nD+knVRophuF1hsJE1oTZZQmbR/WNS1O1UulPtDJG4keKWrHUkMJiZqYVXfqGJpBp/DjPUg9aQ5gc/kOgG/Jkpg2RG6u4f9z4M+8P/kFMv2chaHx6snox5PT1lN5zNID3JLe7mPpfw4elCz160oluuMhMSXkEBy2Y2hsercCaYnZ9YgWp1t44HcxpolQ5SW3ywzKo5YoxZtVqltm7Zw6nIZmcxV1/BIY/ZlNPSIO6oZDSTcWz09J387bnmg1Wy61XUGLFZtJSa26oeVY4Om9WWEG6lWak2q7wp6vWDA14/rPBvt5QNM7PTMBLshvsITWzGF1AU4x5MiWGNacw4iZNI5A1r0OtcXPTff0CTjtifcw3ds9Pzk96w95kCev9dv9sZ9s/owbv+h/7Fv9aal/07p+cdS7Q77P/SKbalf37uYrJhL99y3CMCRStf4YsUxqOJiIcvVhtFPWNFmX+bzAoNQYejhclI2thup6HSC40GFYfRUolm9j4sXwq/4KVrCkllLsiTtWaS9F9sdlqSpyV4vh0e1RsuMaNiHicbssImVkzflJ1sPquIf1/2LnuUVbFw54Oz94PexQV+XVx2u+av3mBwNiiqxY4BHyKKwijPx2NZ6xEv9kOgi2eahumrgxgJMhNK8QkEAjLbY5y97Z6zRpP5PJgkup1PVjJBULokgYLE9/mImggAQAhD+CySE7kxJqeqOu6961yeDNEy6EEFF/iLaK2Bt04A+/PI3cEq1D4NbzXHVgCK1Ur4UAcCIntjqb6BQNzCPNtRWtC3UGRCnhjzxI8xws6+YUSetMGEJlFqAMRcA2PZK1kW5T3YJNpmPEY6HXFlrJK6v+m4rpjHpROryTdsKrgnotcAkp4nSUjubw9dGm2GScyAQqUrimuxVGVxNZb56CS/KOR+4Hy7nXTcOAFzWkxr8NpEM2uxLNr1Ac9Gc0XuhjmlaZUugpi7kAJIeAE1RhE0zEaQTcaK2YSmow9SV5D2kwF0JBF18mm2R9ycGmaO49B5/BHBxXX5mG9RpPG8NNHeCJNpReCGCdihGDha5Bw+B84IUQwjLv3j4dkGmDrIdWMx9bOz+LACQiIwsFUQm2K07ej1kTgwJzAXJursNhDRSyJsOpCFNDJj5OUYMBC3L54cY37HvLy+tiovTpP50cW5O5fDs1Nkt26Wjk+BQAu2ONhgEDqop0TW1mW7JvOK3C7/JvEf5fxpxrW7oI8LirF4Zpb20BVlMsxaAhUTjrbVRQYt4P2WIqkXuQcBE4NpYIkGFTN3pVYpVVqlWmNYPWpXK+1Gs3zYqv+3oPXCHsAQk6yonIDtdiyaOdoaFMwjLicH5Zb4ZTvCWAKMJT5IU/3VdU7JT4lMQjcqlfUI0/UlxRYd71iJDQTSBZUnclxIVyMU7BRUszj63WoHT8Qwmm7oPcPb3slAlCYwMuLQ5BIXA23pR6huRkjekCzknKI/QhPlKnuLEDqw8nWtMGQbEXe/gtZz0OVlIDGepUMQejJItGFa0RR8dFhp1RrjwwbntaNGtXkwao15vV5pHbRaeh/B5JxNMK449XsBv5auyZnyNyjEFJKaAT35DvntkN8O+T0P+VGy4ol6ht+d085PSYuWPbhJd3H09qHdiKLVSJfJRiQ81CiQBqfbVakuUsc35fHOd3e+u/PdZ/ru6sOB3SS1TzX0qa5Dn8vAvmah5LkGfSJtPUGYvov5zVRXZiH36H2NhUg/fxzaVzroL+7m9D7jO+Ijk8rXmO9k62HaRwQ/ssUqrAUxqPVoJBgjEgmvrflecqwVZVRVX5/tXRiNJAw02AARETUjtggTxqGyKAkCs/+/x7xQqOAnWxFzeIRSJgLSrIFXmofSFEo7JLlDkrtstMtGP0Y22iHJne/ufPfv6btPIsmMK+0tFiepZDbj0cJYmn1O0nKGDix9Xc8yl9NLtYpWiBjLMJZTRA7OqFYdVcdNVzQ83vAO661xzT2s8YNmtVkdNWpNJ5/rr5Z+nDlZ0ady623W0byYFNENcFwSwLhUHIZecfsP6o3EmMKa/pgpxc3QOVR6vcSOjXXs+CGMIRsIAztGj2wvXg5OiL6IDHnSW5hEriCYbVRnXnsQpCQbhqbNG5kddNxBx1362aWfHyP97KDjznd3vvv39N0XQcfGNujYeAF0bDCCWGOCWH8mdPSAOwiajbEokMFNoN6AYOMcouAvu/to3d68Ac+AXgFF1lobPmsNQ3bKg0UKllRhJzJYqovCG/rOqG+U9kUHziYIkQFD1JJAt2RV9J0BMCl9d+DLmdR+TAKBbrQodcYxpDI+k9pbNosMXD8Bhzoo+CHtvYawMQlzEmOCf6Cg90EnCNTfcY/Trtbv2g9mA5L4hCRmvTtXCPL5bP/3YNNXAn36jInCxYVZ60c+FzB75jxAGSHu5iZ8ZRB0B9V3UH2X7nfp/sdI9zuovvPdne/+PX33BVDdoqHHoTo6PBuqo2+5wjIs9Y6M6w9H7NpVLAfavFnoaqzuLTG4xhUwJWJoHuqNVn2mtO3sp6c/1f699B72c0clTRlguEoiH52ncTxX7f39eywWFumhzOeynH6dHYS3ZTec7d/UN4Qe+tLUuBmCl5e4unSgI7hmkrJWcSTJik3I0xMYhWuhyF6heP2JwZP06ZAsreQCZQgzZPboi25rUboZbM5RTvykdO+ytqA1GSHbZeQ/bJPnl/pTchgij8ixSX1PzoX+DFyuiEfsX+9lB6svCHeb2deOVy9zCe3419YmO6NuNfZW8AhFgfkI5tXPH4ev2YTQpvb2RBHQFZLKA/jLOUxER7NO+kEIDdIJJgqTiTlN2il8ckPew8Y+BGafggsh2FXfKuEDwvwAcVmrlAYJHQpo1PWrdGU8cSN8yoDlpSbJ8KQX7END+7ww7rXOdroskIH5xByt5U9BiR1LCkLmiDf6WBF1lceu5qlcPCfXtzLxj5RayVAraWrq9QoXRrVXrvmE24ULEwnuK62tb57c0Cvl6FENhRaiusoDacLyUfxQyk1X7Zv5KNArEb0iH5+Cj/qEQHEYM5GLKWRC32N95k7DUIl/MkamQ25wNUngRd/Mlj6WUNIeUapVciyVzJQlWQIw1PydwDECY0x8RIlZ45LQbJFol/yiVxY+/0UfffhSkFk3XyF/Uk8vdNU380wTlmjCkokByvJv0hMZFnybZDDH57UBdJfrryOBZTQX8wytjVFdk9/XYyg1uGBVU1HztvnRXgY4+xfTD6h31gchmHB19ukYXX5gaVGOKigr3RFY1eA6v36I1LiiN8Nv9l6T0uVfTV6SuLPcODkL/MX3jtKPRJK/Ttz9kyLeLtL8iJHGIl3agBwsryXpLU9/rV8j8sdd4LF6f4c+ifaME382FCyvuFhecPHk7RN7DrmdVr8tjfLOblDr+nYm7bdPBf7HUx2xdGmBws1cb0NYLk9m7vOYfFvHNncqhd4ImQseEwLeI/8KZzoeAfZTEES5qwlN9Bk3sAxUzkfSp9Od7KMwR2wjqjLpA2RQ/TW05eYFrO2cjJUdpwbM6AaPJKDrS8BEMmN0WneLlXtSuYkJxig6A5FKpi/zYdmoNDKR+5AqyrreimbqbEw75ijGc8a8ZS7YsrLb5VAkrYi9yGcpyED45q4h9CuWIdtow4NKU+HPacGRSQAqRW6G0/5wjSKIBfYdTRhN9u0gtU99QYRKPmMM9TKqW2qiihFFeY5uekaUFc5bqlV7ul++I/hrX7pknYwKpX19EwyJnZjCzRTKV05WKKN/W9/BlNXKcO4pVdXodX9PG0FUOD5QM6IQ7TLQsc60LtT1NJaP/kYMGCNIrl7SlNfbq4Fl/LV+lfXU1U0bpUj3MoPFchvDwZ9fBe1+QI4HulvIbE9p1swD+z6kpI+6LgeuveihwtmMMFteT/a9zm1DnJ/R5p8zshdHzcyOSsRvSbH4v+18wj+H7vwytoVOuv3eSfcn0cfQTbHjJuhk/8ASoNv/AXBcVtU=
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'Reassign Certifications' (move)"
|
|
---
|
|
|
|
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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Reassign Certifications</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/campaigns/{id}/reassign"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
|
|
## 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={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The certification campaign ID","example":"ef38f94347e94562b5bb8424a56397d8"}}></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><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"certificationIds"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** `>= 1`, `<= 250`"} schema={{"description":"List of certification IDs to reassign","type":"array","items":{"type":"string"},"minItems":1,"maxItems":250,"example":["af3859464779471211bb8424a563abc1","af3859464779471211bb8424a563abc2","af3859464779471211bb8424a563abc3"]}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>reassignTo</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The identity ID to which the review is being assigned.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"The type of the ID provided.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"reason"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Comment to explain why the certification was reassigned","example":"reassigned for some reason"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"202"} value={"202"}><div>
|
|
|
|
The reassign task that has been submitted.
|
|
|
|
</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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the certification task.","example":"2c918086719eec070171a7e3355a360a"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`REASSIGN`, `ADMIN_REASSIGN`, `COMPLETE_CERTIFICATION`, `FINISH_CERTIFICATION`, `COMPLETE_CAMPAIGN`, `ACTIVATE_CAMPAIGN`, `CAMPAIGN_CREATE`, `CAMPAIGN_DELETE`]"} schema={{"type":"string","description":"The type of the certification task. More values may be added in the future.","enum":["REASSIGN","ADMIN_REASSIGN","COMPLETE_CERTIFICATION","FINISH_CERTIFICATION","COMPLETE_CAMPAIGN","ACTIVATE_CAMPAIGN","CAMPAIGN_CREATE","CAMPAIGN_DELETE"],"example":"ADMIN_REASSIGN"}}></SchemaItem><SchemaItem collapsible={false} name={"targetType"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`CERTIFICATION`, `CAMPAIGN`]"} schema={{"type":"string","description":"The type of item that is being operated on by this task whose ID is stored in the targetId field.","enum":["CERTIFICATION","CAMPAIGN"],"example":"CAMPAIGN"}}></SchemaItem><SchemaItem collapsible={false} name={"targetId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of the item being operated on by this task.","example":"2c918086719eec070171a7e3355a834c"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`QUEUED`, `IN_PROGRESS`, `SUCCESS`, `ERROR`]"} schema={{"type":"string","description":"The status of the task.","enum":["QUEUED","IN_PROGRESS","SUCCESS","ERROR"],"example":"QUEUED"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>errors</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
A list of errors that have been encountered by the task.
|
|
|
|
</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"}>reassignmentTrailDTOs</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reassignment trails that lead to self certification identity
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"previousOwner"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of previous owner identity.","example":"ef38f94347e94562b5bb8424a56397d8"}}></SchemaItem><SchemaItem collapsible={false} name={"newOwner"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The ID of new owner identity.","example":"ef38f94347e94562b5bb8424a56397a3"}}></SchemaItem><SchemaItem collapsible={false} name={"reassignmentType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of reassignment.","example":"AUTOMATIC_REASSIGNMENT"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","description":"The date and time on which this task was created.","format":"date-time","example":"2020-09-24T18:10:47.693Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"2c918086719eec070171a7e3355a360a\",\n \"type\": \"ADMIN_REASSIGN\",\n \"targetType\": \"CAMPAIGN\",\n \"targetId\": \"2c918086719eec070171a7e3355a834c\",\n \"status\": \"QUEUED\",\n \"errors\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"reassignmentTrailDTOs\": {\n \"previousOwner\": \"ef38f94347e94562b5bb8424a56397d8\",\n \"newOwner\": \"ef38f94347e94562b5bb8424a56397a3\",\n \"reassignmentType\": \"AUTOMATIC_REASSIGNMENT\"\n },\n \"created\": \"2020-09-24T18:10:47.693Z\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"Example"} value={"Example"}><ResponseSamples responseExample={"{\n \"id\": \"2c918086719eec070171a7e3355a360a\",\n \"type\": \"ADMIN_REASSIGN\",\n \"targetType\": \"CAMPAIGN\",\n \"targetId\": \"2c918086719eec070171a7e3355a834c\",\n \"status\": \"QUEUED\",\n \"errors\": [],\n \"created\": \"2020-09-24T18:10:47.693Z\"\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"}><p> An example of a 403 response object</p><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={"404"} value={"404"}><div>
|
|
|
|
Not Found - returned if the request URL refers to a resource or object that does not exist
|
|
|
|
</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={"404"} value={"404"}><p> An example of a 404 response object</p><ResponseSamples responseExample={"{\n \"detailCode\": \"404 Not found\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server did not find a current representation for the target resource.\"\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"}><p> An example of a 500 response object</p><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> |