docs/_schemas.md in losant_rest-1.9.1 vs docs/_schemas.md in losant_rest-1.9.2

- old
+ new

@@ -14,13 +14,14 @@ * [Application Certificate Authority Post](#application-certificate-authority-post) * [Application Certificate Patch](#application-certificate-patch) * [Application Certificate Post](#application-certificate-post) * [Application Certificates](#application-certificates) * [Success Dry Run](#success-dry-run) -* [Application Clone Enqueue](#application-clone-enqueue) * [Application Clone Post Schema](#application-clone-post-schema) -* [Application Clone](#application-clone) +* [Application Creation By Template Result](#application-creation-by-template-result) +* [Application Export Post Schema](#application-export-post-schema) +* [Application Export Result](#application-export-result) * [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) @@ -107,10 +108,11 @@ * [Experience Endpoints](#experience-endpoints) * [Experience Group](#experience-group) * [Experience Group Patch](#experience-group-patch) * [Experience Group Post](#experience-group-post) * [Experience Groups](#experience-groups) +* [Experience Linked Resources](#experience-linked-resources) * [Experience Slug](#experience-slug) * [Experience Slug Patch](#experience-slug-patch) * [Experience Slug Post](#experience-slug-post) * [Experience Slugs](#experience-slugs) * [Experience User](#experience-user) @@ -147,10 +149,11 @@ * [Github Login](#github-login) * [Integration](#integration) * [Integration Patch](#integration-patch) * [Integration Post](#integration-post) * [Integrations](#integrations) +* [Job Enqueued API Result](#job-enqueued-api-result) * [Last Value Data](#last-value-data) * [Last Value Query](#last-value-query) * [Me](#me) * [Me Patch](#me-patch) * [MQTT Publish Body](#mqtt-publish-body) @@ -184,11 +187,11 @@ * [Time Series Query](#time-series-query) * [User Credentials](#user-credentials) * [User Post](#user-post) * [Validate Context Error](#validate-context-error) * [Validate Context Success](#validate-context-success) -* [Validation Clone Error](#validation-clone-error) +* [Validation Error](#validation-error) * [Virtual Button Press](#virtual-button-press) * [Webhook](#webhook) * [Webhook Patch](#webhook-patch) * [Webhook Post](#webhook-post) * [Webhooks](#webhooks) @@ -1765,16 +1768,16 @@ "type": "string", "max": 255 }, "accessKeyId": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "secretAccessKey": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "region": { "type": "string", "max": 128 @@ -1797,11 +1800,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "bucket": { "type": "string", "max": 255 } @@ -1965,10 +1968,11 @@ "webhook.*", "webhooks.*", "application.archiveData", "application.backfillArchiveData", "application.clone", + "application.export", "application.fullEventsArchive", "application.fullDataTablesArchive", "application.debug", "application.delete", "application.get", @@ -2063,10 +2067,11 @@ "experienceDomain.patch", "experienceDomains.get", "experienceDomains.post", "experienceEndpoint.delete", "experienceEndpoint.get", + "experienceEndpoint.linkedResources", "experienceEndpoint.patch", "experienceEndpoints.get", "experienceEndpoints.post", "experienceEndpoints.stats", "experienceGroup.delete", @@ -2092,10 +2097,11 @@ "experienceVersions.get", "experienceVersions.post", "experienceView.debug", "experienceView.delete", "experienceView.get", + "experienceView.linkedResources", "experienceView.patch", "experienceViews.debug", "experienceViews.detailedSummary", "experienceViews.get", "experienceViews.post", @@ -2273,10 +2279,44 @@ "notValidAfter": { "type": "string", "format": "date-time" } } + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } } } ``` ### <a name="application-certificate-example"></a> Example @@ -2295,11 +2335,14 @@ "fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06", "commonName": "myDomain.com", "issuerName": "Network Solutions OV Server CA 2", "notValidBefore": "2019-04-10T00:00:00.000Z", "notValidAfter": "2020-04-10T00:00:00.000Z" - } + }, + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ``` <br/> @@ -2716,10 +2759,44 @@ }, "certificate": { "type": "string", "maxLength": 32767, "minLength": 50 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } }, "additionalProperties": false } ``` @@ -2785,10 +2862,44 @@ }, "certificate": { "type": "string", "maxLength": 32767, "minLength": 50 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } }, "required": [ "certificate" ], @@ -2798,11 +2909,14 @@ ### <a name="application-certificate-post-example"></a> Example ```json { "description": "An example new certificate description", - "certificate": "MY_SSL_CERTIFICATE" + "certificate": "MY_SSL_CERTIFICATE", + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ``` <br/> @@ -2910,10 +3024,44 @@ "notValidAfter": { "type": "string", "format": "date-time" } } + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } } } }, "count": { @@ -2972,11 +3120,14 @@ "fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06", "commonName": "myDomain.com", "issuerName": "Network Solutions OV Server CA 2", "notValidBefore": "2019-04-10T00:00:00.000Z", "notValidAfter": "2020-04-10T00:00:00.000Z" - } + }, + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ], "count": 1, "totalCount": 4, "perPage": 1, @@ -3021,37 +3172,10 @@ } ``` <br/> -## Application Clone Enqueue - -Schema for the result of an application clone request when creating more than 1000 resources - -### <a name="application-clone-enqueue-schema"></a> Schema - -```json -{ - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "jobQueued": { - "type": "boolean" - } - } -} -``` -### <a name="application-clone-enqueue-example"></a> Example - -```json -{ - "jobQueued": true -} -``` - -<br/> - ## Application Clone Post Schema Schema for the body of an application clone request ### <a name="application-clone-post-schema-schema"></a> Schema @@ -3117,15 +3241,15 @@ } ``` <br/> -## Application Clone +## Application Creation By Template Result -Schema for the result of an application clone request +Schema for creating an application by template result -### <a name="application-clone-schema"></a> Schema +### <a name="application-creation-by-template-result-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", @@ -3397,16 +3521,16 @@ "type": "string", "max": 255 }, "accessKeyId": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "secretAccessKey": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "region": { "type": "string", "max": 128 @@ -3429,11 +3553,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "bucket": { "type": "string", "max": 255 } @@ -3485,23 +3609,31 @@ }, "name": { "type": "string" }, "id": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string" + } + ] }, "message": { "type": "string" } } } } - } + }, + "additionalProperties": false } ``` -### <a name="application-clone-example"></a> Example +### <a name="application-creation-by-template-result-example"></a> Example ```json { "application": { "id": "575ec8687ae143cd83dc4a98", @@ -3537,10 +3669,82 @@ } ``` <br/> +## Application Export Post Schema + +Schema for the body of an application export request + +### <a name="application-export-post-schema-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "includeFiles": { + "type": "boolean", + "default": false + }, + "includeDataTableRows": { + "type": "boolean", + "default": false + }, + "includeDevices": { + "type": "boolean", + "default": false + }, + "email": { + "type": "string", + "format": "email", + "maxLength": 1024 + } + }, + "additionalProperties": false +} +``` +### <a name="application-export-post-schema-example"></a> Example + +```json +{ + "includeFiles": true, + "includeDevices": true, + "email": "test@losant.com" +} +``` + +<br/> + +## Application Export Result + +Schema for an application export result + +### <a name="application-export-result-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "url": { + "type": "string" + } + }, + "additionalProperties": false +} +``` +### <a name="application-export-result-example"></a> Example + +```json +{ + "url": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon/applicationExport.zip" +} +``` + +<br/> + ## Application Key Schema for a single Application Key ### <a name="application-key-schema"></a> Schema @@ -3608,10 +3812,44 @@ "maxItems": 100 }, "description": { "type": "string", "maxLength": 32767 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } } } ``` ### <a name="application-key-example"></a> Example @@ -3623,11 +3861,14 @@ "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "key": "this_would_be_the_key", "status": "active", - "description": "An example key description" + "description": "An example key description", + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ``` <br/> @@ -3650,10 +3891,44 @@ ] }, "description": { "type": "string", "maxLength": 32767 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } }, "additionalProperties": false } ``` @@ -3707,20 +3982,57 @@ "maxItems": 100 }, "description": { "type": "string", "maxLength": 32767 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } }, "additionalProperties": false } ``` ### <a name="application-key-post-example"></a> Example ```json { - "description": "An example new key description" + "description": "An example new key description", + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ``` <br/> @@ -3796,10 +4108,44 @@ "maxItems": 100 }, "description": { "type": "string", "maxLength": 32767 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } } } ``` ### <a name="application-key-post-response-example"></a> Example @@ -3812,11 +4158,14 @@ "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "key": "this_would_be_the_key", "status": "active", "secret": "shhhSecret", - "description": "An example key description" + "description": "An example key description", + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ``` <br/> @@ -3896,10 +4245,44 @@ "maxItems": 100 }, "description": { "type": "string", "maxLength": 32767 + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } } } }, "count": { @@ -3951,11 +4334,14 @@ "applicationId": "575ec8687ae143cd83dc4a97", "creationDate": "2016-06-13T04:00:00.000Z", "lastUpdated": "2016-06-13T04:00:00.000Z", "key": "this_would_be_the_key", "status": "active", - "description": "An example key description" + "description": "An example key description", + "filterType": "all", + "pubTopics": [], + "subTopics": [] } ], "count": 1, "totalCount": 4, "perPage": 1, @@ -4138,16 +4524,16 @@ "type": "string", "max": 255 }, "accessKeyId": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "secretAccessKey": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "region": { "type": "string", "max": 128 @@ -4170,11 +4556,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "bucket": { "type": "string", "max": 255 } @@ -4374,16 +4760,16 @@ "type": "string", "max": 255 }, "accessKeyId": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "secretAccessKey": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "region": { "type": "string", "max": 128 @@ -4406,11 +4792,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "bucket": { "type": "string", "max": 255 } @@ -4825,16 +5211,16 @@ "type": "string", "max": 255 }, "accessKeyId": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "secretAccessKey": { "type": "string", - "min": 16, + "min": 4, "max": 128 }, "region": { "type": "string", "max": 128 @@ -4857,11 +5243,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "bucket": { "type": "string", "max": 255 } @@ -5527,10 +5913,44 @@ "type": "string", "enum": [ "user", "organization" ] + }, + "filterType": { + "oneOf": [ + { + "type": "string", + "enum": [ + "all", + "whitelist", + "blacklist" + ] + }, + { + "type": "string", + "enum": [ + "none" + ] + } + ] + }, + "pubTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } + }, + "subTopics": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + } } }, "required": [ "applicationId", "deviceId", @@ -5545,11 +5965,18 @@ { "applicationId": "575ec8687ae143cd83dc4a97", "deviceId": "575ecf887ae143cd83dc4aa2", "deviceClass": "standalone", "token": "token_to_use_for_authenticating_subsequent_requests", - "ownerType": "organization" + "ownerType": "organization", + "filterType": "whitelist", + "pubTopics": [ + "#" + ], + "subTopics": [ + "#" + ] } ``` <br/> @@ -6533,10 +6960,28 @@ ] }, "config": { "type": "object", "properties": { + "additionalAttributes": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + ] + }, + "excludeConnectionInfo": { + "type": "boolean" + }, "deviceLinkNewWindow": { "type": "boolean" }, "deviceLinkType": { "type": "string", @@ -6558,10 +7003,29 @@ ] }, "showPublicFilter": { "type": "boolean" }, + "sortField": { + "type": "string", + "enum": [ + "id", + "creationDate", + "lastUpdated", + "name" + ] + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + }, "filter": { "oneOf": [ { "type": "string", "maxLength": 255 @@ -6605,10 +7069,49 @@ } }, "additionalProperties": false } ] + }, + "columns": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 48 + }, + "type": { + "type": "string", + "enum": [ + "id", + "connectionStatus", + "attribute", + "tag", + "name", + "custom", + "created", + "updated" + ] + }, + "source": { + "type": "string", + "maxLength": 255 + }, + "headerTemplate": { + "type": "string", + "maxLength": 1024 + }, + "rowTemplate": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false + } } }, "additionalProperties": false } }, @@ -11042,10 +11545,28 @@ ] }, "config": { "type": "object", "properties": { + "additionalAttributes": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + ] + }, + "excludeConnectionInfo": { + "type": "boolean" + }, "deviceLinkNewWindow": { "type": "boolean" }, "deviceLinkType": { "type": "string", @@ -11067,10 +11588,29 @@ ] }, "showPublicFilter": { "type": "boolean" }, + "sortField": { + "type": "string", + "enum": [ + "id", + "creationDate", + "lastUpdated", + "name" + ] + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + }, "filter": { "oneOf": [ { "type": "string", "maxLength": 255 @@ -11114,10 +11654,49 @@ } }, "additionalProperties": false } ] + }, + "columns": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 48 + }, + "type": { + "type": "string", + "enum": [ + "id", + "connectionStatus", + "attribute", + "tag", + "name", + "custom", + "created", + "updated" + ] + }, + "source": { + "type": "string", + "maxLength": 255 + }, + "headerTemplate": { + "type": "string", + "maxLength": 1024 + }, + "rowTemplate": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false + } } }, "additionalProperties": false } }, @@ -15480,10 +16059,28 @@ ] }, "config": { "type": "object", "properties": { + "additionalAttributes": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + ] + }, + "excludeConnectionInfo": { + "type": "boolean" + }, "deviceLinkNewWindow": { "type": "boolean" }, "deviceLinkType": { "type": "string", @@ -15505,10 +16102,29 @@ ] }, "showPublicFilter": { "type": "boolean" }, + "sortField": { + "type": "string", + "enum": [ + "id", + "creationDate", + "lastUpdated", + "name" + ] + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + }, "filter": { "oneOf": [ { "type": "string", "maxLength": 255 @@ -15552,10 +16168,49 @@ } }, "additionalProperties": false } ] + }, + "columns": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 48 + }, + "type": { + "type": "string", + "enum": [ + "id", + "connectionStatus", + "attribute", + "tag", + "name", + "custom", + "created", + "updated" + ] + }, + "source": { + "type": "string", + "maxLength": 255 + }, + "headerTemplate": { + "type": "string", + "maxLength": 1024 + }, + "rowTemplate": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false + } } }, "additionalProperties": false } }, @@ -20173,10 +20828,28 @@ ] }, "config": { "type": "object", "properties": { + "additionalAttributes": { + "oneOf": [ + { + "type": "null" + }, + { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + ] + }, + "excludeConnectionInfo": { + "type": "boolean" + }, "deviceLinkNewWindow": { "type": "boolean" }, "deviceLinkType": { "type": "string", @@ -20198,10 +20871,29 @@ ] }, "showPublicFilter": { "type": "boolean" }, + "sortField": { + "type": "string", + "enum": [ + "id", + "creationDate", + "lastUpdated", + "name" + ] + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + }, "filter": { "oneOf": [ { "type": "string", "maxLength": 255 @@ -20245,10 +20937,49 @@ } }, "additionalProperties": false } ] + }, + "columns": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 48 + }, + "type": { + "type": "string", + "enum": [ + "id", + "connectionStatus", + "attribute", + "tag", + "name", + "custom", + "created", + "updated" + ] + }, + "source": { + "type": "string", + "maxLength": 255 + }, + "headerTemplate": { + "type": "string", + "maxLength": 1024 + }, + "rowTemplate": { + "type": "string", + "maxLength": 32767 + } + }, + "additionalProperties": false + } } }, "additionalProperties": false } }, @@ -33151,10 +33882,6487 @@ } ``` <br/> +## Experience Linked Resources + +The body of an experience linked resources response + +### <a name="experience-linked-resources-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "experienceViews": { + "title": "Experience Views", + "description": "Schema for a collection of Experience Views", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Experience View", + "description": "Schema for a single Experience View", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "experienceViewId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "createdById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "createdByType": { + "type": "string", + "enum": [ + "flow", + "user", + "apiToken" + ] + }, + "lastUpdatedById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "lastUpdatedByType": { + "type": "string", + "enum": [ + "flow", + "user", + "apiToken" + ] + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "viewType": { + "type": "string", + "enum": [ + "layout", + "page", + "component" + ] + }, + "layoutId": { + "type": [ + "string", + "null" + ], + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "layoutName": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "body": { + "type": "string", + "maxLength": 131072, + "minLength": 1 + }, + "viewTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + } + } + } + }, + "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", + "" + ] + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "viewType": { + "type": "string", + "enum": [ + "layout", + "page", + "component" + ] + } + } + }, + "experienceEndpoints": { + "title": "Experience Endpoints", + "description": "Schema for a collection of Experience Endpoints", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Experience Endpoint", + "description": "Schema for a single Experience Endpoint", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "experienceEndpointId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "createdById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "createdByType": { + "type": "string", + "enum": [ + "flow", + "user", + "apiToken" + ] + }, + "lastUpdatedById": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "lastUpdatedByType": { + "type": "string", + "enum": [ + "flow", + "user", + "apiToken" + ] + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "route": { + "type": "string", + "minLength": 1, + "maxLength": 1024 + }, + "enabled": { + "type": "boolean" + }, + "method": { + "type": "string", + "enum": [ + "delete", + "get", + "options", + "patch", + "post", + "put" + ] + }, + "access": { + "type": "string", + "enum": [ + "public", + "authenticated", + "group" + ] + }, + "endpointTags": { + "type": "object", + "patternProperties": { + "^[0-9a-zA-Z_-]{1,255}$": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "staticReply": { + "oneOf": [ + { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "statusCode": { + "type": "number", + "min": 100, + "max": 599, + "integer": true + }, + "type": { + "type": "string", + "enum": [ + "page", + "redirect" + ] + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + }, + { + "type": "null" + } + ] + }, + "unauthorizedReply": { + "oneOf": [ + { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "statusCode": { + "type": "number", + "min": 100, + "max": 599, + "integer": true + }, + "type": { + "type": "string", + "enum": [ + "page", + "redirect" + ] + } + }, + "required": [ + "value", + "type" + ], + "additionalProperties": false + }, + { + "type": "null" + } + ] + }, + "experienceGroups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + } + } + } + } + }, + "count": { + "type": "integer" + }, + "totalCount": { + "type": "integer" + }, + "filter": { + "type": "string" + }, + "filterField": { + "type": "string" + }, + "sortField": { + "type": "string" + }, + "sortDirection": { + "type": "string", + "enum": [ + "asc", + "desc", + "ASC", + "DESC", + "" + ] + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "experienceGroupId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "notFoundRequestCount": { + "type": "number" + } + } + }, + "flows": { + "title": "Workflows", + "description": "Schema for a collection of Workflows", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Workflow", + "description": "Schema for a single Workflow", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "description": { + "type": "string", + "maxLength": 32767 + }, + "iconData": { + "type": "string", + "maxLength": 32767, + "pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$" + }, + "enabled": { + "type": "boolean" + }, + "defaultVersionId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "minimumAgentVersion": { + "type": "string", + "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$" + }, + "flowClass": { + "type": "string", + "enum": [ + "cloud", + "edge", + "experience", + "customNode" + ] + }, + "triggers": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdConnect", + "deviceTagConnect", + "deviceIdDisconnect", + "deviceTagDisconnect", + "integration", + "mqttTopic", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "request", + "udp", + "webhook" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdsTagsConnect", + "deviceIdsTagsDisconnect", + "flowError", + "googlePubSub", + "meridian", + "mqtt", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "particle", + "request", + "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": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "dataTable" + ] + }, + "config": { + "type": "object", + "properties": { + "bulkInsert": { + "type": "boolean" + }, + "delete": { + "type": "boolean" + }, + "insert": { + "type": "boolean" + }, + "update": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "dataTable" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "deviceId", + "deviceTag" + ] + }, + "config": { + "type": "object", + "properties": { + "attributeBlacklist": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "attributeWhitelist": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "maxAge": { + "type": "number" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "deviceIdsTags", + "device", + "deviceTag" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "timeUnit": { + "type": "string", + "maxLength": 48 + }, + "maxAgeToggle": { + "type": "boolean" + }, + "allowedAttributeType": { + "type": "string", + "enum": [ + "attributeWhitelist", + "any", + "attributeBlacklist" + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "deviceIdInactivity", + "deviceTagInactivity" + ] + }, + "config": { + "type": "object", + "properties": { + "seconds": { + "type": "number" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "deviceIdsTagsInactivity" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "endpoint" + ] + }, + "config": { + "type": "object", + "properties": { + "experienceVersion": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "endpoint" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "event" + ] + }, + "config": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "maxLength": 255 + }, + "new": { + "type": "boolean" + }, + "acknowledged": { + "type": "boolean" + }, + "resolved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "event" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "fileTail" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "encoding": { + "type": "string", + "maxLength": 48 + }, + "byteLength": { + "type": "string", + "maxLength": 48 + }, + "delimiter": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "fileTail" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "fileWatch" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "fileAdded": { + "type": "boolean" + }, + "fileChanged": { + "type": "boolean" + }, + "fileRemoved": { + "type": "boolean" + }, + "directoryAdded": { + "type": "boolean" + }, + "directoryRemoved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "fileWatch" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "flowError" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "flowError" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "opcua" + ] + }, + "config": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "maxLength": 1024 + }, + "securityPolicy": { + "type": "string", + "maxLength": 255 + }, + "securityMode": { + "type": "string", + "maxLength": 255 + }, + "username": { + "type": "string", + "maxLength": 1024 + }, + "password": { + "type": "string", + "maxLength": 1024 + }, + "cert": { + "type": "string", + "maxLength": 32767 + }, + "privateKey": { + "type": "string", + "maxLength": 32767 + }, + "nameSpace": { + "type": "string", + "maxLength": 255 + }, + "identifier": { + "type": "string", + "maxLength": 255 + }, + "samplingInterval": { + "type": "string", + "maxLength": 255 + }, + "eventFilter": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "opcua" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "redis" + ] + }, + "config": { + "type": "object", + "properties": { + "host": { + "type": "string", + "maxLength": 1024 + }, + "port": { + "type": "string", + "maxLength": 16 + }, + "password": { + "type": "string", + "maxLength": 1024 + }, + "topic": { + "type": "string", + "maxLength": 1024 + }, + "fileAdded": { + "type": "boolean" + }, + "fileChanged": { + "type": "boolean" + }, + "fileRemoved": { + "type": "boolean" + }, + "directoryAdded": { + "type": "boolean" + }, + "directoryRemoved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "redisTrigger" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "serial" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "baudRate": { + "type": "number" + }, + "encoding": { + "type": "string", + "maxLength": 48 + }, + "writeOnOpen": { + "type": "string", + "maxLength": 1024 + }, + "byteLength": { + "type": "string", + "maxLength": 48 + }, + "delimiter": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "serial" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "parseBy": { + "type": "string", + "enum": [ + "byteLength", + "delimiter" + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "timer" + ] + }, + "config": { + "type": "object", + "properties": { + "seconds": { + "type": "number" + }, + "cron": { + "type": "string", + "maxLength": 255 + }, + "tz": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "timer" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "timerTypeSelect": { + "type": "string", + "enum": [ + "cronWeekly", + "seconds", + "cron" + ] + }, + "timeAt": { + "type": "string", + "maxLength": 255 + }, + "timezone": { + "type": "string", + "maxLength": 255 + }, + "weekdays": { + "type": "array", + "maxItems": 7, + "items": { + "type": "number" + } + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "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": 255 + }, + "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": 255 + }, + "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" + ] + } + }, + "customNodeUseCount": { + "type": "number" + }, + "globals": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "json": { + "type": "string", + "minLength": 1, + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "key", + "json" + ] + } + }, + "deletedInDevelop": { + "type": "boolean" + }, + "stats": { + "type": "object", + "properties": { + "runCount": { + "type": "number" + }, + "errorCount": { + "type": "number" + }, + "byVersion": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "runCount": { + "type": "number" + }, + "errorCount": { + "type": "number" + } + } + } + } + } + } + } + } + } + }, + "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", + "" + ] + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowClass": { + "type": "string", + "enum": [ + "cloud", + "edge", + "experience", + "customNode" + ] + } + } + }, + "flowVersions": { + "title": "Workflow Versions", + "description": "Schema for a collection of Workflow Versions", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "title": "Workflow Version", + "description": "Schema for a single Workflow Version", + "oneOf": [ + { + "description": "Schema for a single Cloud/Edge/Custom Node Workflow Version", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowVersionId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "version": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "notes": { + "type": "string", + "maxLength": 32767 + }, + "enabled": { + "type": "boolean" + }, + "triggers": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdConnect", + "deviceTagConnect", + "deviceIdDisconnect", + "deviceTagDisconnect", + "integration", + "mqttTopic", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "request", + "udp", + "webhook" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdsTagsConnect", + "deviceIdsTagsDisconnect", + "flowError", + "googlePubSub", + "meridian", + "mqtt", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "particle", + "request", + "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": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "dataTable" + ] + }, + "config": { + "type": "object", + "properties": { + "bulkInsert": { + "type": "boolean" + }, + "delete": { + "type": "boolean" + }, + "insert": { + "type": "boolean" + }, + "update": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "dataTable" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "deviceId", + "deviceTag" + ] + }, + "config": { + "type": "object", + "properties": { + "attributeBlacklist": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "attributeWhitelist": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "maxAge": { + "type": "number" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "deviceIdsTags", + "device", + "deviceTag" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "timeUnit": { + "type": "string", + "maxLength": 48 + }, + "maxAgeToggle": { + "type": "boolean" + }, + "allowedAttributeType": { + "type": "string", + "enum": [ + "attributeWhitelist", + "any", + "attributeBlacklist" + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "deviceIdInactivity", + "deviceTagInactivity" + ] + }, + "config": { + "type": "object", + "properties": { + "seconds": { + "type": "number" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "deviceIdsTagsInactivity" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "endpoint" + ] + }, + "config": { + "type": "object", + "properties": { + "experienceVersion": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "endpoint" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "event" + ] + }, + "config": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "maxLength": 255 + }, + "new": { + "type": "boolean" + }, + "acknowledged": { + "type": "boolean" + }, + "resolved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "event" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "fileTail" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "encoding": { + "type": "string", + "maxLength": 48 + }, + "byteLength": { + "type": "string", + "maxLength": 48 + }, + "delimiter": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "fileTail" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "fileWatch" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "fileAdded": { + "type": "boolean" + }, + "fileChanged": { + "type": "boolean" + }, + "fileRemoved": { + "type": "boolean" + }, + "directoryAdded": { + "type": "boolean" + }, + "directoryRemoved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "fileWatch" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "flowError" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "flowError" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "opcua" + ] + }, + "config": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "maxLength": 1024 + }, + "securityPolicy": { + "type": "string", + "maxLength": 255 + }, + "securityMode": { + "type": "string", + "maxLength": 255 + }, + "username": { + "type": "string", + "maxLength": 1024 + }, + "password": { + "type": "string", + "maxLength": 1024 + }, + "cert": { + "type": "string", + "maxLength": 32767 + }, + "privateKey": { + "type": "string", + "maxLength": 32767 + }, + "nameSpace": { + "type": "string", + "maxLength": 255 + }, + "identifier": { + "type": "string", + "maxLength": 255 + }, + "samplingInterval": { + "type": "string", + "maxLength": 255 + }, + "eventFilter": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "opcua" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "redis" + ] + }, + "config": { + "type": "object", + "properties": { + "host": { + "type": "string", + "maxLength": 1024 + }, + "port": { + "type": "string", + "maxLength": 16 + }, + "password": { + "type": "string", + "maxLength": 1024 + }, + "topic": { + "type": "string", + "maxLength": 1024 + }, + "fileAdded": { + "type": "boolean" + }, + "fileChanged": { + "type": "boolean" + }, + "fileRemoved": { + "type": "boolean" + }, + "directoryAdded": { + "type": "boolean" + }, + "directoryRemoved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "redisTrigger" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "serial" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "baudRate": { + "type": "number" + }, + "encoding": { + "type": "string", + "maxLength": 48 + }, + "writeOnOpen": { + "type": "string", + "maxLength": 1024 + }, + "byteLength": { + "type": "string", + "maxLength": 48 + }, + "delimiter": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "serial" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "parseBy": { + "type": "string", + "enum": [ + "byteLength", + "delimiter" + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "timer" + ] + }, + "config": { + "type": "object", + "properties": { + "seconds": { + "type": "number" + }, + "cron": { + "type": "string", + "maxLength": 255 + }, + "tz": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "timer" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "timerTypeSelect": { + "type": "string", + "enum": [ + "cronWeekly", + "seconds", + "cron" + ] + }, + "timeAt": { + "type": "string", + "maxLength": 255 + }, + "timezone": { + "type": "string", + "maxLength": 255 + }, + "weekdays": { + "type": "array", + "maxItems": 7, + "items": { + "type": "number" + } + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "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": 255 + }, + "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": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + }, + "globals": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "json": { + "type": "string", + "minLength": 1, + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "key", + "json" + ] + } + }, + "minimumAgentVersion": { + "type": "string", + "pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$" + }, + "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" + ] + }, + "stats": { + "type": "object", + "properties": { + "runCount": { + "type": "number" + }, + "errorCount": { + "type": "number" + }, + "byVersion": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "runCount": { + "type": "number" + }, + "errorCount": { + "type": "number" + } + } + } + } + } + } + } + } + }, + { + "description": "Schema for a single Experience Workflow Version", + "type": "object", + "properties": { + "id": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowVersionId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "creationDate": { + "type": "string", + "format": "date-time" + }, + "lastUpdated": { + "type": "string", + "format": "date-time" + }, + "name": { + "type": "string", + "minLength": 1, + "maxLength": 255 + }, + "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" + ] + }, + "versions": { + "type": "array", + "items": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "enabled": { + "type": "boolean" + }, + "triggers": { + "type": "array", + "items": { + "oneOf": [ + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdConnect", + "deviceTagConnect", + "deviceIdDisconnect", + "deviceTagDisconnect", + "integration", + "mqttTopic", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "request", + "udp", + "webhook" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "customNodeStart", + "deviceCommand", + "deviceIdsTagsConnect", + "deviceIdsTagsDisconnect", + "flowError", + "googlePubSub", + "meridian", + "mqtt", + "notebook", + "onBoot", + "onConnect", + "onDisconnect", + "particle", + "request", + "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": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "dataTable" + ] + }, + "config": { + "type": "object", + "properties": { + "bulkInsert": { + "type": "boolean" + }, + "delete": { + "type": "boolean" + }, + "insert": { + "type": "boolean" + }, + "update": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "dataTable" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "deviceId", + "deviceTag" + ] + }, + "config": { + "type": "object", + "properties": { + "attributeBlacklist": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "attributeWhitelist": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + } + }, + "maxAge": { + "type": "number" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "deviceIdsTags", + "device", + "deviceTag" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "timeUnit": { + "type": "string", + "maxLength": 48 + }, + "maxAgeToggle": { + "type": "boolean" + }, + "allowedAttributeType": { + "type": "string", + "enum": [ + "attributeWhitelist", + "any", + "attributeBlacklist" + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "deviceIdInactivity", + "deviceTagInactivity" + ] + }, + "config": { + "type": "object", + "properties": { + "seconds": { + "type": "number" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "deviceIdsTagsInactivity" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "endpoint" + ] + }, + "config": { + "type": "object", + "properties": { + "experienceVersion": { + "type": "string", + "minLength": 1, + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "endpoint" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "event" + ] + }, + "config": { + "type": "object", + "properties": { + "subject": { + "type": "string", + "maxLength": 255 + }, + "new": { + "type": "boolean" + }, + "acknowledged": { + "type": "boolean" + }, + "resolved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "event" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "fileTail" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "encoding": { + "type": "string", + "maxLength": 48 + }, + "byteLength": { + "type": "string", + "maxLength": 48 + }, + "delimiter": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "fileTail" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "fileWatch" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "fileAdded": { + "type": "boolean" + }, + "fileChanged": { + "type": "boolean" + }, + "fileRemoved": { + "type": "boolean" + }, + "directoryAdded": { + "type": "boolean" + }, + "directoryRemoved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "fileWatch" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "flowError" + ] + }, + "config": { + "type": "object", + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "flowError" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "opcua" + ] + }, + "config": { + "type": "object", + "properties": { + "uri": { + "type": "string", + "maxLength": 1024 + }, + "securityPolicy": { + "type": "string", + "maxLength": 255 + }, + "securityMode": { + "type": "string", + "maxLength": 255 + }, + "username": { + "type": "string", + "maxLength": 1024 + }, + "password": { + "type": "string", + "maxLength": 1024 + }, + "cert": { + "type": "string", + "maxLength": 32767 + }, + "privateKey": { + "type": "string", + "maxLength": 32767 + }, + "nameSpace": { + "type": "string", + "maxLength": 255 + }, + "identifier": { + "type": "string", + "maxLength": 255 + }, + "samplingInterval": { + "type": "string", + "maxLength": 255 + }, + "eventFilter": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string", + "maxLength": 255 + } + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "opcua" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "redis" + ] + }, + "config": { + "type": "object", + "properties": { + "host": { + "type": "string", + "maxLength": 1024 + }, + "port": { + "type": "string", + "maxLength": 16 + }, + "password": { + "type": "string", + "maxLength": 1024 + }, + "topic": { + "type": "string", + "maxLength": 1024 + }, + "fileAdded": { + "type": "boolean" + }, + "fileChanged": { + "type": "boolean" + }, + "fileRemoved": { + "type": "boolean" + }, + "directoryAdded": { + "type": "boolean" + }, + "directoryRemoved": { + "type": "boolean" + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "redisTrigger" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "serial" + ] + }, + "config": { + "type": "object", + "properties": { + "path": { + "type": "string", + "maxLength": 1024 + }, + "baudRate": { + "type": "number" + }, + "encoding": { + "type": "string", + "maxLength": 48 + }, + "writeOnOpen": { + "type": "string", + "maxLength": 1024 + }, + "byteLength": { + "type": "string", + "maxLength": 48 + }, + "delimiter": { + "type": "string", + "maxLength": 48 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "serial" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "parseBy": { + "type": "string", + "enum": [ + "byteLength", + "delimiter" + ] + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "required": [ + "type" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 1024 + }, + "type": { + "type": "string", + "enum": [ + "timer" + ] + }, + "config": { + "type": "object", + "properties": { + "seconds": { + "type": "number" + }, + "cron": { + "type": "string", + "maxLength": 255 + }, + "tz": { + "type": "string", + "maxLength": 255 + } + }, + "additionalProperties": false + }, + "meta": { + "type": "object", + "properties": { + "category": { + "type": "string", + "enum": [ + "trigger" + ] + }, + "name": { + "type": "string", + "enum": [ + "timer" + ] + }, + "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" + }, + "id": { + "type": "string", + "maxLength": 48 + }, + "timerTypeSelect": { + "type": "string", + "enum": [ + "cronWeekly", + "seconds", + "cron" + ] + }, + "timeAt": { + "type": "string", + "maxLength": 255 + }, + "timezone": { + "type": "string", + "maxLength": 255 + }, + "weekdays": { + "type": "array", + "maxItems": 7, + "items": { + "type": "number" + } + } + }, + "additionalProperties": false + }, + "outputIds": { + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255 + }, + "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": 255 + }, + "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": 255 + }, + "maxItems": 100 + }, + "maxItems": 100 + } + }, + "additionalProperties": false, + "required": [ + "type" + ] + } + }, + "globals": { + "type": "array", + "maxItems": 100, + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + "json": { + "type": "string", + "minLength": 1, + "maxLength": 32767 + } + }, + "additionalProperties": false, + "required": [ + "key", + "json" + ] + } + }, + "stats": { + "type": "object", + "properties": { + "runCount": { + "type": "number" + }, + "errorCount": { + "type": "number" + }, + "byVersion": { + "type": "object", + "patternProperties": { + ".*": { + "type": "object", + "properties": { + "runCount": { + "type": "number" + }, + "errorCount": { + "type": "number" + } + } + } + } + } + } + } + } + } + ] + } + }, + "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", + "" + ] + }, + "applicationId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + "flowId": { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + } + } + } + }, + "additionalProperties": false +} +``` +### <a name="experience-linked-resources-example"></a> Example + +```json +{ + "experienceViews": { + "items": [ + { + "id": "59cc5c628246c6caed4b16c1", + "experienceViewId": "59cc5c628246c6caed4b16c1", + "applicationId": "575ec8687ae143cd83dc4a97", + "creationDate": "2016-06-13T04:00:00.000Z", + "lastUpdated": "2016-06-13T04:00:00.000Z", + "name": "My Page View", + "viewType": "page", + "body": "<p>{{data}}</p>", + "layoutId": "59cc5cad8246c6caed4b16c2", + "viewTags": { + "customKey": "customValue" + } + } + ], + "count": 1, + "totalCount": 4, + "perPage": 1, + "page": 0, + "sortField": "name", + "sortDirection": "asc", + "applicationId": "575ec8687ae143cd83dc4a97" + }, + "experienceEndpoints": { + "items": [ + { + "id": "58c1de6c8f812590d8e82980", + "experienceEndpointId": "58c1de6c8f812590d8e82980", + "applicationId": "575ec8687ae143cd83dc4a97", + "creationDate": "2016-06-13T04:00:00.000Z", + "lastUpdated": "2016-06-13T04:00:00.000Z", + "route": "/my/route/{id}", + "enabled": true, + "method": "get", + "access": "group", + "experienceGroups": [ + { + "name": "myGroup", + "id": "58b9d794cbfafe1be675744f" + } + ] + } + ], + "count": 1, + "totalCount": 4, + "perPage": 1, + "page": 0, + "sortField": "name", + "sortDirection": "asc", + "applicationId": "575ec8687ae143cd83dc4a97" + }, + "flows": { + "items": [ + { + "id": "575ed18f7ae143cd83dc4aa6", + "flowId": "575ed18f7ae143cd83dc4aa6", + "applicationId": "575ec8687ae143cd83dc4a97", + "creationDate": "2016-06-13T04:00:00.000Z", + "lastUpdated": "2016-06-13T04:00:00.000Z", + "name": "My Workflow", + "description": "Description of my empty workflow", + "enabled": true, + "triggers": [], + "nodes": [], + "globals": [], + "stats": { + "runCount": 0, + "errorCount": 0 + } + } + ], + "count": 1, + "totalCount": 4, + "perPage": 1, + "page": 0, + "sortField": "name", + "sortDirection": "asc", + "applicationId": "575ec8687ae143cd83dc4a97" + }, + "flowVersions": { + "items": [ + { + "id": "675ed18f7ae143cd83dc4bb7", + "flowVersionId": "675ed18f7ae143cd83dc4bb7", + "flowId": "575ed18f7ae143cd83dc4aa6", + "applicationId": "575ec8687ae143cd83dc4a97", + "creationDate": "2016-06-13T04:00:00.000Z", + "lastUpdated": "2016-06-13T04:00:00.000Z", + "version": "v1.2.3", + "notes": "Description of my workflow version", + "enabled": true, + "triggers": [], + "nodes": [], + "globals": [] + } + ], + "count": 1, + "totalCount": 4, + "perPage": 1, + "page": 0, + "sortField": "version", + "sortDirection": "asc", + "applicationId": "575ec8687ae143cd83dc4a97", + "flowId": "575ed18f7ae143cd83dc4aa6" + } +} +``` + +<br/> + ## Experience Slug Schema for a single Experience Slug ### <a name="experience-slug-schema"></a> Schema @@ -63608,10 +70816,11 @@ "webhook.*", "webhooks.*", "application.archiveData", "application.backfillArchiveData", "application.clone", + "application.export", "application.fullEventsArchive", "application.fullDataTablesArchive", "application.debug", "application.delete", "application.get", @@ -63706,10 +70915,11 @@ "experienceDomain.patch", "experienceDomains.get", "experienceDomains.post", "experienceEndpoint.delete", "experienceEndpoint.get", + "experienceEndpoint.linkedResources", "experienceEndpoint.patch", "experienceEndpoints.get", "experienceEndpoints.post", "experienceEndpoints.stats", "experienceGroup.delete", @@ -63735,10 +70945,11 @@ "experienceVersions.get", "experienceVersions.post", "experienceView.debug", "experienceView.delete", "experienceView.get", + "experienceView.linkedResources", "experienceView.patch", "experienceViews.debug", "experienceViews.detailedSummary", "experienceViews.get", "experienceViews.post", @@ -63800,10 +71011,11 @@ "dashboard.*", "dashboards.*", "org.*", "applications.get", "applications.post", + "applications.import", "applications.detailedSummary", "auditLog.get", "auditLogs.get", "dashboard.patch", "dashboard.delete", @@ -63942,11 +71154,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "projectId", @@ -63994,21 +71206,21 @@ "maxLength": 1024 }, "privateKey": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "certificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "caCertificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "port", @@ -64194,11 +71406,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "projectId", @@ -64246,21 +71458,21 @@ "maxLength": 1024 }, "privateKey": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "certificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "caCertificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "port", @@ -64384,11 +71596,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "projectId", @@ -64436,21 +71648,21 @@ "maxLength": 1024 }, "privateKey": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "certificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "caCertificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "port", @@ -64615,11 +71827,11 @@ "maxLength": 1024 }, "keyJson": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "projectId", @@ -64667,21 +71879,21 @@ "maxLength": 1024 }, "privateKey": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "certificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 }, "caCertificate": { "type": "string", "maxLength": 32767, - "minLength": 50 + "minLength": 4 } }, "additionalProperties": false, "required": [ "port", @@ -64869,10 +72081,37 @@ } ``` <br/> +## Job Enqueued API Result + +Schema for the result of an job being queued + +### <a name="job-enqueued-api-result-schema"></a> Schema + +```json +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "jobQueued": { + "type": "boolean" + } + } +} +``` +### <a name="job-enqueued-api-result-example"></a> Example + +```json +{ + "jobQueued": true +} +``` + +<br/> + ## Last Value Data Schema for the result of a last value query ### <a name="last-value-data-schema"></a> Schema @@ -65767,39 +73006,69 @@ "enum": [ "deviceData" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } }, "attributes": { "type": "array", "maxItems": 100, "items": { @@ -65830,39 +73099,69 @@ "enum": [ "deviceMetadata" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } } }, "required": [ "inputType", "fileName" @@ -65877,16 +73176,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "queryJson": { "type": "string", "maxLength": 32767 } @@ -65902,17 +73221,61 @@ "type": "object", "properties": { "inputType": { "type": "string", "enum": [ - "externalUrl" + "eventData" ] }, "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, + "queryJson": { "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "maxLength": 32767 + } + }, + "required": [ + "inputType", + "fileName" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "inputType": { + "type": "string", + "enum": [ + "externalUrl" + ] }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, "sourceUrl": { "type": "string", "minLength": 1, "maxLength": 1024 } @@ -65940,16 +73303,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "createMissingColumns": { "type": "boolean" }, "truncateExistingTable": { @@ -65971,12 +73354,22 @@ "enum": [ "file" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -66002,12 +73395,22 @@ "enum": [ "directory" ] }, "directoryName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -66223,10 +73626,14 @@ "required": [ "$date" ] } ] + }, + "templateContext": { + "type": "string", + "maxLength": 32767 } }, "additionalProperties": false } ``` @@ -66318,10 +73725,14 @@ }, "outputsCompletedAt": { "type": "string", "format": "date-time" }, + "templateContext": { + "type": "string", + "maxLength": 32767 + }, "inputInfo": { "type": "object", "patternProperties": { ".*": { "type": "object", @@ -66427,10 +73838,14 @@ "required": [ "$date" ] } ] + }, + "templateContext": { + "type": "string", + "maxLength": 32767 } }, "additionalProperties": false } ``` @@ -66477,39 +73892,69 @@ "enum": [ "deviceData" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } }, "attributes": { "type": "array", "maxItems": 100, "items": { @@ -66540,39 +73985,69 @@ "enum": [ "deviceMetadata" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } } }, "required": [ "inputType", "fileName" @@ -66587,16 +74062,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "queryJson": { "type": "string", "maxLength": 32767 } @@ -66612,17 +74107,61 @@ "type": "object", "properties": { "inputType": { "type": "string", "enum": [ - "externalUrl" + "eventData" ] }, "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, + "queryJson": { "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "maxLength": 32767 + } + }, + "required": [ + "inputType", + "fileName" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "inputType": { + "type": "string", + "enum": [ + "externalUrl" + ] }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, "sourceUrl": { "type": "string", "minLength": 1, "maxLength": 1024 } @@ -66650,16 +74189,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "createMissingColumns": { "type": "boolean" }, "truncateExistingTable": { @@ -66681,12 +74240,22 @@ "enum": [ "file" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -66712,12 +74281,22 @@ "enum": [ "directory" ] }, "directoryName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -66816,39 +74395,69 @@ "enum": [ "deviceData" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } }, "attributes": { "type": "array", "maxItems": 100, "items": { @@ -66879,39 +74488,69 @@ "enum": [ "deviceMetadata" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } } }, "required": [ "inputType", "fileName" @@ -66926,16 +74565,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "queryJson": { "type": "string", "maxLength": 32767 } @@ -66951,17 +74610,61 @@ "type": "object", "properties": { "inputType": { "type": "string", "enum": [ - "externalUrl" + "eventData" ] }, "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, + "queryJson": { "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "maxLength": 32767 + } + }, + "required": [ + "inputType", + "fileName" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "inputType": { + "type": "string", + "enum": [ + "externalUrl" + ] }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, "sourceUrl": { "type": "string", "minLength": 1, "maxLength": 1024 } @@ -66989,16 +74692,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "createMissingColumns": { "type": "boolean" }, "truncateExistingTable": { @@ -67020,12 +74743,22 @@ "enum": [ "file" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -67051,12 +74784,22 @@ "enum": [ "directory" ] }, "directoryName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -67193,39 +74936,69 @@ "enum": [ "deviceData" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } }, "attributes": { "type": "array", "maxItems": 100, "items": { @@ -67256,39 +75029,69 @@ "enum": [ "deviceMetadata" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "deviceTags": { "type": "array", + "maxItems": 100, "items": { "type": "object", "properties": { "key": { - "type": "string", - "pattern": "^[0-9a-zA-Z_-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[0-9a-zA-Z_-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "value": { "type": "string", "minLength": 1, "maxLength": 255 } }, "additionalProperties": false - }, - "maxItems": 100 + } }, "deviceIds": { "type": "array", + "maxItems": 100, "items": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" - }, - "maxItems": 1000 + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + } } }, "required": [ "inputType", "fileName" @@ -67303,16 +75106,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "queryJson": { "type": "string", "maxLength": 32767 } @@ -67328,17 +75151,61 @@ "type": "object", "properties": { "inputType": { "type": "string", "enum": [ - "externalUrl" + "eventData" ] }, "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, + "queryJson": { "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "maxLength": 32767 + } + }, + "required": [ + "inputType", + "fileName" + ], + "additionalProperties": false + }, + { + "type": "object", + "properties": { + "inputType": { + "type": "string", + "enum": [ + "externalUrl" + ] }, + "fileName": { + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] + }, "sourceUrl": { "type": "string", "minLength": 1, "maxLength": 1024 } @@ -67366,16 +75233,36 @@ "enum": [ "dataTable" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "dataTableId": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "createMissingColumns": { "type": "boolean" }, "truncateExistingTable": { @@ -67397,12 +75284,22 @@ "enum": [ "file" ] }, "fileName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -67428,12 +75325,22 @@ "enum": [ "directory" ] }, "directoryName": { - "type": "string", - "pattern": "^[0-9a-zA-Z_.-]{1,255}$" + "oneOf": [ + { + "type": "string", + "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$" + }, + { + "type": "string", + "minLength": 4, + "maxLength": 255, + "pattern": ".*{{.+}}.*" + } + ] }, "destinationDirectoryTemplate": { "type": "string", "minLength": 1, "maxLength": 1024 @@ -70014,10 +77921,11 @@ "webhook.*", "webhooks.*", "application.archiveData", "application.backfillArchiveData", "application.clone", + "application.export", "application.fullEventsArchive", "application.fullDataTablesArchive", "application.debug", "application.delete", "application.get", @@ -70112,10 +78020,11 @@ "experienceDomain.patch", "experienceDomains.get", "experienceDomains.post", "experienceEndpoint.delete", "experienceEndpoint.get", + "experienceEndpoint.linkedResources", "experienceEndpoint.patch", "experienceEndpoints.get", "experienceEndpoints.post", "experienceEndpoints.stats", "experienceGroup.delete", @@ -70141,10 +78050,11 @@ "experienceVersions.get", "experienceVersions.post", "experienceView.debug", "experienceView.delete", "experienceView.get", + "experienceView.linkedResources", "experienceView.patch", "experienceViews.debug", "experienceViews.detailedSummary", "experienceViews.get", "experienceViews.post", @@ -70206,10 +78116,11 @@ "dashboard.*", "dashboards.*", "org.*", "applications.get", "applications.post", + "applications.import", "applications.detailedSummary", "auditLog.get", "auditLogs.get", "dashboard.patch", "dashboard.delete", @@ -70428,10 +78339,11 @@ "webhook.*", "webhooks.*", "application.archiveData", "application.backfillArchiveData", "application.clone", + "application.export", "application.fullEventsArchive", "application.fullDataTablesArchive", "application.debug", "application.delete", "application.get", @@ -70526,10 +78438,11 @@ "experienceDomain.patch", "experienceDomains.get", "experienceDomains.post", "experienceEndpoint.delete", "experienceEndpoint.get", + "experienceEndpoint.linkedResources", "experienceEndpoint.patch", "experienceEndpoints.get", "experienceEndpoints.post", "experienceEndpoints.stats", "experienceGroup.delete", @@ -70555,10 +78468,11 @@ "experienceVersions.get", "experienceVersions.post", "experienceView.debug", "experienceView.delete", "experienceView.get", + "experienceView.linkedResources", "experienceView.patch", "experienceViews.debug", "experienceViews.detailedSummary", "experienceViews.get", "experienceViews.post", @@ -70620,10 +78534,11 @@ "dashboard.*", "dashboards.*", "org.*", "applications.get", "applications.post", + "applications.import", "applications.detailedSummary", "auditLog.get", "auditLogs.get", "dashboard.patch", "dashboard.delete", @@ -70964,15 +78879,15 @@ } ``` <br/> -## Validation Clone Error +## Validation Error Schema for validation errors returned by the API -### <a name="validation-clone-error-schema"></a> Schema +### <a name="validation-error-schema"></a> Schema ```json { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", @@ -70993,27 +78908,34 @@ }, "name": { "type": "string" }, "id": { - "type": "string", - "pattern": "^[A-Fa-f\\d]{24}$" + "oneOf": [ + { + "type": "string", + "pattern": "^[A-Fa-f\\d]{24}$" + }, + { + "type": "string" + } + ] }, "message": { "type": "string" } } } } } } ``` -### <a name="validation-clone-error-example"></a> Example +### <a name="validation-error-example"></a> Example ```json { "type": "Validation", - "message": "Too many validation errors occurred during clone.", + "message": "Too many validation errors occurred.", "validationErrors": [ { "type": "Notebook", "id": "575ec8687ae143cd83dc4a97", "name": "myNote",