mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
101 lines
43 KiB
Plaintext
101 lines
43 KiB
Plaintext
---
|
|
id: create-non-employee-request
|
|
sidebar_label: Create Non-Employee Request
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXOtTIzcS/1dUvg/JbjHG4wdg7sOdF9gtUgQ4MKHu2K2sPCPb2owlRzMD61D+36+7pXnZxjyySTZbTrYoM5Za/fypu0fivqanwvBEanUc1vZrgRE8EadaHU2mkZ4JcSF+TUWc1LZqsQhSI5NZbf/mvnYVC3OgVSI+J700GcOzD/MPW7WEj2L4XAMCXkaBncihCGZBJNiPXPGRmAiV1GBwKOLAyCmuDSv3xzJmxq7G7mQUMcsL40wBNZFRy4ZwFcIXiRzOWDKGUdOp0bfC1BlyLI0AYhqWDCyTTA/ZRxmqfSVis28pf2Ta0NwUhGGTFIjqO0VPYp2aQNRBarfcGx2C4PcLPFfEJKLwPOdwgHMsBeAHtJuYVGzViCPQAFADpiMZ0KztTzGSvK/FwVhMOH5KZlMBi+jBJxGgAUBAsFUiRUxzg0CnKjnlE1EaHCdGqlFtUbnOiiJkMoS1wYrMzWcKCKCg4jMHSZAGKl/yST2eSLDsfKs2lCZ+4kJljXwXM5q5YolruwQSj/gLaePEFaQvM65BizJ6NlWatUYf/3bP64Em9qdjrZ7PO82qrtLJ/0OyE4oU8zjhPvq+M+XxIbo5Z7c8kiVLJ5qBg9/CuBicG6KsHE/AjFurys4nDgyGWiAzNhoQH54ppp0InFRpN4Ouv9fY6+zsBZ1mN9hp+PAp4DvDbiPwW34L1wx5sjIIeBhKXIxH55VwqPI1X2Ssl8AXgxTgZBDpwfaAj9gQor+KLVvMbzCejYyZjAkMJvyznKQTFsvfABnS6VQbiKSKSIvA0EuRS2QE1ZdwkxwC4KzSH3Ax4QAGKLDwEgmBsE6pzPKKEMqILsN5C+ptNBteo+U12/1GY5/+eY0O/KSoUOEfwApQXc2IT4x0lhiZl3HxpgJmZbwpwUMW0FnIFTFSctCysgtZcWOSCbG0vLMRss/nlqN4qlVsHaoJbK4H/Aznc+DPnfTJEM+j6GxIG+p6sJcrYy832NXV8eF6Wz0QibzRarR29ppeR7S5124Pd71BGDS9nUDs+H6z0+4G/vMQ4NIudBwC2sQ6kBw3nTsAzmXoKe2yz8MG9aTtwnGCg1/Iy4VI0OMWweSJC5cevnD9ZUIUOCt82Y48kQni9SZz2GQOX0nmoBZd9PG8dgN1G6h7MtT9JWni0zM/W5Ty6DgRk3h57ImMqTDNhjEQakILYtpp8srbMc2N4VhQyozaHxxIVbZkuOC8vmjt7Q08X3Q6XnvQ4B4fdAJvr7s79JuNtt/pBrVcBRaPFneWoTBCgdUBZqiELzzn2CFQIfwDQtpvl8UUKp1gYvnu7Keji9Pe6cHRz+8uzq7O4avjw6PT/nH/v5gWFvLkTxdVYlkZSqwHhsRnDo/g2OgZoNCoeEjuMkKRFUfhRkan09pKV86kPEx0H/kHda022iqOcP2qSTqAHw2/E7aawz2AEO539nyHMa1O2BQPRVRGLzfINcQtACBa7wumChVeobxK6u7bWilSLhOepCsitbBo7/z8AoyKvntx9MPRQZ8+nh+dHh6fvoNPp2f9ny+OeodoyQM0/MkJjFhqNx0BOQixKeT8yKsakWlXd5qyOIgtc2U5Stxkmu1VRSkJd2bCysYMLAyoflmAkGw9TeNLy/ml+B1GmpPqIJ2YuGJjvX3cwAJxqsRrx9ljSiN0iE6/HkMeLhSvx0KVUYzdcZd3ZYQXS0W/6zX2vGar7+/td5r7nW7d32n+jwSkbt0X5cSRXMdDu7Hf6tR3d5GH1XHTK6H7Gx6LCuR/k478Eldziy/4mvO00FGFhzjzd3QmVpvZUhbRLHPtJZPnrRLf34d/bb/ut7pFu2TTu1nu3fwF4PCIlf48hFjLyHy+ttPkukztVY2lg0iiLY6MgfzBY5COp0bhTjqscIavFDDtkIoqtfpzek3rE6mQCoADHT5ho38rlfBGhkvkUBDLAUxkGGEyRAiaaIPJPJJEDEARaFxVnaCJus/e8JA5DbEDJwwCruHBL0DrKZXYlZIwn2VTIP/Is+gVy4pdwQc7jW6zPdxpc97ca/u7nUF3yFutRrfT7ZKHiziG0rYM4Fn6XV36nVDCyIBFOgCL/AYKAccB3RMDtPjTM3ai8QT9Y+Vux+ZiOn4ZvuvaggT0zcE5a+9CUKlRSs/5aEEJyru6hCcqjSI+wEf4dgq7KkT4zMiRXFkAZtvX4dHb3tVJn3av/1wdXcInpLW0P/UUeGuIbgmsgi+M9R1x7ATAWItFBOqAYGOvHdXXIBBXcXmga8bHsxirkVAMeRolMMOtvmJGmTQbGj2phFL2YvB7WRf1LTbAZ4AUwZgNYC8PmbaY8LoXBGKaeCdOk6/ZWHBIy17VWS+vMbFvAkRh/gwIMSg+MXQtgWEKoSyoFtZpQq8sF4vfQpVVaxRgclI2CgYHcP64n/SCJAXmsvefeTjk3uJYdPYBnq3mqtz1F5AxnqmEByAFj2BfDbQxoGEGRTPUiTFzcITmigF4VDYuR6xyMkVw96NlBoog+i7gafyEuDuPAH48Ei3/4la44IuxpLRoRNbIzOQQydWbNNmNys2VBT6DbSgKN7G7id1N7D4xdhe/vHCv0+jbnCuKlod3/hVtIkuFwmXAw6oTKIxEsuBiErNmjWpy8Xg+UE4HbopQh3CqLcZcEVDOzsUrEObOt+A7z3+yUmel8kVt/sEliXW/3m50WdEmA4GHkN89piOzPGGtih5a5U/V0pXC0EFkdqd+KtXKQNCuYLuEJcW9B6eS2HF6X6NmXARzQwxjTAJhArrsh/k8y7v9Zc3BuikEt6HMbSnvNmQbpVk2yL7ntSiyha0+l5//cN0H3n+BOgLGi89TNOUXTM5tHrnca87BwD4fZNV/lncWQIAMUhBbCYbgAyLcJ74LjmuFqlrLq73VZiABHdWK+oROUM10yjiozKRKISc83mKhFrH6LmFjfkumA37t9ourqtCbaqmSTRmzKWM2qdAmFfp2UqFNGbOJ3U3s/j1j91llDOVJcTqZcDOznua+t+dpYADLThUWxwMfSsZbLM+xFrPvQdMf+MPdQLRD3g53Wt1hM9hp8s6uv+sP2s3dNdm3DbKFBLywt0vAUcV01sewVIFzxYnWYbX3DOqF2gJhDaEnz5tB55U0u9ldzh37WuPh/1mWIcWVHFIVOkJMg7ETHGuysTCAsxHgomIAVRL4QleSUAB4zGCxEMmJpOBFKYCumXm9YQKi2EDJnCxfRaogSoFDQoJIY9aswbEkCCmGmPMBBcpgR4DOXzA7dSb6XZk8u0CJT1BidvQ5EAIDPc/cO6teLhwD8wYx4tIa+IG3DLba4QocAAoCi1l53rnJzzf5+WaP3+zx38Yev8nPN7G7id2/Z+w+Iz932dDD+TkMeHJ+DmPrDZbnUm/Ruf70NJ1CxXFA7s10EKTGlFvdlFeAKyFDU00niKcc7+jWtsvHwrwsv67h3V5MDC1PqYlg6DhJpvH+9vY9mApMNK/zqaxn5zqVvsNbDNu3rRXAI/OLcwBdYRpQw7l3fuzKizop2Ej0YQt4tIBVN4mE3gpqp9bwWvp03h3sONMpQByR2WLg786f6DEeAYNi4rvYXfhA9SzJCLJdmWj+mDw/tdbJYYk8IMcq9a1dC8Yz4HJBPHfGKLuKfYlZt1196UJ2sZNgpdZcWuwMhzXZG8ENlAT25cX3P1z3X7ER5poU62mMaa6QWBxAtJyDixCW9bJGPk6i7cXodDQmxnuVVyUYO2wYgcDsvboUgt1kp41PAeQvAJVJpThJEBDgrA/fZ5YJxa2IcP+rF5pEx5Oh2gYNbfPKvFe011FRIJU9+AVP6++Vxw4lQpDEPRvHOBGpxmM300wuXpLrpUz8I6PmWWoeUYtfLXBhVXsT2HNfAQQwkuBRTNp68eKWnleihxUUPEGqizygJhwf1RdcQWa1F/NRoechvSof79X1WMJGWp3GLG6xGPbBKGTHLBhrHYt/MYaug2FwM0ohil7M1h0u6lFEeM1GiSXPLulJD9JC4u8EAkNZZ+ID3JYpK9GQsKnQhuRHsizE/Ef6YwQfKzLT4xvYPXFkqIP4xTzjgh4u6FkMiB3/dnNCx8JjjiAD4YB1gIPC/oQEjtES5llaK1GdyG/THNwaAmCVqMTTffvLfgFw7hOjL3B0PgYgGLPq/JUf/M4cLTonXVZW1g9Y1OAyv5GGjXFBb5bfvB+Fm+XXJi9K3CvaJmcqmn1plH4ASb4e3P2LEG+DNN8i0rg8F9uPpXv8R8WtvMrNpYWLyZV7yfmN4vKFYncXOL8KvOYmb36Rt3wPt3QNt7gPW75b+vjlz+Ju40MXDCu3E9bcHChdHFh/rB+Dl4zoyqsyZNjcd7klak/lwE/4lnCPyhMo/rLbn4KVyUwjniBCEEIGYymomTIVICrk0VsYpXpCqAbFA0IplMxEaETHggyYn0P5KyOgV2fXUK0qsLPBShWPnwDVT9qVrJdguXN0eXaYhQGko5NJqvBmGjCRThiHYHskVkIZB6mFdChclcgk05QU57MyfMMgRFXUqWYzk/hsiF13iVefa09cCyIidi13bo972WvAtUKQCxFRzOK4ajHzGG2IQ28soindoAe2oPItrfDjcX+JIhBT7s6uNqNtNynexrFABAtH6wytOlTIdLUdqk4IgBLdgxWnuoo/LbVw5zh/1/C1/lEot2cjje0pdghR6NQWf7bUvqmtLrWheBtjSQ4D7u+xi4R15xwfwwBsUdx8KMpK+qtaMIG6SVSb/yKwi+FeX3h0aTRvVyy/l8FK186wHaq1Yz+UugbnZ3Q2b+D+6NXENkAMv4OH+HO/9h7+h1/01DohDKLn97WsnYjAR3SzZG9VruM+oJjz+f8BMxlwRg==
|
|
sidebar_class_name: "post api-method"
|
|
info_path: docs/api/v3/identitynow-v-3-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 'Create Non-Employee Request' (create-non-employee-request)"
|
|
---
|
|
|
|
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 TabItem from "@theme/TabItem";
|
|
|
|
<h1 className={"openapi__heading"}>Create Non-Employee Request</h1>
|
|
|
|
<MethodEndpoint method={"post"} path={"/non-employee-requests"}></MethodEndpoint>
|
|
|
|
|
|
|
|
This request will create a non-employee request and notify the approver. Requires role context of `idn:nesr:create` or the user must own the source.
|
|
|
|
## Request
|
|
|
|
<MimeTabs className={"openapi-tabs__mime"}><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} className={"openapi-markdown__details mime"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-mime"}><h3 className={"openapi-markdown__details-summary-header-body"}>Body</h3><strong className={"openapi-schema__required"}>required</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
Non-Employee creation request body
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"accountName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name.","example":"william.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's first name.","example":"William"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's phone.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"manager"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's source id.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Attribute blob/bag for a non-employee, 10 attributes is the maximum size supported.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={true} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}}></SchemaItem></ul></details></TabItem></MimeTabs><div><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
Non-Employee request creation object
|
|
|
|
</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={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name.","example":"william.smith"}}></SchemaItem><SchemaItem collapsible={false} name={"firstName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's first name.","example":"William"}}></SchemaItem><SchemaItem collapsible={false} name={"lastName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's last name.","example":"Smith"}}></SchemaItem><SchemaItem collapsible={false} name={"email"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's email.","example":"william.smith@example.com"}}></SchemaItem><SchemaItem collapsible={false} name={"phone"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Non-Employee's phone.","example":"5555555555"}}></SchemaItem><SchemaItem collapsible={false} name={"manager"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The account ID of a valid identity to serve as this non-employee's manager.","example":"jane.doe"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>nonEmployeeSource</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee source id.","example":"a0303682-5e4a-44f7-bdc2-6ce6112549c1"}}></SchemaItem><SchemaItem collapsible={false} name={"sourceId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source Id associated with this non-employee source.","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source name associated with this non-employee source.","example":"Retail"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Source description associated with this non-employee source.","example":"Source description"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>data</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Attribute blob/bag for a non-employee.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approvalItems</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
List of approval item for the request
|
|
|
|
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"UUID"} qualifierMessage={undefined} schema={{"type":"string","format":"UUID","description":"Non-Employee approval item id","example":"2c1e388b-1e55-4b0a-ab5c-897f1204159c"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>approver</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Reference to the associated Identity
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"NonEmployeeIdentityDtoType"} qualifierMessage={"**Possible values:** [`GOVERNANCE_GROUP`, `IDENTITY`]"} schema={{"type":"string","enum":["GOVERNANCE_GROUP","IDENTITY"],"example":"IDENTITY","description":"Identifies if the identity is a normal identity or a governance group","title":"NonEmployeeIdentityDtoType"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Identity id","example":"5168015d32f890ca15812c9180835d2e"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"accountName"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Requested identity account name","example":"test.account"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"ApprovalStatus"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `PENDING`, `NOT_READY`, `CANCELLED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED","title":"ApprovalStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"approvalOrder"} required={false} schemaName={"float"} qualifierMessage={undefined} schema={{"type":"number","description":"Approval order","example":1,"format":"float"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"comment of approver","example":"I approve"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2019-08-23T18:52:59.162Z"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2019-08-23T18:40:35.772Z"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"approvalStatus"} required={false} schemaName={"ApprovalStatus"} qualifierMessage={"**Possible values:** [`APPROVED`, `REJECTED`, `PENDING`, `NOT_READY`, `CANCELLED`]"} schema={{"type":"string","enum":["APPROVED","REJECTED","PENDING","NOT_READY","CANCELLED"],"description":"Enum representing the non-employee request approval status","example":"APPROVED","title":"ApprovalStatus"}}></SchemaItem><SchemaItem collapsible={false} name={"comment"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"comment of requester","example":"approved"}}></SchemaItem><SchemaItem collapsible={false} name={"completionDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was completely approved.","example":"2020-03-24T11:11:41.139-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"startDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment start date.","example":"2020-03-24T00:00:00-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"endDate"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"Non-Employee employment end date.","example":"2021-03-25T00:00:00-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"modified"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was last modified.","example":"2020-03-24T11:11:41.139-05:00"}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"When the request was created.","example":"2020-03-24T11:11:41.139-05:00"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\",\n \"accountName\": \"william.smith\",\n \"firstName\": \"William\",\n \"lastName\": \"Smith\",\n \"email\": \"william.smith@example.com\",\n \"phone\": \"5555555555\",\n \"manager\": \"jane.doe\",\n \"nonEmployeeSource\": {\n \"id\": \"a0303682-5e4a-44f7-bdc2-6ce6112549c1\",\n \"sourceId\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"Retail\",\n \"description\": \"Source description\"\n },\n \"data\": {\n \"description\": \"Auditing\"\n },\n \"approvalItems\": [\n {\n \"id\": \"2c1e388b-1e55-4b0a-ab5c-897f1204159c\",\n \"approver\": {\n \"type\": \"IDENTITY\",\n \"id\": \"5168015d32f890ca15812c9180835d2e\"\n },\n \"accountName\": \"test.account\",\n \"approvalStatus\": \"APPROVED\",\n \"approvalOrder\": 1,\n \"comment\": \"I approve\",\n \"modified\": \"2019-08-23T18:52:59.162Z\",\n \"created\": \"2019-08-23T18:40:35.772Z\"\n }\n ],\n \"approvalStatus\": \"APPROVED\",\n \"comment\": \"approved\",\n \"completionDate\": \"2020-03-24T11:11:41.139-05:00\",\n \"startDate\": \"2020-03-24T00:00:00-05:00\",\n \"endDate\": \"2021-03-25T00:00:00-05:00\",\n \"modified\": \"2020-03-24T11:11:41.139-05:00\",\n \"created\": \"2020-03-24T11:11:41.139-05:00\"\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><TabItem label={"400.1 Bad Request Content"} value={"400.1 Bad Request Content"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"firstName is required; accountName is required;\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"400.1.409 Reference conflict"} value={"400.1.409 Reference conflict"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1.409 Reference conflict\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en\",\n \"localeOrigin\": \"REQUEST\",\n \"text\": \"Unable to create Non-Employee because the accountName \\\"existed\\\" is already being used.\"\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"}><p> An example of a 403 response object</p><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={"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"}><p> An example of a 500 response object</p><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> |