mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
100 lines
42 KiB
Plaintext
100 lines
42 KiB
Plaintext
---
|
|
id: peek-resource-objects
|
|
sidebar_label: Peek source connector's resource objects
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXG1z2zYS/isY3ocmHVOWZMm2PNO5U+yk444T5/wy+eB4rhAJSWhIgAeQcVSP//vtLsAXSbRju5lrm1HaSSQSWOz7PgsRvA10JgzPpVbHcXAQZEJ8OhNWFyYSp5PfRJTbYCvI+cwGB1fBOV23wfVWEAsbGZnhRJh2JnIjxWdhGWeWp1kimJ6ymOecGZEXRomYTY1OGY8iXaiccRWzmdFFxvhsZsSMOICx/y2EzW3noxqzXH8Sit3IfM5Oz37+z/jo7fE7xot8ro3MF0xaGi4NkM41i3iSsHwOV8fvjzvAsxVRgQOB79vg0gpzqFUuvuRjoICyyFgdODnDSCsFkmpzkHLFZyK4vgMJM254KnJhLJGQKGfGYfJWoOAGfHPTQW+wWjQXKQ8OboN8kdE9UIiaBXdbQcllcJCbQqxq7mIu2PERaiuHT07BQE98IS3CgEhMd4Tod3vxZDTYi4ajXn847HV7wwnvRrt7owB59Yp7peMF8rC6ZISiqxxv8SxLZETq3v7NIgu3DearZW8DTda/cNIY7xLAWcq/HKIJg4NhF6Tz4rrR6CoyJ7ZLJ2Lei9iZYzFYdx26zlIdi4RNtWHog6xckWk/n9zHX6sMZtHSmUEfziU45grfq9ZoUz6OQPWvLQhOJXOMDbj0WZgOzZ7yIgHRA+/HS5Yif0aL1yqqGJBggJkwrRzAcJkWKVNFOhHmMbxQ+LjAWmKrP2zw0+t27+gPuofNtLJOQf1uF/9Z5uNEgglaV57znN1w0L/IwU18GKOvrtoCOXm0oz3BbRzrLX7jbnwzx5Hx1x2mjlS7Hqn9aNTb7+4Pd/ejYX8U7XZ78Cniu9NRN+rt9HYCNASPT1WycIF5V2aSry37DkY9sPDp0Xk4PgovMIyufE4b0Z/rtjWdYp7iobVnLruFMKLyi8mC2Ftyh4pFdMw1PkTCMyvitzJJpH0yJylNE7BebJnNwOsYVBBkAT5C8iuLyRIfve6wjROzUvFqXrgxfAEUIPpS+wTHbXHXDFYB1lyl88Z0ZNjNXEZzV9GaxfIxTqtszlUk1iP6OEY9TKXTFnlOJiK4ELFyEqyLFqSq6TkBHiXQwYVWXXJNa5JWyBfra78DIT8LVg5YkVaqRq1rW6n27MN3P425AX0dgiG2Ti9/ysGiva2jQ/rQLz+0cVcULqCXObtUwJixPGGFkuAfnsemmp7O5S2fTPcm8WgS7u5PBuEg7vfC0WSvG+7vdaPhvphM9weDuzYmwSc+S13Y40erkgKvweYcUnNJJVk8ym5lzlle6EjaLOELhncpmzbc4mHxawvdn23KerwS0b72PmaVuuKuO6KKNI7KW5YYs2nCZ2DNmIqRmpUaBOHgf65YPbvkgwFcjNEBKGLAVyIOtbOKlkZEkvqhOLu4rdCtVKDA1EU6kgFkbIBMNic6WLxrC1rIZLN5zpRGY4KpOav4sYKKMkLbCjjnoJpJAV7fYZgQ6+/OY+tQvoEECYyBUaOSa+OAQIxqWJ0o2IlUn7YYXAJemIYrhi41RxLNCZCaczUTccNiE60TwVXTZFOeWNFuLiNSTIXJM+1VTvd8VHa78KOshOrADcGm2roomQQNJlazFHi1dTB95gnUCtK1WrAUwJQM6Vr8gILtXBdJjOpIhQFtuF6FKtAXgFPIu6fbUDADEIeahaWVt44TsjGLxtHU5ykY8NCTY6GRTiYC+i5HI27oFH0RVsEwgNsap8Mg6PCaHVzp23WE2CLLtAE3j4FeVBY/5dKaW8U+T0zwAgDD94qJDK+LKlZs0jCvKUs0akTNfGDjGktGq2/yGPRzLnJPH/UEHEsiXvmoC1O/qCv0HNIIT274wlKivc/dOIEYXL+BuqGpNciiI/g8xaXSWkyvLZpLfB9QsUH1wEcKMoRpCqRLitilyGaVqHyF/KSwZUicvz2s3AEdhLIIjcF+gQOVj655sh+DhkT3Ya+6ta4kvSKZ3kiRgKTUpZZfL250cN2ig1rPLWqobUCYQFIb0kCIDSYrINhonXPw6myulXhHaBVG9frhi53B8OXu3n446vb61EdLSH/ltH8hjOlAqkLg6CrxO7fJ0Kiudy1yTKXiyWUW87aAP1ZsXAfnFnmbzbixFXxwsYqFhUq+xqTqSw2EfMQVglEPPtCxC1opRiN7T3B+/rxacHe3CpPf+G5iqXm7r9tco0YEB2397SGEJQj52hgQMwRzepwtHebzvQKb6Jh2lqSC+JLxH2ppl4E6ZD8w+CH0ql9v995IJcKZgcAADgWxHMFEwHn6s6TinWqDyRNJlrCVxi01O6iJTo+94nG5+cIOvTC4cWN49AloHT+i7b10WLmcAg7hEWLrsmJP8Mlud9QfTHcHnPf3B7294WQ05Ts73dFwNKItEmEtn4m2Vmt56Z+FEgZ6lkRHYJHfBe57cNA9MUCLP9SdLduAaDxyW8iNrcT0/DLcQdwCiPbq8D0b7LEE4EdB1/lsRQkqvDzHrcIiSfgEL/mAdYRPjZxJ1caKgBYXE9rR6zfjy5MLuHL2+t+Xr8/hE9Ja23odq7LKaWph5vqGOPYC4NaNhXwUUTH/0VP9sQJA1UDpvtmFBWUyv6UEM/zqLTOapOtALUMpctut7IXsiA7AStrj4xDdbMKxMvhm/cdxFIksD0+8Jn9kc4hqYV522DiOJQoJKcmXzxT6E4BbUHfL4gMWKiCUBRUaTdA1l65fq21Rq3LZGnX3ftI0CgYHcP51PxlHeQHMkZjNKKy8xbPo7QM8O80tc3fRUBqpdAE1EYAS7mgvHGiHRO3Aq2U+HTlElnJVjqsyFqbAUixKd28dM0e5pnsRL+wj4u59AuknJNGqGwiEKPgI/bhsRNYozeQzEtxEsWmyH1WZqwx8NsXqvIndTexuYveRsbt6s9wB93cJ+vTatrz8j2ZYPNegjxEOy5W/rP3u+jhnyC0GCvEQ6ZcPF/4nORgvvmT4+9I3xEeulLd0JKU93PVJ1Sz70l/bAhkkPToJppCJRHxAfNccBzVK3Flf7Y02EwkOqlogImRNwxa6cG1ZoRRtotgtaIWFVT+UmzcQEda6DIirqjjMoFXON0hygyQ31WhTjb6farRBkpvY3cTu3zN2H0SSFVcULR4n2SJNuVk4T/P3aZ+YwQBWPl/CqpAjU62iFSTGKowVLCOHYNLvTXrTvUgMYj6Id3dG03602+fDvd5ebzLo7wXNWn9Vx3EVZMsx1bC3syOpGEAcPj9TKHAum2sdL2//FfgL+BTTGu3vl7gZdA4qva6x46Dlh1qdg2xAGLCjuWd78fLsBOnD0kS+8ayKqTdkeU6QkvZX6SehDXTcQMdN+dmUn++m/Gyg4yZ2N7H794zdJ0HHwdeg4+AJ0HHAEGJNEWL9mdAxBtyB0GwKRsFntfzzGGb5+c4y7HNuZiKvgN4SiuyPWp6I05q9xWeQPFiySzuRqlYXpjcYm+LY8tgEDuBsBilSMchaEtAtepVMBWJSfHg8kan0T/UIpGsW4Xiag1QuZkp/q1bxT3pYSgqJxr1XDT4mwZ3EFOEfUKB90Bkk6m+4x+mt9Yf2g9kZSnyCErPXXyIhMOar/d9h21MCx8C8wXRx7mx9z+MCbs+cK2gjxJfMpa8Kgm6g+gaqb8r9ptx/H+V+A9U3sbuJ3b9n7D4Bqns0dD9UhwGPhuowttNlFZZ6Q2cT/9+InULFc0DuzXREWD2uMTjhCnAlOvisaaOVDvgeBNsOrtvt2/KM79129ejpNp4zDEtIH+rqmLTrEBzDhcGne+d5ntmD7e1bsCPY767DM9kpz/IofYNP/G5PQHkteck9So0+hQPwWLNvQTqkeSPRuV0mJOLODuUBVQv2oCcPHqSs/MHCBYjCHJktPBHrHY0u4/kJ6DJ+sDS6Q461Jh/IdWmSuz8uiyN0jyxt6ntwNRjPgNMVEVGE6/qE+DlCcrf62jnxuszgjwH9tcVOcVifvRLc4PkAej7mxS8fLl6yGQJRSgQFPmzPhMTOAULpPbgIJbpx+awITqLaY3QxcydIxktP42BgsWkCArOP6lwIdlUeGHsHFeAMUjapFCcJyhI46/pFaZ1YfBYJFsdOrUl0PBmrbdDQNl+a99IdSsCOoXGOqfNRhexIGneEwx1c8CJSA8iuslIu3pDruUz8o6QWOmohUbMvV7hwqr2K3NPdEUQ3kuCJJW09e3FHL2zQw/YKriDVVR5QE56P5WeootJqz+ZjiV6I9Jb5+Kg+uAMlS9OYS2rl+aRjFs21tuKfjKHrYBhczQqIomezRadYQoqIsN9tsBS6JUMZAmYk/k4gMJRzJj7Bmk2QRbvdEwrJX8myEPO/0tmQX5dkpstXUFpxZKwj+2yeccEQFwxdDrCef1e50LEgtlEGygPOAQ5r+1Mm8Iw28p6j1ZrVifw2zcHSEAGrRMVmB+7LQZ3g/CdGN3B0NQbScEBnH/1TZXgU0NPC8rWkrHKzYFWD6/wmGqrmit4cv9VPnlhJ/2ryosTjek8Fj3586yx9Tyb56+TdPynjbTLN95hpPAjGvcmz+g0yr5/8Ehj0V+LbtxvNKHnlAd/6JqGlY8nwN9x1rzhBwM7p6LI/SNsklCU8x7CgtBDN8XVDuOsueI7gcQtdU6cUypnRmD/ovDIQmhkYA3FvAdTyiUyAHm2AlytzijiHTNEx8Lst/OMY2p8x7rAP+GaJCDSA3R4+CAz3ftPlawLAtO/RM9hR6S2A2tK0UHhoH9guUsbBJ7/iUrG0UeEyn283nAjuNHY1q0wD6KsoAp29Eya1p1PcuZb4PojgkWuB41i/bQ2qRyv6txvVgpyJhFwbxy3j/q/RBncN5yKht+JA2hb4Ipd6hbfHF2sUgZjyv5VoM9v2k+w2jgUi2F8599np9DrdkPoNfJECtG/QITeIv8eXwayeGvzBrr0fZtUvb+sd/L/ia618ocMOZTvDPTeUvnAdk2ter/x7qVCyg8YrqiolYJvb2sFCTzTHNhhI3N7izg22dHd4GfjHbYGr67pboy4X7Iyf4+qA572qfHHmpXpJvz21vPKqVbJyz1Et6u2GAD5+ErhLUUkHHT3wTptJxJe77X+9CCl/1dPXfpbBftbNcBtUD469bmwavD/Frbpg4l+7lbr9D8Nv4CL+fRB8hP/gi85c/MAgun4blLuJMMbRLeFcG5rxH0D/MOx/x5c6uA==
|
|
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 'Peek source connector's resource objects' (peek-resource-objects)"
|
|
---
|
|
|
|
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"}>Peek source connector's resource objects</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/sources/{sourceId}/connector/peek-resource-objects"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Retrieves a sample of data returned from account and group aggregation requests.
|
|
A token with ORG_ADMIN authority is required to call this API.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"path","name":"sourceId","schema":{"type":"string"},"required":true,"description":"The ID of the Source","example":"cef3ee201db947c5912551015ba0c679"}}></ParamsItem></ul></div></details><MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The type of resource objects to iterate over.","default":"account","example":"group"}}></SchemaItem><SchemaItem collapsible={false} name={"maxCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The maximum number of resource objects to iterate over and return.","default":25,"example":100}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
List of resource objects that was fetched from the source connector.
|
|
|
|
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ID of the source","example":"2c91808568c529c60168cca6f90c1313","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of the source","example":"ODS-AD-Test [source-999999]","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"objectCount"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of objects that were fetched by the connector.","example":25,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"elapsedMillis"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer","description":"The number of milliseconds spent on the entire request.","example":1055,"readOnly":true}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>resourceObjects</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Fetched objects from the source connector.
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"instance"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Identifier of the specific instance where this object resides.","type":"string","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"identity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Native identity of the object in the Source.","type":"string","example":"CN=Aaron Carr,OU=test1,DC=test2,DC=test","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"uuid"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Universal unique identifier of the object in the Source.","type":"string","example":"{abf7bd9b-68b4-4d21-9b70-870c58ebf844}","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"previousIdentity"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Native identity that the object has previously.","type":"string","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Display name for this object.","type":"string","example":"Aaron Carr","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"objectType"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Type of object.","type":"string","example":"account","readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"incomplete"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that this is an incomplete object. Used in special cases where the connector has to return account information in several phases and the objects might not have a complete set of all account attributes. The attributes in this object will replace the corresponding attributes in the Link, but no other Link attributes will be changed.","type":"boolean","example":false,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"incremental"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that this is an incremental change object. This is similar to incomplete but it also means that the values of any multi-valued attributes in this object should be merged with the existing values in the Link rather than replacing the existing Link value.","type":"boolean","example":false,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"delete"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag indicating that this object has been deleted. This is set only when doing delta aggregation and the connector supports detection of native deletes.","type":"boolean","example":false,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"remove"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"A flag set indicating that the values in the attributes represent things to remove rather than things to add. Setting this implies incremental. The values which are always for multi-valued attributes are removed from the current values.","type":"boolean","example":false,"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"missing"} required={false} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"A list of attribute names that are not included in this object. This is only used with SMConnector and will only contain \"groups\".","type":"array","items":{"type":"string"},"example":["missFieldOne","missFieldTwo"],"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"attributes"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"description":"Attributes of this ResourceObject.","type":"object","example":{"telephoneNumber":"12-(345)678-9012","mail":"example@test.com","displayName":"Aaron Carr"},"readOnly":true}}></SchemaItem><SchemaItem collapsible={false} name={"finalUpdate"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"In Aggregation, for sparse object the count for total accounts scanned identities updated is not incremented.","type":"boolean","example":false,"readOnly":true}}></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 \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"ODS-AD-Test [source-999999]\",\n \"objectCount\": 25,\n \"elapsedMillis\": 1055,\n \"resourceObjects\": [\n {\n \"instance\": \"string\",\n \"identity\": \"CN=Aaron Carr,OU=test1,DC=test2,DC=test\",\n \"uuid\": \"{abf7bd9b-68b4-4d21-9b70-870c58ebf844}\",\n \"previousIdentity\": \"string\",\n \"name\": \"Aaron Carr\",\n \"objectType\": \"account\",\n \"incomplete\": false,\n \"incremental\": false,\n \"delete\": false,\n \"remove\": false,\n \"missing\": [\n \"missFieldOne\",\n \"missFieldTwo\"\n ],\n \"attributes\": {\n \"telephoneNumber\": \"12-(345)678-9012\",\n \"mail\": \"example@test.com\",\n \"displayName\": \"Aaron Carr\"\n },\n \"finalUpdate\": false\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> |