mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
168 lines
45 KiB
Plaintext
168 lines
45 KiB
Plaintext
---
|
|
id: import-sp-config
|
|
sidebar_label: Initiates configuration objects import job
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXFtz2ziy/iso7sNOpkRZkuWL9HLKduSsUo7lI8k1O8dyeSAStJFQhJaXODou/fftbgC8iHLsZHLOzkxpHjIyCTQafcPXDQJPjlqKmKdSRUPf6TtysVRxOlmeqSiQ907DSfl94vRvnMmVa57dNhxfJF4sl9gL+kwfZMKWKknZowxDpkkwNf8ovDRhQawWjLP3k9El84hCpsdjgQwFk1Gq4HUqIh6lTXa6Yr4IeBamDSY+i3hlyRHpQMYwivhCTzg8EF9kksroPh8tyZb4UvhsvmLJ0tUjMp7AGHPufcqWbC4CFQuWPghLG9jnaSoWS+jXZFN4YZrivGL1WfpAL1HQhafUL0l5KpgK6I/qpJaxVDFL1Sb9z1yGfA4ThsFh0skS2MX28FcskhQ5kgGLhPA3ePB4BCyz5JNcLs20REpznjniixdmvjilljOHho0zFGp5eEWKSppsGBRSwKmJGJhZCL+hW/t2RqYJiRyGzkVgyA6J7FgkoCWULD5DXvDpezUf+jMHZwAjGN599RiFiiMJliXIOnbZy9Wzp/vuPZVorPdsLyYif6nATpqz6FeVIdFIpczL4lhEaZhbCBkaEr5UkTtYLEO1EoJdyEB4Kw8E/4FH/F4soA/76XJw8eENqDSLPdFkJapZgpYBrNtBUaYoDwYCAV1pTWF35vOUN9ksOofHC9JfhOLUZsDnKtO2oi2TpaulSLQFFZwba81nkEVkFDyU6aoBdhEIMqWbCecTdla2s9ufHtJ0mfT39nxwkxCduJmAiWlBeWqxJ/0IROglewnniVsx0r2/5W7iGsd5A8JFo4vFvzJhPRmtkeYQqDBUj6i4RAD3wB1LPBizP4tc8LK+pt5fkIQhaCx5zBciFTGGjidHYpQAuvEK3kXwBv5cxuKzFI/wIPEexII7/ScHZQSv5kqFgkcOxhkKBU4/4GEi1g0H2ZOx8M2TrZFImzsaOIgC1IhzUOxeftY+DxqOt6jqQT0ysNbcZUxQZI8qC310AU+gozzK9IGa888oDh6tmAgCVLDSzpHy+F6keTwbBtqccokgXzMHvXTmNFik8shlvU1zgEFgGCWp4NY7NWPESGJagwxd+6DUhuIqj3wb1HD6EGNU+FlomxIRdKGpyCgfzzKig48hFWsnJ4o0JGg65dBrAWOCrimI4ANyakVSxNAmA+lVxoIflgeYEIktjlUMgTFJlCc5MoAM0TxgXmZaQLZBU8nHk5EvPU7x7/FBeg+F/EhRZQGCAYkvHAIBGhVK3FnfahMCCz9V/gptbtOAKEAvXHRu0BMaK8RVEGQs51mqozd5BEoEhYHhZJGBx8wxCGI3iH6zaBbd3Q304Hd3+CeD//BtH1ppd7nT0e6utd9tzXsHR+6Bx7nb7QaHLvd5x/X3va53MPdb83av+TFRERiMpmMCep896b9ZsRRMMczMnD67uW0UL2W08XLmTMfDd+8G47vJ9enkbDy8mg5HlzOn3EkLdqTHwl75aPh2e/9Ko9LI/tDXA8Ojdm+/2z3kbdfr7rfd7n7n0D2e8yPXPxRiHvQ6nV73uMxJldAlaARJ3dwW79f257rEvokd49wI9cTzThuMYuzBFs/NbJMdXzeei55otw99t3UsYDK9wHP5/ChwA35wfCB6h15PdGudtVXRWBhrp7G8vxfxzNkyo7JCNlb7PqMYqN+vtclNyOLMCs3OZdn6zIRn6cwBYJVINKg+azeKx6kE2aZAQjPXaXXabuvAbbem7YN+u9fv7De7nYNWF5/2W618XtSXAp7umBAXU/Ok1EjVjAmepl8xXv36m81Xd6sZcJSFoW2wLrOlQwiRLvP1rKToVSLCYHMm9OKVplR0KOwhRXtIrT3UGlqre50LlXuvN5jXU36B/X9Mp1dbuAC9ApAlVjCq1t4jMtFgZRt9aJDFoR7AYphQeTx8gAyiPpqhd5JB1I1SCv0qmuYsXo7uTq6n/9jab84T6WHHghm0gG0tBY9FPFWfRPSq9sjRW5kseeo9fFC+4WXy6+VZVeo1uaN4tXYvc52feLSAjw3ymmTzhYSF298ieVhBl2DL4i3AglBGhsDVtL1FAK+3KvNmaIwLgGOfE0+uWStdBBp8iXkADzfsqvgj/3mbhySnjNjIVhyzZuLSu4DwLAEYpXv5kouPa3hQ2yrCyhhxWSpFQiu3aW9aJTCNCDNWjewQR8qIE+SsrvGUiebrt8UuOVJPCPGXYQTgThO4XmaqHMnq8GJU5AIM1WPHMr18kyxHpczVJLuA6AFdE6YxDPA45jg5CRgv2SYHEWULzNyHbweX0+H017vR6fvB2fTubHR5PnwHDfIXV+PR+fBiAI/G1/S/yeh6fIY/puOTy8n5aPyBfteDGRYDCoxluq1BYOWQ/Xo52EUeM82vSQGgcUEeIPcnBKKx8CB5hpWeKYjarKyJP7bYtrZAIVYWsLoUT3xf6nTRIkKTfVCiZlG4tepYhISyQdKCA25GAeSFgrI4AylCvxBYbug8H+6qYvJfd4gSAHzWDqT/jAHYbCw2BvBNeszl+xqMVjZajTGf5fYrBvtj+CVQqAcDtoCvVKb0Qj8bEGkN8axtrEv9n7Yb1KYubl4nl9uaWG40gx3nlpir4ey64C4ktFfBtlKILhBBTu4/k6UqK9U/qQ9XQHtdNH+AeucwYBUm8TWt1bVaIBbIsB5o64YllTxXsynLiB44ZYPeMOJKgedGL/C3VdPWi/73ZtBOZSWvrtU3t5ur1s2zeq8F5v9rj7tQsWSF2231upvcD7ZyA1T91wbDvEpXzk+perJhzrout15r1WlwSgKB3LFu7CYt/ajmDAEmmh8VdwBkZgh+IG4WdR80rhJYBPgZGvS/R6r8BqT4EQvK2+JElb3rSP4rozo4Bw7uIx2TqHwHFKrlpP3uYW9+fOS73WMPTG6/x93jw+PA7bQPW61W2+fHXhujMu4UZFtjVHXsCbWzBXg7nAljl6Pp3WR6Mp4O3mLsusSo9W48mEzgr7PRh6uLwRQj1tnJ5dng4oIanZ8M8UclRuVN19ZtX+IKHaHEE4QoCT/t6obrXBGbLbODf16NxlPk8wP9qLBgnpFPL6UusX4Vw4O/CxfrEnXesNgKL1gGaWFoioHIKCQUMuDlkmp188XuK1QVmhc72tNOp9/Z77cP/wf59GKBsOn3MmkkyB4hMoNN1OuTz42/UD7AuN/PgNFiyMGhsyV2sJtUNdvezspGcNY+lRu4saiKXgvhlaZxW0R/u8v4Xs0dHUK6rVY9apyFEousA6wXMxfy5DSL0TelnpHdsZgrf6WL/pCkSr9J2ecPCiC+gDwxPINM/2WfOYe83L2PIa8EHqnIDWmLb3fRcO2mzSJN0qqF2lW1ALJottkp9/PKwJmZDLpvDAEYaH1DWLNdML7ZKvaWYcWR4PPDVq8Dq2iX885xt310MO8FfH+/1Tvo9cgmTTG+NLaFZNWh34lIxJCDUH1H/i8IBAwiwa1fhMg4+BYU94wOiMZrYhZaObXNp2n4Zan4AjCLs9OzK9Y9Al+I7jN6zu83hBC51xhcsfyDcUMXL2DmmvAIFkS5NW7ZIPh2cH5yfYFRcDz47+vBBH4hrdrW+UlkNzSAVbAF3D9JiwlQtBAhiAOB2s+G6s8wIR4l5YZS/5WsEszqDDiAHmb0LT3KpIutU+tM5DdfUvaTbIpmA2IoPFtgtQvwIGJ1s9n18wkt4+6FkeTP7EFwX8RvmqyUnII/AlHov6Jg7Je2koMMnFnku2oAMKUnqrooRFnVRhFHLspKQecAzl+2kxMvzYA5mmbZC3NryXNj0g/wrCVX5a6yZ4oiXUUprD3QIwxXIMY4xoxnDnOTsCDZDSOJsl/wyLazMasCjingfdDMvE0VvfN4lrzC765CCD8uTS1/QWkVOh/lrmZPnxVJvY1IZlWgzps7//kunK0R7Hx357s7332N726+HNtSvn5L4KddBz/XEc9AvjEtnjXwE5P1RIrZRvqbBa3IBuFzLZ33v0zBsT8J+iyCIJrGnz8IH+mlvF6gzPWhn89tpd0u/YUukEGSo/k0DCKR8PvEd8ExCUqLar8+2rmK5xIMNNoCEumjj5XKIDkAnWcR1fx50oBkQCTR3+l7DsH0rkee9InId/X3NDskuUOSu9Votxr9ZVajHZLc+e7Od/+cvvtVJJlzRd5icFKSLRb4JQRZmnmPs+UMGjBbt2e5y5GqNtEKEmM5xnKqyMGZd9rzdnDkia7Pu/7hfi/oeIcdfnDUPmrPu50jp7zW3xR+nDtZ1adK+tZ6JBEDiMOd/SwC40pSpfxqATDD71UDDGsYenLcDDIHkd4W2LFbx46XKoW5AWHAjvEzBcbr8YXemNTkabMSvx9HmG13NnFPEyElbZXRZt0OOu6g42752S0/f5nlZwcdd767890/p+9+E3TsvgQdu98AHbsMIVaAEOs/CR19wB0IzQKJx6PsSTyG541EAr9M9dG4vTnLZYFeBUV2eltODymFpwxXFiwllUpkVIgLwxu0XWDb2LbFTwjpmFqEX1hJpY9j4t49YFLcrw/lQuYnVIFuvHJPAjxSpn3G2ls+ivmKKKGgECp9QuuRyzT/JCxeUR30HgL1D6xxGm39rnowG+OML3DGbPDFo2OxLK//Hmz7TmAIzMcYLiZa1898MKBr5jyCNEJ8WerwlUPQHVTfQfXdcr9b7v8ay/0Oqu98d+e7f07f/QaobtDQ81AdGrwaqkPbZovlWOqcvuX//0bs5CqGAzJvpjzC6n6BwQlXgCkhQ3j5DAYRnj7AX6WLRfTnyfBK43/NThaH0MqePX3SJ5fXTb6UTQheoKh0FalHukRjDqLZEnXwM1PtYdiAnVwNTYLRJLnGEk1XxzkirqVszkU4+T0dX6WMX+Cj+laQe5jrJBp4dMaYET0GFpeQQ/w9odZNMpva/GBe13G4/v1z0YSemcs28X11NGjPgNONKeIUblFd+poR0tc18HOmgxSezsWjGuU2EwTlmsNay2Khwe2ATo2hETbrsFM6/2u+kPnp/S/TN+weoSiFAn1jjfnynbMrMCMKdSf2axHsRKtPrLJ7/Q36SeV7HHQtFoQgFDaLJkKwm6ER1CWsAWMI2iT26hnn193wAlLc45V+b2gp3LyQpok3tbyVsb51KKE2ZoqUArKbpZ0XL83re5n4m6XmmpPERC15s8GFFu2Np7/w9mJBYuFhQtL67sE1PbdEDxMseIJUN3lASRg+ql9ReVZr381HhZ6L9Kp8zKJf6NRCtRvTYY0lD3SjyZB5D0ol4r8YQ9NBV7m5z8DTvpstOirhkke4nVaJJVcP6UoXUCPxdwGOEWljKq7JAcRH9RNy299IsxAXfqOjPL9V5kyPb2BxxZZ4GdF384wDujigq+NEYvjXaxcaFvg2zoHigDaAs0L/FAkMo6XYaG7p2Rb5ifwe9cHlA287IirJsq//6BdB0PzSdyJh67wNhGoE3fl3ZXiGz9DCBawiLFsu2JRgnd9Qwbq5ITfNb77piWvpH22+OOOToqoyisLVj47Sz0SSP07c/Q9FvF2k+StGGgOD0dxoWHuqtmTkpwbT1at8dNGdgH/hLfkqIW7IZ4p7uMqEliFP0arJq70HKag+sBQ8RXzYQMtSC/JEc4TT3DDG7ukMWAwsc8joJF5tRxVsOzInh9Hgky4tg7+TzHxPocAkId8UTfYLpGyRB2rBdA2/5IV3H5XJ2yagmSu6re+tVTaArsUii/CqOmA7WzAOJvWCRfgy8TIduCB/iISVhSLol/eyXoymhlOgY9AiXiSjAEvPkNWWFP/CWKD3xNSdQfSoRXPytpjIGC9uoIPGjQ1o/xJtsDb3QYRLTBgh6gIAE6URPgynNYpALDKbHSq+3zOdkj1sC0TMbUjQYb/ZbrZcSingOeZfkOKWiA9B8nirW7JxPaY9ty7zo8CblvlUFOF3N4vubhbd3Sy6u1m0dLOoAYqY4e8tsWqN4SfTVQld/rlxcu1jwVkXgG4bDl4vhm+fnrCsiRWRNT7W15JimQGiJt1rtv1u0VpY2l0zurtm1B7j32qVnwTWYot7bk291aF7NGxhjYpZYJxUSicz1N3M3q071afqbd9tV6ZhyU930hX6UvPaHjYOnVdNr0a4V+HMzU2oC10ARsJEt1H8RCbX638DrWflug==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Initiates configuration objects import job' (import-sp-config)"
|
|
---
|
|
|
|
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"}>Initiates configuration objects import job</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/sp-config/import"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This post will import objects from a JSON configuration file into a tenant. By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed. The backup can be skipped by setting "excludeBackup" to true in the import options. If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded using the /sp-config/export/{exportJobId}/download endpoint.
|
|
You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data.
|
|
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
|
The request will need the following security scope:
|
|
- sp:config:manage
|
|
|
|
## 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":"preview","schema":{"type":"boolean","default":false},"required":false,"description":"This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.","example":"true"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"multipart/form-data"} value={"multipart/form-data-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 style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
The form-data "name" attribute for the file content must be "data".
|
|
|
|
__Example__
|
|
|
|
data: "config_export_0340b957-5caa-44f6-ada2-d3c4c5bd0b19.json",
|
|
options: {
|
|
"excludeTypes": [],
|
|
"includeTypes": ["TRIGGER_SUBSCRIPTION"],
|
|
"objectOptions": {
|
|
"TRIGGER_SUBSCRIPTION": {
|
|
"includedIds": [ "193446a1-c431-4326-8ba7-d6eebf922948"],
|
|
"includedNames":[]
|
|
}
|
|
},
|
|
"defaultReferences": [
|
|
{
|
|
"type": "TRIGGER_SUBSCRIPTION",
|
|
"id": "be9e116d-08e1-49fc-ab7f-fa585e96c9e4",
|
|
"name": "Test Trigger"
|
|
}
|
|
],
|
|
"excludeBackup": false
|
|
}
|
|
|
|
__Sample Import File__
|
|
|
|
{
|
|
"version": 1,
|
|
"timestamp": "2021-05-10T15:19:23.425041-05:00",
|
|
"tenant": "sampleTenant",
|
|
"options": {
|
|
"excludeTypes": [],
|
|
"includeTypes": ["TRIGGER_SUBSCRIPTION"],
|
|
"objectOptions": null
|
|
},
|
|
"objects": [{
|
|
"version": 1,
|
|
"self": {
|
|
"type": "TRIGGER_SUBSCRIPTION",
|
|
"name": "test trigger",
|
|
"id": "193446a1-c431-4326-8ba7-d6eebf922948"
|
|
},
|
|
"object": {
|
|
"type": "HTTP",
|
|
"enabled": true,
|
|
"httpConfig": {
|
|
"url": "https://localhost",
|
|
"httpAuthenticationType": "NO_AUTH",
|
|
"basicAuthConfig": null,
|
|
"bearerTokenAuthConfig": null,
|
|
"httpDispatchMode": "SYNC"
|
|
},
|
|
"triggerName": "Access Request Submitted",
|
|
"responseDeadline": "PT1H",
|
|
"name": "test trigger",
|
|
"triggerId": "idn:access-request-pre-approval"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"data"} required={true} schemaName={"binary"} qualifierMessage={undefined} schema={{"type":"string","format":"binary","description":"JSON file containing the objects to be imported."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>options</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"excludeTypes"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `RULE`, `SOURCE`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`]"} schema={{"description":"Object type names to be excluded from an sp-config export command.","type":"array","items":{"type":"string","enum":["IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","RULE","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION"],"example":"SOURCE"}}}></SchemaItem><SchemaItem collapsible={false} name={"includeTypes"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `RULE`, `SOURCE`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`]"} schema={{"description":"Object type names to be included in an sp-config export command. IncludeTypes takes precedence over excludeTypes.","type":"array","items":{"type":"string","enum":["IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","RULE","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION"],"example":"TRIGGER_SUBSCRIPTION"}}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>objectOptions</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Additional options targeting specific objects related to each item in the includeTypes field
|
|
|
|
</div><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>property name*</strong><span className={"openapi-schema__name"}> ObjectExportImportOptions</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"includedIds"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Object ids to be included in an import or export.","type":"array","items":{"type":"string","example":"be9e116d-08e1-49fc-ab7f-fa585e96c9e4"}}}></SchemaItem><SchemaItem collapsible={false} name={"includedNames"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Object names to be included in an import or export.","type":"array","items":{"type":"string","example":"Test Object"}}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"defaultReferences"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `RULE`, `SOURCE`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`]"} schema={{"description":"List of object types that can be used to resolve references on import.","type":"array","items":{"type":"string","enum":["IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","RULE","SOURCE","TRANSFORM","TRIGGER_SUBSCRIPTION"],"example":"TRIGGER_SUBSCRIPTION"}}}></SchemaItem><SchemaItem collapsible={false} name={"excludeBackup"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted. If excludeBackup is true, the backup will not be performed.","type":"boolean","default":false,"example":"false"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
|
|
|
|
Import job accepted and queued for processing.
|
|
|
|
</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={"jobId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique id assigned to this job.","example":"3469b87d-48ca-439a-868f-2160001da8c1"}}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`NOT_STARTED`, `IN_PROGRESS`, `COMPLETE`, `CANCELLED`, `FAILED`]"} schema={{"type":"string","description":"Status of the job.","enum":["NOT_STARTED","IN_PROGRESS","COMPLETE","CANCELLED","FAILED"],"example":"COMPLETE"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EXPORT`, `IMPORT`]"} schema={{"type":"string","description":"Type of the job, either export or import.","enum":["EXPORT","IMPORT"],"example":"IMPORT"}}></SchemaItem><SchemaItem collapsible={false} name={"expiration"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time until which the artifacts will be available for download.","example":"2021-05-11T22:23:16Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time the job was started.","example":"2021-05-11T22:23:16Z"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The time of the last update to the job.","example":"2021-05-11T22:23:16Z"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"jobId\": \"3469b87d-48ca-439a-868f-2160001da8c1\",\n \"status\": \"COMPLETE\",\n \"type\": \"IMPORT\",\n \"expiration\": \"2021-05-11T22:23:16Z\",\n \"created\": \"2021-05-11T22:23:16Z\",\n \"modified\": \"2021-05-11T22:23:16Z\"\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={"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> |