mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
171 lines
41 KiB
Plaintext
171 lines
41 KiB
Plaintext
---
|
|
id: set-campaign-template-schedule
|
|
sidebar_label: Sets a Campaign Template's Schedule
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXPtz2ziS/ldQvB/ipERZkl+x9ocrxXZ2Pec81o9L7VmuGoiEJM5QoJYg42hd/t/v6wb4kuRHMrmZnZxqMolENhrdje4P3S2Cd14yV6nMokSfhl7fMyo7krO5jCb6Us3msczURTBVYR4rr+VlcmK8/rV3pNIsGkcBjxPFAOPdtLxQmSCN5nQD7C5UZkQ2VcI4JmKcpEKKwA0RmZukLU7HuF6SyThVMlwI9SUymWmJKBO3URyLkRLJZ5XeplGWKY1r2ZT5a3UrEq3aENKoIMftBQS9866MSo8Snakv2SDPpiR8FOp+Mb9fzN9Pc+3d3LMC81RBMwVzZGmuWt5cpnKmMpUaZhmRYnMJZi1P4wa+RSHNC9ln0uvfedliTldNlkZ64t23vFT9M4/SimPTSJeQ//RYJGPWZMU00BlsStOEpKP6AqqYJunsjlQYqJ3XB6Nw92DUk6o7fr2vRp3RaGc/VMojnWh+ZbI3Sbgg+QIyiM7oo5zPY7eO278YEuduVZFk9IsKMkw7T8lbskiZ6u6yusvaHZPlZpFW1hFo9SQWslzpQIZKB+QAWkyUprstQRRZNFMC00VJKMaRikMjzAw3VApGUltjTRMDNyAJwEiTe0C5cTTJYe22eAtnc6YCT3E8OD37R31mLabysxIvpkmemhcCzt8SozwTOsnEi1AuzIu/YNink5P/WjtulMD7isFSh24M8eFF0vmMHM6Ox4V3H95f/o0/Dd6/vxqc8cejwdnJ++PBOQVPtaxuDHxnhsWamnWrsRRqcxUgJmHm22kUTIUdR15VD6sU/wdZ9Bn2/qDjhfgs4yjkoCxEqohpPtMWJ1Yo0x/qof6gxVs1SnOZLljjdzINprjzyq7B2enFJX0BWzicGHq9odfCPztDj0afYPEXYsfJ1hImk/AmOHekxU9SM9etf+IfuEy8ePkI3y4xfIVxoMRFsVOxz26TQvmRym4V/OOnPLbiHqtAzUYqrTifD97/9aTB+sCK3O0tTdEb6m8MgRM4gp0tS4ThdVoUIvK0NWchTfGVxWq6BN+BQ1hBa7PKNJWLlUn/2+rjUKUwiDQqBFDyNVWKNQMaYBRuyRECFLwioI9Zi2WlQNdeF4gJUmegGjVdmqi0DlS9lgcvm8nM3t7fXRH4tDB0sWoc4LC1gwUiM959A06v7YylUUgeisGvDxeM2jIv67ESGRcqFB5tcTnFBfwpJrc7WR3JbLwMNeH50Ek09Cx2iWlCABZG47FKYW3Ml0mBvUbpkALALQmvBpas4Ml+arGgTyKW6wkD/Sq2uv7BS6JwwNIk4SUnmp1uS5zhj99tt9tMX8R6X0SWduhgphSXlI9NQlD2LK5/EcBC7MuRUX1xevHBf73f6ZKSZGBs0glQdaFkKraGnu93exg+9FiWAv9WhoGy1+l1asRD/T7Bfgj0z8phsBxi2+TzeZK6XIMChS3Z4pgvgS1MwJWg3VEzMQeatfvtFE6H+P4chSocas4tHlGlzZCzBI4XuSZrPYVc1kmQqSQQEKAQS0MusWhY+REmsLpl8zZNZjyi16FMKOHPT3Bbhbxex2LeWR2mGdpFT4ePyOH7nR2/07PDoH45pgWBet1yZH/NzoD71ejviazsrr8TrvJc/x9QlbOcr4dVGvY4rjYiyO3g01QpHmqqFGFMnv568A61gA7i3IDBI475el1+cJyTuZHhGUpHjZ3hsbg4tGGxZ/17kIk9ml8nibbQsvfx3SMy7FWJBP978L0d3Vroh/b0Fe+uu/7/jaerL/PIUq9bllIg2hB8qlEeiQHe0qmMkWPI5kIio0SijAauajV2gERDY5EEKF6bFR6Asud3Dv3uoeju9Pf2+r19siPx/R/YnMr2p7znspDjXxhAHpQbt92h7NUUE/Ua3dZNkUbooTBrFTlCPYDLYpSYgYfAjtyl2KCoYAXLNAIZBBENvSOEBwKhwYq1r8YL0DSVPyKPXb9kFpFuyBIZ05aNisrL2AXf0fYXc+XbNMt5rk3hzN097J8k/drNs0UCItrbhavUbF5VdcsY6SKxCDc4/MG6DHWVbA9kpPUH2B/QSdnGA9IrBsyidupCdAg6i0IdTabZOmlrleeT4naeJS1yAGzkXSfy34vq7UFzs0quyBNbqlESviyWYxyl0KWRc1oX+a06dZ+3Aky1Unqvo6sD2A6b4B9YLuSk0MQhQSCO3Xzr/c9mTd1eo0QVe2VQWRtxzvm7aM9ZXbeHa5yqdyp3xMrVdMrUAzq5aE5qzYLua4oiSujXqFD2QL6bClw5dHp+9zXLfn9vQcTMsQdYVOh1dlelf58I1xwTPhAwpNaYw3HXQxO3EpiWBwESiHEec7uIKh+GRV0NB+SNaFCWp7QvRtoxsRK0CaN2O51VCY7iiIafpCkw2BfnJYNxQ4pREi5oxkhzB4f84jt19UKVySg+SsJnZCVvkUf5k1RGJKFikQMMdEUU7SuzBJaxLItoZromysMS7a54I0Poa/U7csrQRpfK4Ffwes5Gd6UjjBfFEOF6Ww9Mqw6UHO13Dnu74/1dKXuvd7sHe6PDsdzZ6RzuHR5y+w3rLCfPyJb+SkkGwiJOAqzIv2CQVEnYngXgydekRQ+sAfN4hv1pX7e0pZpOXkEdb+p5vjn6KHYPsKvpSc7X5WTJCNq/uqBWdh7HckSXqEcNzS3jD2k0idZmQkW+eXzydnB1xinnyd+vTigQidfKbwEDXUQURIUvTJNbW61aBTiuVAxzUOf2leP6CgpJbeqEkftFYWFgTPjWWOZxhhFu9jUj6qxtHVEPpcD+PCC2orZqtxC1uIYUD4jcyHZfDRDz88w/c5Z8JaZKhip92RaDMIxISeSeLvmfIX9A+MswrGJ/nCOUVdlC0EkWBaq5FpUpm6tR5Thn9UWh4IDkT/vJIMhyCMdq1qOw9BYnYoF4obNcU7rLZRRc6IwqOVBiuwuSNIWFGRCjzJRAyCngTOqCrkSs+/tKLYa7d1aY4yzhe4HMzTPi7mMM+PFZtfLGZ+WCzxAOu5YOrUaxTA6RXL+EBxeNn8IWReDbTHYTu5vY3cTuM2N3+ea5y3rcXU59uqupz5WWOeyb8ua5kvqUGVZBZH98tgvZElSxWuv89OkSgf0rilvQczGvvmd+ZLfyFeEH5XrY66Oiqi62/motSEC2o9VgDCRSYZ/lriT2iqR1t7OzOhsK9FEEB9VrUkSgZioWSc4/9hX1vTQt7n/rF5n97VJyBmsRkGbVoT9PUMlsMslNJrnZjTa70Y+zG20yyU3sbmL3zxm7j2aSzS6/y5NMPpvJdGE9zd23D0GBoOy/iTLkylZkPVshZqLMsbxm5uCNet1Rd3wQqN1Q7ob7O4fjXrDfk3sH3YPuaLd34NX3+usqjssga8ZUbb3tOnr22YD0M/K4XMO5TJYkYbP9B/OmakywRtBT5s2wOUx6U+WOa3ucGXQDY+SO6QPtxavzM+KPqZk92S3J00BRmm1NZ5/CKB+p4Oc0N6njJnXcbD+b7eeH2X42qeMmdjex++eM3a9KHXefSh13vyJ13BWUYo0pxfojU8cQeQelZmMsCh25yVN+8Dil8y0Gn1z30YV9JtOJyspEr5FF9g5Xs8jLJBHvpF4UyZJpdCJ1ZS6CN9DOiDYtaCN6kmACiNTFCQ/yKnpCCTkpnXmJo1nEcUwKgW+68Af8DJWNmeXf0+0zgZCQQYGepaJ5b2UEd1JjSv/AgfugEwD1d+xxutX6Tf1gcU4an5HG4uRLoBTFfNn/3Vv3lAA/60ZwcWHX+oHHBWzPXGqUEerL3MJXmYJuUvVNqr7Z7jfb/Y+x3W9S9U3sbmL3zxm7X5Gqu2zo4VQdBM9O1UHb7ogyl3pLzvW7Z+wcKk4Cdm97BoAfWrivnl2dKbgSCTTPGUPo/Hnf2145yG6276LwfttUh/ZtOWCly9MYo6ZZNjf97e07LBoW674t51EbWIZ1yxY6uW0HyWx7BEutASF7CJIciAjE4OOpqzfso8lpRJ5sYY+ZW6OzYuSzMD4/ZvAoZzpVT6u5QCkiLJsWHTRxXsWXIeIcJcULw9Rt9qIV/aDXVRrf/3ZdLKMHdFlnvkdnA72ApEsqkgo31esL6DTDzM6+8hKDak+hzn9vZbIPRNYTb5RM6bQ8Pwyz9dOny5fFURhEPR2CmggVUZmAuPkIF2FUGxQPhtAg3mjSJJ/YtywMGo/eUBSJcQyFxVBfKCWuT50R3gPuz4HPbFIapBgSaNTNVrE6ofqsYtoJ25UlyfGiUG/DQtuyMe4l73pcHkTaHsLB1fZQ++I4IjCi0z1MU5z2oWpPXM8LvWRNr28V4j8Kbr7l5jM383JJCmva68A+yh0glImFjA1b65snt/z8Gj+qpXCFuC7LQJZwcjQfmAqKVftmORr8fOLXlGOoP/FBp+YwYRFMGOyIcShO6d0NiVH/KQS5DoXB9SRHFH2zWHy6yueI8Hudmki+ndKPfCSILN8ZAkNbZ5Ij2qA5P0lsq4RD8mdeWcT8z3wo4+eGznz5GvsoUYZJYL5ZZprQpwl9iwHGyW+3KXIsxDbpwDhgHeCoWn9GAidoDfcsr7Wozuy3eQxtDQFEZS5m3rdf+hXAuU+CbxB1SQMYpvy6fITMHoNnXrRXNYxVdAaWLbgqb5xgi1yym5W3/H2Tts1/N31J40HVQKHXanxvlH4ASf59cPcPQrwN0vyISOMyXmpEnlcvLjopapMyrMr36nz1Ob3e844ALg95ztm05TH108Rrj/I2T/LaA6/EZJzwTK4uqkf4G5esrnYzqd0+VfgbdxmoWBbUbdWLsuqMqGCgkGZIC6aR4j7IXMmMEt8WhVUyYxiapwlhn3sDhpikoAFmGSTkchTF4Med+mJmyWhhs2pyavpucvfcSIJ4RF2t2uITnSEPYFQqS+mJZdz7JXH16QXc8iN5tTguPB0Z52yWa8xGoJTP6JzhU+EQRibILWqjStWqsAW/rkSUowoIozgjFdpcoKUz82FMLXZU7zWvf2IuOL1x/XWYnlbRvSasUuRcxe48emupZnmKN0LNn6p4Tk6CLQfZp6rN8O70coUjmGn3o06STrbdILNNtPQyAChv3Wen3W13fK6VcH2emAylfI05v8xNlq97E8UL4lCD1d4R13DJ2rvG/pB3wblApcppe06NP9Ist5WcLaGvvdUSGgP75SvdWK0bCn6TEfndHbWKqKy8p8vAJ+pDXN9UFSNX2lgv+oyQHgM+l9/5VrfL1rk72/6Sf+z6yjfBrdWwaIDqRdX78PDxV0UtE6h2z6/04J4WS2tvuB9R/MvaOxGIzfKvQ1Rp2xG2T/Yo7U2td/Hxitxz5F5DN7NdmFTe4iL93feG+A9fkrkNDhDx9Tuv6GmCxrIt8sx1aZb7gEUB2f8ChufhCQ==
|
|
sidebar_class_name: "put 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 'Sets a Campaign Template's Schedule' (set-campaign-template-schedule)"
|
|
---
|
|
|
|
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"}>Sets a Campaign Template's Schedule</h1>
|
|
|
|
<MethodEndpoint method={"put"} path={"/campaign-templates/{id}/schedule"}></MethodEndpoint>
|
|
|
|
:::caution deprecated
|
|
|
|
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
|
|
|
|
:::
|
|
|
|
Sets the schedule for a campaign template. If a schedule already exists, it will be overwritten with the new one.
|
|
|
|
## 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 ID of the campaign template being scheduled.","example":"04bedce387bd47b2ae1f86eb0bb36dee"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`WEEKLY`, `MONTHLY`, `ANNUALLY`, `CALENDAR`]"} schema={{"type":"string","description":"Determines the overall schedule cadence. In general, all time period fields smaller than the chosen type can be configured. For example, a DAILY schedule can have 'hours' set, but not 'days'; a WEEKLY schedule can have both 'hours' and 'days' set.","enum":["WEEKLY","MONTHLY","ANNUALLY","CALENDAR"],"example":"WEEKLY"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>months</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Specifies which months of a schedule are active. Only valid for ANNUALLY schedule types. Examples:
|
|
|
|
On February and March:
|
|
* type LIST
|
|
* values "2", "3"
|
|
|
|
Every 3 months, starting in January (quarterly):
|
|
* type LIST
|
|
* values "1"
|
|
* interval 3
|
|
|
|
Every two months between July and December:
|
|
* type RANGE
|
|
* values "7", "12"
|
|
* interval 2
|
|
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`LIST`, `RANGE`]"} schema={{"type":"string","description":"Enum type to specify months value","enum":["LIST","RANGE"],"example":"LIST"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Values of the months based on the enum type mentioned above","items":{"type":"string"},"example":["1"]}}></SchemaItem><SchemaItem collapsible={false} name={"interval"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","example":2,"format":"int64","description":"Interval between the cert generations"}}></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"}>days</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Specifies which day(s) a schedule is active for. This is required for all schedule types.
|
|
The "values" field holds different data depending on the type of schedule:
|
|
* WEEKLY: days of the week (1-7)
|
|
* MONTHLY: days of the month (1-31, L, L-1...)
|
|
* ANNUALLY: if the "months" field is also set: days of the month (1-31, L, L-1...); otherwise: ISO-8601 dates without year ("--12-31")
|
|
* CALENDAR: ISO-8601 dates ("2020-12-31")
|
|
|
|
Note that CALENDAR only supports the LIST type, and ANNUALLY does not support the RANGE type when provided
|
|
with ISO-8601 dates without year.
|
|
|
|
Examples:
|
|
|
|
On Sundays:
|
|
* type LIST
|
|
* values "1"
|
|
|
|
The second to last day of the month:
|
|
* type LIST
|
|
* values "L-1"
|
|
|
|
From the 20th to the last day of the month:
|
|
* type RANGE
|
|
* values "20", "L"
|
|
|
|
Every March 2nd:
|
|
* type LIST
|
|
* values "--03-02"
|
|
|
|
On March 2nd, 2021:
|
|
* type: LIST
|
|
* values "2021-03-02"
|
|
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`LIST`, `RANGE`]"} schema={{"type":"string","description":"Enum type to specify days value","enum":["LIST","RANGE"],"example":"LIST"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Values of the days based on the enum type mentioned above","items":{"type":"string"},"example":["1"]}}></SchemaItem><SchemaItem collapsible={false} name={"interval"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","example":2,"format":"int64","description":"Interval between the cert generations"}}></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"}>hours</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"}}>
|
|
|
|
Specifies which hour(s) a schedule is active for. Examples:
|
|
|
|
Every three hours starting from 8AM, inclusive:
|
|
* type LIST
|
|
* values "8"
|
|
* interval 3
|
|
|
|
During business hours:
|
|
* type RANGE
|
|
* values "9", "5"
|
|
|
|
At 5AM, noon, and 5PM:
|
|
* type LIST
|
|
* values "5", "12", "17"
|
|
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`LIST`, `RANGE`]"} schema={{"type":"string","description":"Enum type to specify hours value","enum":["LIST","RANGE"],"example":"LIST"}}></SchemaItem><SchemaItem collapsible={false} name={"values"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"type":"array","description":"Values of the days based on the enum type mentioned above","items":{"type":"string"},"example":["1"]}}></SchemaItem><SchemaItem collapsible={false} name={"interval"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","example":2,"description":"Interval between the cert generations"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"expiration"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Specifies the time after which this schedule will no longer occur.","example":"2022-09-19 13:55:26"}}></SchemaItem><SchemaItem collapsible={false} name={"timeZoneId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The time zone to use when running the schedule. For instance, if the schedule is scheduled to run at 1AM, and this field is set to \"CST\", the schedule will run at 1AM CST.","example":"CST"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"204"} value={"204"}><div>
|
|
|
|
No content - indicates the request was successful but there is no content to be returned in the response.
|
|
|
|
</div><div></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={"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"}><Markdown> An example of a 404 response object</Markdown><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"}><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> |