LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-10 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ad727a2d67247b2eb97e69ea22fb548da334f9cb
developer.sailpoint.com/docs/api/beta/list-workflow-library-actions.api.mdx
darrell-thobe-sp ad727a2d67 test embbeding
2024-03-06 15:22:04 -05:00

87 lines
39 KiB
Plaintext
Raw Blame History

---
id: list-workflow-library-actions
sidebar_label: List Workflow Library Actions
hide_title: true
hide_table_of_contents: true
api: eJztXHtv2zgS/yqEukC3ge04ztv/HNw8iiySNpfHFrg0d0tLtM2NRKqilMQX5LvfzJB6+RU3Xexd91wUiC2Rw3nPbyjRT56ORcJTqdVJ4HW9UJr0s07uBqF+OJX9hCfjno93jdfwUj40XvfGywcY77bhBcL4iYxxDMy/GknDkIhh6UiwBzeScUuE8XsuQ94PBUs1G+usBWTFYyoSxcND7QP5pwmKvSCQ+JGHLNB+FgmVErtsoBMmuD9ytIFQloQwYZSmsemur9dGtwysG2up0pavo3XDuVkfiTBezzk0xaemSUVsWqM0Ct84tr3nhhfzhEcCOEUVPHkSefuaiWQMCyu4Q8qLZOpNquSMPzKVRX2RMD1giTBZiNrR8DHNEtX6oi6FYDe/brLe+Qm7TLkKeBKwAx2GgpZn58XStz8X0ol7EaLtJiSTgVrnsVw3jk7TL+g0SxHekfYinQgmFXyMrJKA90R8zWQiwBcGPDQCrcOjOATxOtvthmf8kYg4WikdxygzrCuGIoGZloy9tNmBC5FUMsoirwvzIv5oPxOVQAw4aIG+PT83ZmtTDwZGTKvzE10GtkGD6GKDLAydVhncaLFrk/EwHDMTC18OpAjYg0xHbI2ss4aKj/lQKp6CD44SnQ1HRMcZ5ocxx3cYo1D/fOUPZEiuPoODqVVNmkg1xBipW+qYaBQenxkYRarOlcHMGMLzkdlpfbCUVH+y5t9YQYGzpuPz3Rf1RR3nVxmkM5PFsU5SYA+tRD4HpPQD3gb/CgNIaypgNpHqxHSRwtqaDNbWumxNfF3zKmbzZMDEV/bFM3HXTwR4YdOHW1wO1RfPe4aEaoSfJTIdU5q5NiI50GDWx7SXpSPMvjAxT1VdIBB4tzgLuI8hUwnKoJ12ezqRnkJWxgw0mZOBOx9XUCnO4XEcSp/8b/13gxOfpi3Ok4Sjs8hURLRgKlMSLq8MrJfnZDdD938H3cP3OEE9pdIyKoNpP5p0I0uKnRy2GFUX+M/RhVLpM/RWE3MfbHNyWJinKAil1qe1jf5qnX1JBj7i4CrNAyLIDlCcgdMZO6iQt2SXJE+DquR7B1cnnz5OhdWS5A4rF6tUPwiFbipQiX6N81wxLVwS88cx+fYMs08kZCVYmb3ijEo/TyuWgD++iFNT85iFfoGl+Qp8/mVxD13uMC4wk8jGJKYSvHJ9UhP/Ci6h1bEMDOU9/U3RqxboAvCKCJdQPBtlEVcMY5IQDq1jfRIWeJG13HOsoy3tnYVEENpIlUzAeAqj+1ladynlKJc5vaDe1zoUXM3Qr9LoLXLgxLASoPvkVGYvRtWiEgTTXOOdnOtSO1iDoKSjBr1ummRY8xQWrhsPsyCmFPjDQcvwseQaEpQMHQZECoi34AOlMEhwI+Hf9fWjuxJzSKWYaUPrfBEkfnllAzDILBzGhfRwGOI1GUB2hJR8Lv07IjvU9whZlS8+AIKIi+uFjQq/zmMGsnpCaOZOjH/lYSbOuaT6SowXBHhwj1SDK7v0bdV6JP4zqnQi2zqgflzGLI6S5nAMBpf+5WT6nm9rKHoAFMDcDyMBZrHpNLBkmM5SdC1bDdAFLIC1ZTsOIQvn1rRh/9bUp2D+Lqk5MrZXUFCUXUovE0EDbt6JygUkz8v6RT4DjELeoT6Avo+4YYEcDOCqSl15poUNdCMSoGKfKN6DSYOcF4KLfW7gCiarokUpndK0Zrm2lW5KvYXtJ7U7INWigmp6aWBwcTVu5HkTo8smTuA0yHxRXx5jCUhJW727T8+T2ZNnqb4Q9/pO9BCn2Dj/CWut92a6EK5PD69ARBeBdm1sfUj429IJZ82e8DMqYTwIQfzFnBSjKgx4Xm15wDaddnOj0+xsX7V3uu02/G9t7ez9A2OlQL0Bkk0lFWwIduwv4eo/W2s/eSXnldUWI9nFLFfr7FyuexAs91I8oAsDYE3GWom3hgqjMaw/Rq+QUES54gDgWyjMAr6rS06xTgnloy6r2ZFCb37BCebO+hZfWEBk2iUs8l7MlRszGza+NA1agEUmEW2o01zs7O9td8TeQOz19/hmsLUntn2xu73rL7SBDGapPq91L3LmwN5c3g56Z+e9kw8f/3V8cnp1dLGQFUdrgplKmSiUWM9PWCJe0ONiBXb8/Y299t7O7sa+EH57t72xu8F3xebm9jbf3GnzVygwhzzzWVIWhc9l6sxGELugcFvIgiM1xUQioH+MBHSNlGGXCp85c74leOokFkXOy272kn+d9T72PnyvX83oqaZ8zP1reFuzWtKDUGKVPkoSQMlNsFmOJwZuS+ZrJqBp7etgjHhDqnseyqD1io51Tp8RiBQy1oEOlgDax1AqmsOES+RQEMs+THRoAjcDqAWyJHMkRONq1Rs10dpg73kA8lr5DpwwqNuE+3dA62SJxvhaSZjP8ilMlhsUM5YVu4L3d9r7na3Bzhbnnb2tjd3t/v6Ab26297f393F1aKYNRM/LPR91kQDWQg3gSf4bFAKOYPJNWVx8+V6PaCzZ6NixhZiOX4bIuAHQ8P3BOdvaZSFXw4yu8+GEElTz+nKqw8Aejwh/SuRQzuyx8xbk8Oi4d316BVcujv5+fXQJn5DW1D54T4G3BuiWmrZ9R4BX01KAB0CptvsQQYutOaprIBBXpjpQ2m9mbECZzMUzzHCrz5hRJc0GiY5qoeTbvST2s2yJVgPAMFwDyAToucC/OHytRx1789Rpco2NACyJ5F2LVfbj77GPMTB/jKiaB4EoettBBqEsaOcVsC7ge4D2om6LUpWT/V6eYE6rRnm2jd9SGyAZMEdiVqOw8BbHorMP8Gw1V+fuqqI0UiluVQIot82CrxNI15CZQDYJ/YtLR7RbCIlH5eOKjFXNm5Tuziwzh6mmez7PzBJxdx5C+mmSaMWNe+GCjx4quN4GrVE8NrEZye2X0+SiA3K6yAO/aMFXsbuK3VXsLhO7kzcv3Ea8u0vQZ2Ma+lwraJxHOqHiOQV9EvIepVk+yG5LWkM2cLvVQaRfPl9BYN8JhePFY4z7cX8gPrKlfPqZbGEP9+gmf7KTl/7SFsgg6dE9tIVMJIIu8V1y7JUocXN6tWOd9CU4qJoBESFrJvgcmXFQWZIphZxw02CBFka9TdmI34u8zc73egFjN+2DohWSXCHJVTVaVaO/TDVaIclV7K5i98eM3YVIsrp/95TjJJNFEU/G1tPcffuQDAaw/JUQVoQcmWoSrSAxVmAsr44cvH5no78x2PXFVsC3gp3N/UHH3+nw7d2N3Y3+VmfXq9b6mzKOiyCrx1TF3taOpGIAcfeA4zIFzmVSrYP69h+oNxEDTGuYegrcDDoHld4W2LGzP+M5s9bsjKtxjpBMDUOqUkeY02BshGOTfCwM4PSagGKQqiTwha4kIwFU8CUKRu+UYfCiFEA3GTd7A3zpyQZK7mTFKlL5YQYcUiYINaJmDY4lQUgxQMwHFAjBDiE7/4Ho1Jnou5A8u0CJT1FidvToC4GBXiD37Vn7uyfKvtnJLq2B52z02m6HK3AAaAhszipw5wqfr/D5qsavavxfo8av8Pkqdlex+2PG7jfgc4eG5uNzGLA0PoexrTYrsNQxPdL/s2E6hYrjgNybad/PEtpuzjE44QpwJWRoSC870ouWXa88WxPaVxXXy3fPLfa3XNUP8DyBscBIzy0ey1b+CqbSD/R6fx80NCP52PfD0XFwAB0ksAu0SL2JRA+26Y6Iu7fp3FsSxQmChZTzt23HOoMER2Qa+DKr8ya6DCzG0Eq8NTS6Rd4zJR/IdZ2Ez98viyU0R5ZZ6lu4GoxnwOmEiChC5XQCvfVoV586o1DWEuzVOlOLfcJhHfZe8ARfMaXHFz//8vnqHRu6t9MDd1pESHoLlbNzcBHKZr18Kx8nUYEpj/D0ag9LMHoYOl2LuTM9J04JHyHNX0BeJpXiJEGpAGctf66E1+bNOcHzRTXZoUyEO/2GY5yI1OWxmziXi1fkei0Tb3JqTUutSdTwREuNC6vaG9++fONDCCMJHhrS1qsXt/SaFXrYQ8EVpDrJA2rC8VF/xOXnVns1HzV6TaRX5+OL+jySeGywNo3ZzMUMVMIwYCfMH2ltxN8YQ9fBMLgZZhBFr2brARdtUkQ0O+0KS027ZFM2ARgSf6cQGMo6E+9jYSZcogGyqcCG5G9kWYj53+jo0W81menyDdRPHBlo/xsOS03wjAs2ccGmzQHG8W/LEzoWxLY9CQpBbx3goLQ/ZQLHaCXvWVozszqRX6c5WBp8YJWomLhrv3TLBOc+MbqBo4sxkIYRVxcP/eA7c7SwRtWUle8ITGpwmt9QQ2mc0Jvlt9iRwnL5vyYvStwrN04+qXD8R2fpOZnkfyfv/pcy3irT/BUzjUO66G7Vo49VJ3/v8Nr0Rh7uNNNZFLhLsUqgGtCwPaSMKKZKKA55SqdQMKr9kRS0BRALniL2a6Bn6YgiEbp1DH88uoOEhvRibgIsc2jaZAj08lMwtDKngLHAEu2K301GfQiu5Y+gpRQt9hm6MuWDWbAjw9cs4N7v2rVml3hwCQ3LDnNjA+iKokzBahiXWcQ4uNQLHhFI42c2cUGDpkSuC03Qr5iVRzG6GorQot4kicynAe4uQ+NaMfwLa4Hd82OvoHq0ojv2XApyIUKetygTvyvwAm3wtiaeX6Sjg8AWdHiVFc5OrqYoAjFlQC7ovXUyXHeTzDqOBSLYHln32WxttNpNahfw0I82KXSxFeJ0xLc4g+uOhbHyBxwmTrUUW+uv+tkGVz0Q9q/HuFuFPGW2DbF934032ffBtLzzg15iBALgqKcn3NbAVugZL9uj6NgPgkrdu/fu7PlcAX6sH1mYqbo7gRsF+W9IuK0Az8O+cXk9/H/9OsICPRa/HvFKRa5+vKD88YIFai5/J6LU8225OwFRfAtj7bYkhbSdZjcuK7OmHu0hlWIz6cMRJk0+B7a6D7jU8/N/ALaLysc=
sidebar_class_name: "get 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 'List Workflow Library Actions' (list-workflow-library-actions)"
---
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"}>List Workflow Library Actions</h1>
<MethodEndpoint method={"get"} path={"/workflow-library/actions"}></MethodEndpoint>
This lists the workflow actions available to you.
## Request
<details style={{"marginBottom":"1rem"}} className={"openapi-markdown__details"} data-collapsed={false} open={true}><summary style={{}}><h3 className={"openapi-markdown__details-summary-header-params"}>Query Parameters</h3></summary><div><ul><ParamsItem className={"paramsItem"} param={{"in":"query","name":"limit","description":"Max number of results to return.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":250,"schema":{"type":"integer","format":"int32","minimum":0,"maximum":250,"default":250}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"offset","description":"Offset into the full result set. Usually specified with *limit* to paginate through the results.\nSee [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.","required":false,"example":0,"schema":{"type":"integer","format":"int32","minimum":0,"default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"in":"query","name":"filters","required":false,"schema":{"type":"string"},"description":"Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)\n\nFiltering is supported for the following fields and operators:\n\n**id**: *eq*","example":"id eq \"sp:create-campaign\""}}></ParamsItem></ul></div></details><div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
List of workflow actions
</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"}}><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={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action ID. This is a static namespaced ID for the action","example":"sp:create-campaign"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action Name","example":"Create Certification Campaign"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action type","example":"ACTION"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Action Description","example":"Generates a certification campaign."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>formFields</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
One or more inputs that the action accepts
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"helpText"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Describes the form field in the UI","example":"The name to give to this certification campaign."}}></SchemaItem><SchemaItem collapsible={false} name={"label"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A human readable name for this form field in the UI","example":"Campaign Name"}}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the input attribute","example":"name"}}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Denotes if this field is a required attribute","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={""} qualifierMessage={"**Possible values:** [`text`, `textarea`, `boolean`, `email`, `url`, `number`, `json`, `checkbox`, `jsonpath`, `select`, `multiType`, `duration`, `toggle`, `identityPicker`, `governanceGroupPicker`, `string`, `object`, `array`, `secret`, `keyValuePairs`, `emailPicker`, `advancedToggle`]"} schema={{"description":"The type of the form field","nullable":true,"enum":["text","textarea","boolean","email","url","number","json","checkbox","jsonpath","select","multiType","duration","toggle","identityPicker","governanceGroupPicker","string","object","array","secret","keyValuePairs","emailPicker","advancedToggle"],"example":"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={"isDynamicSchema"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean","description":"Determines whether the dynamic output schema is returned in place of the action's output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.","example":false}}></SchemaItem><SchemaItem collapsible={false} name={"outputSchema"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object","description":"Defines the output schema, if any, that this action produces.","example":{"definitions":{},"properties":{"autoRevokeAllowed":{"$id":"#sp:create-campaign/autoRevokeAllowed","default":true,"examples":[false],"title":"autoRevokeAllowed","type":"boolean"},"deadline":{"$id":"#sp:create-campaign/deadline","default":"","examples":["2020-12-25T06:00:00.468Z"],"format":"date-time","pattern":"^.*$","title":"deadline","type":"string"},"description":{"$id":"#sp:create-campaign/description","default":"","examples":["A review of everyone's access by their manager."],"pattern":"^.*$","title":"description","type":"string"},"emailNotificationEnabled":{"$id":"#sp:create-campaign/emailNotificationEnabled","default":true,"examples":[false],"title":"emailNotificationEnabled","type":"boolean"},"filter":{"$id":"#sp:create-campaign/filter","properties":{"id":{"$id":"#sp:create-campaign/filter/id","default":"","examples":["e0adaae69852e8fe8b8a3d48e5ce757c"],"pattern":"^.*$","title":"id","type":"string"},"type":{"$id":"#sp:create-campaign/filter/type","default":"","examples":["CAMPAIGN_FILTER"],"pattern":"^.*$","title":"type","type":"string"}},"title":"filter","type":"object"},"id":{"$id":"#sp:create-campaign/id","default":"","examples":["2c918086719eec070171a7e3355a360a"],"pattern":"^.*$","title":"id","type":"string"},"name":{"$id":"#sp:create-campaign/name","default":"","examples":["Manager Review"],"pattern":"^.*$","title":"name","type":"string"},"recommendationsEnabled":{"$id":"#sp:create-campaign/recommendationsEnabled","default":true,"examples":[false],"title":"recommendationEnabled","type":"boolean"},"type":{"$id":"#sp:create-campaign/type","default":"","examples":["MANAGER"],"pattern":"^.*$","title":"type","type":"string"}},"title":"sp:create-campaign","type":"object"}}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"[\n {\n \"id\": \"sp:create-campaign\",\n \"name\": \"Create Certification Campaign\",\n \"type\": \"ACTION\",\n \"description\": \"Generates a certification campaign.\",\n \"formFields\": [\n {\n \"helpText\": \"The name to give to this certification campaign.\",\n \"label\": \"Campaign Name\",\n \"name\": \"name\",\n \"required\": false,\n \"type\": \"text\"\n }\n ],\n \"isDynamicSchema\": false,\n \"outputSchema\": {\n \"definitions\": {},\n \"properties\": {\n \"autoRevokeAllowed\": {\n \"$id\": \"#sp:create-campaign/autoRevokeAllowed\",\n \"default\": true,\n \"examples\": [\n false\n ],\n \"title\": \"autoRevokeAllowed\",\n \"type\": \"boolean\"\n },\n \"deadline\": {\n \"$id\": \"#sp:create-campaign/deadline\",\n \"default\": \"\",\n \"examples\": [\n \"2020-12-25T06:00:00.468Z\"\n ],\n \"format\": \"date-time\",\n \"pattern\": \"^.*$\",\n \"title\": \"deadline\",\n \"type\": \"string\"\n },\n \"description\": {\n \"$id\": \"#sp:create-campaign/description\",\n \"default\": \"\",\n \"examples\": [\n \"A review of everyone's access by their manager.\"\n ],\n \"pattern\": \"^.*$\",\n \"title\": \"description\",\n \"type\": \"string\"\n },\n \"emailNotificationEnabled\": {\n \"$id\": \"#sp:create-campaign/emailNotificationEnabled\",\n \"default\": true,\n \"examples\": [\n false\n ],\n \"title\": \"emailNotificationEnabled\",\n \"type\": \"boolean\"\n },\n \"filter\": {\n \"$id\": \"#sp:create-campaign/filter\",\n \"properties\": {\n \"id\": {\n \"$id\": \"#sp:create-campaign/filter/id\",\n \"default\": \"\",\n \"examples\": [\n \"e0adaae69852e8fe8b8a3d48e5ce757c\"\n ],\n \"pattern\": \"^.*$\",\n \"title\": \"id\",\n \"type\": \"string\"\n },\n \"type\": {\n \"$id\": \"#sp:create-campaign/filter/type\",\n \"default\": \"\",\n \"examples\": [\n \"CAMPAIGN_FILTER\"\n ],\n \"pattern\": \"^.*$\",\n \"title\": \"type\",\n \"type\": \"string\"\n }\n },\n \"title\": \"filter\",\n \"type\": \"object\"\n },\n \"id\": {\n \"$id\": \"#sp:create-campaign/id\",\n \"default\": \"\",\n \"examples\": [\n \"2c918086719eec070171a7e3355a360a\"\n ],\n \"pattern\": \"^.*$\",\n \"title\": \"id\",\n \"type\": \"string\"\n },\n \"name\": {\n \"$id\": \"#sp:create-campaign/name\",\n \"default\": \"\",\n \"examples\": [\n \"Manager Review\"\n ],\n \"pattern\": \"^.*$\",\n \"title\": \"name\",\n \"type\": \"string\"\n },\n \"recommendationsEnabled\": {\n \"$id\": \"#sp:create-campaign/recommendationsEnabled\",\n \"default\": true,\n \"examples\": [\n false\n ],\n \"title\": \"recommendationEnabled\",\n \"type\": \"boolean\"\n },\n \"type\": {\n \"$id\": \"#sp:create-campaign/type\",\n \"default\": \"\",\n \"examples\": [\n \"MANAGER\"\n ],\n \"pattern\": \"^.*$\",\n \"title\": \"type\",\n \"type\": \"string\"\n }\n },\n \"title\": \"sp:create-campaign\",\n \"type\": \"object\"\n }\n }\n]"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
Client Error - Returned if the request body is invalid.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"401"} value={"401"}><div>
Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":"JWT validation failed: JWT is expired"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"error\": \"JWT validation failed: JWT is expired\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
Forbidden - Returned if the user you are running as, doesn't have access to this end-point.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"403"} value={"403"}><Markdown> An example of a 403 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"403 Forbidden\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The server understood the request but refuses to authorize it.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"429"} value={"429"}><div>
Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"message"} required={false} schemaName={""} qualifierMessage={undefined} schema={{"description":"A message describing the error","example":" Rate Limit Exceeded "}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"message\": \" Rate Limit Exceeded \"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>
Internal Server Error - Returned if there is an unexpected error.
</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"detailCode"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Fine-grained error code providing more detail of the error.","example":"400.1 Bad Request Content"}}></SchemaItem><SchemaItem collapsible={false} name={"trackingId"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Unique tracking id for the error.","example":"e7eab60924f64aa284175b9fa3309599"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>messages</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Generic localized reason for error
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>causes</strong><span className={"openapi-schema__name"}> object[]</span></span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"locale"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The locale for the message text, a BCP 47 language tag.","example":"en-US","nullable":true}}></SchemaItem><SchemaItem collapsible={false} name={"localeOrigin"} required={false} schemaName={"LocaleOrigin"} qualifierMessage={"**Possible values:** [`DEFAULT`, `REQUEST`, `null`]"} schema={{"type":"string","enum":["DEFAULT","REQUEST",null],"description":"An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.","example":"DEFAULT","nullable":true,"title":"LocaleOrigin"}}></SchemaItem><SchemaItem collapsible={false} name={"text"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Actual text of the error message in the indicated locale.","example":"The request was syntactically correct but its content is semantically invalid."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"detailCode\": \"400.1 Bad Request Content\",\n \"trackingId\": \"e7eab60924f64aa284175b9fa3309599\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ],\n \"causes\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"The request was syntactically correct but its content is semantically invalid.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"500"} value={"500"}><Markdown> An example of a 500 response object</Markdown><ResponseSamples responseExample={"{\n \"detailCode\": \"500.0 Internal Fault\",\n \"trackingId\": \"b21b1f7ce4da4d639f2c62a57171b427\",\n \"messages\": [\n {\n \"locale\": \"en-US\",\n \"localeOrigin\": \"DEFAULT\",\n \"text\": \"An internal fault occurred.\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div></div>
Reference in New Issue View Git Blame Copy Permalink