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

105 lines
41 KiB
Plaintext
Raw Blame History

---
id: export-sp-config
sidebar_label: Initiates configuration objects export job
hide_title: true
hide_table_of_contents: true
api: eJztXOtz2zYS/1cw6oc2GVO2ZMW2/OVGlmUfU1nSSXJzOcfjQiQkM6EIliDjqB7/77e7AF962M5jmjaj6Uwqk3jsLvbx2yWA+4oMRcRjTwa2WzmuiE+hjOJR2JbB1JtVdipKOEnkxYvK8dV95VKJCN7E4lPcSuJbeFZR4bFDbY8jwV3skD2Y84DPROX64XqnEvOZwuajgWWGhoeuUE7khTg5TD2+9RQLpYrZnef7TFPC5OS9cGLFppGcs/hWsFgEPIhZLBlnr0f9HtOzJZoJNvV8UX0XnMmIzWUkmBdMZTTX7/hEJjENokdl8SIUCh7wmAGXkQhif8FUEtLMhoBpEjjYm/sghR0WiamIcParEecj1i5Ofv3LbRyH6nh31xUfhY+SrSru+aH0grjqyPmu5wa7rnTUruJcWSXKd38yEwvXMky/qII8I/FHIlR8Il1Yg/slmXWMkOhvhaKII+mzO+SIpDhBCTh+4goXfhDvmq90aC8SsO5xlIidCnYHGeA0PAx9z9GEvVc4131FObdizvEXyg1m12TCQNz3+1PSkOU3YYRSiD2hsJ/4RKSMUeyrzPTzRWEBn+PKSGTA9HK1DvCAqdCILl0jEC0om4s8GQJ4FPEF/OnFYq4KJKs48gLUaxEkc1TIVrvdGY1uBsP+md3twAvzYNj5z2VnNL5p93tn9jk+H4+HN6O3vfbNqH85bHcKby7H/77pD/Fnu3UxaNnnvRsYbNwZwpOz/vDi5rRzZvfssd3vwZPz/m+dYa/VgyHOh/3LATyyTzu9sT1+e9M/ed1pFybNXuT0de2zTvttu9u5GY1bY3zS64/tM7vdwvFvxp2LQVc/H7RGozf94enNoN+122+LT4iPdPbB5Qm8vzFz2Z1RPv+wT3MOL+l/o875BbShX8PfbGDgtDP69cbujTvnw5Zhb9QvTKhFBT/GLRxuPGz1RigR+m2fn3dApJcno/bQHpjuQN6vZ93+G/QP4hOfhz4umxnn4QFWNPgSHSoawWMaxOzC8CzmH+DfMBKOcEXggN/4CMZf1OKtyv2oKre2MSqg9m197XJXNbDlup6OF5lbjnk0EzEoAeidcLyp52RhLRI+B4+PWiq4c8tQeVJHXdR0iGvCd3Nly11vNt2g5Gofd8SpOdjuZhvy3A3G48110IkKoeTZNpDJdyKaolY7cK29I1GzGs2pY/HJ4dSa8ldHr0TzwGmKRtHg3R6a80ZqHzH2b0PvGIIw05MBWUBX7MX0Qj/TkdimqVLdeCj0v1+vUMtrcfU8uVyviOVKE1gHuFWiTtOVUXS9rAklYa7yvyTr0Gh2AkCQuWLqBSDlQptdXAY2zUTN3stJtSRGg1heywmrMSS5skrtgC98CWAylx+RaroC2MjMh38EeMUnWsBroVHe2qC9rAtqh33aQ/I+cj95fIi8l5mamCpGoqvr5di09fR/Z0+/7MbJasyKK5lEDujKZAEashl1B5gtmKaURECeAT4cfbd9qlJnv4y807DwtOKVyXiOwhmRrGEvffWFDmcHm4W1WlNYzT1qFn6wuNOkZocHj/gl448MS3HEA4UZGXGF3uJx8RbaL0lYO/yvlvEagp4j6FzZ1sk6f7si7nWeeyjmACzZqceBvhjSLp9d8OgD+pg24FLIXC3WlTobgx/yQxJWlsXqzWbgklUyyXhU6VPweYFbZPTOi28h4VUxpFNyE455dOSlAZeW5vPX4BlzFImGJD+G9intn7dgG7zDd1vHDfT85YZa6YHP/pVi8jFIOBK0AiB8wK4w7AVVcyLWRuwwNbUBrYZaFSOhQpCbjtX1vfrG5QZMwLjjiBCBL87xRyISQVNBriXB4ykAH6g2zy5IPLcAAVNjmespnHMZeEATIGDGgZZZoAF6jAWqFUCz3zhoTo4OXatx5HCrsd/k1tHB0dSq1w729vZqLj9yaohkVMzjZC3GLM89onZMTsmU0ulM6gjRGCPzcNzBeGD3MHSfDwFSoIr1ITh3KDi3EQB0u9TorGXjj1JukzV9SJHwU1ShHRVo2mECzFFkMA9WTqPsIrGd/w76Qwzo9gX9KJFgnhHECz1dAltHhq7ewRMX8iQr9sg/LxcOBcMXLAliD4tfnvFDHDWVI05Ma2E5jENlc+VdgECzvKCgujVr75VVq43r9eP6/nHt4H9IpxMJTNW+lkgjQXbHIXpBZghDPm/+uXQp0n0tAWYVfQ7pQhJiB63cYlW315PyUKwcXhmbyhTcaFRpXXPhFdi4zmF/Wm+GrAA4XTXi4nRFrr5/NjMeLdWfS/XqljMX1kj6HGIbOLqJ/ISp4xrGtWck9smXNvb2Vt1n2/fAGbJOFAFFFhuKOImQYk8vqCkUs4l0Fww8lRdA1PXc6rvgczzp4/7TFTEYUFu6z3AZZyBOaxZxkqogoh3oiC7+o+diNYQK9HrIVCupXVnGIItqjZ1wFzjWHLYNM+i9Iu58gLE+w6unXdC949pumFYcCj452GvWG9ODBuf1o0bt8NWkOeX7+3vNV80mmSSEKgiKRa+eVhTKU5+LQESew3yI/r73JwgE7EHh5wpULpx8TRFiwxrQGM9x2Wjk1DZj09DL8APODuPspD1gjUNwBcEsoed8tiSEwLrE2BIkvkmz8UsBcK4H7gNw89ZaWhoDIDltXXYxCJict7KDY618/GkFoK8uqiWQCrpwK++0l9IMkLMUPogDvCV7aUZ9CQxxxLl5Q0//pRYKC2lg0zzxY+hhZl/Tozh0/pUpNSZHf+1iv3hVUd2BEKJSoDvhCjpInXW8bBGesbpGki/ZreCuiF5UWaEeSChYQf8FxSK38FFmmoAxCwK5+I0qkAAfRXktclGWVyP3Jt3ioqBxAOVP60nLiRMgjtgsWmGmLVk5ktYHaNaSK1M3LgiNRLoIYgi9CIIhjXNkFGEJZgK8ebH+UIW+zEPZz3mQtkt9VrkohNRcaGJOY0nvHJ6oZ9jdwAf3YxFr2YuPwhgflQu1N6LVSJfJeCQTFKmzaZUtV2r4WVl2a7tb293a7nNsd/nl0KSN5i2Bn9oq+LkMeALyjSh4roCfiLQnkCxtpMGYXsgdSk+0dF6/GYNhfxABtieEquH3N8JHOpSvfhPK1kM/nyD8yBartBZIIMnRbGcATyTcY6I7p7iS5tyNvf3V2c5kNPFAQYM1IJGg7kImkBvBmidBgJRwtQO5kFDBzzG75eAfMTtXKst5ReBaeg/DFklukeQ2Gm2j0Q8TjbZIcmu7W9v9Z9ruo0iyvHXA4CSVzOc8WmhNM++RW86gAUs/YLDM5AqfrXK0goOxDGNVysihMqnXJrXpoSMaLm+4B/vNad05qPNXh7XD2qRRP6wUY/1VbseZkZVtqrDeeh1JxADicCNaEoByqVhKt1wABPFGYopujbbJprgZZA4ivc6xY2MVO/ZkDLzBwIAdow0FxsthV2+D1cOj3OhDNcLsdKsFfhBESIk6DJL2VLyFjlvouA0/2/Dzw4SfLXTc2u7Wdv+ZtvtZ0LHxFHRsfAZ0bDCEWFOEWN8TOrqAOxCaTWFRgAdz+gn4CIEV+GWqj8bs9Qb2DOiVUGS9uYoix1KyCx4sUrCkSpXIIBcXujdoO8e2UdoWd22zGbjIgIHX8gDdolbh1gXApLhdwffmHtkxMgTjRgurNcUNYdpmUn3LZjE7nRQ5BV9i7VWCjnmgTmKK8A9GoDroDBz1N6xxmtX6qnowGyLHXeSYdT45QqDNZ/XfV+v2CdhAfITuYqTXesOGAV0z5wGkEeJTqN1XBkG3UH0L1bfhfhvuf4xwv4XqW9vd2u4/03Y/A6obNLQZqkODZ0N1aFvdYxmWOkPl+ssRO5mKoYDUm0mHsLqbY3DCFaBKSBBen4BOhOPlDJXd7Jjzrt7AWsH7HBATanKSyIdW6Z0F9/pmhYcqD70qOC9YqHgRyDu6uGAColnjdXCbqbYwbMBaA9skGPrQR+Sh6mo/R4NrKRMnqKTp3QiPjkybcGH5FpB7mNsfdvAsn1EjegwkhpBD/KyodZXUZoU/4Osy8h++nhc90AZe1onv0dmgPQNKl1g0G4XT6zdGCLj17CuXcORBBEv99ZXJ+tiszk4Ej+jqCtz98svrN+MXbIYwk8w8wSMX6aZ+zgagIuTGWulOEOxEkSWSyUxvr2+V9tqg2bCpDwyzd8FICHZlGyH0wL8PwSGTSLGTIB+AvZ53YwZIaJeX+r2gMLd8wUf1XWCxUw+9D50gwjaGRUrv2FWY8sULfH0pET+lo1l6NItGUy+WqNCivXL07m0nEiQW7iuS1hdPrsezCuNh8gRPcNRlGlASho7yDiknXbUvpqM0noXjlel4F7yhAxnlbky7LKYgBPous5lzK6US/2IMVQfN4GqWgBV9MVl0CsQii7DqewWSLD2l5VmACIm+LhhGoJVJ3xBDgETq2giZ5O+0smDzv9N5pd9LPNPjKwic2BIvd/limnFCCye0tA9Qhn4dl1CxwLaRB/IDWgHa+fqTJzCEFvyeHmutV6fhd6kPhgZHmjs1VHis/zjOHZz5xehFZafQBtwwAupszxielzZjYXAqCSstBSxLcJVeX0JMXJKbpjf7oIlx8u/GL3Lcyism/cBffGsvvcGT/H387nfyeFtP8yN6GgNxsfI4zK/C6uT3aqw9Y1q4X2LldHDhlPzqKeFnnwz+yy7zwLdTSSI3eVDRwE8MVl2tXio6awj/wlvyU5RJQJ6mj1IjgisOFPo8Rosmj+bceoLqHqHgMeLeHbQqOScvZM7oCnMme0ZH+yJYLg6ZqofXpFFlPp2Zk7PQoBp1Gv9WidknIsEcIY8WVfYGUtHAAZXENBR3KMO799LkoyPQygEqNTtNFZ3hkeokgNnQJyVzxsGcnrAG11NOop025EWBSGUhCfZmvVIPhmaGLNCFMSKaq/4US+qQrReU/om5QOeVqaeD6HEV9aUHlZyRId4BZA6yl1OWp8YGS7NuhR9iIgwRB8CnKMxwYY9XRoTBAvMRR0azXdNJ7WJbGARTQ60++9Vadc+iVAmeY14JqXthcBsk78G6qw3nH/MTk8uaeZ9/XNje+bf+zj+DFDDF2w2xJIlrkOiUU+f2ePGiGYscHGX34EhusQAAb+/vsWaF6e4DPga/iQURvLUgzWTpag7oQLUrKgd8EFgzMR9LrLE+xWuKI6tfgTDB1j10PezRtteFGsWgj5XBysRcaDjX5ZaI38FD/Pe48g7+gz8KV1PQ8/tKWryENnrcFF+ug1fmh76B5P/jGYmK
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 export job' (export-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 export job</h1>
<MethodEndpoint method={"post"} path={"/sp-config/export"}></MethodEndpoint>
This post will export objects from the tenant to a JSON configuration file.
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
## Request
<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 style={{"marginTop":"1rem","marginBottom":"1rem"}}>
Export options control what will be included in the export.
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"excludeTypes"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ACCESS_REQUEST_CONFIG`, `ATTR_SYNC_SOURCE_CONFIG`, `AUTH_ORG`, `CAMPAIGN_FILTER`, `FORM_DEFINITION`, `GOVERNANCE_GROUP`, `IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `LIFECYCLE_STATE`, `NOTIFICATION_TEMPLATE`, `PASSWORD_POLICY`, `PASSWORD_SYNC_GROUP`, `PUBLIC_IDENTITIES_CONFIG`, `ROLE`, `RULE`, `SEGMENT`, `SERVICE_DESK_INTEGRATION`, `SOD_POLICY`, `SOURCE`, `TAG`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`, `WORKFLOW`]"} schema={{"description":"Object type names to be excluded from an sp-config export command.","type":"array","items":{"type":"string","enum":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SEGMENT","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TAG","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOW"],"example":"SOURCE"}}}></SchemaItem><SchemaItem collapsible={false} name={"includeTypes"} required={false} schemaName={"string[]"} qualifierMessage={"**Possible values:** [`ACCESS_PROFILE`, `ACCESS_REQUEST_CONFIG`, `ATTR_SYNC_SOURCE_CONFIG`, `AUTH_ORG`, `CAMPAIGN_FILTER`, `FORM_DEFINITION`, `GOVERNANCE_GROUP`, `IDENTITY_OBJECT_CONFIG`, `IDENTITY_PROFILE`, `LIFECYCLE_STATE`, `NOTIFICATION_TEMPLATE`, `PASSWORD_POLICY`, `PASSWORD_SYNC_GROUP`, `PUBLIC_IDENTITIES_CONFIG`, `ROLE`, `RULE`, `SEGMENT`, `SERVICE_DESK_INTEGRATION`, `SOD_POLICY`, `SOURCE`, `TAG`, `TRANSFORM`, `TRIGGER_SUBSCRIPTION`, `WORKFLOW`]"} 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":["ACCESS_PROFILE","ACCESS_REQUEST_CONFIG","ATTR_SYNC_SOURCE_CONFIG","AUTH_ORG","CAMPAIGN_FILTER","FORM_DEFINITION","GOVERNANCE_GROUP","IDENTITY_OBJECT_CONFIG","IDENTITY_PROFILE","LIFECYCLE_STATE","NOTIFICATION_TEMPLATE","PASSWORD_POLICY","PASSWORD_SYNC_GROUP","PUBLIC_IDENTITIES_CONFIG","ROLE","RULE","SEGMENT","SERVICE_DESK_INTEGRATION","SOD_POLICY","SOURCE","TAG","TRANSFORM","TRIGGER_SUBSCRIPTION","WORKFLOW"],"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={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional user defined description/name for export job.","example":"Export Job 1 Test"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"202"} value={"202"}><div>
Export 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><SchemaItem collapsible={false} name={"description"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Optional user defined description/name for export job.","example":"ETS configuration objects from Acme-Solar sandbox"}}></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 \"description\": \"ETS configuration objects from Acme-Solar sandbox\"\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>
Reference in New Issue View Git Blame Copy Permalink