mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 12:27:47 +00:00
71 lines
27 KiB
Plaintext
71 lines
27 KiB
Plaintext
---
|
|
id: create-form-definition-dynamic-schema
|
|
sidebar_label: Generate JSON Schema dynamically.
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztW21v2zgS/iuE7oDbApGdpGn3Nl8Obtw9ZJE2QZxcP6QBSku0xVYSdSTV1Gf4v+/MULTenMSb612KO3eBwKLIeePzDDmkdhlYPjfB8U1wUhqrMvar0pkJbvcCVQjNrVT5aRwcB5EW3Ap8ORYzmUt8MV7kPJPRJEpExoO9QIt/lsLYNypeBMfLIBYm0rLAniAAW5k0zCaCVR1ZwRep4jGzijn5jLMZqGDxWgeLnRJmvJZI5VbkFjXwokhlREYOPxtUswyqfvCr0OiClcJQX2u1nJbWPbXfzVpuob9d69uOn47RE87KXIIjbF7KmMkYjJKzhczn4CO87jgClotvPCtSAeL2q3/hhj/+HwywiwJ7G7A8n8Pzt3CuQgiH2GBRsFqtB6jpZxHZzoBRHQDo2XKv6+24fvJT9vC0sMZ4ZsU32/J21Hz9iFsN1Wim3DAXnehXgZdCf+8QY1B9j64RV9C6ZWxIQNM0Hm0RCFSA6r8KbaD3+zKbgoc9O/7RfL2lQZVIljuZDdMO9ogLHNgVyNy+PqqNhEcxp95NK1vq74dgwaMvfI7tc2mTcjqIVDY0XKaFArlDU4So1gxjlXFJkZE27aO8lXAuXRLBGK3tXxJgAlMckzwQ1KZ9n+jb4aRLmGCUKwi0Hm/C9Xp6O1N3sML4YO6TWoDqGU+NoBZTqNw4Cw9BW2+SL4UtdW58dhSpyADz5rvlRlXaorST9VsexxQgnl40+/WicN4YxxKVxmjib5Pz9x5pc5HjIiJibypP00XQmrCu7j97I4PE2sIcD8n60LUOlJ4PY81ndni4f7gfHhwO175vNpqCvNfN91Ib+54QvKyhho2MWrvMBMdnZZr2RkDbvQNS3ldxxh/QYCzXdgzB8kAlFsbQEFrphlRiJtiTUdeenB4DH1sWmnP43yawwz1oRb1Hm5A/ypnQWml2B2pbewcVRaVGHv0B1Hdda6MiFhYcOlGxaPS9Z5Fa9wTDM2EMxMY0RnGtOeJcWpGZJgLeojPv3ACfrWHi85jrmI0uTitvfUpglWxaQwZBf3LaHqQKCLZhsTqjdq+P4pZb5lpbK5PIw+vJIwtTNQwhTr/OtZzLDZuIs8bbKjkUyhg5BUu+8hQmkakZvLgjo5wsdscNM5DfIkszW1s2fvvr6PrsaivbKosQy7gV6a/d0OqDAcm65CntWdAcbHJTUEW+ZcQV7utw71Gh8rElHLUjtLehELeQMaCf+zG8E9Ng1Rb3zuPMJQtbmg5W6yW6t4g35UzqsRgiDXaB7W7X+6A7vueYGOs4e7ANZ3lpE6Xlv4iXO+bumLtj7vMz9+U2zC0NVBWA00wa3MqaHXl35N2R9/nJe7QNeZEGDApVqBrLfMfYHWN3jH02xh7+siG8SrGM5wtf05o/RNEmUbZhyHbMaHO7eyzs33l9TTS4SLMIX2s6sOog8xQ80zlgaCL0V9hWvN0CGbsEsksgz5tA2rTvuLcmevdmy4965JLilyjefylmf90Xr/nR4SsxfT09OJjG0+n+q5+jeHr0mNvNRPN05ylDvbrn+E161hrHWjdnuzJglxP+f3PCD7GpQDsEoEnaRXB8swyugaAnyMVvdlTaBK/0/T3YMewy0Pnb1S0KxSV6DmCrklU4VfHCq6HL++49z9+raxx3t1Pd9zRudAY0T5AF6IyArPkiwKoHde0FhEOvE03LhE0UXsoBVIlfHP0IhuhEWN9nGmowobtoCytDwvVNkMtUzo5Sp0F9lbQEG3luVwNeyIHLyXaRqztCwxTySs91DzqEJnagNOEUDMgFLTlwyqUZEu4QP+NlihBYQ+xByRgQJMBClZo5MXuYdVx4XTOYWMBm8S+Geg8QBXs9/8Cva52u/n1fnKB7fNkUvge1QX8GlnZcRBduaxQTrpz2Hpbr1QPPkg97ys6x2yF7I7iGNcqqLyJnP/324epF4wqyNLggC4kXt4yzC4AI3hayURQBt6tBkHtsolU5dyX0qHVyTVvfWQoOs4/5RAh2c1oF4T0k0su3kysKKQ7CZrcS3v7kZycWX0WKK8agjiQCT8b5ECI05K1xL/Cyl2VKw9KRu5QCrYOPecjGUgvCPn1l4l1E7zi7KbxfvOHXU434k5cWOmkhSTMvOla40N5EqcSlLYKNAYrgqaFoPVm5kxc25IVzDcAJUWrXBoxEZUf7viHys/ZkO1ryKKW17fiYf0hklLD2MObSGTOJKtOYnbIoUcqIvzGG0EEa3OCXQ+LJZt2h0pAYER7uN0wKncpQhqURZN8ZECN3YOJTVVq38isGKTV2lPxEMwuc/wQLbMw+tXym5hvYSWDPWEXmyTajwhAVhi4HmMp+t/1DYOECCj5QHnAAOKnnnzJBZWgj7zlZG7M6iR/SGFwaIjCVpMDa6B6O6wRX/WL0Anuv+0Aaxo2lZxSDZ1bJwoW4FSy/L+hGsG9vqmCn1Imbs9ePpRv+H81f9HhUb/XP83TxvbP0PZnkx8m7z5TxdpnmfzHTVNt5LJkv629o39YfSf2nvmLrfJgptxa1xcduIA7o0yy/m6R9U+0/ezniGo8qEwF/4S3lHjqBAD31xUZTUJFyS1/FYZaKEgkggQK+ENziXnYPmaIyyixQrWM6g8qXBM3pi2MNU8BTPpUpyBuwq1ozpwTgNsqIU3w2JZX+9MFywvO5GLAPULLmEcAMDwoAbvjuM2CTDJ0A0i4QqGzswQubyCwrYeoWmGfKjHGgyCMIj6WJSpeII5XnwseCvkFk61E+KyF10AU6shBQKZ3P8MhVRqIB5Ed0AY79cTSEHmdxffriHbkUKTEN+7XLkMdkA3vCRKQFHWOAWfgRWK3h3elVTyIIyw34FQn6BLAaZIbYt/5IFga8HBwM9kMqf6Ad60iofRvCtyllO99GV0jHYmQIaHNnG6UrjlyFehN0K9TqFOC+GhWqngRLXBi5XE65EVi0rbAZ2K+xnr+t6zF8Ao2J4DEya11cn7iDt/DKfV/sq+neIRyWiW4EVjqFfbBvswq/OJ/gTEyr7/kz2tcEmt9BI/49Dj7CfwH+rwLOaehE7csgBXKU7rzFyfW7pE2bhOoHurla/Q4JiPVB
|
|
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 'Generate JSON Schema dynamically.' (create-form-definition-dynamic-schema)"
|
|
---
|
|
|
|
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"}>Generate JSON Schema dynamically.</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/form-definitions/forms-action-dynamic-schema"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Generate JSON Schema dynamically.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
Body is the request payload to create a form definition dynamic schema
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>attributes</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"formDefinitionId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"FormDefinitionID is a unique guid identifying this form definition","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"FormDefinitionID"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description is the form definition dynamic schema description text","example":"A description","type":"string","x-go-name":"Description"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"ID is a unique identifier","example":"00000000-0000-0000-0000-000000000000","type":"string","x-go-name":"ID"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Type is the form definition dynamic schema type","example":"action","type":"string","x-go-name":"Type"}}></SchemaItem><SchemaItem collapsible={false} name={"versionNumber"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"VersionNumber is the form definition dynamic schema version number","example":1,"format":"int64","type":"integer","x-go-name":"VersionNumber"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Returns a form elements dynamic schema
|
|
|
|
</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={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>outputSchema</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
OutputSchema holds a JSON schema generated dynamically
|
|
|
|
</div></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"outputSchema\": {\n \"outputSchema\": {\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"properties\": {\n \"firstName\": {\n \"title\": \"First Name\",\n \"type\": \"string\"\n },\n \"fullName\": {\n \"title\": \"Full Name\",\n \"type\": \"string\"\n },\n \"lastName\": {\n \"title\": \"Last Name\",\n \"type\": \"string\"\n },\n \"startDate\": {\n \"format\": \"date-time\",\n \"title\": \"Start Date\",\n \"type\": \"string\"\n }\n },\n \"type\": \"object\"\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
An error with the request occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
An error with the authorization occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
An error with the user permissions occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
|
|
|
|
An error with the item not found
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
|
|
|
|
Too many requests
|
|
|
|
</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={{"description":"DetailCode is the text of the status code returned","example":"Internal Server Error","type":"string","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"TrackingID is the request tracking unique identifier","example":"9cd03ef80e6a425eb6b11bdbb057cdb4","type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"Internal Server Error\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"trackingId\": \"9cd03ef80e6a425eb6b11bdbb057cdb4\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
An internal server error occurred
|
|
|
|
</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","x-go-name":"DetailCode"}}></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"}}><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={{"description":"Locale is the current Locale","example":"en-US","type":"string","x-go-name":"Locale"}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"LocaleOrigin holds possible values of how the locale was selected","example":"DEFAULT","type":"string","x-go-name":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Text is the actual text of the error message","example":"This is an error","type":"string","x-go-name":"Text"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"statusCode"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"type":"integer","format":"int64","x-go-name":"StatusCode"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","x-go-name":"TrackingID"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"string\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"This is an error\"\n }\n ],\n \"statusCode\": 0,\n \"trackingId\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div> |