mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
113 lines
44 KiB
Plaintext
113 lines
44 KiB
Plaintext
---
|
|
id: get-sp-config-export
|
|
sidebar_label: Download export job result.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXG1z2kgS/itTug+bpBAYDLbxlyuMsVdZGzjAm8o5LmeQBphEaHQaKTbn8n+/7pmRkHhxHCd1u0mxH7KyNNPT7/30MNKDJUIW0ZiLwPGsY2vK4mHYFsGETzv3oYhiq2TFdCqt42tr2Lf1E+umZHlMuhEPcSJMG824JCzwQsGDmAARSeIZI0yRIBPuMxIxmfgxD6ZkEol5/vEnMSZ3PJ6pexH7T8JkzDzykXsfCQ084om7wBfUk4THJBaEKoLlD8FoOR4I+D4JGMwTASNioohNhO+LO1xTMjeJeLwg0gWB5fGHwCYyPHaVPMcRox7J35jTgE4ZyB7SiM5ZzCLUwIPFUdiQxjN4FMAD+It7cC3dGZtT6/jBihch3pVxBMtajyULGeQRA+XGUcLWFceIc5rym1fITMhUaVJLN2aZKphXhlXZPZ2HPi7HJvtHk2Z9v37ImvXGQW3cGI+P6rU6bRzsNw+9I+vxBjmRoQgkk8hnbW8P/1fkRpscdPh22OsSMf7E3FjiSqCWmAUxzqBh6HNXeUzlk8RpD+vi66noOzxWDGrHIXoBMjCckBPhLaxVnWRP58JjPhgxItosqX5SLZBUImQxjNCTY67F+wIW45o5wxI4JpuyaG21dhJFIBoxM1ZMkRpAC1RQevURxZuD88GNddOXLGB8TkFnlkdjZuPQtcVHcDO/3B2VICvSj1dNXNurVe29hl2tjmq149r+cfXg3+hfYBeqLbO6fnGpLrhrKpyeAz7GIlweY1evLyI+5QFdW1yqC9us9bhC+2tL99QF9UkiWUQ8NuEB+FhuTAVjSRl6GQFFBozjvIXIqJIR6ByZEGqy3OR3RW9g966feGwEg+S61/fUJIIkCDIiMcmM0SZqlqcTFg0gP9hFRwRTQaZQujIM0Cii6NE8ZnO5STMsSOaYTFvtdmc4vO0PemfORQcemBuDzr+uOsPRbbvXPXPO8f5oNLgdvu+2b4e9q0G7k3tyNfr9tjfAy3brst9yzru3QGzUGcCds97g8va0c+Z0nZHT68Kd896fnUG31QUS54PeVR9uOaed7sgZvb/tnbzttHOLZg+W/F04Z532+/ZF53Y4ao3wTrc3cs6cdgvp3446l/0Lfb/fGg7f9Qant/3ehdN+n7+j5EhX71+dwPNbs5bTGS7XH/TUmoMr9b9h5/wSxqirwZ8OCHDaGf5x63RHnfNBy4g37OUW1KqCi1ELyY0Gre4QNaKunfPzDqj06mTYHjh9Mx3Y++PsovcOa9vS7QydR3A2HrzEh8wsDy6e9CDi5MiTmH6Gf8OIucxjgQtxC9mJ5L1453K/qsttHIwOqHNbb5nzih7Y8jxu0qzJi+BGEUAxBX9C5vIJd9OaDnXNxyyPXsqoOyPoPOijWB3yng5Qi/ne0tmyBEuz5fqFVPt0Ik7DwfG2xxD3tgQPn5saZYLnm2Ig0++YNVm1euDZe0esatebE9em48OJPaGNowZrHrhNVs8HvIeFczu3TwT7j+EXix3RiwFbj0tIpe/pwuiopVLfeMzNf9jsUKu2uH6eXm7W1HKtGaxZN48F7jRfKUebEYFEQKB80AUEHhegSNnKXD6voG2K2wY4jZUQWhgIgR2FVtc6FCykZhxoTKiRnKLCA49/4V6CYaZp64Se6CZK/mAoWiC+DYVK5k826aJIfQijyNgX7mctyFxj/QpLQf+SerghpL8G8pwt9H6T5HTUU5WxbBRPwMqultVfQL8G/4RCSj6GNjFrBDcXihJZrRMlgim7RHT+LZEs8ZaUBTd5f2q5OK2kuwr5M1XIFJSVsPf+Hr90TldaLLdZPdo72m941WaVHh3sVRte7ajeaIzr49p+jeKSuuv/jkU9LkOfLlThKC7/+4C03Jh/YeSUA/SLRbSw8ikVA1gT1qnsNBbLJLm1QHksptyXZXKmk5jHQhZ42P4JXe5zwVDeWthx7+Ix/a9k1TftHrR9jtmrE0WQXmxo8uMkwkaPT/I7O2QMPT9mAB58oT73vmt7oZiotKht4T3DQmfQg9rTiKpWlCmWXZgIoFtAekfMNBfQHGuS2aYAjisaDTRRrpIT6oG8Wr62EQYtF1H3M9BynuGnVwGH+SSdAjBIpekty7JDRscHe81afXJQpxS8tHrYGDcndH9/r9loNnF1qM+STtmm8llc+pwFLAJwCLUBLPJfhhsrFHSvO3Jc/KmKW7SBovEM/ePGlx6biWn4JTG7jyF5k5N2n9QPiU+DaaLu0+mKEgL7aog7cYnv0zHeUm5aMkz01GbGUx0RpOLW1QXmMJPhrRLSWtvebAWq7oNbAqvgCzNxpzg2AuCuDdRgUAeDTu6NofoGBKKBzA/k+i+5kAi3PTahiR/DDLP6hhl50suN0zSUVNzcx+QVL7NyCSAo3IMYBzw/plJtharhb1quy8LYvjCafENmjHosel0mua4BohGIwvwFYllIAxrIqn3UBEJZ12aRAOYVMXdXktdSlUVrLNPXRd4oauPq/hnbVpAREWspMfNRmHlL1rQo+wDPWnNF7go7xajSRRBTyLUwEsCHKyLMt2QMsvFYEpOO0FwSEk+QjssyVgHoIjeXmhmVkeGZSxP5jLjr+5B+bCVa9uALM8GnmgqdjZQ1UjOZjAQP9U4eTDajMnOlgZ81b7vY3cXuLnafE7urD9PfIsxTBX2q69DnKqAJ6DdSxXMN+kTKewJB0kG6m9OGLOEGgYFIb9+NILA/s4DoPhh/N/qB+EiX8vWdo8we+v4Y4UdmrIItkEGlRy3BBDIR844V30uOrSVK3F9fDWDomIODBhsgovp9YCESQkFlURIEyAmVJeIJJoPfYjKjkB8pRISUOgPqnx1t9bvjDknukOSuGu2q0a9TjXZIche7u9j9OWP3SSSZcaWixeAkmcznNFpoTzPPUVpKYEB21oVkIadMtYpWkBjJMJZVRA7WuFYdVyeHLqt7tO4d7DcnNfegRhuH1cPquF47tPK1/noZx1mQFWMqZ29tR6ViAHH4c3USgHPJWAivuP2X4KmaCaY1dZgrxc2gc1DpzRI71texY1fEIBsQBuwYbdlevBpcIH1YWp8VA72JJMLf0KNsq3OG+6AAKdGHQdNcxjvouIOOu/KzKz+/TPnZQcdd7O5i9+eM3W+CjvWvQcf6N0DHOkGINUGI9VdCRw9wB0KzCRgFZDBnRUCOEESBK7P7aMJeH3PLgF4BRdaa6yhyJAS5pMEiBUuysBMZLNWF6Q3GznFslI7Fs11kCikyIJC1OKBb9Co8xw2YFA8x+XzOVRyjQEA3WtitSQxS6ZhJ/S1bxRyokiop+AL3XgX4GAd3YhOEf0BB7YNOIVH/wD1OY63v2g8mA5T4AiUmnXuXMYz5bP+3semUgAPMR5guhtrWW44L6D1zGkAbwe5Dnb4yCLqD6juoviv3u3L/a5T7HVTfxe4udn/O2P0GqG7Q0HaoDgOeDdVhbHmPZFjqDJ3r/47YVagYDpR7E+EqrO4tMbjCFeBK5uVizCH4+uyxVcnehTKHZCsP3HuspO92WnisHQGi5i2JfJgzi+NQHlcqD/pFxMcyDXkZMhlYLV4E4q7sinllDHrakILwxKkONxxAWn3HdBtlpeSIox/rpJe9UWmiFj0WVK8OGTxJOTDvWC6gETEvWZbwYK3xKXUbX++EhuI3aU4Ao4rW5AO5riL/8ftl0YS2yLJJfU+uBuMJcLoiIopwg+bSr1gre10BP22dsVoJ2vv6Jj9miAhdc7g2cll18LeB2hpDPRxWIyeMRtA+6OMyr96+G70mU8SlKi8kEiEx49hIQGT1wY1U3mulR0dwkipFkUim+oWDVuFwDsYZmfigFPIhGDJGrh2jqC4UhAFkcKV2nMRU0sBZN69SC3rsC/OxVpaX2kbn5F5QAS1WaGHea1UXVQPBA/2yCdwt40vq+ii4elkGxxgRVT9IrsNULpqT66VM/COlZmtqtqImX69woVV77erD3m7ElFqoL5W2Xry4pmfn6GG3BXeQ6ioPqAnDR/FIlZta7cV8FOjZSK/Ix4fg3YxD0S1OIzrHEQk10/eIQ9yZEJL9kxB0HQyV62kCkfZitu5wUVtFhF3by7Fk6yVtbgOEVPxdQGAE2pnoGEu4QjBCb6aosP2oLAt5QX9f4WNBZnX7GiotjvSEK1/MMy5o44LmvXFp+DdvJACzENsog8oD2gHaS/urTGAYzeVGTWtj5lfkK2oOlg/1pQdVcsNj89mHZRI0V/p7EDg6GwOpGhF4dsgM/jZfjVBYoKCsdO9gVYPr/PoCiuiK3jS/2S+gWFj/bvKixK3lFksv8Bc/OktvySR/n7z7F2W8Xab5FTONwcTobmpZ0zzknfzEYLr1LT+pPhYC/8JTFasKfkNzk3ttMkco9GmMXq2i2p1xpjYLQkZjxIcl9CwxV5EIfT2GP5Oa0FS9jhsByxTaO+4DPbWdna5MVcBo8Il2xb9lYg5XCHBJaD5ZmbyD/i1wwSzYu+GxXnj2SZgmbgiW6avPBZ2mxgbQNZ8nAX6mB9hO5oSCS33FIzwu3UQnLugmApbqQijol81KoxhdDUVQ72KzaC57E9yHhhY3Z/ivrAV2l2YTmuoX78yngJaCDPD1evPmcxHaf402eJs9Y36I3SNkXQBgLLfCpTNaowjEAvPLh4imFTNJVnAsEMleP7b2y9Xynq1aCrgfChlDv5tnP/2sTu4zRPr7N+VVV3xYbsH/ut9+MgUOO5NKiFtvqLZEd1O6ib22siZWbUGYt8qP1Tehsk4W+p4ZKBuHPzzgZg22do94G9jHnYDrm2XXproncAa8hp55Aulp9aNReeW/GpjPS71WPze9+FNSG2VNNyODxXIfwoLLzwy3L0BIaPJBNrW/pPjWD/QOVG7K2m802ApmuwLnHfDTx/8Bm7BdoA==
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api/beta/identitynow-beta-api
|
|
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Download export job result.' (get-sp-config-export)"
|
|
---
|
|
|
|
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"}>Download export job result.</h1>
|
|
|
|
<MethodEndpoint method={"get"} path={"/sp-config/export/{id}/download"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
|
|
The request will need one of the following security scopes:
|
|
- sp:config:read - 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"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"id","schema":{"type":"string"},"required":true,"description":"The ID of the export job whose results will be downloaded.","example":"ef38f94347e94562b5bb8424a56397d8"}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Exported JSON objects.
|
|
|
|
</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={"version"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current version of the export results object.","example":1}}></SchemaItem><SchemaItem collapsible={false} name={"timestamp"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Time the export was completed.","example":"2021-05-11T22:23:16Z"}}></SchemaItem><SchemaItem collapsible={false} name={"tenant"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the tenant where this export originated.","example":"sample-tenant"}}></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><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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Options used to create this export.
|
|
|
|
</div><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></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"}>objects</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"version"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"Current version of configuration object.","example":1}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>self</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Self block for imported/exported object.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} 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={{"type":"string","description":"Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types.","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={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Imported/exported object's ID.","example":"2c9180835d191a86015d28455b4b232a"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Imported/exported object's display name.","example":"HR Active Directory"}}></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"}>object</strong><span className={"openapi-schema__name"}> </span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Object details. Format dependant on the object type.
|
|
|
|
</div></div></details></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 \"version\": 1,\n \"timestamp\": \"2021-05-11T22:23:16Z\",\n \"tenant\": \"sample-tenant\",\n \"description\": \"Export Job 1 Test\",\n \"options\": {\n \"excludeTypes\": [\n \"SOURCE\"\n ],\n \"includeTypes\": [\n \"TRIGGER_SUBSCRIPTION\"\n ],\n \"objectOptions\": {\n \"TRIGGER_SUBSCRIPTION\": {\n \"includedIds\": [\n \"be9e116d-08e1-49fc-ab7f-fa585e96c9e4\"\n ],\n \"includedNames\": [\n \"Test 2\"\n ]\n }\n }\n },\n \"objects\": [\n {\n \"version\": 1,\n \"self\": {\n \"type\": \"SOURCE\",\n \"id\": \"2c9180835d191a86015d28455b4b232a\",\n \"name\": \"HR Active Directory\"\n }\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Client Error - Returned if the request body is invalid.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Generic localized reason for error
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"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> |