mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
119 lines
43 KiB
Plaintext
119 lines
43 KiB
Plaintext
---
|
|
id: patch-org-config
|
|
sidebar_label: Patch an Org configuration property
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXH9T2zi3/iqa3D92uy8OIQRCmOncCUmgaWnCJqTQ0g6r2HJisC1j2UDa4bvfc45kxyEp0O7OfXd3Mp2hiS0dnd/nOYrsbyUZiZgnngy7Tmm/FPHEnvbjSUuGrjcpbZQSPlGl/YsSXGPm4peNkhJ2GnvJDO58K42UiOFWIu6TZppMcbTnhPsynlg2zVD7AQ/5RJS+PMBcRyg79iJcEhY8wQWZHpdqRph0WTIVDJaIRZgwIMRS5YUTNk2SaH9z80rJkBgt2zLYZGoWJvy+zIC/IJChP4PRwmGujJk95eEEZyK9xAsE+ypDgQvwEOmWQcJY3KRCJQfSAXG+PWKvyXxPJThB2VMRcMaTJPbGaSJYGjkc/sv1pxi3bRk7tJykFS/eDvs9RiJ++RWZV8B9IqWvyp5I3DJwsDlNAn8zdu3dRqX6iqmEhw6PHWTMRp2GCTLFo8j3bFqGpLdI/P/gR7ytecNPySwSwDaPYz4DEl4iAlW4LsdXwk5Kj43QZMioNkU/k4dxxRzheiHocjxjF4PDFkMmmcV+VCyjZS8WDnqHjOACSDBFV4pi1GDiCeITbs25VaDqcLLE7em0oHVU9Vgw+Ar2DoD+RkmEaYDLcMehhQN5K+hD5HMbP5kLtoxQRwkYHxkR9zyIfFw3G/lguHyWoybTN4xipAeGixmQiYUCC+YOyOOJSBjSRLbBBYUvAnRxLQR3XbCOVndSFLJU5G6zuDaweMv9VJDuQtF3KSIfczuf3BN3rDgfxPcSvzD4YSOfjlJMRFycv12pzGdk9wtTcv/KxuQXchLgzFkIkcVDHuDAaOr5XlR6eChQy7w4I6a/L+cQdAjSgtFjHv4LStxgmQ/Svc/oH59LYAUHPhuTw/d5PD+pOOAz5+sthCFFQx47dDuffKH9uuCB2q1Km5iSPoHdSrkZS81AxBDqm6cyhviXIC7SmodPEqeCLqgIeNQ6rFYqy6kLtYJZ+w7iWKW2LZRyUx+yI+UO8VyKWZlXvpM/2qd9ZvtcKdJsXj4YJEiOWRGW9sa+QL+2U5VIEJFBtRBxyH1K79wJvJD9+rnUHxxdNtvvu73PpVdoxxit8ChFxJMe+cxL8gR6V1ZPTL6f25TbgbCU9Dn6cCm3xYsIKwhditV5VbmbepA/PbXSC2Ftxk6ncNcBO9oJ2EGHu4J5IqTy4qQ+EuTqGmpJLEBFUGZhDZj5gfueA76pC40NqQNWcGUKzssTtjkWCd+cF9zNWxxuIWsWsrboyksetlHybdXCUineyFDGaijT2BadkIPRDgVP0riolTFkesHDJbUc+pwqnyPAsmBP1IgA4bUGjlvDy9abZu+oc/mm3+sPhpfD/mjQ6lx2es2D487lYad5Ohp0mItUQE2CVp9rsIAGFqzocl9hQPA4aBnfQiTzbMoevGfZeNZtw/0QggOX1CFWVFi7s73Xqe80rZ3Dw12r1tzdsXbarbpV2Wvv1mrV3YNKo1PSLAx5NJwpqLpd5z1EFKysXlI+MpDRbff29xVpv+ugLoFNuGAossCQLD/FLmSbjALQrtqNrb3Knl1vbPFGTexUtuqN6vbe3rji7FZ3dxpAKSMPo7d2dnYpnxcpXP4YjerlKirbP0hl21D5ovWqgeVLjMphJNZcncpYPvL75hWR97F3OvjYrA7r6s5T7bPrrU+3tQ/ve5Pbm86VdzDduUzdtHWmAl4NrJ3zZtu7ujmYVLyr8+PxbCcc7vr3n3rnfDw9CpsnR6J9ZNc+bF/9/i6e3n2wRm9m0eBY7X06nvSvvN97qWr0vGBYSU+cdzIYnO2eHp7dnM/c8KNjfQ17k/H4Q3o3mjWOZu2GGLc/vB2GyQlXyf3wvj6yZ0fp2cGN2/v0MUrv3w3OxGX99MPH3crN8c7O1ehm9nWvVzsfjceOfe+MP1VS73o3TayD20bl/bvT8Sdxf3B2eTKo3diT7jXvqNp1V4THs4P78Oir91HWm/1K8nZvfPSmv3f4dnDtjVtR8/duUj/pDo9l/Whyee42rrYqzrub6sf2ZFaLTk5vv267neqnNx/D89b57fnhsGndfuCT169NSLTHLzMcFosxVzpnP2mwziiLNiVHsf8y8sNhn40Gx08SzrDsDPzWAvqWUtJKYQVYzuOeTogtLEWu8a+BgBYEIJxjIMOfyZLdZpctEGePqOui8P28WEyLBiYo6QxEJONEV2T1Iz3CYtm1pZ8G4csqb89UXT2HQWmPiYmFMjTst9kB9nWADhjRXcA5zyqyC1Ud7ZevouYAD1bkvm9WVRsE8pIpVZUknuFQLwjSBDVZZk1Wq1SYiGPQ6J1H01TqJ8yNZQAzZ9jziSAilB5Ix3M1OtfL/mKaJA+5Kj+2APLsciA2r1NeaPup87MSZrNRQmRCS7hCBoAHyTSWdzCLmt1MBqARcIeQsoJeJKP3mtjDsZkOX7/GtZdL7QqRoOmFNmB/ReOAPRlP9KXtKrZeoKkA2zPoIwJ+rz9Xt2r12t72bq3+WAMD4YPr3wLcAikZrTN3fFJKGbp+/F/lYjueApg9Ax35wk2sRFqxN5miqCyUoSPsWHDaTSByCwJWi6i+GDcAcKk1yW/Ot0ge6HptFQJv+R5GZoesYkE0A5DCbtpzje1o44GNpaNdMiTY9qdw+WLMQo7hnt+Szgti9hAC0ZrEnPp97Ug2TGRA8dajTY1AQvrRJDNITeMWQTVoorzFDrgD8mr5WkYYVF/M7Wug9RKENgq9G2zpzBTmzXPeimVFXfDxbqVRrbm7Nc6re7Wt+s644fLt7Upjp9HA1QPINHwiViXBxaWPRIgQmfnSBot8BYWgz0BCRgZo8ZfnTaLxwqZCj83FNPwy3FmDHMYOWiesVmc+APWUrvNHDY0IrdFwqcIhvifCfQgEL1zFSrZl0u4cNkfHp3Bl0Pl91BnCJ6S11HE3Mak76JbAKvjCVN4Rx0YAajlNg1Rmvxmqv4FAHAK1MNDT3zTuYyaxwAyz+ooZRdI6QxdDydbbkOxXryzKG5AN4FpA21qILKCB0lnztyb0pFFiHRtN/samApJi/AoSqeNQKofGlDpyTJcz2pxxCmnXTbEngpSTTGWaQF4BvLmYKwuqfIw3shxyXDQKBgdw/gIsYycpMEdiFqMw9xbDorEPpkFaZ5G704LSSKW4h2ojasYdAlvG2KOyMcjmQYdq0hGaS0HiCbNxecYqpkZKd+81M21sL+GezVP1grg78SH9WCRafuNWmOCjvlpnI7JGZiaTkcyWK002o3JzZYHPXE/4zjp217G7jt0Xxu7jmwOz72juEvTZWoY+oxD7cBlT8VyCPjF5TyhZNki3O9qQGwDMMoj09uwUAvtaEPYV9xEC078QH+lSvuJHn8we+vo428DPSv/cFsgg6VFL4EImEs4+8T3nmBSlVbW9vNqhjMceOGi4AiLiDiiDbpQ6vzgNQ+SEQ0PjSKHCXxI25ZAf9Q6rzoDU4zhWhL9BrJHkGkmuq9G6Gv17qtEaSa5jdx27/8zYfRJJ5lxRtBicpNIg4PFMe5q5T2d3GAxg2S/gLA+5/CREEa0gMZZjrNIiciiNq1vjLbdui5rDa87udsOt2rtVvlPfqm+Na9V6qVjrL+ZxnAfZYkwV7K3taH4rjm8Bx6UhOJdKpHQWt/9AvbFwMa3RqZAMN4POy/Trf4Yda8vYsScTkA1/BbaAxurtxdHgGOnD0kQe9UY/yyHM1qqD4TwhSIk+DJr2VLKGjmvouC4/6/Lzryk/a+i4jt117P4zY/eHoGPtOehY+wHoWGMIseig3X8TOjqAOxCauR4e+MvPfOQnjM3uowl7c844A3oLKLLaWHFSVEr2Hg86GLCkFnYiw7m6ML3B2ADHxtlYPGvBJpAiQzyF7QG6Ra/CU5GASfGEvO8FHsUxCgR045nVdPGAtI6Z+VEGs4o5k6AoKfhSH6e/4x64k3AR/gEF2gedQKL+C/c4jbX+1H4wG6DExygx69zbQmDM5/u/O6tOCXRDcxB2qG39neMCes+ch9BGiPtIp68cgq6h+hqqr8v9utz/O8r9GqqvY3cdu//M2P0BqG7Q0PehOgx4MVSHseUKy7HUIZ1Q/f9G7BQqhgNybyZtwurOHIMTrgBXyp+2Lc0fB5s/wVPCZ2wRDmpO8Az6/Hj6NzAQGOahzCOvDHkLbJTMQnlHj8Pio0ArEg6eL9XBhQNY86RreosyqTT20Gt1iiPiWsHmoG9JgaLpSMGTlLOHrfD4PNNkNhh4uPEgugwsRtA+/KJodNk88PdIPpBrFPsPf14WTeg7sqxS35OrwXgGnD4SEUUoPBI9RKytV196MHpeP3CXv7q0WB+HVdmB4DE+NUUHX359e3b6ik0QYVKE6yehhYctAcTICbgIZbBmdggEJ1FRiWU6mRLjzYVjNhgxzPVBYPY5HArBLrpGCT1I7QPIxaTS5sKDNPMHfR1xK3yseuW5JtHxPCfcBA1tLj6A84oqHLUCXqiPg+NB+c+hxdr0IBw92IBjjIjU2bGLKJOLF+T6WSb+J6NmaWoWUVOvHnGhVXth62PbNoQtkuC+Im399OKanlWgh30TXEGqj3lATRg+Fg9H2ZnVfpqPBXoW0lvk43N4Rk8wPnqCSmcrpqD6+Q7rMnsqpRL/yxi6DobBxSSFKPpptuixSYsiwqpWCixZeknLswAMEn/HEBihdiY+xmJMWETqbREKyT/IshDzf9AzH38syEyXL6Bm4khH2uqnecYFLXpKSOcAZfjXJQkdC2IbZdCPzpADtOb2p0xgGC3kPU1rZVYn8ps0B0uDDawSFRXt6y/78wRnPjG6gaPzMZCGEUvnx8XwGRlDC+vSgrKyXYDHGlzm15dQDh/pTfOb/5aJJfLvJi9K3JxvlvRDf/ZXZ+nvZJK/T979L2W8dab5N2Yag25x03Ewf6dK5/m3ICy+kCJ7EcLSGxe+4MNzriSRTItRDKADgwWXNwZx53oq4C/cpTxAIB1aIGrqCCEVCQF7CUYMZQx76gnaUogEp+cFN9BrZUBRDt0/phahNKFJDGMgJSjAu3zs+UCPNr2zlTkFowat6DP4XaXmCIbUL6sRZXaGD3naYHLs8PDwL9y7kqbVG4LV6QUjrJ05Er33Jg1hNYz5NMA3AjznbY6n7FQnRWg4QpHpQhKszGdlGQLdGEUoU68TB6rv4m41NMIFp3pmLfApZbaqQfVoRfPqj7kg+nE//eqNxZbgOdrgydZU+BG9zADYgo6xsML77ukSRSAWmt9H8H01ZpLaxLH4VhUQXrvPdnmrXLGoFcEXwkiVQFdcIK5fm8NDetnG4ouMzO7Q0sbVt/mG/d/gBUim2mGbshnhjhrKmeq2SYfoRanQmUIYTkEJePXbN9xqwVbtAS9DzGMff/Fl3oXhN6Cmt1woB1wLbPXNHr91OouKLz956j1H2CfqyXpH54lplCvyLvukedp6A6PH5g1Pgd4xiPkdXMS/+6XP8A++mPdr4CC6/q2U7b/BGE04w0mrYIL5gCI/PPwfb6M64Q==
|
|
sidebar_class_name: "patch 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 'Patch an Org configuration property' (patch-org-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"}>Patch an Org configuration property</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/org-config"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json-patch+json"} value={"application/json-patch+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><span style={{"opacity":"0.6"}}> array</span><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
|
|
</div></div><ul 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={"op"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`add`, `remove`, `replace`, `move`, `copy`, `test`]"} schema={{"type":"string","description":"The operation to be performed","enum":["add","remove","replace","move","copy","test"],"example":"replace"}}></SchemaItem><SchemaItem collapsible={false} name={"path"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A string JSON Pointer representing the target path to an element to be affected by the operation","example":"/description"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>value</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The value to be used for the operation, required for "add" and "replace" operations
|
|
|
|
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"string"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"integer"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem><TabItem label={"array"} value={"3-item-properties"}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><div><span className={"badge badge--info"}>anyOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
string
|
|
|
|
</div></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
|
|
|
|
integer
|
|
|
|
</div></TabItem></SchemaTabs></div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></TabItem></SchemaTabs></div></details></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The Org was successfully patched.
|
|
|
|
</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={"orgName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the org.","example":"acme-solar"}}></SchemaItem><SchemaItem collapsible={false} name={"timeZone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The selected time zone which is to be used for the org. This directly affects when scheduled tasks are executed. Valid options can be found at /beta/org-config/valid-time-zones","example":"America/Toronto"}}></SchemaItem><SchemaItem collapsible={false} name={"lcsChangeHonorsSourceEnableFeature"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag to determine whether the LCS_CHANGE_HONORS_SOURCE_ENABLE_FEATURE flag is enabled for the current org.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"armCustomerId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM Customer ID","nullable":true,"example":"DE38E75A-5FF6-4A65-5DC7-08D64426B09E"}}></SchemaItem><SchemaItem collapsible={false} name={"armSapSystemIdMappings"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A list of IDN::sourceId to ARM::systemId mappings.","nullable":true,"example":[{"sourceId":"2c91808c791a94e501792388b0d62659","systemId":"1556"},{"sourceId":"2_2c91808c791a94e501792388b0d62659","systemId":"2_1556"},{"sourceId":"3_2c91808c791a94e501792388b0d62659","systemId":"3_1556"}]}}></SchemaItem><SchemaItem collapsible={false} name={"armAuth"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM authentication string","nullable":true,"example":"epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag=="}}></SchemaItem><SchemaItem collapsible={false} name={"armDb"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM database name","nullable":true,"example":"EU"}}></SchemaItem><SchemaItem collapsible={false} name={"armSsoUrl"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"ARM SSO URL","nullable":true,"example":"https://your-arm-sso-url"}}></SchemaItem><SchemaItem collapsible={false} name={"iaiEnableCertificationRecommendations"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Flag to determine whether IAI Certification Recommendations are enabled for the current org","example":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"}>sodReportConfigs</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={"columnName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Name of column in report","example":"SOD Business Name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, column is required in all reports, and this entry is immutable. A 400 error will result from any attempt to modify the column's definition.","example":true,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"included"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"If true, column is included in the report. A 400 error will be thrown if an attempt is made to set included=false if required==true.","example":false,"default":false}}></SchemaItem><SchemaItem collapsible={false} name={"order"} required={false} schemaName={"int32"} qualifierMessage={"**Possible values:** `<= 2147483647`"} schema={{"type":"integer","format":"int32","minimum":0,"maximum":2147483647,"description":"Relative sort order for the column. Columns will be displayed left-to-right in nondecreasing order.","example":2}}></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 \"orgName\": \"acme-solar\",\n \"timeZone\": \"America/Toronto\",\n \"lcsChangeHonorsSourceEnableFeature\": false,\n \"armCustomerId\": \"DE38E75A-5FF6-4A65-5DC7-08D64426B09E\",\n \"armSapSystemIdMappings\": [\n {\n \"sourceId\": \"2c91808c791a94e501792388b0d62659\",\n \"systemId\": \"1556\"\n },\n {\n \"sourceId\": \"2_2c91808c791a94e501792388b0d62659\",\n \"systemId\": \"2_1556\"\n },\n {\n \"sourceId\": \"3_2c91808c791a94e501792388b0d62659\",\n \"systemId\": \"3_1556\"\n }\n ],\n \"armAuth\": \"epiYNTRYA2S7swisDWk1Zv4VMNgvqEjiBh5_ufuCWsma2m-5XADijqBg0ijXLby5nS6lxZNXabhGnAPGeDGc4V3jQKrhwV-UHypRLs8ZLgOjiQNus9NimS0uPdKomRW6TFWqXyfnYd-znNgbbVuwUy9GyD9ebDVJSntPastxSx7UcyGuWBqfNZYpuxKRWe_7TVY60qL55jUqyz8N4XUbbdcxdbZ0uik6ut-Bv90MKTbZexBW_PR4qcgIkaEs4kIenLyBxnGziYo7AO0tJ8bGHO8FJRkibCpAQIt7PISLo7Gg_Xf9j10dKq2YDgy4pPTvz3fE2ZHYnXCXvXFSA-vVag==\",\n \"armDb\": \"EU\",\n \"armSsoUrl\": \"https://your-arm-sso-url\",\n \"iaiEnableCertificationRecommendations\": true,\n \"sodReportConfigs\": [\n {\n \"columnName\": \"SOD Business Name\",\n \"required\": true,\n \"included\": false,\n \"order\": 2\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> |