docs/_schemas.md in losant_rest-1.15.2 vs docs/_schemas.md in losant_rest-1.16.0

- old
+ new

@@ -26,10 +26,11 @@ * [Application Creation By Template Result](#application-creation-by-template-result) * [Application Dashboard Post](#application-dashboard-post) * [Application Export Post Schema](#application-export-post-schema) * [Application Export Result](#application-export-result) * [Application Global Patch](#application-global-patch) +* [Application Import Options](#application-import-options) * [Application Key](#application-key) * [Application Key Patch](#application-key-patch) * [Application Key Post](#application-key-post) * [Application Key Post Response](#application-key-post-response) * [Application Keys](#application-keys) @@ -183,10 +184,14 @@ * [Workflow Import Result](#workflow-import-result) * [Github Login](#github-login) * [Historical Summaries](#historical-summaries) * [Historical Summary](#historical-summary) * [Instance](#instance) +* [Instance Custom Node](#instance-custom-node) +* [Instance Custom Node Patch](#instance-custom-node-patch) +* [Instance Custom Node Post](#instance-custom-node-post) +* [Instance Custom Nodes](#instance-custom-nodes) * [Instance Member](#instance-member) * [Instance Member Patch](#instance-member-patch) * [Instance Member Post](#instance-member-post) * [Instance Members](#instance-members) * [Instance Organization](#instance-organization) @@ -229,10 +234,11 @@ * [Organization Member Patch](#organization-member-patch) * [Organization Patch](#organization-patch) * [Organization Post](#organization-post) * [Organization Role Info](#organization-role-info) * [Organizations](#organizations) +* [Palette Response](#palette-response) * [Password Reset Finish](#password-reset-finish) * [Password Reset Input](#password-reset-input) * [Password Reset Response](#password-reset-response) * [Payload Stats](#payload-stats) * [Recent Item](#recent-item) @@ -7059,10 +7065,11 @@ "flow.getStorageEntriesMetadata", "flow.stats", "flows.get", "flows.getByVersion", "flows.import", + "flows.palette", "flows.post", "flowVersion.delete", "flowVersion.errors", "flowVersion.get", "flowVersion.log", @@ -7173,11 +7180,20 @@ "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", "instanceApiToken.patch", - "instanceApiToken.delete" + "instanceApiToken.delete", + "instanceCustomNodes.*", + "instanceCustomNodes.get", + "instanceCustomNodes.post", + "instanceCustomNode.*", + "instanceCustomNode.get", + "instanceCustomNode.patch", + "instanceCustomNode.delete", + "instanceCustomNode.errors", + "instanceCustomNode.stats" ] }, { "type": "string", "enum": [ @@ -15210,10 +15226,39 @@ ] ``` <br/> +## Application Import Options + +Schema for additional application import options + +### <a name="application-import-options-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "importUrl": { + "type": "string", + "format": "url" + } + }, + "additionalProperties": false +} +``` +### <a name="application-import-options-example"></a> Example + +```json +{ + "importUrl": "https://storage.mySite.com/myZipFile.zip" +} +``` + +<br/> + ## Application Key Schema for a single Application Key ### <a name="application-key-schema"></a> Schema @@ -59763,15 +59808,32 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { "type": "string", "maxLength": 32767, "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, "enabled": { "type": "boolean" }, "defaultVersionId": { "type": "string", @@ -59840,10 +59902,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -62479,10 +62542,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -64994,15 +65058,10 @@ }, "description": { "type": "string", "maxLength": 32767 }, - "iconData": { - "type": "string", - "maxLength": 32767, - "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" - }, "flowClass": { "type": "string", "enum": [ "experience" ] @@ -65067,10 +65126,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -69497,15 +69557,32 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { "type": "string", "maxLength": 32767, "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, "enabled": { "type": "boolean" }, "defaultVersionId": { "type": "string", @@ -69574,10 +69651,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -72293,10 +72371,14 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { "oneOf": [ { "type": "string", "maxLength": 32767, @@ -72305,10 +72387,24 @@ { "type": "null" } ] }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output", + "" + ] + }, "enabled": { "type": "boolean" }, "defaultVersionId": { "oneOf": [ @@ -72370,10 +72466,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -74855,10 +74952,14 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { "oneOf": [ { "type": "string", "maxLength": 32767, @@ -74867,10 +74968,24 @@ { "type": "null" } ] }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output", + "" + ] + }, "enabled": { "type": "boolean" }, "triggers": { "type": "array", @@ -74921,10 +75036,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -77728,10 +77844,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -80243,15 +80360,10 @@ }, "description": { "type": "string", "maxLength": 32767 }, - "iconData": { - "type": "string", - "maxLength": 32767, - "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" - }, "flowClass": { "type": "string", "enum": [ "experience" ] @@ -80316,10 +80428,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -82607,10 +82720,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -85183,10 +85297,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -87698,15 +87813,10 @@ }, "description": { "type": "string", "maxLength": 32767 }, - "iconData": { - "type": "string", - "maxLength": 32767, - "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" - }, "flowClass": { "type": "string", "enum": [ "experience" ] @@ -87771,10 +87881,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -91020,15 +91131,32 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { "type": "string", "maxLength": 32767, "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, "enabled": { "type": "boolean" }, "defaultVersionId": { "type": "string", @@ -91097,10 +91225,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -93704,15 +93833,40 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { + "oneOf": [ + { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + { + "type": "null" + } + ] + }, + "docsUrl": { "type": "string", - "maxLength": 32767, - "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + "maxLength": 1024 }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output", + "" + ] + }, "enabled": { "type": "boolean" }, "triggers": { "type": "array", @@ -93763,10 +93917,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -96333,10 +96488,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -98873,15 +99029,32 @@ }, "description": { "type": "string", "maxLength": 32767 }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, "iconData": { "type": "string", "maxLength": 32767, "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, "enabled": { "type": "boolean" }, "defaultVersionId": { "type": "string", @@ -98950,10 +99123,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -101538,10 +101712,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -104053,15 +104228,10 @@ }, "description": { "type": "string", "maxLength": 32767 }, - "iconData": { - "type": "string", - "maxLength": 32767, - "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" - }, "flowClass": { "type": "string", "enum": [ "experience" ] @@ -104126,10 +104296,11 @@ "deviceCommand", "deviceIdsTagsConnect", "deviceIdsTagsDisconnect", "eeaInit", "flowError", + "azureEventHub", "googlePubSub", "meridian", "mqtt", "notebook", "onBoot", @@ -106609,10 +106780,11 @@ "flow.getStorageEntriesMetadata", "flow.stats", "flows.get", "flows.getByVersion", "flows.import", + "flows.palette", "flows.post", "flowVersion.delete", "flowVersion.errors", "flowVersion.get", "flowVersion.log", @@ -106723,11 +106895,20 @@ "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", "instanceApiToken.patch", - "instanceApiToken.delete" + "instanceApiToken.delete", + "instanceCustomNodes.*", + "instanceCustomNodes.get", + "instanceCustomNodes.post", + "instanceCustomNode.*", + "instanceCustomNode.get", + "instanceCustomNode.patch", + "instanceCustomNode.delete", + "instanceCustomNode.errors", + "instanceCustomNode.stats" ] }, { "type": "string", "enum": [ @@ -107766,10 +107947,2715 @@ } ``` <br/> +## Instance Custom Node + +Schema for a single Instance Custom Node + +### <a name="instance-custom-node-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "instanceCustomNodeId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "createdById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "createdByType": { + "type": "string", + "enum": [ + "apiToken", + "user" + ] + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "lastUpdatedById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "lastUpdatedByType": { + "type": "string", + "enum": [ + "apiToken", + "user" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, + "iconData": { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, + "minimumAgentVersion": { + "type": "string", + "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$" + }, + "triggers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "x": { + "type": "number" + }, + "y": { + "type": "number" + }, + "uiId": { + "type": "string", + "maxLength": 48 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + "maxItems": 1 + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "config": { + "type": "object" + }, + "meta": { + "type": "object" + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + }, + "customNodeConfig": { + "type": "object", + "properties": { + "outputCount": { + "type": "number", + "enum": [ + 1, + 2 + ] + }, + "resultMode": { + "type": "string", + "enum": [ + "optional", + "required", + "none" + ] + }, + "resultDescription": { + "type": "string", + "maxLength": 32767 + }, + "fields": { + "type": "array", + "maxItems": 100, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checkbox" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "select" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "options": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 1024 + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "value" + ] + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "label", + "defaultValue", + "options" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stringTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 1024 + }, + "required": { + "type": "boolean" + }, + "validRegExp": { + "type": "string", + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "numberTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "number" + }, + "required": { + "type": "boolean" + }, + "validMin": { + "type": "number" + }, + "validMax": { + "type": "number" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "jsonTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payloadPath" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "section" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "outputCount", + "resultMode", + "fields" + ] + }, + "customNodeSupports": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "cloud" + ] + } + }, + "sourceApplicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "sourceFlowId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "sourceFlowVersion": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "stats": { + "type": "object", + "properties": { + "errorCount": { + "type": "integer" + }, + "runCount": { + "type": "integer" + } + }, + "additionalProperties": false + }, + "usage": { + "type": "object", + "properties": { + "sandbox": { + "type": "object", + "properties": { + "appCount": { + "type": "integer" + }, + "flowCount": { + "type": "integer" + } + }, + "additionalProperties": false + } + }, + "patternProperties": { + "^[A-Fa-f\\d]{24}$": { + "type": "object", + "properties": { + "appCount": { + "type": "integer" + }, + "flowCount": { + "type": "integer" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + } +} +``` +### <a name="instance-custom-node-example"></a> Example + +```json +{ + "id": "575ed18f7ae143cd83dc4aa6", + "instanceCustomNodeId": "575ed18f7ae143cd83dc4aa6", + "instanceId": "575ec8687ae143cd83dc4a97", + "creationDate": "2016-06-13T04:00:00.000Z", + "lastUpdated": "2016-06-13T04:00:00.000Z", + "name": "My Instance Custom Node", + "description": "Description of my instance custom node", + "triggers": [ + { + "type": "customNodeStart" + } + ], + "nodes": [ + { + "type": "CustomNodeCapNode" + } + ], + "usage": { + "575ed6e87ae143cd83dc4aa8": { + "appCount": 1, + "flowCount": 2 + } + }, + "stats": { + "runCount": 123, + "errorCount": 12 + } +} +``` + +<br/> + +## Instance Custom Node Patch + +Schema for the body of a Instance Custom Node modification request + +### <a name="instance-custom-node-patch-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, + "iconData": { + "oneOf": [ + { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + { + "type": "null" + } + ] + }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output", + "" + ] + }, + "minimumAgentVersion": { + "type": "string", + "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$" + }, + "triggers": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdConnect", + "deviceTagConnect", + "deviceIdDisconnect", + "deviceTagDisconnect", + "integration", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "udp", + "webhook" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdsTagsConnect", + "deviceIdsTagsDisconnect", + "eeaInit", + "flowError", + "azureEventHub", + "googlePubSub", + "meridian", + "mqtt", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "particle", + "udp", + "webhook" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "x": { + "type": "number" + }, + "y": { + "type": "number" + }, + "uiId": { + "type": "string", + "maxLength": 48 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "icon": { + "type": "string", + "maxLength": 1024 + }, + "color": { + "type": "string", + "maxLength": 1024 + }, + "inputCount": { + "type": "number" + }, + "outputCount": { + "type": "number" + }, + "triggerId": { + "type": "string", + "maxLength": 48 + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "virtualButton" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "virtualButton" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "x": { + "type": "number" + }, + "y": { + "type": "number" + }, + "uiId": { + "type": "string", + "maxLength": 48 + }, + "groupId": { + "type": "string", + "maxLength": 48 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "icon": { + "type": "string", + "maxLength": 1024 + }, + "color": { + "type": "string", + "maxLength": 1024 + }, + "inputCount": { + "type": "number" + }, + "outputCount": { + "type": "number" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "payload": { + "type": "string", + "maxLength": 262144 + }, + "deviceId": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "enum": [ + "" + ] + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + } + ] + } + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "config": { + "type": "object" + }, + "meta": { + "type": "object" + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + }, + "customNodeConfig": { + "type": "object", + "properties": { + "outputCount": { + "type": "number", + "enum": [ + 1, + 2 + ] + }, + "resultMode": { + "type": "string", + "enum": [ + "optional", + "required", + "none" + ] + }, + "resultDescription": { + "type": "string", + "maxLength": 32767 + }, + "fields": { + "type": "array", + "maxItems": 100, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checkbox" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "select" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "options": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 1024 + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "value" + ] + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "label", + "defaultValue", + "options" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stringTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 1024 + }, + "required": { + "type": "boolean" + }, + "validRegExp": { + "type": "string", + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "numberTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "number" + }, + "required": { + "type": "boolean" + }, + "validMin": { + "type": "number" + }, + "validMax": { + "type": "number" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "jsonTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payloadPath" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "section" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "outputCount", + "resultMode", + "fields" + ] + }, + "customNodeSupports": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "cloud" + ] + } + } + }, + "additionalProperties": { + "oneOf": [ + { + "type": "array", + "maxItems": 0 + }, + { + "type": "string", + "maxLength": 1024 + }, + { + "type": "boolean" + } + ] + }, + "maxProperties": 25 +} +``` +### <a name="instance-custom-node-patch-example"></a> Example + +```json +{ + "name": "My Updated Instance Custom Node", + "category": "logic" +} +``` + +<br/> + +## Instance Custom Node Post + +Schema for the body of a Instance Custom Node creation request + +### <a name="instance-custom-node-post-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, + "iconData": { + "oneOf": [ + { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + { + "type": "null" + } + ] + }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output", + "" + ] + }, + "minimumAgentVersion": { + "type": "string", + "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$" + }, + "triggers": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdConnect", + "deviceTagConnect", + "deviceIdDisconnect", + "deviceTagDisconnect", + "integration", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "udp", + "webhook" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdsTagsConnect", + "deviceIdsTagsDisconnect", + "eeaInit", + "flowError", + "azureEventHub", + "googlePubSub", + "meridian", + "mqtt", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "particle", + "udp", + "webhook" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "x": { + "type": "number" + }, + "y": { + "type": "number" + }, + "uiId": { + "type": "string", + "maxLength": 48 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "icon": { + "type": "string", + "maxLength": 1024 + }, + "color": { + "type": "string", + "maxLength": 1024 + }, + "inputCount": { + "type": "number" + }, + "outputCount": { + "type": "number" + }, + "triggerId": { + "type": "string", + "maxLength": 48 + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "virtualButton" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "virtualButton" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "x": { + "type": "number" + }, + "y": { + "type": "number" + }, + "uiId": { + "type": "string", + "maxLength": 48 + }, + "groupId": { + "type": "string", + "maxLength": 48 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "icon": { + "type": "string", + "maxLength": 1024 + }, + "color": { + "type": "string", + "maxLength": 1024 + }, + "inputCount": { + "type": "number" + }, + "outputCount": { + "type": "number" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "payload": { + "type": "string", + "maxLength": 262144 + }, + "deviceId": { + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "enum": [ + "" + ] + }, + { + "type": "null" + } + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + } + ] + } + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "config": { + "type": "object" + }, + "meta": { + "type": "object" + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + }, + "customNodeConfig": { + "type": "object", + "properties": { + "outputCount": { + "type": "number", + "enum": [ + 1, + 2 + ] + }, + "resultMode": { + "type": "string", + "enum": [ + "optional", + "required", + "none" + ] + }, + "resultDescription": { + "type": "string", + "maxLength": 32767 + }, + "fields": { + "type": "array", + "maxItems": 100, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checkbox" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "select" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "options": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 1024 + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "value" + ] + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "label", + "defaultValue", + "options" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stringTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 1024 + }, + "required": { + "type": "boolean" + }, + "validRegExp": { + "type": "string", + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "numberTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "number" + }, + "required": { + "type": "boolean" + }, + "validMin": { + "type": "number" + }, + "validMax": { + "type": "number" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "jsonTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payloadPath" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "section" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "outputCount", + "resultMode", + "fields" + ] + }, + "customNodeSupports": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "cloud" + ] + } + } + }, + "additionalProperties": { + "oneOf": [ + { + "type": "array", + "maxItems": 0 + }, + { + "type": "string", + "maxLength": 1024 + }, + { + "type": "boolean" + } + ] + }, + "maxProperties": 25, + "required": [ + "name", + "triggers", + "nodes" + ] +} +``` +### <a name="instance-custom-node-post-example"></a> Example + +```json +{ + "name": "My New Instance Custom Node", + "description": "Description of my new instance custom node", + "triggers": [ + { + "type": "customNodeStart" + } + ], + "nodes": [ + { + "type": "CustomNodeCapNode" + } + ] +} +``` + +<br/> + +## Instance Custom Nodes + +Schema for a collection of Custom Nodes within an instance + +### <a name="instance-custom-nodes-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Instance Custom Node", + "description": "Schema for a single Instance Custom Node", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "instanceCustomNodeId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "createdById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "createdByType": { + "type": "string", + "enum": [ + "apiToken", + "user" + ] + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "lastUpdatedById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "lastUpdatedByType": { + "type": "string", + "enum": [ + "apiToken", + "user" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, + "iconData": { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, + "minimumAgentVersion": { + "type": "string", + "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$" + }, + "triggers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "x": { + "type": "number" + }, + "y": { + "type": "number" + }, + "uiId": { + "type": "string", + "maxLength": 48 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + "maxItems": 1 + }, + "nodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "config": { + "type": "object" + }, + "meta": { + "type": "object" + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 48, + "minLength": 1 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + }, + "customNodeConfig": { + "type": "object", + "properties": { + "outputCount": { + "type": "number", + "enum": [ + 1, + 2 + ] + }, + "resultMode": { + "type": "string", + "enum": [ + "optional", + "required", + "none" + ] + }, + "resultDescription": { + "type": "string", + "maxLength": 32767 + }, + "fields": { + "type": "array", + "maxItems": 100, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checkbox" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "select" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "options": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 1024 + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "value" + ] + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "label", + "defaultValue", + "options" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stringTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 1024 + }, + "required": { + "type": "boolean" + }, + "validRegExp": { + "type": "string", + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "numberTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "number" + }, + "required": { + "type": "boolean" + }, + "validMin": { + "type": "number" + }, + "validMax": { + "type": "number" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "jsonTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payloadPath" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "section" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "outputCount", + "resultMode", + "fields" + ] + }, + "customNodeSupports": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "cloud" + ] + } + }, + "sourceApplicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "sourceFlowId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "sourceFlowVersion": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "stats": { + "type": "object", + "properties": { + "errorCount": { + "type": "integer" + }, + "runCount": { + "type": "integer" + } + }, + "additionalProperties": false + }, + "usage": { + "type": "object", + "properties": { + "sandbox": { + "type": "object", + "properties": { + "appCount": { + "type": "integer" + }, + "flowCount": { + "type": "integer" + } + }, + "additionalProperties": false + } + }, + "patternProperties": { + "^[A-Fa-f\\d]{24}$": { + "type": "object", + "properties": { + "appCount": { + "type": "integer" + }, + "flowCount": { + "type": "integer" + } + }, + "additionalProperties": false + } + }, + "additionalProperties": false + } + } + } + }, + "instanceId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "count": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "perPage": { + "type": "integer" + }, + "page": { + "type": "integer" + }, + "filter": { + "type": "string" + }, + "filterField": { + "type": "string" + }, + "sortField": { + "type": "string" + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + } + } +} +``` +### <a name="instance-custom-nodes-example"></a> Example + +```json +{ + "items": [ + { + "id": "575ed18f7ae143cd83dc4aa6", + "instanceCustomNodeId": "575ed18f7ae143cd83dc4aa6", + "instanceId": "575ec8687ae143cd83dc4a97", + "creationDate": "2016-06-13T04:00:00.000Z", + "lastUpdated": "2016-06-13T04:00:00.000Z", + "name": "My Instance Custom Node", + "description": "Description of my instance custom node", + "triggers": [ + { + "type": "customNodeStart" + } + ], + "nodes": [ + { + "type": "CustomNodeCapNode" + } + ], + "usage": { + "575ed6e87ae143cd83dc4aa8": { + "appCount": 1, + "flowCount": 2 + } + }, + "stats": { + "runCount": 123, + "errorCount": 12 + } + } + ], + "count": 1, + "totalCount": 4, + "perPage": 1, + "page": 0, + "sortField": "name", + "sortDirection": "asc", + "instanceId": "575ec8687ae143cd83dc4a97" +} +``` + +<br/> + ## Instance Member Schema for an Instance member ### <a name="instance-member-schema"></a> Schema @@ -109713,10 +112599,11 @@ "maxLength": 255 }, "integrationType": { "type": "string", "enum": [ + "azureEventHub", "googlePubSub", "meridian", "mqtt", "particle" ] @@ -109730,10 +112617,36 @@ "type": "string", "minLength": 1, "maxLength": 1024 } }, + "azureEventHubConfig": { + "type": "object", + "properties": { + "hubName": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "consumerGroup": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "connectionString": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "hubName", + "consumerGroup", + "connectionString" + ] + }, "googlePubSubConfig": { "type": "object", "properties": { "projectId": { "type": "string", @@ -109968,10 +112881,11 @@ "maxLength": 255 }, "integrationType": { "type": "string", "enum": [ + "azureEventHub", "googlePubSub", "meridian", "mqtt", "particle" ] @@ -109985,10 +112899,36 @@ "type": "string", "minLength": 1, "maxLength": 1024 } }, + "azureEventHubConfig": { + "type": "object", + "properties": { + "hubName": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "consumerGroup": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "connectionString": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "hubName", + "consumerGroup", + "connectionString" + ] + }, "googlePubSubConfig": { "type": "object", "properties": { "projectId": { "type": "string", @@ -110161,10 +113101,11 @@ "maxLength": 255 }, "integrationType": { "type": "string", "enum": [ + "azureEventHub", "googlePubSub", "meridian", "mqtt", "particle" ] @@ -110178,10 +113119,36 @@ "type": "string", "minLength": 1, "maxLength": 1024 } }, + "azureEventHubConfig": { + "type": "object", + "properties": { + "hubName": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "consumerGroup": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "connectionString": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "hubName", + "consumerGroup", + "connectionString" + ] + }, "googlePubSubConfig": { "type": "object", "properties": { "projectId": { "type": "string", @@ -110395,10 +113362,11 @@ "maxLength": 255 }, "integrationType": { "type": "string", "enum": [ + "azureEventHub", "googlePubSub", "meridian", "mqtt", "particle" ] @@ -110412,10 +113380,36 @@ "type": "string", "minLength": 1, "maxLength": 1024 } }, + "azureEventHubConfig": { + "type": "object", + "properties": { + "hubName": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "consumerGroup": { + "type": "string", + "maxLength": 256, + "minLength": 1 + }, + "connectionString": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "hubName", + "consumerGroup", + "connectionString" + ] + }, "googlePubSubConfig": { "type": "object", "properties": { "projectId": { "type": "string", @@ -118149,10 +121143,844 @@ } ``` <br/> +## Palette Response + +Schema for the set of additional nodes for the workflow palette + +### <a name="palette-response-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "customNodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, + "iconData": { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, + "customNodeConfig": { + "type": "object", + "properties": { + "outputCount": { + "type": "number", + "enum": [ + 1, + 2 + ] + }, + "resultMode": { + "type": "string", + "enum": [ + "optional", + "required", + "none" + ] + }, + "resultDescription": { + "type": "string", + "maxLength": 32767 + }, + "fields": { + "type": "array", + "maxItems": 100, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checkbox" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "select" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "options": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 1024 + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "value" + ] + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "label", + "defaultValue", + "options" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stringTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 1024 + }, + "required": { + "type": "boolean" + }, + "validRegExp": { + "type": "string", + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "numberTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "number" + }, + "required": { + "type": "boolean" + }, + "validMin": { + "type": "number" + }, + "validMax": { + "type": "number" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "jsonTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payloadPath" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "section" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "outputCount", + "resultMode", + "fields" + ] + }, + "flowVersionId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "compatibleFlowClasses": { + "type": "object", + "properties": { + "cloud": { + "type": "boolean" + }, + "experience": { + "type": "boolean" + }, + "customNode": { + "type": "boolean" + }, + "edge": { + "type": [ + "boolean", + "string" + ] + }, + "embedded": { + "type": [ + "boolean", + "string" + ] + } + } + } + } + }, + "instanceNodes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "shortDescription": { + "type": "string", + "maxLength": 1024 + }, + "iconData": { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + "docsUrl": { + "type": "string", + "maxLength": 1024 + }, + "category": { + "type": "string", + "enum": [ + "data", + "experience", + "logic", + "output" + ] + }, + "customNodeConfig": { + "type": "object", + "properties": { + "outputCount": { + "type": "number", + "enum": [ + 1, + 2 + ] + }, + "resultMode": { + "type": "string", + "enum": [ + "optional", + "required", + "none" + ] + }, + "resultDescription": { + "type": "string", + "maxLength": 32767 + }, + "fields": { + "type": "array", + "maxItems": 100, + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checkbox" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "select" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "options": { + "type": "array", + "minItems": 1, + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "label": { + "type": "string", + "maxLength": 1024 + }, + "value": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "value" + ] + } + } + }, + "additionalProperties": false, + "required": [ + "type", + "label", + "defaultValue", + "options" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "stringTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 1024 + }, + "required": { + "type": "boolean" + }, + "validRegExp": { + "type": "string", + "maxLength": 1024 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "numberTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "number" + }, + "required": { + "type": "boolean" + }, + "validMin": { + "type": "number" + }, + "validMax": { + "type": "number" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "jsonTemplate" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "defaultValue": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "payloadPath" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "required": { + "type": "boolean" + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + }, + { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "section" + ] + }, + "label": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "id": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "description": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "type", + "label" + ] + } + ] + } + } + }, + "additionalProperties": false, + "required": [ + "outputCount", + "resultMode", + "fields" + ] + }, + "compatibleFlowClasses": { + "type": "object", + "properties": { + "cloud": { + "type": "boolean" + }, + "experience": { + "type": "boolean" + }, + "customNode": { + "type": "boolean" + }, + "edge": { + "type": [ + "boolean", + "string" + ] + }, + "embedded": { + "type": [ + "boolean", + "string" + ] + } + } + } + } + } + } + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } +} +``` +### <a name="palette-response-example"></a> Example + +```json +{ + "applicationId": "61f407b56dd9921e15f2b02b", + "customNodes": [ + { + "name": "Custom Node A", + "category": "logic", + "customNodeConfig": { + "outputCount": 1, + "resultMode": "optional", + "fields": [] + }, + "id": "61f407b56dd9921e15f2b02e", + "version": "develop", + "compatibleFlowClasses": { + "cloud": true + } + }, + { + "name": "Custom Node B", + "shortDescription": "what", + "customNodeConfig": { + "outputCount": 2, + "resultMode": "required", + "fields": [] + }, + "id": "61f407b56dd9921e15f2b02f", + "version": "Version 2", + "flowVersionId": "61f407b56dd9921e15f2b031", + "compatibleFlowClasses": { + "cloud": true + } + } + ] +} +``` + +<br/> + ## Password Reset Finish Schema for the body of a request to complete the reset password flow ### <a name="password-reset-finish-schema"></a> Schema @@ -119537,10 +123365,11 @@ "flow.getStorageEntriesMetadata", "flow.stats", "flows.get", "flows.getByVersion", "flows.import", + "flows.palette", "flows.post", "flowVersion.delete", "flowVersion.errors", "flowVersion.get", "flowVersion.log", @@ -119651,11 +123480,20 @@ "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", "instanceApiToken.patch", - "instanceApiToken.delete" + "instanceApiToken.delete", + "instanceCustomNodes.*", + "instanceCustomNodes.get", + "instanceCustomNodes.post", + "instanceCustomNode.*", + "instanceCustomNode.get", + "instanceCustomNode.patch", + "instanceCustomNode.delete", + "instanceCustomNode.errors", + "instanceCustomNode.stats" ] }, { "type": "string", "enum": [ @@ -120053,10 +123891,11 @@ "flow.getStorageEntriesMetadata", "flow.stats", "flows.get", "flows.getByVersion", "flows.import", + "flows.palette", "flows.post", "flowVersion.delete", "flowVersion.errors", "flowVersion.get", "flowVersion.log", @@ -120167,10 +124006,19 @@ "instanceApiTokens.get", "instanceApiTokens.post", "instanceApiToken.*", "instanceApiToken.get", "instanceApiToken.patch", - "instanceApiToken.delete" + "instanceApiToken.delete", + "instanceCustomNodes.*", + "instanceCustomNodes.get", + "instanceCustomNodes.post", + "instanceCustomNode.*", + "instanceCustomNode.get", + "instanceCustomNode.patch", + "instanceCustomNode.delete", + "instanceCustomNode.errors", + "instanceCustomNode.stats" ] }, { "type": "string", "enum": [