mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 20:37:47 +00:00
125 lines
42 KiB
Plaintext
125 lines
42 KiB
Plaintext
---
|
|
id: patch-workflow
|
|
sidebar_label: Patch Workflow
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJztXAtz27gR/isY9mbyqKm35dgznZ5iOz3f5GLXlpu2TmYOIkGJOYpUCTKOmtF/77cL8CXJj6Rpe73RXC6hSGCx2Oe3IMDPTrJQqczCJD7znSNnITNv9jZJfwmi5NbZczI51c7RjVPc0s77PcdX2kvDBXVClwuZZqGMoqXIF77MlJCxUJ9CnYXxVBT9RK7p582PV+dvxAUN8v7pLMsW+qjdzpIk0q1QZUErSaftWTaP2mngDQ87vWdCL+NMfmqBFa28PA2zJdj57FxrlR4ncaY+ZaM8mxGLenF0a0c7mstYTpXzfgVuFzKVc5WpVHPPGD/AdeiDZBibKc+c9Umd+SIJRDZToiaMVP0jD1MFOWVprsBRtoyIlg7nC1zsOerTIkp83ApkpKmBN1Nz6Rx9drLlgltmKcTALSX3OXK87sFEyb509w8GvjvY73vuoeoM3EF/uB9Mgn0ZdCbOiiZCwyudvUz8JZFc58YjccQZPZKLRRR6rNX2B53ELqv193RJjzfYkmkqlySPTM117X4y+aC8bEM4I0FqZC2K88J8hNTCV0EYK19MluLm8tWxIBUKV3yp0huivoGFOntGS6TNlAw2CxXziUdbhNvkdgwllkYuskRMlMDPIEnnioxAxfmchpG+zwPPk4+KLxaR9OjK3vCSBckogwqIkUqDRcuV5fJBjkbCPLCCSUIoLhUgkyoNDdITsrxMplOVCaJJbJNbRWqOBnYSMgigHSPurD7Jhn2162ODxY8yyhXLLlbnAbvE3cb5Rt2Ken9MP8yiWuPVXtmdZjFVab1/v9OpehTPa11K+yralDdKEjDmDENN8sxo3LrvYhZG4QJ+UaNWWHFBzPxebQQsMgiWgpVjriFDmENTiHuisEF+9o7s450DLfi4tirH77K9vldw4LPk60e4IXtD6Tv82HbmWV7bSBpFgl1XTiIlglBFPj9uzucEJhtDH9RjhlCLWdlIrCQ8dI2ACGMB1YuL0fj4B2FjCsVXaxg3xqtq9m+M2mmz6Mt2zpWCKE7nMoxYpXd0Sm5jtonS7Kyyzk5O34zPxn+jqEOJp+cddl90XuwPX3j7vUNv2OniypPD4LDjdfvdPtpZ1b8NoyiUc4F/tRHdnYM3TbfBOHkT8U7SIr2HPnlethS3s+SJFpXRCQgvniq/dd8sVUwC9qtBOAHcyxkiZdhkDIEZLp81RCvGFG4o1agFq74mdfINr8zcSH8IHr7Ls0KPpttMOGnA9EMt8EeKzNAN0mROndFnQXHo+/Kq5eEJhUEvXISQzZnf+g4tv2sVkmpxCtW5cdkjExhhxzFy8hXYJbK55ymtOXlHaHWpdB6hbZxH0V7ptl4RmormtQBq76xW96kZE51Ot1rZ6V9gZRvCYIML/fiomIpbPXetumnI9yseFyPqBTzMdO51OpsuOK4BBVEGsXsycjMNw8+bobgk0Ux3xPhDyaVk4+ykJSp9X1+fnYipiiniIKTlmJDwUsUctRqhy+91ut6+OnT9/sHEHSDLuDLoDtzhcNAdBP1Df3946HC8AiCj7sdJbia5kQgox8rM3Or3tmZmJN8Jkh+BrXAOb8uI4wLHiRlAxUQpApQ0GHlhjdUeuAhgr3mq/sM80CiQmp9z2i5n3uCmA25Yomqrlko+KDK7NNBWXiyC9pkVjkwlI7dgxA7Q1Fiv0+u5na7b7Yy7w6PO8Kg7bA37w/6L7mBw8Hen4CtJH4Z2pfXYHgiFpb9vmKMh9WiDrEiejM8FdWrV4FeZEBrYqry72vsy69/knxyiKTbvAClHDoaBlL5SA6ScYDJQne4Lr9cZDnoczDjnfMWofqgRppaCCDSH/SlEiFGRsP+a4LYNFDWF/ThO2JzRsqhebqvqpeKgkbkdk6G3hrRSdNlMZgINdYNoSwgG10QAUwaz81BrwkIEMs5O3ohb5GrgoIyeAHPcEhkT75uUOEZFuICTISFbeA7650Rbz8KF8JCxAdZseCbMyyCnAMvMBA0rxcX1WACxbQCcxxnvI+1xm+CJFAneaNAIDRNLVaBSFXuUVB5nxUQsj0NwDikWqtzExg+Dpkdb8LrdbBlsA3et1og8NMZJ9YuGYWNoGIH0gDmQJ/VM6U2D/SrE5tSA1oPBj4QwlwtijvGW0WAzBpNB22S0aVMWv32psLkbGTKN2rrDVQ0SXNWg4P2TOYe/wQvmSaqYrlWpnRQJOg21auY6ONxFpCRua6Uaqx/CT7ycas+yii5acA1roAwXSlxz8IBFhEfhxAqQ0UVNWmbRolbn/faQ7eh4fHb+5hHItiwNC3GfVFZLSMtWF1XvSZJAT/GG0k+5Jekd+Ycv1+J1uY5H8TROMg6pBlNw8ISPmcHIKI2Jw4Mkz80uapUqszWOU8DvR/mXbWyskA1fryeq+toPE2yofGMN6KFAXtQAp38dn16+Gb3G5dXxD6cn169PT5rBvWh5D9c0xmrdBGsrKVaPpx9pmWZse42q1nsPiKhqirQRsVrM0s+Ztc038MXT8ZVQNMKasGC2G9L56nRTFVWVgB6smeB2YYRsTw710KgcOHhxS32ilS/NgYXMgoNsFM5DXM6AksxkdZ0t0ybAzMXaetd3LcONvvnj0+9bJZPiD38QT8yycPrk2fti5ajQ1ycwjQD1TVWmCqKVKOva4sS8oa/HpetRoS9OI8Xa1ZYBK7loJVNv5qK0cOH3YbB0vjR/jyiOUxgXnll5F3KS5NnDQ1/mBMsMA1zbGAa4Y8qBU6/p4wr5xM8pDH07hXCSMkS3K8RLk/jKTH1DLbVnj1DORxmFvji+hIFXts0iMVI6Sbwt63hr7YUicROTeYqU6BQr58RKJietaZ7mbWdVF3RHPBfP2338vy+e8wrGnZXKplxbzrZMZNttfcZvImiM9Qc2qw22LZUcR5RzxWmawmpdcamyPKV3BmFg7YHxuqC0Tvk8jFmYrS9ZTrm/kEI5AiRwzO9pHlLlK1Qt7jSV/FZDMcseOgpQ/Bj6BNkYXxmSReTkdk0YB0m0uuKl9DFfM79jOxnOn9L7BbTOHhGqr43bF10Agivv3xxWHSg5GXYOe4NgOJCy92LQPdifHAay3+8c7h/yMs4c1oagWMcmxUJ6c+g/0eJR6Iko8aCRf0IgwA2QvUF9NPh9b5CaOmAajyxLTNtympZfQQFoD1798vhCDA5EhJif8305XRNC7F5f0fIxoBlBGwM9MXND+BwGHm6NfgWAODl9Nbp+TcDg8vTP16dXuCJaG741imGtPpllwotJvBZfTYCWbwxYRGkinluqzzEhaath2zA0v/QSKHouLPxCDzv6lh510oKAb8OVimj9NGyp1h4QH+7N+eXdRNKrD067SjwfAZEuMve1leRzMVPSV+mzlhiVCN68ONHov+RXUL5vgCMRCHK4MpgJsxmlBQry3traRyXKpjaqEPK6rhRyDnD+iJDrZTklH5pm3QtLa7EsWv2AZyO5JnfjmtBYpPTuGXWIx2+3vSRNqaxHsBQh0IgNR6QujcATF+3KiFUPmRzufjLMnGQJP/Nkrh/hdxcRwo/LUysffFTW+TQvl3A0Ym0UarIRyZbK3Nm2KtVVOL55LbTz3Z3v7nz3kb67/vDSviCyTxn6dDehz3Usc8g35eS5AX1Stp4YSNU2MkstRpF7VNNbiPTj2zEc+xcVU3vgRcKv3xAfmVS+wfyo1Ie5PylWXovUX+mCGGQ5mhmYlydHzHfFsVn2ZlH1N0d7laSTEAYab4GIiJqpWCa5kBBZmscxcSL1nvATpeMnmZhJxEfJ6ysmAtKoqHvM6s8OSe6Q5C4b7bLRbyYb7ZDkznd3vvv/6bv3IsnmnkCLk3Q+n8t0aSzNPqfZSoEGotiqVL3ALbdE1dEKERMlxnKayMGZ9LqTbnDgqYEvB/6wfxj0vGFP7h90D7qTQe/Aqef6m8qPSydr+lRN30aPLGKAuI/AcXkM49JZkvjN5T+IN1UBhTVevC1wM2QOkb4vsWPvcMvOhSQRP8l4WSAk3cCQcSUjimloO6e2adGWtxBMERdj2oYQJn6xLwhUeIslv5gg56VZgG66dEcBbeA1jlIYWTlKGHtRDg45EkQJoeYEhhXSu7eAMB8oMIKdIjp/Q3RqVfRvIXlxSTN+za9iTj95SpGjl8h9f9v67lls3wRcGQXfsdBrqh0ZwwBQEJiYVeLOHT7f4fNdjt/l+N9Gjt/h853v7nz3/9N3vwCfWzR0Nz5Hg0fjc7RtdUSJpV7xDqz/NkxnV7EcsHmLxPPylJebCwzOuAKmVB4edapzGcWeLt3+HPorh/bKESQ03DQ3NXyGkqCcVUsuwnIfXpzc0l699gSS2RJ0zIY/MhhqIEYXZ7aoMKeZ0pAs14Q5Jm6EbDezVRsD76VcbNNcJjkCG5PZo11g1or4Nu2lRAnxRNvN3mYry9r8MK/rNFr9+3MxhO6Yyzbx3Tsa2gtwujZFu3WkOHFLu3Hm9mDa+rnbKodQjbZ5vuKcmvXESyVT2j/Hry2e/vh2/Kx+GIXPBquQygLavw0T4Sg2KpbwqRMnljTJpzNmfNR4SUJeI8wWx3fxlVLipr5f7hLxmEVKnRSHAOpVHUb11UcVUeZrNTaJtkM/bkNCbdno94yzHJcDYWyOddBZkHexK05CCj68vZ3a2ClydSduFsW8ZG1eX8vE7wpqrqHmMjX9bI0Le+zaM5tuPLgukZCRZml99eCGnlujR7UT7hDVdR5IEpaP5qstr9DaV/PRoOcSvSYf7+K3vIGw2U2YiCU0MmDkizPhzZJEqz8KQaZDbnAzzeFFX80W71p02SPcXqfGkmuGdEMXgJD5ew3HiI0xmd109gRngCRoXPJn1ix8/mfeO/dzY858+4aOdKKln3j6q3mmAV0a0DUxQFv+TVoiw4Jvm08A0H44NoDjSv8cCSyjtbhnaG2N6ky+zX0oNXhg1WyiXxyZH0dVgLNXgh9Q67INwjDh6fJlHx2ZtbQoNzWEVawErEtwk98oQUpck5vht1yJojT5a5svzXhULZicx9HyW0fpOyLJryfu/o8i3i7S/BYjjUW4tPB4WX1947SoRe4+K7/95PnGVwHe0zdIgoSnZMuMugO9tFhwc3GQT+4o/I2nHAcYqKMM4sKOEVKdENjLyGM4YnizUPGywkLJjHDlHlltMmcvX6QJhRYUj0xoymdDUohDohAMIzodQwvfxciSndGAVrIZ+m0PztBYZit+S7xFpRd7UDlVebR1A88+JLbcu4LW+SMY4qQwJAC6+TyP6XQX2M7nQsJcH7A2P9ReboIiir5YFbJIGFaWvYoIQWZMU2hxvZPO9XlAK9YohmtG9cBYsCltl6ull1Xb951qIpe0Az00n4dolgQP0YYluzMVLajOREQHuFO1EX46G29QBLFYY16o5+mbKraTblNb+vIHJm/Mp9/qtjoulyL00ZJEZ6iMa8TNp11qX75ZOydQrs//1z7+Y9MX1R3tBS2TEeO5qYOMz904ZbmJ9kfmLMwMU6NHnz/TIgoVYCu6DU+mCv3mfVVbsTPbQ1N+edbpznk/vbQHB56JrZ8K2spvsfgXL2sxAZe/KFouAMcoqsEzr+cwP+aBfYHgjs1ZqKLjfR/5oQLUdDbLRfd04yBUlvB8aBatJ/YjQ3OzHJFKPpiFv4+cd/gPP5KFMWs04vufnWJxD20+lCdE5R34w15AB2j2Lwvy7gc=
|
|
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 Workflow' (patch-workflow)"
|
|
---
|
|
|
|
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"}>Patch Workflow</h1>
|
|
|
|
<MethodEndpoint method={"patch"} path={"/workflows/{id}"}></MethodEndpoint>
|
|
|
|
|
|
|
|
Partially update an existing Workflow using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
|
|
|
## Request
|
|
|
|
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"Id of the Workflow","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"c17bea3a-574d-453c-9e04-4365fbf5af0b"}}}></ParamsItem></ul></div></details><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><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><TabItem label={"200"} value={"200"}><div>
|
|
|
|
The Workflow 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={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Workflow ID. This is a UUID generated upon creation.","example":"d201c5e9-d37b-4aff-af14-66414f39d569"}}></SchemaItem><SchemaItem collapsible={false} name={"executionCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of times this workflow has been executed.","example":2}}></SchemaItem><SchemaItem collapsible={false} name={"failureCount"} required={false} schemaName={"int32"} qualifierMessage={undefined} schema={{"type":"integer","format":"int32","description":"The number of times this workflow has failed during execution.","example":0}}></SchemaItem><SchemaItem collapsible={false} name={"created"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time","description":"The date and time the workflow was created.","example":"2022-01-10T16:06:16.636381447Z"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>creator</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Workflow creator's identity.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","description":"Workflow creator's DTO type.","enum":["IDENTITY"],"example":"IDENTITY"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Workflow creator's identity ID.","example":"2c7180a46faadee4016fb4e018c20642"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Workflow creator's display name.","example":"Michael Michaels"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the workflow","example":"Send Email"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>owner</strong><span className={"openapi-schema__name"}> </span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The identity that owns the workflow. The owner's permissions in IDN will determine what actions the workflow is allowed to perform. Ownership can be changed by updating the owner in a PUT or PATCH request.
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** [`IDENTITY`]"} schema={{"type":"string","enum":["IDENTITY"],"example":"IDENTITY","description":"The type of object that is referenced"}}></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the object","example":"2c91808568c529c60168cca6f90c1313"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the object","example":"William Wilson"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Description of what the workflow accomplishes","example":"Send an email to the identity who's attributes changed."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>definition</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The map of steps that the workflow will execute.
|
|
|
|
</div><SchemaItem collapsible={false} name={"start"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the starting step.","example":"Send Email Test"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>steps</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.
|
|
|
|
</div><SchemaItem name={"property name*"} required={false} schemaName={"any"} qualifierMessage={undefined} schema={{"type":"object","description":"One or more step objects that comprise this workflow. Please see the Workflow documentation to see the JSON schema for each step type.","example":{"Send Email":{"actionId":"sp:send-email","attributes":{"body":"This is a test","from":"sailpoint@sailpoint.com","recipientId.$":"$.identity.id","subject":"test"},"nextStep":"success","selectResult":null,"type":"ACTION"},"success":{"type":"success"}},"additionalProperties":true}} collapsible={false} discriminator={false}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Enable or disable the workflow. Workflows cannot be created in an enabled state.","default":false,"example":false}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>trigger</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
The trigger that starts the workflow
|
|
|
|
</div><SchemaItem collapsible={false} name={"type"} required={true} schemaName={"string"} qualifierMessage={"**Possible values:** [`EVENT`, `EXTERNAL`, `SCHEDULED`]"} schema={{"type":"string","enum":["EVENT","EXTERNAL","SCHEDULED"],"example":"EVENT","description":"The trigger type"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span><strong style={{"fontSize":"var(--ifm-code-font-size)","color":"var(--openapi-required)"}}> required</strong></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
|
|
|
|
Workflow Trigger Attributes.
|
|
|
|
</div></div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"Event Trigger Attributes"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"id"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The unique ID of the trigger","example":"idn:identity-attributes-changed"}}></SchemaItem><SchemaItem collapsible={false} name={"filter.$"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"JSON path expression that will limit which events the trigger will fire on","example":"$.changes[?(@.attribute == 'manager')]"}}></SchemaItem></TabItem><TabItem label={"External Trigger Attributes"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A unique name for the external trigger","example":"search-and-notify"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Additonal context about the external trigger","example":"Run a search and notify the results"}}></SchemaItem></TabItem><TabItem label={"Scheduled Trigger Attributes"} value={"2-item-properties"}><SchemaItem collapsible={false} name={"cronString"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A valid CRON expression","externalDocs":{"description":"CRON expression editor","url":"https://crontab.guru/"},"example":"0 * */3 */5 *"}}></SchemaItem></TabItem></SchemaTabs></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"d201c5e9-d37b-4aff-af14-66414f39d569\",\n \"executionCount\": 2,\n \"failureCount\": 0,\n \"created\": \"2022-01-10T16:06:16.636381447Z\",\n \"creator\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c7180a46faadee4016fb4e018c20642\",\n \"name\": \"Michael Michaels\"\n },\n \"name\": \"Send Email\",\n \"owner\": {\n \"type\": \"IDENTITY\",\n \"id\": \"2c91808568c529c60168cca6f90c1313\",\n \"name\": \"William Wilson\"\n },\n \"description\": \"Send an email to the identity who's attributes changed.\",\n \"definition\": {\n \"start\": \"Send Email Test\",\n \"steps\": {\n \"Send Email\": {\n \"actionId\": \"sp:send-email\",\n \"attributes\": {\n \"body\": \"This is a test\",\n \"from\": \"sailpoint@sailpoint.com\",\n \"recipientId.$\": \"$.identity.id\",\n \"subject\": \"test\"\n },\n \"nextStep\": \"success\",\n \"selectResult\": null,\n \"type\": \"ACTION\"\n },\n \"success\": {\n \"type\": \"success\"\n }\n }\n },\n \"enabled\": false,\n \"trigger\": {\n \"type\": \"EVENT\",\n \"attributes\": {\n \"id\": \"idn:identity-attributes-changed\",\n \"filter.$\": \"$.changes[?(@.attribute == 'manager')]\"\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"}><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> |