# Schemas
* [Advanced Device Query](#advanced-device-query)
* [Advanced Event Query](#advanced-event-query)
* [Advanced Query](#advanced-query)
* [API Token](#api-token)
* [API Token Patch](#api-token-patch)
* [API Tokens](#api-tokens)
* [Application](#application)
* [Application API Token Post](#application-api-token-post)
* [Application Apply Template Patch Schema](#application-apply-template-patch-schema)
* [Application Certificate](#application-certificate)
* [Application Certificate Authorities](#application-certificate-authorities)
* [Application Certificate Authority](#application-certificate-authority)
* [Application Certificate Authority Patch](#application-certificate-authority-patch)
* [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 Post Schema](#application-clone-post-schema)
* [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)
* [Application Patch](#application-patch)
* [Application Post](#application-post)
* [Application Readme](#application-readme)
* [Application Readme Patch](#application-readme-patch)
* [Application Search Result](#application-search-result)
* [Application Template](#application-template)
* [Application Template Categories](#application-template-categories)
* [Application Template Category](#application-template-category)
* [Application Templates](#application-templates)
* [Applications](#applications)
* [Audit Log](#audit-log)
* [Audit Log Filter](#audit-log-filter)
* [Audit Logs](#audit-logs)
* [Authenticated Device](#authenticated-device)
* [Authenticated User](#authenticated-user)
* [Change Password](#change-password)
* [Composite Device State](#composite-device-state)
* [Dashboard](#dashboard)
* [Dashboard Context Instance](#dashboard-context-instance)
* [Dashboard Patch](#dashboard-patch)
* [Dashboard Post](#dashboard-post)
* [Dashboard Send Report](#dashboard-send-report)
* [Dashboard Update Events](#dashboard-update-events)
* [Dashboards](#dashboards)
* [Data Export](#data-export)
* [Data Table](#data-table)
* [Data Table Column](#data-table-column)
* [Data Table Patch](#data-table-patch)
* [Data Table Post](#data-table-post)
* [Data Table Row](#data-table-row)
* [Data Table Row Insert Multiple](#data-table-row-insert-multiple)
* [Data Table Row Insert](#data-table-row-insert)
* [Data Table Row Insert Result](#data-table-row-insert-result)
* [Data Table Row Insert Update](#data-table-row-insert-update)
* [Data Table Rows](#data-table-rows)
* [Data Table Rows Delete](#data-table-rows-delete)
* [Data Table Rows Export](#data-table-rows-export)
* [Data Tables](#data-tables)
* [Device](#device)
* [Device Class Filter](#device-class-filter)
* [Device Command](#device-command)
* [Device Commands](#device-commands)
* [Device Connection Status](#device-connection-status)
* [Device Credentials](#device-credentials)
* [Device Log](#device-log)
* [Device Patch](#device-patch)
* [Device Post](#device-post)
* [Device Recipe](#device-recipe)
* [Device Recipe Bulk Create](#device-recipe-bulk-create)
* [Device Recipe Bulk Create Enqueue](#device-recipe-bulk-create-enqueue)
* [Device Recipe Bulk Create Post](#device-recipe-bulk-create-post)
* [Device Recipe Patch](#device-recipe-patch)
* [Device Recipe Post](#device-recipe-post)
* [Device Recipes](#device-recipes)
* [Device State](#device-state)
* [Device State or States](#device-state-or-states)
* [Device States](#device-states)
* [Device Tag Filter](#device-tag-filter)
* [Devices](#devices)
* [Devices Data Removed](#devices-data-removed)
* [Devices Delete Post](#devices-delete-post)
* [Devices Deleted](#devices-deleted)
* [Devices Metadata Export Post](#devices-metadata-export-post)
* [Devices Patch](#devices-patch)
* [Devices Remove Data Post](#devices-remove-data-post)
* [Devices Updated](#devices-updated)
* [Disable Two Factor Auth](#disable-two-factor-auth)
* [Edge Deployment](#edge-deployment)
* [Edge Deployment Release](#edge-deployment-release)
* [Edge Deployment Remove](#edge-deployment-remove)
* [Edge Deployment Replace](#edge-deployment-replace)
* [Edge Deployments](#edge-deployments)
* [Email Verification Verify](#email-verification-verify)
* [Enable Two Factor Auth](#enable-two-factor-auth)
* [Error](#error)
* [Event](#event)
* [Event Patch](#event-patch)
* [Event Post](#event-post)
* [Event Tags Summary](#event-tags-summary)
* [Events](#events)
* [Events Deleted](#events-deleted)
* [Event Export Options](#event-export-options)
* [Experience Bootstrap Options](#experience-bootstrap-options)
* [Experience Bootstrap Result](#experience-bootstrap-result)
* [Experience Domain](#experience-domain)
* [Experience Domain Patch](#experience-domain-patch)
* [Experience Domain Post](#experience-domain-post)
* [Experience Domains](#experience-domains)
* [Experience Endpoint](#experience-endpoint)
* [Experience Endpoint Patch](#experience-endpoint-patch)
* [Experience Endpoint Post](#experience-endpoint-post)
* [Experience Endpoint Stats](#experience-endpoint-stats)
* [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)
* [Experience User Patch](#experience-user-patch)
* [Experience User Post](#experience-user-post)
* [Experience Users](#experience-users)
* [Experience Version](#experience-version)
* [Experience Version Patch](#experience-version-patch)
* [Experience Version Post](#experience-version-post)
* [Experience Versions](#experience-versions)
* [Experience View](#experience-view)
* [Experience View Patch](#experience-view-patch)
* [Experience View Post](#experience-view-post)
* [Experience Views](#experience-views)
* [File Schema](#file-schema)
* [File Patch](#file-patch)
* [File Post](#file-post)
* [File Upload Post Response](#file-upload-post-response)
* [Files Schema](#files-schema)
* [Workflow](#workflow)
* [Workflow Errors](#workflow-errors)
* [Workflow Log](#workflow-log)
* [Workflow Patch](#workflow-patch)
* [Workflow Post](#workflow-post)
* [Workflow Statistics](#workflow-statistics)
* [Workflow Storage Entries](#workflow-storage-entries)
* [Workflow Storage Entry](#workflow-storage-entry)
* [Workflow Trigger Filter](#workflow-trigger-filter)
* [Workflow Version](#workflow-version)
* [Workflow Version Patch](#workflow-version-patch)
* [Workflow Version Post](#workflow-version-post)
* [Workflow Versions](#workflow-versions)
* [Workflows](#workflows)
* [Workflows Import Post](#workflows-import-post)
* [Workflow Import Result](#workflow-import-result)
* [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)
* [Multi Device Command](#multi-device-command)
* [Notebook](#notebook)
* [Notebook Data Export Options](#notebook-data-export-options)
* [Notebook Execution Logs](#notebook-execution-logs)
* [Notebook Execution Options](#notebook-execution-options)
* [Notebook Patch](#notebook-patch)
* [Notebook Post](#notebook-post)
* [Notebooks](#notebooks)
* [Organization](#organization)
* [Organization Invitation Action](#organization-invitation-action)
* [Organization Invitation Information](#organization-invitation-information)
* [Organization Invitation Post](#organization-invitation-post)
* [Organization Invitation Result](#organization-invitation-result)
* [Organization Invitations](#organization-invitations)
* [Organization Member Patch](#organization-member-patch)
* [Organization Patch](#organization-patch)
* [Organization Post](#organization-post)
* [Organizations](#organizations)
* [Password Reset Finish](#password-reset-finish)
* [Password Reset Input](#password-reset-input)
* [Password Reset Response](#password-reset-response)
* [Payload Counts](#payload-counts)
* [Recent Item](#recent-item)
* [Recent Item List](#recent-item-list)
* [Resource Transfer](#resource-transfer)
* [SAML Response](#saml-response)
* [SSO Request](#sso-request)
* [Success](#success)
* [Template Keywords](#template-keywords)
* [Time Series Data](#time-series-data)
* [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 Error](#validation-error)
* [Virtual Button Press](#virtual-button-press)
* [Webhook](#webhook)
* [Webhook Patch](#webhook-patch)
* [Webhook Post](#webhook-post)
* [Webhooks](#webhooks)
## Advanced Device Query
Schema for advanced device queries
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"name": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceClass": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"gatewayId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"parentId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"ancestorId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"attributeName": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"tags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"$or": [
{
"name": {
"$ne": "myValue"
}
},
{
"parentId": "575ec8687ae143cd83dc4a97"
}
]
}
```
## Advanced Event Query
Schema for advanced event queries
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedEventQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedEventQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedEventQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"sourceId": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"sourceType": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"level": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"state": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"subject": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceId": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"eventTags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"$or": [
{
"level": {
"$ne": "myValue"
}
},
{
"level": 5
}
]
}
```
## Advanced Query
Schema for advanced filters and queries
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
}
},
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"$or": [
{
"level": {
"$ne": "myValue"
}
},
{
"level": 5
}
]
}
```
## API Token
Schema for a single API Token
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"apiTokenId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"application"
]
},
"creatorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creatorType": {
"type": "string",
"enum": [
"apiToken",
"user",
"flow"
]
},
"creatorName": {
"type": "string",
"maxLength": 1024
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"scope": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"token": {
"type": "string",
"minLength": 1
}
}
}
```
### Example
```json
{
"id": "575ec7417ae143cd83dc4a95",
"apiTokenId": "575ec7417ae143cd83dc4a95",
"creatorId": "575ed70c7ae143cd83dc4aa9",
"creatorType": "user",
"ownerId": "575ec8687ae143cd83dc4a97",
"ownerType": "application",
"name": "My API Token",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"expirationDate": "2017-06-13T04:00:00.000Z",
"scope": [
"all.Application"
],
"status": "active",
"token": "the_actual_token_string"
}
```
## API Token Patch
Schema for the body of an API Token modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated API Token",
"status": "inactive"
}
```
## API Tokens
Schema for a collection of API Tokens
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "API Token",
"description": "Schema for a single API Token",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"apiTokenId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"application"
]
},
"creatorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creatorType": {
"type": "string",
"enum": [
"apiToken",
"user",
"flow"
]
},
"creatorName": {
"type": "string",
"maxLength": 1024
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"scope": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"token": {
"type": "string",
"minLength": 1
}
}
}
},
"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",
""
]
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"application"
]
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ec7417ae143cd83dc4a95",
"apiTokenId": "575ec7417ae143cd83dc4a95",
"creatorId": "575ed70c7ae143cd83dc4aa9",
"creatorType": "user",
"ownerId": "575ec8687ae143cd83dc4a97",
"ownerType": "application",
"name": "My API Token",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"expirationDate": "2017-06-13T04:00:00.000Z",
"scope": [
"all.Application"
],
"status": "active",
"token": "the_actual_token_string"
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"ownerId": "575ec8687ae143cd83dc4a97",
"ownerType": "application"
}
```
## Application
Schema for a single Application
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"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"
},
"appliedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"organizationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"organizationIconColor": {
"type": "string",
"maxLength": 64
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 1024
},
"endpointSlug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"expUserTokenCutoff": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"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
},
"cloudOnly": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"key",
"json"
]
}
},
"blobUrlTTL": {
"type": "number",
"minimum": 3600,
"maximum": 604800
},
"summary": {
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"eventCount": {
"type": "number"
},
"experienceDomainCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceSlugCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"keyCount": {
"type": "number"
},
"storageStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"size": {
"type": "number"
}
}
},
"webhookCount": {
"type": "number"
}
}
},
"ftueTracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"version": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"skipped",
"completed"
]
}
},
"required": [
"name",
"version",
"status"
],
"additionalProperties": false
},
"maxItems": 100
},
"archiveConfig": {
"type": "object",
"properties": {
"directory": {
"type": "string",
"max": 255
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeDevices": {
"type": "boolean",
"default": true
},
"includeEvents": {
"type": "boolean",
"default": false
},
"includeDataTables": {
"type": "boolean",
"default": false
},
"dataTablesMode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"dataTableIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"s3": {
"type": "object",
"properties": {
"bucket": {
"type": "string",
"max": 255
},
"accessKeyId": {
"type": "string",
"min": 4,
"max": 128
},
"secretAccessKey": {
"type": "string",
"min": 4,
"max": 128
},
"region": {
"type": "string",
"max": 128
}
},
"required": [
"bucket",
"accessKeyId",
"secretAccessKey",
"region"
],
"additionalProperties": false
},
"gcs": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"bucket": {
"type": "string",
"max": 255
}
},
"required": [
"projectId",
"keyJson",
"bucket"
],
"additionalProperties": false
},
"azure": {
"type": "object",
"properties": {
"account": {
"type": "string",
"min": 3,
"max": 24
},
"accountKey": {
"type": "string",
"max": 255
},
"bucket": {
"type": "string",
"min": 3,
"max": 63
}
},
"required": [
"account",
"accountKey",
"bucket"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
```
### Example
```json
{
"id": "575ec8687ae143cd83dc4a97",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"ownerId": "575ed70c7ae143cd83dc4aa9",
"ownerType": "user",
"name": "My Application",
"description": "The is the best application description",
"summary": {
"deviceCount": 5,
"flowCount": 2,
"webhookCount": 0,
"eventCount": 0,
"keyCount": 1,
"deviceRecipeCount": 0
},
"archiveConfig": {
"s3": {
"bucket": "bucketName",
"accessKeyId": "awsAccessKey",
"accessSecretKey": "awsSecretKey",
"region": "us-west-1"
},
"mode": "all",
"deviceIds": [
"575ec8687ae143cd83dc4a95",
"575ec8687ae143cd83dc4a91"
]
}
}
```
## Application API Token Post
Schema for the body of an Application API Token creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"scope": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"all.Application",
"all.Application.read",
"all.Device",
"all.Device.read",
"application.*",
"applicationApiToken.*",
"applicationApiTokens.*",
"applicationCertificate.*",
"applicationCertificates.*",
"applicationCertificateAuthority.*",
"applicationCertificateAuthorities.*",
"applicationKey.*",
"applicationKeys.*",
"data.*",
"dataTable.*",
"dataTables.*",
"dataTableRow.*",
"dataTableRows.*",
"device.*",
"deviceRecipe.*",
"deviceRecipes.*",
"devices.*",
"edgeDeployments.*",
"event.*",
"events.*",
"experience.*",
"experienceDomain.*",
"experienceDomains.*",
"experienceEndpoint.*",
"experienceEndpoints.*",
"experienceGroup.*",
"experienceGroups.*",
"experienceSlug.*",
"experienceSlugs.*",
"experienceUser.*",
"experienceUsers.*",
"experienceVersion.*",
"experienceVersions.*",
"experienceView.*",
"experienceViews.*",
"integration.*",
"integrations.*",
"file.*",
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
"notebook.*",
"notebooks.*",
"webhook.*",
"webhooks.*",
"application.applyTemplate",
"application.archiveData",
"application.backfillArchiveData",
"application.clone",
"application.export",
"application.import",
"application.fullEventsArchive",
"application.fullDataTablesArchive",
"application.debug",
"application.delete",
"application.get",
"application.mqttPublishMessage",
"application.mqttSubscriptionStream",
"application.patch",
"application.payloadCounts",
"application.search",
"applicationApiToken.delete",
"applicationApiToken.get",
"applicationApiToken.patch",
"applicationApiTokens.get",
"applicationApiTokens.post",
"applicationCertificate.delete",
"applicationCertificate.get",
"applicationCertificate.patch",
"applicationCertificates.get",
"applicationCertificates.post",
"applicationCertificateAuthority.delete",
"applicationCertificateAuthority.get",
"applicationCertificateAuthority.patch",
"applicationCertificateAuthorities.get",
"applicationCertificateAuthorities.post",
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
"data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
"dataTable.patch",
"dataTable.removeColumn",
"dataTableRow.delete",
"dataTableRow.get",
"dataTableRow.patch",
"dataTableRows.get",
"dataTableRows.post",
"dataTableRows.query",
"dataTableRows.export",
"dataTableRows.delete",
"dataTableRows.truncate",
"dataTables.get",
"dataTables.post",
"device.commandStream",
"device.debug",
"device.delete",
"device.export",
"device.get",
"device.getCommand",
"device.getCompositeState",
"device.getLogEntries",
"device.getState",
"device.patch",
"device.removeData",
"device.sendCommand",
"device.sendState",
"device.setConnectionStatus",
"device.stateStream",
"deviceRecipe.bulkCreate",
"deviceRecipe.delete",
"deviceRecipe.get",
"deviceRecipe.patch",
"deviceRecipes.get",
"deviceRecipes.post",
"devices.patch",
"devices.delete",
"devices.removeData",
"devices.detailedSummary",
"devices.export",
"devices.get",
"devices.post",
"devices.sendCommand",
"edgeDeployments.get",
"edgeDeployments.release",
"edgeDeployments.remove",
"edgeDeployments.replace",
"event.delete",
"event.get",
"event.patch",
"events.delete",
"events.get",
"events.mostRecentBySeverity",
"events.patch",
"events.post",
"events.export",
"experience.delete",
"experience.bootstrap",
"experienceDomain.delete",
"experienceDomain.get",
"experienceDomain.patch",
"experienceDomains.get",
"experienceDomains.post",
"experienceEndpoint.delete",
"experienceEndpoint.get",
"experienceEndpoint.linkedResources",
"experienceEndpoint.patch",
"experienceEndpoints.get",
"experienceEndpoints.post",
"experienceEndpoints.stats",
"experienceGroup.delete",
"experienceGroup.get",
"experienceGroup.patch",
"experienceGroups.detailedSummary",
"experienceGroups.get",
"experienceGroups.post",
"experienceSlug.delete",
"experienceSlug.get",
"experienceSlug.patch",
"experienceSlugs.get",
"experienceSlugs.post",
"experienceUser.delete",
"experienceUser.get",
"experienceUser.patch",
"experienceUsers.detailedSummary",
"experienceUsers.get",
"experienceUsers.post",
"experienceVersion.delete",
"experienceVersion.get",
"experienceVersion.patch",
"experienceVersions.get",
"experienceVersions.post",
"experienceView.debug",
"experienceView.delete",
"experienceView.get",
"experienceView.linkedResources",
"experienceView.patch",
"experienceViews.debug",
"experienceViews.detailedSummary",
"experienceViews.get",
"experienceViews.post",
"file.get",
"file.patch",
"file.move",
"file.delete",
"file.upload",
"files.get",
"files.post",
"flow.clearStorageEntries",
"flow.debug",
"flow.delete",
"flow.errors",
"flow.get",
"flow.getStorageEntries",
"flow.log",
"flow.patch",
"flow.pressVirtualButton",
"flow.setStorageEntry",
"flow.stats",
"flows.get",
"flows.getByVersion",
"flows.import",
"flows.post",
"flowVersion.delete",
"flowVersion.errors",
"flowVersion.get",
"flowVersion.log",
"flowVersion.patch",
"flowVersion.stats",
"flowVersions.get",
"flowVersions.post",
"integration.delete",
"integration.get",
"integration.patch",
"integrations.get",
"integrations.post",
"notebook.delete",
"notebook.execute",
"notebook.get",
"notebook.logs",
"notebook.patch",
"notebook.requestInputDataExport",
"notebook.upload",
"notebooks.get",
"notebooks.post",
"webhook.delete",
"webhook.get",
"webhook.patch",
"webhooks.get",
"webhooks.post"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New API Token",
"expirationDate": "2017-06-13T04:00:00.000Z",
"scope": [
"all.Application"
],
"status": "active"
}
```
## Application Apply Template Patch Schema
Schema for the body of an application template import request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"templateId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"required": [
"templateId"
],
"additionalProperties": false
}
```
### Example
```json
{
"templateId": "575ec8687ae143cd83dc4a97",
"email": "email.example.com"
}
```
## Application Certificate
Schema for a single Application Certificate
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationCertificateId": {
"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"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"certificateInfo": {
"type": "object",
"properties": {
"serialNumber": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"fingerprint": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"commonName": {
"type": "string",
"maxLength": 1024
},
"issuerName": {
"type": "string",
"maxLength": 1024
},
"notValidBefore": {
"type": "string",
"format": "date-time"
},
"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
}
}
}
}
```
### Example
```json
{
"id": "5cd02a50df66feb0994c7196",
"applicationCertificateId": "5cd02a50df66feb0994c7196",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"status": "active",
"description": "An example certificate description",
"certificateInfo": {
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
"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": []
}
```
## Application Certificate Authorities
Schema for a collection of Application Certificate Authorities
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Application Certificate Authority",
"description": "Schema for a single Application Certificate Authority",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationCertificateAuthorityId": {
"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"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"caBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"caInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serialNumber": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"fingerprint": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"commonName": {
"type": "string",
"maxLength": 1024
},
"issuerName": {
"type": "string",
"maxLength": 1024
},
"notValidBefore": {
"type": "string",
"format": "date-time"
},
"notValidAfter": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
},
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "5cd02a7bdf66feb0994c7197",
"applicationCertificateAuthorityId": "5cd02a7bdf66feb0994c7197",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"status": "active",
"name": "my certificate authority",
"description": "An example certificate authority description",
"caBundle": "MY_SSL_CERTIFICATE",
"caInfo": [
{
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
"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"
}
]
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "key",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Application Certificate Authority
Schema for a single Application Certificate Authority
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationCertificateAuthorityId": {
"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"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"caBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"caInfo": {
"type": "array",
"items": {
"type": "object",
"properties": {
"serialNumber": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"fingerprint": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"commonName": {
"type": "string",
"maxLength": 1024
},
"issuerName": {
"type": "string",
"maxLength": 1024
},
"notValidBefore": {
"type": "string",
"format": "date-time"
},
"notValidAfter": {
"type": "string",
"format": "date-time"
}
}
}
}
}
}
```
### Example
```json
{
"id": "5cd02a7bdf66feb0994c7197",
"applicationCertificateAuthorityId": "5cd02a7bdf66feb0994c7197",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"status": "active",
"name": "my certificate authority",
"description": "An example certificate authority description",
"caBundle": "MY_SSL_CERTIFICATE",
"caInfo": [
{
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
"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"
}
]
}
```
## Application Certificate Authority Patch
Schema for the body of an Application Certificate Authority modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"description": {
"type": "string",
"maxLength": 32767
},
"caBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
}
},
"additionalProperties": false
}
```
### Example
```json
{
"status": "active",
"description": "An example updated authority description"
}
```
## Application Certificate Authority Post
Schema for the body of an Application Certificate Authority creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"description": {
"type": "string",
"maxLength": 32767
},
"caBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
}
},
"required": [
"name",
"caBundle"
],
"additionalProperties": false
}
```
### Example
```json
{
"name": "my certificate authority",
"description": "An example new authority description",
"caBundle": "MY_SSL_CERTIFICATE"
}
```
## Application Certificate Patch
Schema for the body of an Application Certificate modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"description": {
"type": "string",
"maxLength": 32767
},
"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
}
```
### Example
```json
{
"status": "active",
"description": "An example updated certificate description"
}
```
## Application Certificate Post
Schema for the body of an Application Certificate creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"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"
],
"additionalProperties": false
}
```
### Example
```json
{
"description": "An example new certificate description",
"certificate": "MY_SSL_CERTIFICATE",
"filterType": "all",
"pubTopics": [],
"subTopics": []
}
```
## Application Certificates
Schema for a collection of Application Certificates
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Application Certificate",
"description": "Schema for a single Application Certificate",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationCertificateId": {
"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"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"certificateInfo": {
"type": "object",
"properties": {
"serialNumber": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"fingerprint": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"commonName": {
"type": "string",
"maxLength": 1024
},
"issuerName": {
"type": "string",
"maxLength": 1024
},
"notValidBefore": {
"type": "string",
"format": "date-time"
},
"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": {
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "5cd02a50df66feb0994c7196",
"applicationCertificateId": "5cd02a50df66feb0994c7196",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"status": "active",
"description": "An example certificate description",
"certificateInfo": {
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
"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,
"page": 0,
"sortField": "key",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Success Dry Run
Schema for reporting a successful dry run of clone application
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"requiresJob": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"success": true,
"jobRequired": false
}
```
## Application Clone Post Schema
Schema for the body of an application clone request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"dryRun": {
"type": "boolean",
"default": false
},
"includeFiles": {
"type": "boolean",
"default": false
},
"includeDataTableRows": {
"type": "boolean",
"default": false
},
"includeDevices": {
"type": "boolean",
"default": false
},
"ownerId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"ownerType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"additionalProperties": false
}
```
### Example
```json
{
"options": {
"includeFiles": true,
"includeDevices": true,
"ownerType": "organization",
"ownerId": "575ec8687ae143cd83dc4a98"
}
}
```
## Application Creation By Template Result
Schema for creating an application by template result
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"application": {
"title": "Application",
"description": "Schema for a single Application",
"type": "object",
"properties": {
"id": {
"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"
},
"appliedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"organizationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"organizationIconColor": {
"type": "string",
"maxLength": 64
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 1024
},
"endpointSlug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"expUserTokenCutoff": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"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
},
"cloudOnly": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"key",
"json"
]
}
},
"blobUrlTTL": {
"type": "number",
"minimum": 3600,
"maximum": 604800
},
"summary": {
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"eventCount": {
"type": "number"
},
"experienceDomainCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceSlugCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"keyCount": {
"type": "number"
},
"storageStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"size": {
"type": "number"
}
}
},
"webhookCount": {
"type": "number"
}
}
},
"ftueTracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"version": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"skipped",
"completed"
]
}
},
"required": [
"name",
"version",
"status"
],
"additionalProperties": false
},
"maxItems": 100
},
"archiveConfig": {
"type": "object",
"properties": {
"directory": {
"type": "string",
"max": 255
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeDevices": {
"type": "boolean",
"default": true
},
"includeEvents": {
"type": "boolean",
"default": false
},
"includeDataTables": {
"type": "boolean",
"default": false
},
"dataTablesMode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"dataTableIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"s3": {
"type": "object",
"properties": {
"bucket": {
"type": "string",
"max": 255
},
"accessKeyId": {
"type": "string",
"min": 4,
"max": 128
},
"secretAccessKey": {
"type": "string",
"min": 4,
"max": 128
},
"region": {
"type": "string",
"max": 128
}
},
"required": [
"bucket",
"accessKeyId",
"secretAccessKey",
"region"
],
"additionalProperties": false
},
"gcs": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"bucket": {
"type": "string",
"max": 255
}
},
"required": [
"projectId",
"keyJson",
"bucket"
],
"additionalProperties": false
},
"azure": {
"type": "object",
"properties": {
"account": {
"type": "string",
"min": 3,
"max": 24
},
"accountKey": {
"type": "string",
"max": 255
},
"bucket": {
"type": "string",
"min": 3,
"max": 63
}
},
"required": [
"account",
"accountKey",
"bucket"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"validationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string"
}
]
},
"message": {
"type": "string"
}
}
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"application": {
"id": "575ec8687ae143cd83dc4a98",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"ownerId": "575ed70c7ae143cd83dc4aa9",
"ownerType": "user",
"name": "My Application Cloned",
"description": "The is the best application description",
"summary": {
"deviceCount": 5,
"flowCount": 2,
"webhookCount": 0,
"eventCount": 0,
"keyCount": 1,
"deviceRecipeCount": 0
},
"archiveConfig": {
"s3": {
"bucket": "bucketName",
"accessKeyId": "awsAccessKey",
"accessSecretKey": "awsSecretKey",
"region": "us-west-1"
},
"mode": "all",
"deviceIds": [
"575ec8687ae143cd83dc4a95",
"575ec8687ae143cd83dc4a91"
]
}
}
}
```
## Application Export Post Schema
Schema for the body of an application export request
### 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
}
```
### Example
```json
{
"includeFiles": true,
"includeDevices": true,
"email": "test@losant.com"
}
```
## Application Export Result
Schema for an application export result
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"url": {
"type": "string"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"url": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon/applicationExport.zip"
}
```
## Application Key
Schema for a single Application Key
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationKeyId": {
"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"
},
"key": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"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
}
}
}
}
```
### Example
```json
{
"id": "575ec76c7ae143cd83dc4a96",
"applicationKeyId": "575ec76c7ae143cd83dc4a96",
"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",
"filterType": "all",
"pubTopics": [],
"subTopics": []
}
```
## Application Key Patch
Schema for the body of an Application Key modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"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
}
```
### Example
```json
{
"status": "active",
"description": "An example updated key description"
}
```
## Application Key Post
Schema for the body of an Application Key creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"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
}
```
### Example
```json
{
"description": "An example new key description",
"filterType": "all",
"pubTopics": [],
"subTopics": []
}
```
## Application Key Post Response
Schema for a response of Application Key creation
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationKeyId": {
"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"
},
"key": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"secret": {
"type": "string"
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"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
}
}
}
}
```
### Example
```json
{
"id": "575ec76c7ae143cd83dc4a96",
"applicationKeyId": "575ec76c7ae143cd83dc4a96",
"applicationId": "575ec8687ae143cd83dc4a97",
"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",
"filterType": "all",
"pubTopics": [],
"subTopics": []
}
```
## Application Keys
Schema for a collection of Application Keys
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Application Key",
"description": "Schema for a single Application Key",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationKeyId": {
"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"
},
"key": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"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": {
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ec76c7ae143cd83dc4a96",
"applicationKeyId": "575ec76c7ae143cd83dc4a96",
"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",
"filterType": "all",
"pubTopics": [],
"subTopics": []
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "key",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Application Patch
Schema for the body of an Application modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 1024
},
"endpointSlug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"expUserTokenCutoff": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"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
},
"cloudOnly": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"key",
"json"
]
}
},
"ftueTracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"version": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"skipped",
"completed"
]
}
},
"required": [
"name",
"version",
"status"
],
"additionalProperties": false
},
"maxItems": 100
},
"archiveConfig": {
"type": "object",
"properties": {
"directory": {
"type": "string",
"max": 255
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeDevices": {
"type": "boolean",
"default": true
},
"includeEvents": {
"type": "boolean",
"default": false
},
"includeDataTables": {
"type": "boolean",
"default": false
},
"dataTablesMode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"dataTableIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"s3": {
"type": "object",
"properties": {
"bucket": {
"type": "string",
"max": 255
},
"accessKeyId": {
"type": "string",
"min": 4,
"max": 128
},
"secretAccessKey": {
"type": "string",
"min": 4,
"max": 128
},
"region": {
"type": "string",
"max": 128
}
},
"required": [
"bucket",
"accessKeyId",
"secretAccessKey",
"region"
],
"additionalProperties": false
},
"gcs": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"bucket": {
"type": "string",
"max": 255
}
},
"required": [
"projectId",
"keyJson",
"bucket"
],
"additionalProperties": false
},
"azure": {
"type": "object",
"properties": {
"account": {
"type": "string",
"min": 3,
"max": 24
},
"accountKey": {
"type": "string",
"max": 255
},
"bucket": {
"type": "string",
"min": 3,
"max": 63
}
},
"required": [
"account",
"accountKey",
"bucket"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"blobUrlTTL": {
"type": "number",
"minimum": 3600,
"maximum": 604800
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Application",
"description": "Description of my updated application"
}
```
## Application Post
Schema for the body of an Application creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationTemplateId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 1024
},
"appliedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"endpointSlug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"expUserTokenCutoff": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"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
},
"cloudOnly": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"key",
"json"
]
}
},
"archiveConfig": {
"type": "object",
"properties": {
"directory": {
"type": "string",
"max": 255
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeDevices": {
"type": "boolean",
"default": true
},
"includeEvents": {
"type": "boolean",
"default": false
},
"includeDataTables": {
"type": "boolean",
"default": false
},
"dataTablesMode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"dataTableIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"s3": {
"type": "object",
"properties": {
"bucket": {
"type": "string",
"max": 255
},
"accessKeyId": {
"type": "string",
"min": 4,
"max": 128
},
"secretAccessKey": {
"type": "string",
"min": 4,
"max": 128
},
"region": {
"type": "string",
"max": 128
}
},
"required": [
"bucket",
"accessKeyId",
"secretAccessKey",
"region"
],
"additionalProperties": false
},
"gcs": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"bucket": {
"type": "string",
"max": 255
}
},
"required": [
"projectId",
"keyJson",
"bucket"
],
"additionalProperties": false
},
"azure": {
"type": "object",
"properties": {
"account": {
"type": "string",
"min": 3,
"max": 24
},
"accountKey": {
"type": "string",
"max": 255
},
"bucket": {
"type": "string",
"min": 3,
"max": 63
}
},
"required": [
"account",
"accountKey",
"bucket"
],
"additionalProperties": false
}
},
"additionalProperties": false
},
"blobUrlTTL": {
"type": "number",
"minimum": 3600,
"maximum": 604800
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New Application",
"description": "Description of my new application"
}
```
## Application Readme
Schema for an Application Readme
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"lastUpdatedById": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"lastUpdatedByType": {
"type": "string",
"enum": [
"flow",
"user",
"apiToken"
]
},
"content": {
"type": "string"
}
}
}
```
### Example
```json
{
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"lastUpdatedById": "575ed70c7ae143cd83dc4aa9",
"lastUpdatedByType": "user",
"content": "The readme content"
}
```
## Application Readme Patch
Schema for the body of an Application Readme modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"content": {
"type": "string",
"maxLength": 131072
}
},
"additionalProperties": false
}
```
### Example
```json
{
"content": "The new readme content"
}
```
## Application Search Result
Results of a search of an application's resources
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string"
},
"metadata": {
"type": "object"
},
"viewType": {
"type": "string"
},
"version": {
"type": "string"
},
"_type": {
"type": "string",
"enum": [
"applicationApiToken",
"dashboard",
"dataTable",
"deviceRecipe",
"device",
"experienceDomain",
"event",
"experienceEndpoint",
"experienceGroup",
"experienceSlug",
"experienceUser",
"experienceVersion",
"experienceView",
"file",
"flow",
"integration",
"webhook"
]
}
},
"required": [
"id",
"name",
"_type"
]
}
}
```
### Example
```json
[
{
"type": "device",
"name": "My Device #1",
"metadata": {
"descriptor": "a basic description of device #1"
},
"id": "575ec8687ae143cd83dc4a97"
}
]
```
## Application Template
Schema for a single Application Template
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"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
},
"readme": {
"type": "string",
"maxLength": 131072
},
"categoryIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
},
"description": {
"type": "string",
"maxLength": 1024
},
"public": {
"type": "boolean"
},
"authorName": {
"type": "string",
"maxLength": 255
},
"imageUrl": {
"type": "string",
"maxLength": 1024
},
"authorUrl": {
"type": "string",
"maxLength": 1024
},
"templateUrl": {
"type": "string",
"maxLength": 1024
},
"summary": {
"type": "object",
"properties": {
"applicationCertificateAuthorityCount": {
"type": "number"
},
"dashboardCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"notebookCount": {
"type": "number"
},
"dataTableCsvSize": {
"type": "number"
},
"webhookCount": {
"type": "number"
}
}
}
}
}
```
### Example
```json
{
"id": "586e9d5151265cb9d72f6ec6",
"creationDate": "2020-01-13T04:00:00.000Z",
"lastUpdated": "2020-01-13T04:00:00.000Z",
"name": "smart environment",
"description": "a smart env set up",
"public": true,
"authorName": "Losant",
"authorUrl": "https://www.losant.com",
"templateUrl": "https://app.losant.com",
"summary": {
"applicationCertificateAuthorityCount": 0,
"dashboardCount": 0,
"deviceCount": 1,
"deviceRecipeCount": 0,
"dataTableCount": 2,
"fileCount": 0,
"experienceGroupCount": 1,
"experienceUserCount": 1,
"experienceVersionCount": 3,
"experienceViewCount": 6,
"experienceEndpointCount": 6,
"flowCount": 1,
"integrationCount": 0,
"notebookCount": 0,
"dataTableCsvSize": 4008,
"webhookCount": 0
}
}
```
## Application Template Categories
Schema for a collection of Application Template Categories
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Application Template Category",
"description": "Schema for a single Application Template Category",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
}
}
}
},
"baseId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "586e9d5151265cb9d72f6ec6",
"name": "Workflows",
"description": "Pre-built workflows for quick solution development"
},
{
"id": "586e9d5151265cb9d72f6ec7",
"name": "Device Recipes",
"description": "Pre-configured device recipes"
}
],
"baseId": "586e9d5151265cb9d72f6ec6",
"count": 2,
"totalCount": 2
}
```
## Application Template Category
Schema for a single Application Template Category
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
}
}
}
```
### Example
```json
{
"id": "586e9d5151265cb9d72f6ec6",
"name": "Workflows",
"description": "Pre-built workflows for quick solution development"
}
```
## Application Templates
Schema for a collection of Application Templates
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Application Template",
"description": "Schema for a single Application Template",
"type": "object",
"properties": {
"id": {
"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
},
"readme": {
"type": "string",
"maxLength": 131072
},
"categoryIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
},
"description": {
"type": "string",
"maxLength": 1024
},
"public": {
"type": "boolean"
},
"authorName": {
"type": "string",
"maxLength": 255
},
"imageUrl": {
"type": "string",
"maxLength": 1024
},
"authorUrl": {
"type": "string",
"maxLength": 1024
},
"templateUrl": {
"type": "string",
"maxLength": 1024
},
"summary": {
"type": "object",
"properties": {
"applicationCertificateAuthorityCount": {
"type": "number"
},
"dashboardCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"notebookCount": {
"type": "number"
},
"dataTableCsvSize": {
"type": "number"
},
"webhookCount": {
"type": "number"
}
}
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"perPage": {
"type": "integer"
},
"page": {
"type": "integer"
},
"filter": {
"type": "string"
},
"filterField": {
"type": "string"
},
"categoryId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"keywords": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
},
"sortField": {
"type": "string"
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
}
}
}
```
### Example
```json
{
"items": [
{
"id": "586e9d5151265cb9d72f6ec6",
"creationDate": "2020-01-13T04:00:00.000Z",
"lastUpdated": "2020-01-13T04:00:00.000Z",
"name": "smart environment",
"description": "a smart env set up",
"public": true,
"authorName": "Losant",
"authorUrl": "https://www.losant.com",
"templateUrl": "https://app.losant.com",
"summary": {
"applicationCertificateAuthorityCount": 0,
"dashboardCount": 0,
"deviceCount": 1,
"deviceRecipeCount": 0,
"dataTableCount": 2,
"fileCount": 0,
"experienceGroupCount": 1,
"experienceUserCount": 1,
"experienceVersionCount": 3,
"experienceViewCount": 6,
"experienceEndpointCount": 6,
"flowCount": 1,
"integrationCount": 0,
"notebookCount": 0,
"dataTableCsvSize": 4008,
"webhookCount": 0
}
}
],
"count": 1,
"totalCount": 8,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc"
}
```
## Applications
Schema for a collection of Applications
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Application",
"description": "Schema for a single Application",
"type": "object",
"properties": {
"id": {
"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"
},
"appliedTemplateIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"organizationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"organizationIconColor": {
"type": "string",
"maxLength": 64
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 1024
},
"endpointSlug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"expUserTokenCutoff": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"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
},
"cloudOnly": {
"type": "boolean",
"default": false
},
"description": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"key",
"json"
]
}
},
"blobUrlTTL": {
"type": "number",
"minimum": 3600,
"maximum": 604800
},
"summary": {
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"eventCount": {
"type": "number"
},
"experienceDomainCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceSlugCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"keyCount": {
"type": "number"
},
"storageStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"size": {
"type": "number"
}
}
},
"webhookCount": {
"type": "number"
}
}
},
"ftueTracking": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"version": {
"type": "number"
},
"status": {
"type": "string",
"enum": [
"skipped",
"completed"
]
}
},
"required": [
"name",
"version",
"status"
],
"additionalProperties": false
},
"maxItems": 100
},
"archiveConfig": {
"type": "object",
"properties": {
"directory": {
"type": "string",
"max": 255
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeDevices": {
"type": "boolean",
"default": true
},
"includeEvents": {
"type": "boolean",
"default": false
},
"includeDataTables": {
"type": "boolean",
"default": false
},
"dataTablesMode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"dataTableIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"s3": {
"type": "object",
"properties": {
"bucket": {
"type": "string",
"max": 255
},
"accessKeyId": {
"type": "string",
"min": 4,
"max": 128
},
"secretAccessKey": {
"type": "string",
"min": 4,
"max": 128
},
"region": {
"type": "string",
"max": 128
}
},
"required": [
"bucket",
"accessKeyId",
"secretAccessKey",
"region"
],
"additionalProperties": false
},
"gcs": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"bucket": {
"type": "string",
"max": 255
}
},
"required": [
"projectId",
"keyJson",
"bucket"
],
"additionalProperties": false
},
"azure": {
"type": "object",
"properties": {
"account": {
"type": "string",
"min": 3,
"max": 24
},
"accountKey": {
"type": "string",
"max": 255
},
"bucket": {
"type": "string",
"min": 3,
"max": 63
}
},
"required": [
"account",
"accountKey",
"bucket"
],
"additionalProperties": false
}
},
"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",
""
]
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ec8687ae143cd83dc4a97",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"ownerId": "575ed70c7ae143cd83dc4aa9",
"ownerType": "user",
"name": "My Application",
"description": "The is the best application description",
"summary": {
"deviceCount": 5,
"flowCount": 2,
"webhookCount": 0,
"eventCount": 0,
"keyCount": 1,
"deviceRecipeCount": 0
},
"archiveConfig": {
"s3": {
"bucket": "bucketName",
"accessKeyId": "awsAccessKey",
"accessSecretKey": "awsSecretKey",
"region": "us-west-1"
},
"mode": "all",
"deviceIds": [
"575ec8687ae143cd83dc4a95",
"575ec8687ae143cd83dc4a91"
]
}
}
],
"count": 1,
"totalCount": 8,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc"
}
```
## Audit Log
Schema for a single Audit Log entry
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"auditLogId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"primaryTargetId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"primaryTargetType": {
"type": "string",
"enum": [
"Application",
"Dashboard",
"OrgInvite"
]
},
"primaryTargetName": {
"type": "string",
"maxLength": 1024
},
"secondaryTargetId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"secondaryTargetType": {
"type": "string",
"enum": [
"ApiToken",
"ApplicationKey",
"DataTable",
"Device",
"DeviceRecipe",
"Event",
"ExperienceDomain",
"ExperienceEndpoint",
"ExperienceGroup",
"ExperienceSlug",
"ExperienceUser",
"ExperienceVersion",
"ExperienceView",
"File",
"Flow",
"Integration",
"Webhook"
]
},
"secondaryTargetName": {
"type": "string",
"maxLength": 1024
},
"actorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"actorType": {
"type": "string",
"enum": [
"Application",
"Device",
"Flow",
"User",
"ApiToken"
]
},
"actorName": {
"type": "string",
"maxLength": 1024
},
"requestResource": {
"type": "string",
"maxLength": 1024
},
"requestAction": {
"type": "string",
"maxLength": 1024
},
"requestQueryParams": {
"type": "object"
},
"requestBody": {
"type": "object"
},
"requestPathParams": {
"type": "object"
},
"responseBody": {
"type": "object"
},
"responseStatus": {
"type": "integer",
"minimum": 100,
"maximum": 599
}
}
}
```
### Example
```json
{
"id": "586e9d5151265cb9d72f6ec6",
"auditLogId": "586e9d5151265cb9d72f6ec6",
"creationDate": "2016-06-13T04:00:00.000Z",
"orgId": "575ed6e87ae143cd83dc4aa8",
"primaryTargetId": "575ec8687ae143cd83dc4a97",
"primaryTargetType": "Application",
"primaryTargetName": "My Application",
"actorId": "575ed70c7ae143cd83dc4aa9",
"actorType": "User",
"actorName": "example@losant.com",
"requestResource": "application",
"requestAction": "delete",
"requestQueryParams": {},
"requestBody": {},
"requestPathParams": {
"applicationId": "575ec8687ae143cd83dc4a97"
},
"responseBody": {
"success": true
},
"responseStatus": 200
}
```
## Audit Log Filter
Schema for the filter of an audit log query
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"primaryTarget": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"type": {
"type": "string",
"enum": [
"Application",
"Dashboard",
"OrgInvite"
]
},
"name": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"secondaryTarget": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"type": {
"type": "string",
"enum": [
"ApiToken",
"ApplicationKey",
"DataTable",
"Device",
"DeviceRecipe",
"Event",
"ExperienceDomain",
"ExperienceEndpoint",
"ExperienceGroup",
"ExperienceSlug",
"ExperienceUser",
"ExperienceVersion",
"ExperienceView",
"File",
"Flow",
"Integration",
"Webhook"
]
},
"name": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"actor": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"type": {
"type": "string",
"enum": [
"Application",
"Device",
"Flow",
"User",
"ApiToken"
]
},
"name": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"request": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resource": {
"type": "string",
"maxLength": 1024
},
"action": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"responseCode": {
"type": "array",
"items": {
"type": "integer",
"minimum": 100,
"maximum": 599
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"primaryTarget": [
{
"type": "Dashboard"
},
{
"type": "Application",
"id": "575ec8687ae143cd83dc4a97"
}
],
"actor": [
{
"type": "User",
"id": "575ed70c7ae143cd83dc4aa9"
}
]
}
```
## Audit Logs
Schema for a collection of Audit Logs
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Audit Log",
"description": "Schema for a single Audit Log entry",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"auditLogId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"primaryTargetId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"primaryTargetType": {
"type": "string",
"enum": [
"Application",
"Dashboard",
"OrgInvite"
]
},
"primaryTargetName": {
"type": "string",
"maxLength": 1024
},
"secondaryTargetId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"secondaryTargetType": {
"type": "string",
"enum": [
"ApiToken",
"ApplicationKey",
"DataTable",
"Device",
"DeviceRecipe",
"Event",
"ExperienceDomain",
"ExperienceEndpoint",
"ExperienceGroup",
"ExperienceSlug",
"ExperienceUser",
"ExperienceVersion",
"ExperienceView",
"File",
"Flow",
"Integration",
"Webhook"
]
},
"secondaryTargetName": {
"type": "string",
"maxLength": 1024
},
"actorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"actorType": {
"type": "string",
"enum": [
"Application",
"Device",
"Flow",
"User",
"ApiToken"
]
},
"actorName": {
"type": "string",
"maxLength": 1024
},
"requestResource": {
"type": "string",
"maxLength": 1024
},
"requestAction": {
"type": "string",
"maxLength": 1024
},
"requestQueryParams": {
"type": "object"
},
"requestBody": {
"type": "object"
},
"requestPathParams": {
"type": "object"
},
"responseBody": {
"type": "object"
},
"responseStatus": {
"type": "integer",
"minimum": 100,
"maximum": 599
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"perPage": {
"type": "integer"
},
"page": {
"type": "integer"
},
"sortField": {
"type": "string"
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "586e9d5151265cb9d72f6ec6",
"auditLogId": "586e9d5151265cb9d72f6ec6",
"creationDate": "2016-06-13T04:00:00.000Z",
"orgId": "575ed6e87ae143cd83dc4aa8",
"primaryTargetId": "575ec8687ae143cd83dc4a97",
"primaryTargetType": "Application",
"primaryTargetName": "My Application",
"actorId": "575ed70c7ae143cd83dc4aa9",
"actorType": "User",
"actorName": "example@losant.com",
"requestResource": "application",
"requestAction": "delete",
"requestQueryParams": {},
"requestBody": {},
"requestPathParams": {
"applicationId": "575ec8687ae143cd83dc4a97"
},
"responseBody": {
"success": true
},
"responseStatus": 200
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "creationDate",
"sortDirection": "desc",
"orgId": "575ed6e87ae143cd83dc4aa8"
}
```
## Authenticated Device
Schema for the successful response when authenticating a Device
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"token": {
"type": "string",
"minLength": 1
},
"ownerType": {
"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",
"deviceClass",
"token"
]
}
```
### Example
```json
{
"applicationId": "575ec8687ae143cd83dc4a97",
"deviceId": "575ecf887ae143cd83dc4aa2",
"deviceClass": "standalone",
"token": "token_to_use_for_authenticating_subsequent_requests",
"ownerType": "organization",
"filterType": "whitelist",
"pubTopics": [
"#"
],
"subTopics": [
"#"
]
}
```
## Authenticated User
Schema for the successful response when authenticating a User
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"userId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"token": {
"type": "string",
"minLength": 1
}
},
"required": [
"userId",
"token"
]
}
```
### Example
```json
{
"userId": "575ed70c7ae143cd83dc4aa9",
"token": "token_to_use_for_authenticating_subsequent_requests"
}
```
## Change Password
Schema for the body of a request to change the current user's password
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"twoFactorCode": {
"type": "string",
"maxLength": 2048
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 2048
},
"newPassword": {
"type": "string",
"minLength": 12,
"maxLength": 2048,
"pattern": "^(?=.*[A-Z])(?=.*[^A-z0-9])(?=.*[0-9])(?=.*[a-z]).{12,}$"
},
"invalidateExistingTokens": {
"type": "boolean"
},
"tokenTTL": {
"type": "integer",
"minimum": 0
}
},
"required": [
"password",
"newPassword"
],
"additionalProperties": false
}
```
### Example
```json
{
"newPassword": "yourNewPassword",
"password": "yourCurrentPassword",
"invalidateExistingTokens": true
}
```
## Composite Device State
Schema for a composite Device state
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "object",
"properties": {
"value": {
"type": [
"number",
"string",
"boolean"
]
},
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
}
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"voltage": {
"time": "2016-06-13T04:00:00.000Z",
"value": 22.4
},
"loaded": {
"time": "2016-06-13T03:00:00.000Z",
"value": false
}
}
```
## Dashboard
Schema for a single Dashboard
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"dashboardId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"organizationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"organizationIconColor": {
"type": "string",
"maxLength": 64
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"refreshRate": {
"type": "number",
"minimum": 5,
"maximum": 600
},
"defaultTheme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"isPasswordProtected": {
"type": "boolean"
},
"public": {
"type": "boolean"
},
"reportConfigs": {
"type": "array",
"max": 10,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"cron": {
"type": "string",
"maxLength": 255
},
"toEmail": {
"type": "array",
"min": 1,
"max": 10,
"items": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"subject": {
"type": "string",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"theme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"timezone": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"cron",
"toEmail"
]
}
},
"blocks": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"application-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"bar"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"xAxisFormat": {
"type": "string",
"maxLength": 255
},
"xAxisLabel": {
"type": "string",
"maxLength": 255
},
"xAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"xAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"custom-chart",
"custom-html"
]
},
"config": {
"type": "object",
"properties": {
"configuration": {
"oneOf": [
{
"type": "object",
"properties": {
"headContent": {
"type": "string",
"maxLength": 32767
},
"bodyContent": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "string",
"maxLength": 32767
}
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"time-series"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"data-table"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
]
}
},
"vegaVersion": {
"type": "string",
"enum": [
"vegaLite2",
"vegaLite3",
"vega4",
"vega5"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"dashboard-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"data-table"
]
},
"config": {
"type": "object",
"properties": {
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultSortColumn": {
"type": "string",
"maxLength": 255
},
"defaultSortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-list"
]
},
"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",
"enum": [
"custom",
"default"
]
},
"deviceLinkUrl": {
"type": "string",
"maxLength": 2048
},
"match": {
"type": "string",
"enum": [
"unfiltered",
"all",
"any"
]
},
"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
},
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"tags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"searchParam": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"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
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-log"
]
},
"config": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-state-table"
]
},
"config": {
"type": "object",
"properties": {
"attributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"sortDirection": {
"type": "integer",
"minimum": -1,
"maximum": 1
},
"sortIndex": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"headerTemplate": {
"type": "string",
"maxLength": 1024
},
"id": {
"type": "string",
"maxLength": 48
},
"rowTemplate": {
"type": "string",
"maxLength": 32767
},
"type": {
"type": "string",
"enum": [
"deviceTags",
"deviceId",
"deviceName",
"timestamp",
"attribute"
]
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"event-list"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"sortField": {
"type": "string",
"maxLength": 255
},
"filter": {
"type": "string",
"maxLength": 255
},
"eventState": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"columnErrors": {
"type": "object",
"additionalProperties": false
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"selectedTag": {
"type": "string",
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"level",
"subject",
"subjectWithMessage",
"creationDate",
"creationDateWithSource",
"lastUpdatedDate",
"lastUpdatedDateWithSource",
"id",
"state",
"tag",
"deviceName",
"sourceId"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"gauge"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"displayAsPercentage": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"gaugeMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeType": {
"type": "string",
"enum": [
"battery",
"dial",
"number",
"tank",
"thermometer"
]
},
"precision": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"precisionType": {
"type": "string",
"enum": [
"floating",
"significant"
]
},
"segment": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"graph"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"recharts": {
"type": "boolean"
},
"displayType": {
"type": "string",
"enum": [
"stick",
"line"
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"cumulative": {
"type": "boolean"
},
"detectDataGaps": {
"type": "boolean"
},
"expression": {
"type": "string",
"maxLength": 255
},
"graphType": {
"type": "string",
"enum": [
"area",
"bar",
"line"
]
},
"label": {
"type": "string",
"maxLength": 255
},
"yAxisFormat": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"yAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"yAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"lineType": {
"type": "string",
"enum": [
"monotone",
"step",
"stepAfter",
"linear",
"stepBefore"
]
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"dotWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"heatmap"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"query": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"iframe"
]
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image"
]
},
"config": {
"type": "object",
"properties": {
"bgColor": {
"type": "string",
"maxLength": 64
},
"imageLinkNewWindow": {
"type": "boolean"
},
"imageLinkUrl": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"imageSource": {
"type": "string",
"enum": [
"static",
"attribute"
]
},
"deviceId": {
"type": "string",
"maxLength": 255
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image-overlay"
]
},
"config": {
"type": "object",
"properties": {
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"defaultZoom": {
"type": "number"
},
"segments": {
"type": "array",
"maxItems": 300,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"overlays": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"indicator",
"label",
"image"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"value"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"valueTemplate": {
"type": "string",
"maxLength": 255
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bar"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"valueTemplate": {
"type": "string",
"maxLength": 255
},
"length": {
"type": "integer",
"min": 1,
"max": 10
},
"orientation": {
"type": "string",
"enum": [
"horizontal",
"vertical"
]
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height",
"config"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"indicator"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"input"
]
},
"config": {
"type": "object",
"properties": {
"defaultMode": {
"type": "string",
"enum": [
"unlocked",
"locked"
]
},
"controls": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"range"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"step": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"defaultValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"toggle"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"select"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 255
},
"options": {
"type": "array",
"maxItems": 500,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 255
},
"label": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"help"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"help": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"button"
]
},
"action": {
"type": "string",
"enum": [
"workflow",
"command"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"color": {
"type": "string",
"maxLength": 64
},
"payload": {
"type": "string",
"maxLength": 32767
},
"buttonId": {
"type": "string",
"maxLength": 255
},
"workflowId": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"commandName": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"map"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"clusterPoints": {
"type": "boolean"
},
"compositeResult": {
"type": "boolean"
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"query": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"open-event-indicator"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"pie"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"percentFormat": {
"type": "string",
"maxLength": 255
},
"valueFormat": {
"type": "string",
"maxLength": 255
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"position-chart"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"compositeResult": {
"type": "boolean"
},
"coordinateA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"coordinateB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultCenter": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"pixelA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"pixelB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
},
"xAttribute": {
"type": "string",
"maxLength": 255
},
"yAttribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"section-header"
]
},
"config": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 255
},
"content": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"workflow-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
},
"includeCloud": {
"type": "boolean"
},
"includeEdge": {
"type": "boolean"
},
"includeExperience": {
"type": "boolean"
},
"experienceVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
}
]
}
},
"contextConfiguration": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceAttribute"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceId"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeFullDevice": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceTag"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": [
"number",
"string"
]
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"string"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"regExp": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"experienceUser"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
}
]
},
"maxItems": 100
}
}
}
```
### Example
```json
{
"id": "575ece2b7ae143cd83dc4a9b",
"dashboardId": "575ece2b7ae143cd83dc4a9b",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"organizationName": "Losant",
"organizationIconColor": "#284fff",
"ownerType": "organization",
"ownerId": "58238ff2fe7b4b01009a0554",
"name": "My Dashboard",
"description": "The best dashboard description",
"refreshRate": 60,
"public": false,
"isPasswordProtected": false,
"defaultTheme": "light",
"blocks": [],
"_currentRole": "admin",
"reportConfigs": [
{
"toEmail": [
"test@email.com"
],
"cron": "0 0 12 * * MON-FRI *",
"theme": "dark",
"subject": "Daily Dashboard Report"
}
],
"contextConfiguration": [
{
"validationEnabled": true,
"validationConfig": {
"deviceIds": [
"589de9bca1975a00017b2293"
],
"deviceTags": [
{
"key": "type",
"value": "Weather Station"
}
],
"includeFullDevice": true
},
"name": "deviceId-withIdAndTagValidationAndIncludeFullDevice",
"type": "deviceId",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": "589de9bca1975a00017b2295"
},
{
"validationEnabled": false,
"validationConfig": {
"includeFullDevice": false
},
"name": "deviceId-noValidationNoFullDevice",
"type": "deviceId",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": "589de9bca1975a00017b2295"
},
{
"validationEnabled": true,
"validationConfig": {
"attributes": [
"dew-point",
"feels-like",
"humidity",
"location",
"pressure",
"temp",
"visibility",
"wind-speed"
]
},
"name": "attr",
"type": "deviceAttribute",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": "temp"
},
{
"validationEnabled": true,
"validationConfig": {
"deviceTags": [
{
"key": "DeviceRecipe",
"value": "Weather Station"
},
{
"key": "region"
}
]
},
"name": "deviceTag-withValidation",
"type": "deviceTag",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": {
"key": "DeviceRecipe",
"value": "Weather Station"
}
},
{
"validationEnabled": false,
"validationConfig": {},
"name": "deviceTag-noValidation",
"type": "deviceTag",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": {
"key": "DeviceRecipe",
"value": "Weather Station"
}
}
]
}
```
## Dashboard Context Instance
Schema for a dashboard context instance
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"oneOf": [
{
"type": "string",
"maxLength": 32767
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"myContextVariable": "myValue",
"myOtherVariable": "575ecf887ae143cd83dc4aa2"
}
```
## Dashboard Patch
Schema for the body of a Dashboard modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"blocks": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"application-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"bar"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"xAxisFormat": {
"type": "string",
"maxLength": 255
},
"xAxisLabel": {
"type": "string",
"maxLength": 255
},
"xAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"xAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"custom-chart",
"custom-html"
]
},
"config": {
"type": "object",
"properties": {
"configuration": {
"oneOf": [
{
"type": "object",
"properties": {
"headContent": {
"type": "string",
"maxLength": 32767
},
"bodyContent": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "string",
"maxLength": 32767
}
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"time-series"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"data-table"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
]
}
},
"vegaVersion": {
"type": "string",
"enum": [
"vegaLite2",
"vegaLite3",
"vega4",
"vega5"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"dashboard-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"data-table"
]
},
"config": {
"type": "object",
"properties": {
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultSortColumn": {
"type": "string",
"maxLength": 255
},
"defaultSortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-list"
]
},
"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",
"enum": [
"custom",
"default"
]
},
"deviceLinkUrl": {
"type": "string",
"maxLength": 2048
},
"match": {
"type": "string",
"enum": [
"unfiltered",
"all",
"any"
]
},
"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
},
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"tags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"searchParam": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"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
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-log"
]
},
"config": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-state-table"
]
},
"config": {
"type": "object",
"properties": {
"attributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"sortDirection": {
"type": "integer",
"minimum": -1,
"maximum": 1
},
"sortIndex": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"headerTemplate": {
"type": "string",
"maxLength": 1024
},
"id": {
"type": "string",
"maxLength": 48
},
"rowTemplate": {
"type": "string",
"maxLength": 32767
},
"type": {
"type": "string",
"enum": [
"deviceTags",
"deviceId",
"deviceName",
"timestamp",
"attribute"
]
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"event-list"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"sortField": {
"type": "string",
"maxLength": 255
},
"filter": {
"type": "string",
"maxLength": 255
},
"eventState": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"columnErrors": {
"type": "object",
"additionalProperties": false
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"selectedTag": {
"type": "string",
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"level",
"subject",
"subjectWithMessage",
"creationDate",
"creationDateWithSource",
"lastUpdatedDate",
"lastUpdatedDateWithSource",
"id",
"state",
"tag",
"deviceName",
"sourceId"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"gauge"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"displayAsPercentage": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"gaugeMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeType": {
"type": "string",
"enum": [
"battery",
"dial",
"number",
"tank",
"thermometer"
]
},
"precision": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"precisionType": {
"type": "string",
"enum": [
"floating",
"significant"
]
},
"segment": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"graph"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"recharts": {
"type": "boolean"
},
"displayType": {
"type": "string",
"enum": [
"stick",
"line"
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"cumulative": {
"type": "boolean"
},
"detectDataGaps": {
"type": "boolean"
},
"expression": {
"type": "string",
"maxLength": 255
},
"graphType": {
"type": "string",
"enum": [
"area",
"bar",
"line"
]
},
"label": {
"type": "string",
"maxLength": 255
},
"yAxisFormat": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"yAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"yAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"lineType": {
"type": "string",
"enum": [
"monotone",
"step",
"stepAfter",
"linear",
"stepBefore"
]
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"dotWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"heatmap"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"query": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"iframe"
]
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image"
]
},
"config": {
"type": "object",
"properties": {
"bgColor": {
"type": "string",
"maxLength": 64
},
"imageLinkNewWindow": {
"type": "boolean"
},
"imageLinkUrl": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"imageSource": {
"type": "string",
"enum": [
"static",
"attribute"
]
},
"deviceId": {
"type": "string",
"maxLength": 255
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image-overlay"
]
},
"config": {
"type": "object",
"properties": {
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"defaultZoom": {
"type": "number"
},
"segments": {
"type": "array",
"maxItems": 300,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"overlays": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"indicator",
"label",
"image"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"value"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"valueTemplate": {
"type": "string",
"maxLength": 255
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bar"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"valueTemplate": {
"type": "string",
"maxLength": 255
},
"length": {
"type": "integer",
"min": 1,
"max": 10
},
"orientation": {
"type": "string",
"enum": [
"horizontal",
"vertical"
]
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height",
"config"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"indicator"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"input"
]
},
"config": {
"type": "object",
"properties": {
"defaultMode": {
"type": "string",
"enum": [
"unlocked",
"locked"
]
},
"controls": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"range"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"step": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"defaultValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"toggle"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"select"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 255
},
"options": {
"type": "array",
"maxItems": 500,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 255
},
"label": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"help"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"help": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"button"
]
},
"action": {
"type": "string",
"enum": [
"workflow",
"command"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"color": {
"type": "string",
"maxLength": 64
},
"payload": {
"type": "string",
"maxLength": 32767
},
"buttonId": {
"type": "string",
"maxLength": 255
},
"workflowId": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"commandName": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"map"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"clusterPoints": {
"type": "boolean"
},
"compositeResult": {
"type": "boolean"
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"query": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"open-event-indicator"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"pie"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"percentFormat": {
"type": "string",
"maxLength": 255
},
"valueFormat": {
"type": "string",
"maxLength": 255
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"position-chart"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"compositeResult": {
"type": "boolean"
},
"coordinateA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"coordinateB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultCenter": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"pixelA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"pixelB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
},
"xAttribute": {
"type": "string",
"maxLength": 255
},
"yAttribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"section-header"
]
},
"config": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 255
},
"content": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"workflow-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
},
"includeCloud": {
"type": "boolean"
},
"includeEdge": {
"type": "boolean"
},
"includeExperience": {
"type": "boolean"
},
"experienceVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
}
]
}
},
"reportConfigs": {
"type": "array",
"max": 10,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"cron": {
"type": "string",
"maxLength": 255
},
"toEmail": {
"type": "array",
"min": 1,
"max": 10,
"items": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"subject": {
"type": "string",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"theme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"timezone": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"cron",
"toEmail"
]
}
},
"description": {
"type": "string",
"maxLength": 32767
},
"refreshRate": {
"type": "number",
"minimum": 5,
"maximum": 600
},
"defaultTheme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"public": {
"type": "boolean"
},
"password": {
"type": [
"string",
"null"
]
},
"contextConfiguration": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceAttribute"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceId"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeFullDevice": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceTag"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": [
"number",
"string"
]
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"string"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"regExp": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"experienceUser"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
}
]
},
"maxItems": 100
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Dashboard",
"description": "Description of my updated dashboard",
"refreshRate": 300,
"public": true
}
```
## Dashboard Post
Schema for the body of a Dashboard creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"blocks": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"application-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"bar"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"xAxisFormat": {
"type": "string",
"maxLength": 255
},
"xAxisLabel": {
"type": "string",
"maxLength": 255
},
"xAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"xAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"custom-chart",
"custom-html"
]
},
"config": {
"type": "object",
"properties": {
"configuration": {
"oneOf": [
{
"type": "object",
"properties": {
"headContent": {
"type": "string",
"maxLength": 32767
},
"bodyContent": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "string",
"maxLength": 32767
}
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"time-series"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"data-table"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
]
}
},
"vegaVersion": {
"type": "string",
"enum": [
"vegaLite2",
"vegaLite3",
"vega4",
"vega5"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"dashboard-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"data-table"
]
},
"config": {
"type": "object",
"properties": {
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultSortColumn": {
"type": "string",
"maxLength": 255
},
"defaultSortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-list"
]
},
"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",
"enum": [
"custom",
"default"
]
},
"deviceLinkUrl": {
"type": "string",
"maxLength": 2048
},
"match": {
"type": "string",
"enum": [
"unfiltered",
"all",
"any"
]
},
"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
},
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"tags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"searchParam": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"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
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-log"
]
},
"config": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-state-table"
]
},
"config": {
"type": "object",
"properties": {
"attributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"sortDirection": {
"type": "integer",
"minimum": -1,
"maximum": 1
},
"sortIndex": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"headerTemplate": {
"type": "string",
"maxLength": 1024
},
"id": {
"type": "string",
"maxLength": 48
},
"rowTemplate": {
"type": "string",
"maxLength": 32767
},
"type": {
"type": "string",
"enum": [
"deviceTags",
"deviceId",
"deviceName",
"timestamp",
"attribute"
]
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"event-list"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"sortField": {
"type": "string",
"maxLength": 255
},
"filter": {
"type": "string",
"maxLength": 255
},
"eventState": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"columnErrors": {
"type": "object",
"additionalProperties": false
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"selectedTag": {
"type": "string",
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"level",
"subject",
"subjectWithMessage",
"creationDate",
"creationDateWithSource",
"lastUpdatedDate",
"lastUpdatedDateWithSource",
"id",
"state",
"tag",
"deviceName",
"sourceId"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"gauge"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"displayAsPercentage": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"gaugeMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeType": {
"type": "string",
"enum": [
"battery",
"dial",
"number",
"tank",
"thermometer"
]
},
"precision": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"precisionType": {
"type": "string",
"enum": [
"floating",
"significant"
]
},
"segment": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"graph"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"recharts": {
"type": "boolean"
},
"displayType": {
"type": "string",
"enum": [
"stick",
"line"
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"cumulative": {
"type": "boolean"
},
"detectDataGaps": {
"type": "boolean"
},
"expression": {
"type": "string",
"maxLength": 255
},
"graphType": {
"type": "string",
"enum": [
"area",
"bar",
"line"
]
},
"label": {
"type": "string",
"maxLength": 255
},
"yAxisFormat": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"yAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"yAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"lineType": {
"type": "string",
"enum": [
"monotone",
"step",
"stepAfter",
"linear",
"stepBefore"
]
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"dotWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"heatmap"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"query": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"iframe"
]
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image"
]
},
"config": {
"type": "object",
"properties": {
"bgColor": {
"type": "string",
"maxLength": 64
},
"imageLinkNewWindow": {
"type": "boolean"
},
"imageLinkUrl": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"imageSource": {
"type": "string",
"enum": [
"static",
"attribute"
]
},
"deviceId": {
"type": "string",
"maxLength": 255
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image-overlay"
]
},
"config": {
"type": "object",
"properties": {
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"defaultZoom": {
"type": "number"
},
"segments": {
"type": "array",
"maxItems": 300,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"overlays": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"indicator",
"label",
"image"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"value"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"valueTemplate": {
"type": "string",
"maxLength": 255
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bar"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"valueTemplate": {
"type": "string",
"maxLength": 255
},
"length": {
"type": "integer",
"min": 1,
"max": 10
},
"orientation": {
"type": "string",
"enum": [
"horizontal",
"vertical"
]
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height",
"config"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"indicator"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"input"
]
},
"config": {
"type": "object",
"properties": {
"defaultMode": {
"type": "string",
"enum": [
"unlocked",
"locked"
]
},
"controls": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"range"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"step": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"defaultValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"toggle"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"select"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 255
},
"options": {
"type": "array",
"maxItems": 500,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 255
},
"label": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"help"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"help": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"button"
]
},
"action": {
"type": "string",
"enum": [
"workflow",
"command"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"color": {
"type": "string",
"maxLength": 64
},
"payload": {
"type": "string",
"maxLength": 32767
},
"buttonId": {
"type": "string",
"maxLength": 255
},
"workflowId": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"commandName": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"map"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"clusterPoints": {
"type": "boolean"
},
"compositeResult": {
"type": "boolean"
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"query": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"open-event-indicator"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"pie"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"percentFormat": {
"type": "string",
"maxLength": 255
},
"valueFormat": {
"type": "string",
"maxLength": 255
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"position-chart"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"compositeResult": {
"type": "boolean"
},
"coordinateA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"coordinateB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultCenter": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"pixelA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"pixelB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
},
"xAttribute": {
"type": "string",
"maxLength": 255
},
"yAttribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"section-header"
]
},
"config": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 255
},
"content": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"workflow-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
},
"includeCloud": {
"type": "boolean"
},
"includeEdge": {
"type": "boolean"
},
"includeExperience": {
"type": "boolean"
},
"experienceVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
}
]
}
},
"description": {
"type": "string",
"maxLength": 32767
},
"refreshRate": {
"type": "number",
"minimum": 5,
"maximum": 600
},
"defaultTheme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"reportConfigs": {
"type": "array",
"max": 10,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"cron": {
"type": "string",
"maxLength": 255
},
"toEmail": {
"type": "array",
"min": 1,
"max": 10,
"items": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"subject": {
"type": "string",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"theme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"timezone": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"cron",
"toEmail"
]
}
},
"public": {
"type": "boolean"
},
"password": {
"type": [
"string",
"null"
]
},
"contextConfiguration": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceAttribute"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceId"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeFullDevice": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceTag"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": [
"number",
"string"
]
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"string"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"regExp": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"experienceUser"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
}
]
},
"maxItems": 100
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New Dashboard",
"public": false
}
```
## Dashboard Send Report
Schema for the body of a Dashboard report request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"required": [
"toEmail"
],
"properties": {
"toEmail": {
"type": "array",
"min": 1,
"max": 10,
"items": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"subject": {
"type": "string",
"max": 255
},
"message": {
"type": "string",
"max": 32767
},
"theme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"time": {
"type": "number"
},
"timezone": {
"type": "string",
"max": 255
}
},
"additionalProperties": false
}
```
### Example
```json
{
"toEmail": [
"test@email.com"
],
"subject": "Dashboard Report",
"message": "Lookit",
"time": 1551887386704,
"theme": "dark",
"timezone": "America/New_York"
}
```
## Dashboard Update Events
Schema for the body of an update events request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"eventIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"updates": {
"title": "Event Patch",
"description": "Schema for the body of an Event modification request",
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"comment": {
"type": "string",
"maxLength": 32767
},
"data": {},
"eventTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
```
### Example
```json
{
"eventIds": [
"596e6ce831761df4231708f1"
],
"updates": {
"state": "acknowledged",
"comment": "Looking into this issue"
}
}
```
## Dashboards
Schema for a collection of Dashboards
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Dashboard",
"description": "Schema for a single Dashboard",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"dashboardId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"ownerId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"ownerType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"organizationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"organizationIconColor": {
"type": "string",
"maxLength": 64
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"refreshRate": {
"type": "number",
"minimum": 5,
"maximum": 600
},
"defaultTheme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"isPasswordProtected": {
"type": "boolean"
},
"public": {
"type": "boolean"
},
"reportConfigs": {
"type": "array",
"max": 10,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"cron": {
"type": "string",
"maxLength": 255
},
"toEmail": {
"type": "array",
"min": 1,
"max": 10,
"items": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"subject": {
"type": "string",
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"theme": {
"type": "string",
"enum": [
"dark",
"light"
]
},
"timezone": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"cron",
"toEmail"
]
}
},
"blocks": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"application-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"bar"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"xAxisFormat": {
"type": "string",
"maxLength": 255
},
"xAxisLabel": {
"type": "string",
"maxLength": 255
},
"xAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"xAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"custom-chart",
"custom-html"
]
},
"config": {
"type": "object",
"properties": {
"configuration": {
"oneOf": [
{
"type": "object",
"properties": {
"headContent": {
"type": "string",
"maxLength": 32767
},
"bodyContent": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "string",
"maxLength": 32767
}
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"time-series"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"data-table"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
]
}
},
"vegaVersion": {
"type": "string",
"enum": [
"vegaLite2",
"vegaLite3",
"vega4",
"vega5"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"dashboard-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"data-table"
]
},
"config": {
"type": "object",
"properties": {
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultSortColumn": {
"type": "string",
"maxLength": 255
},
"defaultSortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"queryMode": {
"type": "string",
"enum": [
"$or",
"$and",
"advanced"
]
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-list"
]
},
"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",
"enum": [
"custom",
"default"
]
},
"deviceLinkUrl": {
"type": "string",
"maxLength": 2048
},
"match": {
"type": "string",
"enum": [
"unfiltered",
"all",
"any"
]
},
"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
},
{
"type": "object",
"properties": {
"ids": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"tags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"searchParam": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
"query": {
"type": "string",
"maxLength": 32767
},
"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
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-log"
]
},
"config": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"device-state-table"
]
},
"config": {
"type": "object",
"properties": {
"attributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"sortDirection": {
"type": "integer",
"minimum": -1,
"maximum": 1
},
"sortIndex": {
"type": "integer",
"minimum": 0,
"maximum": 100
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"headerTemplate": {
"type": "string",
"maxLength": 1024
},
"id": {
"type": "string",
"maxLength": 48
},
"rowTemplate": {
"type": "string",
"maxLength": 32767
},
"type": {
"type": "string",
"enum": [
"deviceTags",
"deviceId",
"deviceName",
"timestamp",
"attribute"
]
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"event-list"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"sortField": {
"type": "string",
"maxLength": 255
},
"filter": {
"type": "string",
"maxLength": 255
},
"eventState": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
},
{
"type": "object",
"additionalProperties": false
}
]
},
"columnErrors": {
"type": "object",
"additionalProperties": false
},
"columns": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"selectedTag": {
"type": "string",
"maxLength": 255
},
"type": {
"type": "string",
"enum": [
"level",
"subject",
"subjectWithMessage",
"creationDate",
"creationDateWithSource",
"lastUpdatedDate",
"lastUpdatedDateWithSource",
"id",
"state",
"tag",
"deviceName",
"sourceId"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"gauge"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"displayAsPercentage": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"gaugeMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"gaugeType": {
"type": "string",
"enum": [
"battery",
"dial",
"number",
"tank",
"thermometer"
]
},
"precision": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"precisionType": {
"type": "string",
"enum": [
"floating",
"significant"
]
},
"segment": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"graph"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"recharts": {
"type": "boolean"
},
"displayType": {
"type": "string",
"enum": [
"stick",
"line"
]
},
"segments": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"cumulative": {
"type": "boolean"
},
"detectDataGaps": {
"type": "boolean"
},
"expression": {
"type": "string",
"maxLength": 255
},
"graphType": {
"type": "string",
"enum": [
"area",
"bar",
"line"
]
},
"label": {
"type": "string",
"maxLength": 255
},
"yAxisFormat": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"yAxisMax": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"yAxisMin": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"lineType": {
"type": "string",
"enum": [
"monotone",
"step",
"stepAfter",
"linear",
"stepBefore"
]
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"dotWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"heatmap"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"query": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"iframe"
]
},
"config": {
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image"
]
},
"config": {
"type": "object",
"properties": {
"bgColor": {
"type": "string",
"maxLength": 64
},
"imageLinkNewWindow": {
"type": "boolean"
},
"imageLinkUrl": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"imageSource": {
"type": "string",
"enum": [
"static",
"attribute"
]
},
"deviceId": {
"type": "string",
"maxLength": 255
},
"attribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"image-overlay"
]
},
"config": {
"type": "object",
"properties": {
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"defaultZoom": {
"type": "number"
},
"segments": {
"type": "array",
"maxItems": 300,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"queryType": {
"type": "string",
"enum": [
"gauge"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
}
]
}
},
"overlays": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"indicator",
"label",
"image"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"value"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"valueTemplate": {
"type": "string",
"maxLength": 255
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bar"
]
},
"size": {
"type": "string",
"enum": [
"small",
"medium",
"large"
]
},
"position": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"backgroundColor": {
"type": "string",
"maxLength": 64
},
"valueTemplate": {
"type": "string",
"maxLength": 255
},
"length": {
"type": "integer",
"min": 1,
"max": 10
},
"orientation": {
"type": "string",
"enum": [
"horizontal",
"vertical"
]
}
},
"required": [
"type",
"position",
"size",
"defaultCondition"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height",
"config"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"indicator"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"conditions": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"defaultCondition": {
"type": "object",
"properties": {
"color": {
"type": "string",
"maxLength": 64
},
"id": {
"type": "string",
"maxLength": 48
},
"label": {
"type": "string",
"maxLength": 32767
},
"condition": {
"type": "string",
"maxLength": 2048
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"shape": {
"type": "string",
"enum": [
"circle",
"square",
"triangle-down",
"triangle-up",
"octagon"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"input"
]
},
"config": {
"type": "object",
"properties": {
"defaultMode": {
"type": "string",
"enum": [
"unlocked",
"locked"
]
},
"controls": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"range"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"max": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"min": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"step": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"defaultValue": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"toggle"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"color": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "boolean"
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"text"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 2048
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"select"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"defaultQuery": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"defaultValue": {
"type": "string",
"maxLength": 255
},
"options": {
"type": "array",
"maxItems": 500,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 255
},
"label": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"help"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"help": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"button"
]
},
"action": {
"type": "string",
"enum": [
"workflow",
"command"
]
},
"id": {
"type": "string",
"maxLength": 48
},
"templateId": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 512
},
"grid": {
"type": "object",
"properties": {
"h": {
"type": "number"
},
"w": {
"type": "number"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
}
},
"additionalProperties": false
},
"color": {
"type": "string",
"maxLength": 64
},
"payload": {
"type": "string",
"maxLength": 32767
},
"buttonId": {
"type": "string",
"maxLength": 255
},
"workflowId": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "null"
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"commandName": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"map"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"attribute": {
"type": "string",
"maxLength": 255
},
"clusterPoints": {
"type": "boolean"
},
"compositeResult": {
"type": "boolean"
},
"defaultBearing": {
"type": "number"
},
"defaultCenter": {
"type": "string",
"maxLength": 255
},
"defaultPitch": {
"type": "number"
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"locationTagKey": {
"oneOf": [
{
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"mapStyle": {
"type": "string",
"enum": [
"normal",
"satellite"
]
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"query": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"open-event-indicator"
]
},
"config": {
"type": "object",
"properties": {
"allowUpdates": {
"type": "boolean"
},
"query": {
"type": "string",
"maxLength": 32767
},
"filter": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"pie"
]
},
"config": {
"type": "object",
"properties": {
"realTime": {
"type": "boolean"
},
"duration": {
"type": "integer",
"minimum": 0
},
"percentFormat": {
"type": "string",
"maxLength": 255
},
"valueFormat": {
"type": "string",
"maxLength": 255
},
"segments": {
"type": "array",
"maxItems": 255,
"items": {
"type": "object",
"properties": {
"attribute": {
"type": "string",
"maxLength": 255
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"color": {
"type": "string",
"maxLength": 64
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"label": {
"type": "string",
"maxLength": 255
},
"expression": {
"type": "string",
"maxLength": 255
},
"yAxisLabel": {
"type": "string",
"maxLength": 255
},
"lineWeight": {
"type": "integer",
"minimum": 0,
"maximum": 5
},
"detectDataGaps": {
"type": "boolean"
},
"graphType": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"position-chart"
]
},
"config": {
"type": "object",
"properties": {
"additionalAttributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"compositeResult": {
"type": "boolean"
},
"coordinateA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"coordinateB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultCenter": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"defaultZoom": {
"oneOf": [
{
"type": "number"
},
{
"type": "string",
"maxLength": 64
}
]
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
},
"deviceTags": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 255
},
"value": {
"type": "string",
"maxLength": 255
},
"fromCtx": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"duration": {
"type": "integer",
"minimum": 0
},
"endColor": {
"type": "string",
"maxLength": 64
},
"iconTemplate": {
"type": "string",
"maxLength": 73727
},
"imageUrl": {
"type": "string",
"maxLength": 32767
},
"includeArrows": {
"type": "boolean"
},
"includeLines": {
"type": "boolean"
},
"pinMode": {
"type": "string",
"enum": [
"simple",
"advanced"
]
},
"pixelA": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"pixelB": {
"type": "string",
"minLength": 3,
"maxLength": 255
},
"popupTemplate": {
"type": "string",
"maxLength": 32767
},
"resizedPins": {
"type": "boolean"
},
"resolution": {
"oneOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "null"
},
{
"type": "string",
"maxLength": 255
}
]
},
"startColor": {
"type": "string",
"maxLength": 64
},
"xAttribute": {
"type": "string",
"maxLength": 255
},
"yAttribute": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"section-header"
]
},
"config": {
"type": "object",
"properties": {
"title": {
"type": "string",
"maxLength": 255
},
"content": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 48
},
"title": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"startX": {
"type": "number"
},
"startY": {
"type": "number"
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"blockType": {
"type": "string",
"enum": [
"workflow-list"
]
},
"config": {
"type": "object",
"properties": {
"filter": {
"type": "string",
"maxLength": 255
},
"includeCloud": {
"type": "boolean"
},
"includeEdge": {
"type": "boolean"
},
"includeExperience": {
"type": "boolean"
},
"experienceVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"required": [
"blockType",
"startX",
"startY",
"width",
"height"
],
"additionalProperties": false
}
]
}
},
"contextConfiguration": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceAttribute"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceId"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"includeFullDevice": {
"type": "boolean"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"deviceTag"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"number"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": [
"number",
"string"
]
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"min": {
"type": "number"
},
"max": {
"type": "number"
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"string"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"regExp": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"type": {
"type": "string",
"enum": [
"experienceUser"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"defaultValue": {
"type": "string",
"maxLength": 32767
},
"validationEnabled": {
"type": "boolean"
},
"validationConfig": {
"type": "object",
"properties": {
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false
}
},
"required": [
"name",
"type",
"defaultValue"
],
"additionalProperties": false
}
]
},
"maxItems": 100
}
}
}
},
"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",
""
]
},
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ece2b7ae143cd83dc4a9b",
"dashboardId": "575ece2b7ae143cd83dc4a9b",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"organizationName": "Losant",
"organizationIconColor": "#284fff",
"ownerType": "organization",
"ownerId": "58238ff2fe7b4b01009a0554",
"name": "My Dashboard",
"description": "The best dashboard description",
"refreshRate": 60,
"public": false,
"isPasswordProtected": false,
"defaultTheme": "light",
"blocks": [],
"_currentRole": "admin",
"reportConfigs": [
{
"toEmail": [
"test@email.com"
],
"cron": "0 0 12 * * MON-FRI *",
"theme": "dark",
"subject": "Daily Dashboard Report"
}
],
"contextConfiguration": [
{
"validationEnabled": true,
"validationConfig": {
"deviceIds": [
"589de9bca1975a00017b2293"
],
"deviceTags": [
{
"key": "type",
"value": "Weather Station"
}
],
"includeFullDevice": true
},
"name": "deviceId-withIdAndTagValidationAndIncludeFullDevice",
"type": "deviceId",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": "589de9bca1975a00017b2295"
},
{
"validationEnabled": false,
"validationConfig": {
"includeFullDevice": false
},
"name": "deviceId-noValidationNoFullDevice",
"type": "deviceId",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": "589de9bca1975a00017b2295"
},
{
"validationEnabled": true,
"validationConfig": {
"attributes": [
"dew-point",
"feels-like",
"humidity",
"location",
"pressure",
"temp",
"visibility",
"wind-speed"
]
},
"name": "attr",
"type": "deviceAttribute",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": "temp"
},
{
"validationEnabled": true,
"validationConfig": {
"deviceTags": [
{
"key": "DeviceRecipe",
"value": "Weather Station"
},
{
"key": "region"
}
]
},
"name": "deviceTag-withValidation",
"type": "deviceTag",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": {
"key": "DeviceRecipe",
"value": "Weather Station"
}
},
{
"validationEnabled": false,
"validationConfig": {},
"name": "deviceTag-noValidation",
"type": "deviceTag",
"applicationId": "589de7d2a1975a00017b227f",
"defaultValue": {
"key": "DeviceRecipe",
"value": "Weather Station"
}
}
]
}
],
"count": 1,
"totalCount": 5,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc"
}
```
## Data Export
Schema for exporting data devices query
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"callbackUrl": {
"type": "string",
"maxLength": 1024
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceQuery": {
"title": "Advanced Query",
"description": "Schema for advanced filters and queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
}
},
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"start": {
"type": "number"
},
"end": {
"type": "number"
},
"options": {
"type": "object",
"properties": {
"includeDate": {
"type": "boolean",
"default": true
},
"includeID": {
"type": "boolean",
"default": true
},
"includeBlobData": {
"type": "boolean",
"default": false
}
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"email": "example@losant.com",
"deviceIds": [
"575ecf887ae143cd83dc4aa2",
"575ef5c97ae143cd83dc4aac"
],
"attributes": [
"voltage"
],
"end": 0,
"options": {
"includeDate": false,
"includeID": true
}
}
```
## Data Table
Schema for a single Data Table
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"dataTableId": {
"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
},
"columns": {
"type": "array",
"items": {
"title": "Data Table Column",
"description": "Schema for a single Data Table Column",
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"constraint": {
"type": "string",
"enum": [
"unique",
"required",
"optional"
]
},
"defaultValue": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"name",
"dataType",
"constraint"
],
"additionalProperties": false
},
"maxItems": 50
}
}
}
```
### Example
```json
{
"id": "596e6ce831761df4231708f1",
"dataTableId": "596e6ce831761df4231708f1",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Data Table",
"columns": [
{
"name": "myColumn1",
"dataType": "string",
"constraint": "unique"
},
{
"name": "myColumn2",
"dataType": "number",
"constraint": "optional"
}
]
}
```
## Data Table Column
Schema for a single Data Table Column
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"constraint": {
"type": "string",
"enum": [
"unique",
"required",
"optional"
]
},
"defaultValue": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"name",
"dataType",
"constraint"
],
"additionalProperties": false
}
```
### Example
```json
{
"name": "myColumn3",
"dataType": "string",
"constraint": "optional",
"defaultValue": "aDefault"
}
```
## Data Table Patch
Schema for the body of a Data Table modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Data Table"
}
```
## Data Table Post
Schema for the body of a Data Table creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"columns": {
"type": "array",
"items": {
"title": "Data Table Column",
"description": "Schema for a single Data Table Column",
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"constraint": {
"type": "string",
"enum": [
"unique",
"required",
"optional"
]
},
"defaultValue": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"name",
"dataType",
"constraint"
],
"additionalProperties": false
},
"maxItems": 50
}
},
"required": [
"name"
],
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Data Table",
"columns": [
{
"name": "myColumn1",
"dataType": "string",
"constraint": "unique"
},
{
"name": "myColumn2",
"dataType": "number",
"constraint": "optional"
}
]
}
```
## Data Table Row
Schema for a single Data Table Row
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
}
}
```
### Example
```json
{
"id": "596fbb703fc088453872e609",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"myColumn1": "myValue",
"myColumn2": 5
}
```
## Data Table Row Insert Multiple
Schema for inserting data table rows
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"title": "Data Table Row Insert Update",
"description": "Schema for inserting or updating a data table row",
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
```
### Example
```json
[
{
"myColumn1": "myValue"
},
{
"myColumn1": "myValue"
}
]
```
## Data Table Row Insert
Schema for inserting a data table row or rows
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
"title": "Data Table Row Insert Update",
"description": "Schema for inserting or updating a data table row",
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"additionalProperties": false
},
{
"title": "Data Table Row Insert Multiple",
"description": "Schema for inserting data table rows",
"type": "array",
"items": {
"title": "Data Table Row Insert Update",
"description": "Schema for inserting or updating a data table row",
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"additionalProperties": false
}
}
]
}
```
### Example
```json
{
"myColumn1": "myValue"
}
```
## Data Table Row Insert Result
Schema for a the result of a single or multiple row insert
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
"title": "Data Table Row",
"description": "Schema for a single Data Table Row",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
}
},
{
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time"
},
"count": {
"type": "number"
},
"rowIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
}
}
]
}
```
### Example
```json
{
"id": "596fbb703fc088453872e609",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"myColumn1": "myValue",
"myColumn2": 5
}
```
## Data Table Row Insert Update
Schema for inserting or updating a data table row
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"myColumn1": "myValue"
}
```
## Data Table Rows
Schema for a collection of Data Table Rows
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Data Table Row",
"description": "Schema for a single Data Table Row",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"format": "date-time"
}
},
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"string",
"number",
"boolean",
"null"
]
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"sortColumn": {
"type": "string"
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"dataTableId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"query": {
"type": "object"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "596fbb703fc088453872e609",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"myColumn1": "myValue",
"myColumn2": 5
}
],
"count": 1,
"totalCount": 4,
"offset": 0,
"limit": 1,
"sortColumn": "myColumn1",
"sortDirection": "asc",
"dataTableId": "596e6ce831761df4231708f1",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Data Table Rows Delete
Schema for response to data table rows removal
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"removed": {
"type": "Number"
}
}
}
```
### Example
```json
{
"removed": 100
}
```
## Data Table Rows Export
Schema for the body of a data table export
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"query": {
"title": "Advanced Query",
"description": "Schema for advanced filters and queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedQuery"
},
"maxItems": 100
}
},
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"queryOptions": {
"type": "object",
"properties": {
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"limit": {
"type": "number"
},
"sortColumn": {
"type": "string"
},
"offset": {
"type": "number"
}
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"email": "email@example.com",
"query": {
"$or": [
{
"myColumn1": {
"$ne": "myValue"
}
},
{
"myColumn2": 5
}
]
},
"queryOptions": {
"limit": 10000
}
}
```
## Data Tables
Schema for a collection of Data Tables
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Data Table",
"description": "Schema for a single Data Table",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"dataTableId": {
"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
},
"columns": {
"type": "array",
"items": {
"title": "Data Table Column",
"description": "Schema for a single Data Table Column",
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"boolean"
]
},
"constraint": {
"type": "string",
"enum": [
"unique",
"required",
"optional"
]
},
"defaultValue": {
"type": [
"string",
"number",
"boolean"
]
}
},
"required": [
"name",
"dataType",
"constraint"
],
"additionalProperties": false
},
"maxItems": 50
}
}
}
},
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "596e6ce831761df4231708f1",
"dataTableId": "596e6ce831761df4231708f1",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Data Table",
"columns": [
{
"name": "myColumn1",
"dataType": "string",
"constraint": "unique"
},
{
"name": "myColumn2",
"dataType": "number",
"constraint": "optional"
}
]
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Device
Schema for a single Device
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"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
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"edgeAgentVersion": {
"type": "string",
"pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
},
"connectionInfo": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"connected": {
"enum": [
1,
0,
null
]
}
}
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"id": "575ecf887ae143cd83dc4aa2",
"deviceId": "575ecf887ae143cd83dc4aa2",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Device",
"description": "A device description",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
},
{
"key": "floor",
"value": "8"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"parentId": "5d8a0da7ce2f3d37c205d0c5",
"deviceClass": "standalone",
"connectionInfo": {
"time": "2016-06-14T08:15:00.000Z",
"connected": 1
}
}
```
## Device Class Filter
Select one or multiple device classes
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
{
"type": "array",
"items": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"additionalProperties": false
}
]
}
```
### Example
```json
[
"standalone",
"edgeCompute"
]
```
## Device Command
Schema for a command for a single Device
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"payload": {}
},
"required": [
"name"
],
"additionalProperties": false
}
```
### Example
```json
{
"time": "2016-06-13T04:00:00.000Z",
"name": "myCommand",
"payload": [
1,
1,
2,
3,
5
]
}
```
## Device Commands
Schema for an array of Device Commands
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"title": "Device Command",
"description": "Schema for a command for a single Device",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"payload": {}
},
"required": [
"name"
],
"additionalProperties": false
}
}
```
### Example
```json
[
{
"time": "2016-06-13T04:00:00.000Z",
"name": "myCommand",
"payload": [
1,
1,
2,
3,
5
]
},
{
"time": "2016-06-13T04:00:00.000Z",
"name": "myCommand",
"payload": [
1,
1,
2,
3,
5
]
}
]
```
## Device Connection Status
Schema for the body of a request to set a device's connection status
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
"title": "Device Connected",
"description": "Schema for marking a device as connected",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"connected"
]
},
"connectedAt": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"title": "Device Disconnected",
"description": "Schema for marking a device as disconnected",
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"disconnected"
]
},
"connectedAt": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"disconnectedAt": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"disconnectReason": {
"type": "string",
"maxLength": 1024
},
"messagesFromClient": {
"type": "number"
},
"messagesToClient": {
"type": "number"
}
},
"required": [
"status"
],
"additionalProperties": false
}
]
}
```
### Example
```json
{
"status": "connected"
}
```
## Device Credentials
Schema for the body of a device authentication request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"key": {
"type": "string"
},
"secret": {
"type": "string"
},
"tokenTTL": {
"type": "integer",
"minimum": 0
},
"requestedScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"all.Device",
"all.Device.read",
"data.export",
"data.timeSeriesQuery",
"data.lastValueQuery",
"device.commandStream",
"device.get",
"device.getCompositeState",
"device.getState",
"device.stateStream",
"device.getLogEntries",
"device.getCommand",
"device.debug",
"device.sendState",
"device.sendCommand",
"device.setConnectionStatus",
"devices.get",
"devices.sendCommand"
]
}
}
},
"required": [
"deviceId"
],
"additionalProperties": false
}
```
### Example
```json
{
"deviceId": "575ecf887ae143cd83dc4aa2",
"key": "this_would_be_the_key",
"secret": "this_would_be_the_secret"
}
```
## Device Log
Log of connection information for a Device
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"connected": {
"enum": [
1,
0
]
},
"time": {
"type": "string",
"format": "date-time"
},
"disconnectReason": {
"type": "string"
},
"messagesFromClient": {
"type": "number"
},
"messagesToClient": {
"type": "number"
}
}
}
}
```
### Example
```json
[
{
"connected": 1,
"time": "2016-06-03T00:56:22.447Z"
},
{
"connected": 0,
"disconnectReason": "Connection Lost",
"messagesFromClient": 2548,
"messagesToClient": 0,
"time": "2016-06-03T00:56:21.028Z"
},
{
"connected": 1,
"time": "2016-06-01T06:24:39.190Z"
},
{
"connected": 0,
"disconnectReason": "Connection Lost",
"messagesFromClient": 479,
"messagesToClient": 0,
"time": "2016-06-01T06:24:37.925Z"
},
{
"connected": 1,
"time": "2016-05-31T22:24:48.777Z"
}
]
```
## Device Patch
Schema for the body of a Device modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Device",
"description": "Description of my updated device",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
}
```
## Device Post
Schema for the body of a Device creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New Device",
"description": "Description of my new device",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
}
```
## Device Recipe
Schema for a single Device Recipe
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceRecipeId": {
"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
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceDescription": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"id": "575ecec57ae143cd83dc4a9f",
"deviceRecipeId": "575ecec57ae143cd83dc4a9f",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "Actual recipe name",
"deviceName": "Future device name",
"description": "My recipe description",
"deviceDescription": "Future device description",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
}
```
## Device Recipe Bulk Create
Schema for the result of a bulk Device creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"created": {
"type": "number"
},
"failed": {
"type": "number"
},
"csvResult": {
"type": "string"
}
}
}
```
### Example
```json
{
"created": 10,
"failed": 0,
"csvResult": "a,comma,separated,string,of,results"
}
```
## Device Recipe Bulk Create Enqueue
Schema for the result of a bulk Device creation request when creating more than 750 devices
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"jobQueued": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"jobQueued": true
}
```
## Device Recipe Bulk Create Post
Schema for the body of a bulk Device creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"nameColumn": {
"type": "string"
},
"descriptionColumn": {
"type": "string"
},
"csv": {
"type": "string"
},
"makeUniqueKeySecret": {
"type": "boolean"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"csv"
]
}
```
### Example
```json
{
"nameColumn": "myNameColumn",
"descriptionColumn": "column2",
"csv": "a,comma,separated,string,of,input,data"
}
```
## Device Recipe Patch
Schema for the body of a Device Recipe modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceDescription": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Device Recipe",
"deviceName": "Future device name",
"description": "Description of my updated device recipe",
"deviceDescription": "Future device description",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
}
```
## Device Recipe Post
Schema for the body of a Device Recipe creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceDescription": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New Device Recipe",
"deviceName": "Future device name",
"description": "Description of my new device recipe",
"deviceDescription": "Future device description",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
}
```
## Device Recipes
Schema for a collection of Device Recipes
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Device Recipe",
"description": "Schema for a single Device Recipe",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceRecipeId": {
"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
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"deviceDescription": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
}
}
},
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ecec57ae143cd83dc4a9f",
"deviceRecipeId": "575ecec57ae143cd83dc4a9f",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "Actual recipe name",
"deviceName": "Future device name",
"description": "My recipe description",
"deviceDescription": "Future device description",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Device State
Schema for a single Device state
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"meta": {},
"data": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"number",
"string",
"boolean"
]
}
},
"additionalProperties": false
},
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
### Example
```json
{
"time": "2016-06-13T04:00:00.000Z",
"data": {
"voltage": 22.4
}
}
```
## Device State or States
Schema for a single device state or an array of device states
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
"title": "Device State",
"description": "Schema for a single Device state",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"meta": {},
"data": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"number",
"string",
"boolean"
]
}
},
"additionalProperties": false
},
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"data"
],
"additionalProperties": false
},
{
"title": "Device States",
"description": "Schema for an array of Device states",
"type": "array",
"items": {
"title": "Device State",
"description": "Schema for a single Device state",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"meta": {},
"data": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"number",
"string",
"boolean"
]
}
},
"additionalProperties": false
},
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
]
}
```
### Example
```json
{
"time": "2016-06-13T04:00:00.000Z",
"data": {
"voltage": 22.4
}
}
```
## Device States
Schema for an array of Device states
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"title": "Device State",
"description": "Schema for a single Device state",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"meta": {},
"data": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"number",
"string",
"boolean"
]
}
},
"additionalProperties": false
},
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"data"
],
"additionalProperties": false
}
}
```
### Example
```json
[
{
"time": "2016-06-13T04:00:00.000Z",
"data": {
"voltage": 22.4
}
},
{
"time": "2016-06-13T04:00:00.000Z",
"data": {
"voltage": 22.4
}
}
]
```
## Device Tag Filter
Array of Tags for filtering devices. Tag keys and tag values are optional.
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
```
### Example
```json
[
{
"key": "Floor",
"value": "2"
},
{
"key": "Serial"
}
]
```
## Devices
Schema for a collection of Devices
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Device",
"description": "Schema for a single Device",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"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
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"edgeAgentVersion": {
"type": "string",
"pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
},
"connectionInfo": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"connected": {
"enum": [
1,
0,
null
]
}
}
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
}
}
},
"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}$"
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"tagFilter": {
"title": "Device Tag Filter",
"description": "Array of Tags for filtering devices. Tag keys and tag values are optional.",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"query": {
"type": "object"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ecf887ae143cd83dc4aa2",
"deviceId": "575ecf887ae143cd83dc4aa2",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Device",
"description": "A device description",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
},
{
"key": "floor",
"value": "8"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"parentId": "5d8a0da7ce2f3d37c205d0c5",
"deviceClass": "standalone",
"connectionInfo": {
"time": "2016-06-14T08:15:00.000Z",
"connected": 1
}
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Devices Data Removed
Schema for response to bulk device data removal
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"completed": {
"type": "number"
},
"notApplicable": {
"type": "number"
}
}
}
```
### Example
```json
{
"completed": 3,
"skipped": 0
}
```
## Devices Delete Post
Schema for the body of a bulk device delete request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"query": {
"title": "Advanced Device Query",
"description": "Schema for advanced device queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"name": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceClass": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"gatewayId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"parentId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"ancestorId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"attributeName": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"tags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"query"
]
}
```
### Example
```json
{
"query": {
"name": {
"$ne": "My Device"
}
},
"email": "email@example.com"
}
```
## Devices Deleted
Schema for response to devices removal
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"removed": {
"type": "number"
},
"failed": {
"type": "number"
}
}
}
```
### Example
```json
{
"removed": 3
}
```
## Devices Metadata Export Post
Schema for the body of a device metadata export request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"callbackUrl": {
"type": "string",
"maxLength": 1024
},
"query": {
"title": "Advanced Device Query",
"description": "Schema for advanced device queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"name": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceClass": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"gatewayId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"parentId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"ancestorId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"attributeName": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"tags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
```
### Example
```json
{
"query": {
"name": {
"$ne": "My Device"
}
},
"email": "email@example.com"
}
```
## Devices Patch
Schema for the body of a Devices modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"updateFields": {
"title": "Device Patch",
"description": "Schema for the body of a Device modification request",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
},
"maxItems": 100
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
},
"maxItems": 256
},
"deviceClass": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
},
"gatewayId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"systemInterval": {
"type": "integer",
"minimum": 5,
"maximum": 3600
},
"keepDuplicates": {
"type": "boolean"
}
},
"additionalProperties": false
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"query": {
"title": "Advanced Device Query",
"description": "Schema for advanced device queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"name": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceClass": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"gatewayId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"parentId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"ancestorId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"attributeName": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"tags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"updateOperations": {
"type": "array",
"maxItems": 25,
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"name"
]
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"deviceClass"
]
},
"value": {
"type": "string",
"enum": [
"standalone",
"gateway",
"peripheral",
"floating",
"edgeCompute",
"system"
]
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"description"
]
},
"value": {
"type": "string",
"maxLength": 32767
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"gatewayId",
"parentId"
]
},
"value": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"systemInterval"
]
},
"value": {
"type": "integer",
"minimum": 5,
"maximum": 3600
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"keepDuplicates"
]
},
"value": {
"type": "boolean"
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"tag"
]
},
"value": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"attributeTag"
]
},
"attributeName": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
},
"required": [
"operation",
"target",
"attributeName",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"set"
]
},
"target": {
"type": "string",
"enum": [
"attributeDescription"
]
},
"attributeName": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"maxLength": 32767
}
},
"required": [
"operation",
"target",
"attributeName",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"remove"
]
},
"target": {
"type": "string",
"enum": [
"description",
"parentId"
]
}
},
"required": [
"operation",
"target"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"remove"
]
},
"target": {
"type": "string",
"enum": [
"tag"
]
},
"tagKey": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"required": [
"operation",
"target",
"tagKey"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"remove"
]
},
"target": {
"type": "string",
"enum": [
"attribute"
]
},
"attributeName": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"required": [
"operation",
"target",
"attributeName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"remove"
]
},
"target": {
"type": "string",
"enum": [
"attributeTag"
]
},
"attributeName": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"tagKey": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"required": [
"operation",
"target",
"attributeName",
"tagKey"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"remove"
]
},
"target": {
"type": "string",
"enum": [
"attributeDescription"
]
},
"attributeName": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"required": [
"operation",
"target",
"attributeName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"add"
]
},
"target": {
"type": "string",
"enum": [
"attribute"
]
},
"value": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"operation": {
"type": "string",
"enum": [
"add"
]
},
"target": {
"type": "string",
"enum": [
"attributeSystem"
]
},
"value": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"dataType": {
"type": "string",
"enum": [
"string",
"number",
"gps",
"boolean",
"blob"
]
},
"contentType": {
"type": "string",
"maxLength": 64
},
"description": {
"type": "string",
"maxLength": 32767
},
"attributeTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"system": {
"type": "object",
"properties": {
"aggregation": {
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
"aggregationOptions": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false
},
"additionalProperties": false,
"maxItems": 0
},
"childAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"mode": {
"type": "string",
"enum": [
"all",
"whitelist",
"blacklist"
]
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [
"name",
"mode"
],
"additionalProperties": false
},
"maxItems": 256
}
},
"additionalProperties": false
}
},
"required": [
"name",
"dataType"
],
"additionalProperties": false
}
},
"required": [
"operation",
"target",
"value"
],
"additionalProperties": false
}
]
}
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"additionalProperties": false,
"required": []
}
```
### Example
```json
{
"updateFields": {
"name": "My Updated Device",
"description": "Description of my updated device",
"tags": [
{
"key": "TagKey",
"value": "TagValue"
}
],
"attributes": [
{
"name": "voltage",
"dataType": "number"
}
],
"deviceClass": "standalone"
},
"deviceIds": [
"575ecec57ae143cd83dc4a9f",
"575ecec57ae143cd83dc4a9e",
"575ecec57ae143cd83dc4a9a"
]
}
```
## Devices Remove Data Post
Schema for the body of a bulk data removal request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"query": {
"title": "Advanced Device Query",
"description": "Schema for advanced device queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"name": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceClass": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"gatewayId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"parentId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"ancestorId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"attributeName": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"tags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"start": {
"type": "number"
},
"end": {
"type": "number"
},
"attributes": {
"oneOf": [
{
"type": "null"
},
{
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"maxLength": 255
}
}
]
},
"keepConnectionHistory": {
"type": "boolean"
},
"keepCommandHistory": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"query"
]
}
```
### Example
```json
{
"query": {
"name": {
"$ne": "My Device"
}
},
"start": 1,
"end": 0,
"attributes": [
"deleteMyData",
"mineToo"
]
}
```
## Devices Updated
Schema for response of devices updated if under 100 devices queried
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"updated": {
"type": "number"
},
"failed": {
"type": "number"
},
"skipped": {
"type": "number"
},
"logLink": {
"type": "string"
}
}
}
```
### Example
```json
{
"updated": 3,
"failed": 0,
"skipped": 2,
"logLink": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon"
}
```
## Disable Two Factor Auth
Schema for the body of a request to disable two factor auth
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"twoFactorCode": {
"type": "string",
"maxLength": 2048
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 2048
}
},
"required": [
"password",
"twoFactorCode"
],
"additionalProperties": false
}
```
### Example
```json
{
"twoFactorCode": "123123",
"password": "this would be your password"
}
```
## Edge Deployment
Schema for a single deployment of an edge workflow to an edge device
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"edgeDeploymentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"flowId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"flowName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"currentVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"desiredVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"date": {
"type": "string",
"format": "date-time"
},
"changeType": {
"type": "string",
"enum": [
"current",
"desired"
]
},
"newValue": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"previousValue": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"attemptedValue": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"error": {
"type": "string"
}
}
}
}
}
}
```
### Example
```json
{
"id": "5a591be186b70d7b9f9b0954",
"edgeDeploymentId": "5a591be186b70d7b9f9b0954",
"applicationId": "575ec8687ae143cd83dc4a97",
"deviceId": "575ecf887ae143cd83dc4aa2",
"flowId": "575ed18f7ae143cd83dc4aa6",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"desiredVersion": "v1.4.0",
"currentVersion": null,
"logs": [
{
"sourceType": "user",
"sourceId": "575ed70c7ae143cd83dc4aa9",
"date": "2016-06-13T04:00:00.000Z",
"changeType": "desired",
"newValue": "v1.4.0",
"previousValue": null
}
]
}
```
## Edge Deployment Release
Schema for deploying an edge workflow to one or more edge devices
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flowId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"version": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false,
"required": [
"flowId",
"version"
]
}
```
### Example
```json
{
"flowId": "575ed18f7ae143cd83dc4aa6",
"version": "v1.2.3",
"deviceIds": [
"575ecf887ae143cd83dc4aa2"
]
}
```
## Edge Deployment Remove
Schema for removing edge deployments. Can remove a specific workflow from a specific device, can remove all workflows from a specific device, or can remove a specific workflow from all devices.
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flowId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"additionalProperties": false,
"required": [
"flowId",
"deviceId"
]
}
```
### Example
```json
{
"flowId": "575ed18f7ae143cd83dc4aa6",
"deviceId": null
}
```
## Edge Deployment Replace
Schema for replacing a deployment of a workflow version with a different workflow version
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flowId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"oldVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"newVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false,
"required": [
"flowId",
"oldVersion",
"newVersion"
]
}
```
### Example
```json
{
"flowId": "575ed18f7ae143cd83dc4aa6",
"oldVersion": "v1.2.3",
"newVersion": "v1.2.4"
}
```
## Edge Deployments
Schema for a collection of Edge Deployments
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Edge Deployment",
"description": "Schema for a single deployment of an edge workflow to an edge device",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"edgeDeploymentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"flowId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"flowName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"currentVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"desiredVersion": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"date": {
"type": "string",
"format": "date-time"
},
"changeType": {
"type": "string",
"enum": [
"current",
"desired"
]
},
"newValue": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"previousValue": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"attemptedValue": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 255
},
"error": {
"type": "string"
}
}
}
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"flowId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
```
### Example
```json
{
"items": [
{
"id": "5a591be186b70d7b9f9b0954",
"edgeDeploymentId": "5a591be186b70d7b9f9b0954",
"applicationId": "575ec8687ae143cd83dc4a97",
"deviceId": "575ecf887ae143cd83dc4aa2",
"flowId": "575ed18f7ae143cd83dc4aa6",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"desiredVersion": "v1.4.0",
"currentVersion": null,
"logs": [
{
"sourceType": "user",
"sourceId": "575ed70c7ae143cd83dc4aa9",
"date": "2016-06-13T04:00:00.000Z",
"changeType": "desired",
"newValue": "v1.4.0",
"previousValue": null
}
]
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "id",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Email Verification Verify
Schema for the body of a request verifying an email
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"token": {
"type": "string",
"minLength": 1
}
},
"required": [
"email",
"token"
],
"additionalProperties": false
}
```
### Example
```json
{
"email": "example@losant.com",
"token": "the email verification token"
}
```
## Enable Two Factor Auth
Schema for the body of a request to enable two factor auth
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"twoFactorAuthKey": {
"type": "string",
"minLength": 52,
"maxLength": 52
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 2048
}
},
"required": [
"password",
"twoFactorAuthKey"
],
"additionalProperties": false
}
```
### Example
```json
{
"twoFactorAuthKey": "HBBGWJJVOVLXS4ZGNRTDOUKTMESFUR3BMRWVQND2HJYT44TOMVJA",
"password": "this would be your password"
}
```
## Error
Schema for errors returned by the API
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
```
### Example
```json
{
"type": "NotFound",
"message": "Application was not found"
}
```
## Event
Schema for a single Event
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"eventId": {
"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"
},
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"experienceUser",
"public"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"sourceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"level": {
"type": "string",
"enum": [
"info",
"warning",
"error",
"critical"
]
},
"state": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"data": {},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"eventTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"updates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"experienceUser",
"public"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"sourceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": "string",
"maxLength": 32767
},
"data": {},
"stateChange": {
"type": "object",
"properties": {
"old": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"new": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
}
}
}
}
}
}
}
}
```
### Example
```json
{
"id": "575ed0de7ae143cd83dc4aa5",
"eventId": "575ed0de7ae143cd83dc4aa5",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"sourceType": "user",
"sourceId": "575ed70c7ae143cd83dc4aa9",
"sourceName": "hello@example.com",
"level": "info",
"state": "new",
"subject": "Power levels critical",
"message": "Power levels on device 432 have surpassed critical thresholds",
"updates": [],
"deviceId": "575ecf887ae143cd83dc4aa2",
"deviceName": "My Device",
"eventTags": {
"customKey": "customValue"
}
}
```
## Event Patch
Schema for the body of an Event modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"comment": {
"type": "string",
"maxLength": 32767
},
"data": {},
"eventTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
```
### Example
```json
{
"state": "acknowledged",
"comment": "Looking into this issue"
}
```
## Event Post
Schema for the body of an Event creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"info",
"warning",
"error",
"critical"
]
},
"state": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"data": {},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"eventTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"creationDate": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
}
},
"required": [
"level",
"subject"
],
"additionalProperties": false
}
```
### Example
```json
{
"level": "info",
"state": "new",
"subject": "Power levels critical",
"message": "Power levels on device 432 have surpassed critical thresholds",
"deviceId": "575ecf887ae143cd83dc4aa2"
}
```
## Event Tags Summary
Summary of all unique event tags and values in an application.
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"eventTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"key",
"value"
],
"additionalProperties": false
}
}
}
}
```
### Example
```json
{
"eventTags": [
{
"key": "TagKey",
"value": "TagValue"
},
{
"key": "floor",
"value": "8"
}
]
}
```
## Events
Schema for a collection of Events
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Event",
"description": "Schema for a single Event",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"eventId": {
"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"
},
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"experienceUser",
"public"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"sourceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"level": {
"type": "string",
"enum": [
"info",
"warning",
"error",
"critical"
]
},
"state": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"subject": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"message": {
"type": "string",
"maxLength": 32767
},
"data": {},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"eventTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"updates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"experienceUser",
"public"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"sourceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": "string",
"maxLength": 32767
},
"data": {},
"stateChange": {
"type": "object",
"properties": {
"old": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"new": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
}
}
}
}
}
}
}
}
},
"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",
""
]
},
"state": {
"type": "string",
"enum": [
"new",
"acknowledged",
"resolved"
]
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"query": {
"type": "object"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ed0de7ae143cd83dc4aa5",
"eventId": "575ed0de7ae143cd83dc4aa5",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"sourceType": "user",
"sourceId": "575ed70c7ae143cd83dc4aa9",
"sourceName": "hello@example.com",
"level": "info",
"state": "new",
"subject": "Power levels critical",
"message": "Power levels on device 432 have surpassed critical thresholds",
"updates": [],
"deviceId": "575ecf887ae143cd83dc4aa2",
"deviceName": "My Device",
"eventTags": {
"customKey": "customValue"
}
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "subject",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97",
"state": "new"
}
```
## Events Deleted
Schema for response to events removal
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"removed": {
"type": "Number"
}
}
}
```
### Example
```json
{
"removed": 3
}
```
## Event Export Options
Export options for events
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"query": {
"title": "Advanced Event Query",
"description": "Schema for advanced event queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedEventQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedEventQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedEventQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"sourceId": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"sourceType": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"level": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"state": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"subject": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceId": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"eventTags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
```
### Example
```json
{
"email": "email@example.com",
"query": {
"$or": [
{
"subject": {
"$ne": "myValue"
}
},
{
"level": "info"
}
]
}
}
```
## Experience Bootstrap Options
The body of an experience bootstrap request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"replaceExisting": {
"type": "boolean",
"default": false
},
"createUsers": {
"type": "boolean",
"default": true
},
"createGroups": {
"type": "boolean",
"default": true
},
"slug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"replaceExisting": true
}
```
## Experience Bootstrap Result
The result of an experience bootstrap request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"resourceSuffix": {
"type": "string"
},
"password": {
"type": "string"
},
"email": {
"type": "string"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"homePath": "/",
"password": "examplePass",
"email": "example.user@example.com"
}
```
## Experience Domain
Schema for a single Experience Domain
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceDomainId": {
"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"
},
"sslCert": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"sslBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"domainName": {
"type": "string",
"maxLength": 45,
"minLength": 3
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
```
### Example
```json
{
"id": "58c1de6c8f812590d8e82980",
"experienceDomainId": "58c1de6c8f812590d8e82980",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"domainName": "my.example.domain.com",
"version": "develop"
}
```
## Experience Domain Patch
Schema for the body of an Experience Domain modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sslKey": {
"oneOf": [
{
"type": "string",
"maxLength": 32767,
"minLength": 50
},
{
"type": "null"
}
]
},
"sslCert": {
"oneOf": [
{
"type": "string",
"maxLength": 32767,
"minLength": 50
},
{
"type": "null"
}
]
},
"sslBundle": {
"oneOf": [
{
"type": "string",
"maxLength": 32767,
"minLength": 50
},
{
"type": "null"
}
]
},
"version": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 255
},
{
"type": "null"
}
]
},
"domainName": {
"type": "string",
"maxLength": 45,
"minLength": 3
}
},
"additionalProperties": false
}
```
### Example
```json
{
"domainName": "my.example.domain.com",
"sslCert": "MY_SSL_CERTIFICATE",
"sslKey": "MY_SSL_KEY",
"version": "develop"
}
```
## Experience Domain Post
Schema for the body of an Experience Domain creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"sslKey": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"sslCert": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"sslBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"domainName": {
"type": "string",
"maxLength": 45,
"minLength": 3
},
"version": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 255
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"required": [
"domainName"
]
}
```
### Example
```json
{
"domainName": "my.example.domain.com",
"sslCert": "MY_SSL_CERTIFICATE",
"sslKey": "MY_SSL_KEY",
"version": "develop"
}
```
## Experience Domains
Schema for a collection of Experience Domains
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Experience Domain",
"description": "Schema for a single Experience Domain",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceDomainId": {
"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"
},
"sslCert": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"sslBundle": {
"type": "string",
"maxLength": 32767,
"minLength": 50
},
"domainName": {
"type": "string",
"maxLength": 45,
"minLength": 3
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "58c1de6c8f812590d8e82980",
"experienceDomainId": "58c1de6c8f812590d8e82980",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"domainName": "my.example.domain.com",
"version": "develop"
}
],
"count": 1,
"totalCount": 1,
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Experience Endpoint
Schema for a single Experience Endpoint
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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}$"
}
}
}
}
}
}
```
### Example
```json
{
"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"
}
]
}
```
## Experience Endpoint Patch
Schema for the body of an Experience Endpoint modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"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
},
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"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"
}
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"access": "group",
"experienceGroupIds": [
"58c1de6f8f812590d8e82983"
]
}
```
## Experience Endpoint Post
Schema for the body of an Experience Endpoint creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"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
},
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"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"
}
]
}
},
"additionalProperties": false,
"required": [
"route",
"method"
]
}
```
### Example
```json
{
"route": "/my/route/{id}",
"method": "get",
"access": "public"
}
```
## Experience Endpoint Stats
Schema for stats for an experience's endpoints
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"patternProperties": {
".*": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"count": {
"type": "number"
}
}
}
}
}
}
```
### Example
```json
{
"58cae95a0f5fcd000138ed0d": [
{
"time": "2017-03-21T20:00:00.000Z",
"count": 10
},
{
"time": "2017-03-21T21:00:00.000Z",
"count": 1
}
],
"NotFound": [
{
"time": "2017-03-21T20:00:00.000Z",
"count": 1
},
{
"time": "2017-03-21T21:00:00.000Z",
"count": 4
}
]
}
```
## Experience Endpoints
Schema for a collection of Experience Endpoints
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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"
}
}
}
```
### Example
```json
{
"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"
}
```
## Experience Group
Schema for a single Experience Group
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceGroupId": {
"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
},
"experienceUserIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"experienceEndpointIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"groupTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceQueryJson": {
"type": [
"string",
"null"
],
"maxLength": 8192
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
}
}
}
```
### Example
```json
{
"id": "58b9d794cbfafe1be675744f",
"experienceGroupId": "58b9d794cbfafe1be675744f",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Group",
"experienceUserIds": [
"58b9d782cbfafe1be675744d",
"58b9d787cbfafe1be675744e"
],
"experienceEndpointIds": [
"58b9d743cbfafe1be675744b",
"58b9d743cbfafe1be675744c"
]
}
```
## Experience Group Patch
Schema for the body of an Experience Group modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"experienceUserIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"experienceEndpointIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"groupTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceQueryJson": {
"type": [
"string",
"null"
],
"maxLength": 8192
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My New Group Name",
"experienceUserIds": [
"575ed70c7ae143cd83dc4aa9",
"675ed70c7ae143cd83dc4aa9"
],
"experienceEndpointIds": [
"58b9d743cbfafe1be675744b",
"58b9d743cbfafe1be675744c"
],
"parentId": "775ed70c7ae143cd83dc4aa9",
"deviceIds": [
"58b9d743cbfafe1be675744d"
],
"deviceTags": [
{
"key": "myKey",
"value": "foo"
}
]
}
```
## Experience Group Post
Schema for the body of an Experience Group creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"experienceUserIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"experienceEndpointIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"groupTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceQueryJson": {
"type": [
"string",
"null"
],
"maxLength": 8192
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My Group",
"experienceUserIds": [
"575ed70c7ae143cd83dc4aa9",
"675ed70c7ae143cd83dc4aa9"
],
"experienceEndpointIds": [
"58b9d743cbfafe1be675744b",
"58b9d743cbfafe1be675744c"
],
"deviceIds": [
"58b9d743cbfafe1be675744d"
],
"deviceTags": [
{
"key": "floor",
"value": 8
}
],
"parentId": "58b9d743cbfafe1be675744e"
}
```
## Experience Groups
Schema for a collection of Experience Groups
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Experience Group",
"description": "Schema for a single Experience Group",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceGroupId": {
"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
},
"experienceUserIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"experienceEndpointIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"groupTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceQueryJson": {
"type": [
"string",
"null"
],
"maxLength": 8192
},
"parentId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
}
}
}
},
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "58b9d794cbfafe1be675744f",
"experienceGroupId": "58b9d794cbfafe1be675744f",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Group",
"experienceUserIds": [
"58b9d782cbfafe1be675744d",
"58b9d787cbfafe1be675744e"
],
"experienceEndpointIds": [
"58b9d743cbfafe1be675744b",
"58b9d743cbfafe1be675744c"
]
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Experience Linked Resources
The body of an experience linked resources response
### 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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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
}
```
### 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": "{{data}}
",
"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"
}
}
```
## Experience Slug
Schema for a single Experience Slug
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceSlugId": {
"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"
},
"slug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
```
### Example
```json
{
"id": "5b995e51ea9994b50d745284",
"experienceSlugId": "5b995e51ea9994b50d745284",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"slug": "my-custom-slug",
"version": "develop"
}
```
## Experience Slug Patch
Schema for the body of an Experience Slug modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 255
},
{
"type": "null"
}
]
},
"slug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"slug": "my-new-slug",
"version": null
}
```
## Experience Slug Post
Schema for the body of an Experience Slug creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"oneOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 255
},
{
"type": "null"
}
]
},
"slug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
}
},
"additionalProperties": false,
"required": [
"slug"
]
}
```
### Example
```json
{
"slug": "my-custom-slug",
"version": "develop"
}
```
## Experience Slugs
Schema for a collection of Experience Slugs
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Experience Slug",
"description": "Schema for a single Experience Slug",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceSlugId": {
"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"
},
"slug": {
"type": "string",
"minLength": 4,
"maxLength": 63,
"pattern": "^[0-9a-z-]*$"
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "5b995e51ea9994b50d745284",
"experienceSlugId": "5b995e51ea9994b50d745284",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"slug": "my-custom-slug",
"version": "develop"
}
],
"count": 1,
"totalCount": 1,
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Experience User
Schema for a single Experience User
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceUserId": {
"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"
},
"passwordLastUpdated": {
"type": "string",
"format": "date-time"
},
"lastLogin": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"maxLength": 1024
},
"lastName": {
"type": "string",
"maxLength": 1024
},
"avatarUrl": {
"type": "string",
"format": "url"
},
"tokenCutoff": {
"type": "string",
"format": "date-time"
},
"userTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"experienceGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
}
}
}
```
### Example
```json
{
"id": "58b9d782cbfafe1be675744d",
"experienceUserId": "58b9d782cbfafe1be675744d",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
"lastLogin": "2016-06-13T04:00:00.000Z",
"email": "example@experienceuser.com",
"firstName": "Example",
"lastName": "Name",
"avatarUrl": "https://example.avatar.url/is_here.png",
"userTags": {
"customKey": "customValue"
}
}
```
## Experience User Patch
Schema for the body of an Experience User modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"maxLength": 1024
},
"lastName": {
"type": "string",
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 2048
},
"tokenCutoff": {
"type": "string",
"format": "date-time"
},
"userTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false
}
```
### Example
```json
{
"password": "aNewPassword",
"userTags": {
"customKey": "newCustomValue"
}
}
```
## Experience User Post
Schema for the body of an Experience User creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"maxLength": 1024
},
"lastName": {
"type": "string",
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 2048
},
"tokenCutoff": {
"type": "string",
"format": "date-time"
},
"userTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"experienceGroupIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false,
"required": [
"email",
"password"
]
}
```
### Example
```json
{
"email": "example@experienceuser.com",
"firstName": "Example",
"lastName": "Name",
"password": "aUserPassword",
"userTags": {
"customKey": "customValue"
}
}
```
## Experience Users
Schema for a collection of Experience Users
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Experience User",
"description": "Schema for a single Experience User",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceUserId": {
"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"
},
"passwordLastUpdated": {
"type": "string",
"format": "date-time"
},
"lastLogin": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"maxLength": 1024
},
"lastName": {
"type": "string",
"maxLength": 1024
},
"avatarUrl": {
"type": "string",
"format": "url"
},
"tokenCutoff": {
"type": "string",
"format": "date-time"
},
"userTags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"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"
},
"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}$"
},
"experienceGroupId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "58b9d782cbfafe1be675744d",
"experienceUserId": "58b9d782cbfafe1be675744d",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
"lastLogin": "2016-06-13T04:00:00.000Z",
"email": "example@experienceuser.com",
"firstName": "Example",
"lastName": "Name",
"avatarUrl": "https://example.avatar.url/is_here.png",
"userTags": {
"customKey": "customValue"
}
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Experience Version
Schema for a single Experience Version
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceVersionId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"createdById": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"createdByType": {
"type": "string",
"enum": [
"flow",
"user",
"apiToken"
]
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"attachedDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"domainName": {
"type": "string",
"maxLength": 45,
"minLength": 3
},
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
},
"attachedSlugs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
}
}
}
```
### Example
```json
{
"id": "5b995ec6ea9994b50d745285",
"experienceVersionId": "5b995ec6ea9994b50d745285",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"version": "myVersionName",
"endpointDefaultCors": true,
"attachedDomains": [
{
"id": "58c1de6c8f812590d8e82980",
"domainName": "my.example.domain.com"
}
],
"attachedSlugs": [
{
"id": "5b995e51ea9994b50d745284",
"slug": "my-custom-slug"
}
]
}
```
## Experience Version Patch
Schema for the body of an Experience Version modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"endpointDefaultCors": {
"type": "boolean"
},
"description": {
"type": "string",
"maxLength": 32767
},
"sourceVersionIdOrName": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
```
### Example
```json
{
"endpointDefaultCors": false
}
```
## Experience Version Post
Schema for the body of an Experience Version creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"domainIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"slugIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false,
"required": [
"version"
]
}
```
### Example
```json
{
"version": "myNewVersion",
"description": "my version description",
"domainIds": [
"58c1de6c8f812590d8e82980"
],
"slugIds": [
"5b995e51ea9994b50d745284"
]
}
```
## Experience Versions
Schema for a collection of Experience Versions
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Experience Version",
"description": "Schema for a single Experience Version",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"experienceVersionId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"createdById": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"createdByType": {
"type": "string",
"enum": [
"flow",
"user",
"apiToken"
]
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"endpointDefaultCors": {
"type": "boolean"
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"attachedDomains": {
"type": "array",
"items": {
"type": "object",
"properties": {
"domainName": {
"type": "string",
"maxLength": 45,
"minLength": 3
},
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
},
"attachedSlugs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
}
}
}
},
"count": {
"type": "integer"
},
"totalCount": {
"type": "integer"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "5b995ec6ea9994b50d745285",
"experienceVersionId": "5b995ec6ea9994b50d745285",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"version": "myVersionName",
"endpointDefaultCors": true,
"attachedDomains": [
{
"id": "58c1de6c8f812590d8e82980",
"domainName": "my.example.domain.com"
}
],
"attachedSlugs": [
{
"id": "5b995e51ea9994b50d745284",
"slug": "my-custom-slug"
}
]
}
],
"count": 1,
"totalCount": 1,
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Experience View
Schema for a single Experience View
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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
}
}
}
```
### Example
```json
{
"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": "{{data}}
",
"layoutId": "59cc5cad8246c6caed4b16c2",
"viewTags": {
"customKey": "customValue"
}
}
```
## Experience View Patch
Schema for the body of an Experience View modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"layoutId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Fa-f\\d]{24}$"
},
"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
}
},
"additionalProperties": false
}
```
### Example
```json
{
"body": "New Content! {{newData}}
",
"viewTags": {
"customKey": "newCustomValue"
}
}
```
## Experience View Post
Schema for the body of an Experience View creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"viewType": {
"type": "string",
"enum": [
"layout",
"page",
"component"
]
},
"layoutId": {
"type": [
"string",
"null"
],
"pattern": "^[A-Fa-f\\d]{24}$"
},
"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
}
},
"additionalProperties": false,
"required": [
"name",
"viewType",
"body"
]
}
```
### Example
```json
{
"name": "My Page View",
"viewType": "page",
"body": "{{data}}
",
"layoutId": "59cc5cad8246c6caed4b16c2",
"viewTags": {
"customKey": "customValue"
}
}
```
## Experience Views
Schema for a collection of Experience Views
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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"
]
}
}
}
```
### Example
```json
{
"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": "{{data}}
",
"layoutId": "59cc5cad8246c6caed4b16c2",
"viewTags": {
"customKey": "customValue"
}
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## File Schema
Schema for a single file
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"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"
},
"authorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"authorType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"notebook"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"moving",
"deleting",
"completed"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"parentDirectory": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"enum": [
"file",
"directory"
]
},
"fileSize": {
"type": "number"
},
"s3etag": {
"type": "string"
},
"contentType": {
"type": "string",
"maxLength": 1024
},
"fileDimensions": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
},
"moveIntoId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"url": {
"type": "string"
}
}
}
```
### Example
```json
{
"id": "575ec8687ae143cd83dc4a97",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"authorId": "575ed70c7ae143cd83dc4aa9",
"authorType": "user",
"status": "pending",
"name": "file.csv",
"type": "file",
"parentDirectory": "/",
"fileSize": 500,
"contentType": "text/csv"
}
```
## File Patch
Schema to patch a file
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"fileSize": {
"type": "number"
},
"contentType": {
"type": "string",
"maxLength": 1024
},
"fileDimensions": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
}
}
}
```
### Example
```json
{
"fileSize": 500,
"contentType": "image",
"fileDimensions": {
"width": 200,
"height": 200
}
}
```
## File Post
Schema to create a single file or directory
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"parentDirectory": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"enum": [
"file",
"directory"
]
},
"fileSize": {
"type": "number"
},
"contentType": {
"type": "string",
"maxLength": 1024
},
"fileDimensions": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
}
}
}
```
### Example
```json
{
"name": "file.csv",
"type": "file",
"parentDirectory": "/",
"fileSize": 500,
"contentType": "text/csv"
}
```
## File Upload Post Response
Schema to upload the file to s3
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"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"
},
"authorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"authorType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"notebook"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"moving",
"deleting",
"completed"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"parentDirectory": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"enum": [
"file",
"directory"
]
},
"fileSize": {
"type": "number"
},
"contentType": {
"type": "string",
"maxLength": 1024
},
"fileDimensions": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
},
"upload": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"fields": {
"type": "object",
"patternProperties": {
"^.*$": {
"type": "string"
}
},
"properties": {
"key": {
"type": "string"
},
"bucket": {
"type": "string"
}
}
}
}
}
}
}
```
### Example
```json
{
"id": "575ec8687ae143cd83dc4a97",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"authorId": "575ed70c7ae143cd83dc4aa9",
"authorType": "user",
"status": "pending",
"name": "file.csv",
"type": "file",
"parentDirectory": "/",
"fileSize": 500,
"contentType": "text/csv",
"upload": {
"url": "https://s3.us-west-1.amazonaws.com/a-bucket-on-amazon",
"fields": {
"key": "5630dcbe1035c9d0011/file.js",
"bucket": "a-bucket-on-amazon",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "AKIAJPGQGBQX4PYM6FXA/20180416/us-west-1/s3/aws4_request",
"X-Amz-Date": "20180416T142402Z",
"Policy": "wMloiLCJjb25kaXRpb25zIjpbeyJrZXkiOiI1NjMwZGNiZTEwM2Y4ZTQ4NWM5ZDAwMTEvZmlsZS5qcyJ9LHsiYnVja2V0IjoibG9zYW50LWZpbGVzIn0seyJYLUFtei1BbGdvcml0aG0iOiJBV1M0LUhNQUMtU0hBMjU2In0seyJYLUFtei1DcmVkZW50aWFsIjoiQUtJQUpQR1FHQlFYNFBZTTZGWEEvMjAxODA0MTYvdXMtd2VzdC0xL3MzL2F3czRfcmVxdWVzdCJ9LHsiWC1BbXotRGF0ZSI6IjIwMTgwNDE2VDE0MjQwMloifV19",
"X-Amz-Signature": "a4a411df572c43b4427ff08ef51763bc2d834fa399c3688f347d936370"
}
}
}
```
## Files Schema
Schema for a collection of files
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "File Schema",
"description": "Schema for a single file",
"type": "object",
"properties": {
"id": {
"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"
},
"authorId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"authorType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"notebook"
]
},
"status": {
"type": "string",
"enum": [
"pending",
"moving",
"deleting",
"completed"
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"parentDirectory": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"enum": [
"file",
"directory"
]
},
"fileSize": {
"type": "number"
},
"s3etag": {
"type": "string"
},
"contentType": {
"type": "string",
"maxLength": 1024
},
"fileDimensions": {
"type": "object",
"properties": {
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
},
"moveIntoId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"url": {
"type": "string"
}
}
}
},
"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",
""
]
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ec8687ae143cd83dc4a97",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"authorId": "575ed70c7ae143cd83dc4aa9",
"authorType": "user",
"status": "pending",
"name": "file.csv",
"type": "file",
"parentDirectory": "/",
"fileSize": 500,
"contentType": "text/csv"
},
{
"id": "575ec8687ae143cd83dc4a96",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"authorId": "575ed70c7ae143cd83dc4aa9",
"authorType": "user",
"status": "completed",
"name": "b",
"type": "directory",
"parentDirectory": "/a/",
"fileSize": 500,
"contentType": "text/csv"
}
],
"count": 2
}
```
## Workflow
Schema for a single Workflow
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
}
}
}
}
}
}
}
}
}
```
### Example
```json
{
"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
}
}
```
## Workflow Errors
Workflow run error information
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"flowVersionId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"limit": {
"type": "number"
},
"sortDirection": {
"type": "string",
"enum": [
"asc",
"desc",
"ASC",
"DESC",
""
]
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"flowVersionId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"nodeId": {
"type": "string"
},
"nodeLabel": {
"type": "string"
},
"error": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
```
### Example
```json
{
"start": "2016-06-03T00:00:00.000Z",
"end": "2016-06-04T00:00:00.000Z",
"limit": 25,
"sortDirection": "desc",
"errors": [
{
"time": "2016-06-03T00:00:00.000Z",
"nodeId": "dji4r",
"error": {
"name": "Validation",
"message": "Result path is required"
}
}
]
}
```
## Workflow Log
Log of aggregated workflow run information
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"flowVersionId": {
"type": "string"
},
"time": {
"type": "string",
"format": "date-time"
},
"pathsFailed": {
"type": "number"
},
"pathsCompleted": {
"type": "number"
},
"runCount": {
"type": "number"
},
"wallTime": {
"type": "number"
},
"errors": {
"type": "array",
"items": {}
}
}
}
}
```
### Example
```json
[
{
"flowVersionId": "develop",
"time": "2016-06-03T00:56:22.447Z",
"pathsFailed": 0,
"pathsCompleted": 1,
"runCount": 1,
"wallTime": 450,
"errors": []
},
{
"flowVersionId": "develop",
"time": "2016-06-03T00:56:22.447Z",
"pathsFailed": 0,
"pathsCompleted": 1,
"runCount": 3,
"wallTime": 152,
"errors": []
}
]
```
## Workflow Patch
Schema for the body of a Workflow modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"iconData": {
"oneOf": [
{
"type": "string",
"maxLength": 32767,
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"defaultVersionId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"triggers": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"enum": [
"customNodeStart",
"deviceCommand",
"deviceIdConnect",
"deviceTagConnect",
"deviceIdDisconnect",
"deviceTagDisconnect",
"integration",
"notebook",
"onBoot",
"onConnect",
"onDisconnect",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Workflow",
"description": "Description of my updated workflow",
"enabled": false
}
```
## Workflow Post
Schema for the body of a Workflow creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"iconData": {
"oneOf": [
{
"type": "string",
"maxLength": 32767,
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
},
{
"type": "null"
}
]
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
]
}
},
"flowClass": {
"type": "string",
"enum": [
"cloud",
"edge",
"experience",
"customNode"
]
},
"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"
]
},
"customNodeSupports": {
"type": "array",
"items": {
"type": "string",
"enum": [
"cloud"
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New Workflow",
"description": "Description of my new workflow"
}
```
## Workflow Statistics
Statistics about the runs for a given workflow
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"flowVersionId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"resolution": {
"type": "number"
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"pathsFailed": {
"type": "number"
},
"pathsCompleted": {
"type": "number"
},
"runCount": {
"type": "number"
},
"wallTime": {
"type": "number"
}
}
}
}
}
}
```
### Example
```json
{
"start": "2016-06-03T00:00:00.000Z",
"end": "2016-06-04T00:00:00.000Z",
"resolution": 86400000,
"metrics": [
{
"time": "2016-06-03T00:00:00.000Z",
"pathsFailed": 0,
"pathsCompleted": 1,
"runCount": 1,
"wallTime": 450
}
]
}
```
## Workflow Storage Entries
Set of persistent workflow storage values
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"patternProperties": {
"^.{1,255}$": {}
}
}
```
### Example
```json
{
"myStorageKey": "hello",
"other key": [
13,
21,
34
]
}
```
## Workflow Storage Entry
Schema for the body of a request to set a Workflow storage entry
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"key": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"value": {}
},
"additionalProperties": false,
"required": [
"key"
]
}
```
### Example
```json
{
"key": "myStorageKey",
"value": 12
}
```
## Workflow Trigger Filter
Array of triggers for filtering workflows. Trigger keys and trigger types are optional.
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"maxLength": 1024
}
},
"additionalProperties": false
},
"maxItems": 100
}
```
### Example
```json
[
{
"type": "webhook",
"key": "575ed78e7ae143cd83dc4aab"
}
]
```
## Workflow Version
Schema for a single Workflow Version
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
}
}
}
}
}
}
}
}
}
]
}
```
### Example
```json
{
"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": []
}
```
## Workflow Version Patch
Schema for the body of a Workflow Version modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"notes": {
"type": "string",
"maxLength": 32767
},
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"notes": "Updated workflow version notes",
"enabled": false
}
```
## Workflow Version Post
Schema for the body of a Workflow Version creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
]
}
},
"additionalProperties": false,
"required": [
"version"
]
}
```
### Example
```json
{
"version": "v1.2.3",
"notes": "Notes about my new workflow version",
"enabled": false
}
```
## Workflow Versions
Schema for a collection of Workflow Versions
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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}$"
}
}
}
```
### Example
```json
{
"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"
}
```
## Workflows
Schema for a collection of Workflows
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
]
}
}
}
```
### Example
```json
{
"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"
}
```
## Workflows Import Post
Schema for the body of a workflow import request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flows": {
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"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"
},
"triggers": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"key": {
"type": "string",
"maxLength": 1024
},
"type": {
"type": "string",
"enum": [
"customNodeStart",
"deviceCommand",
"deviceIdConnect",
"deviceTagConnect",
"deviceIdDisconnect",
"deviceTagDisconnect",
"integration",
"notebook",
"onBoot",
"onConnect",
"onDisconnect",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
]
}
},
"flowClass": {
"type": "string",
"enum": [
"cloud",
"edge",
"experience",
"customNode"
]
},
"defaultVersionId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"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"
]
},
"customNodeSupports": {
"type": "array",
"items": {
"type": "string",
"enum": [
"cloud"
]
}
}
},
"additionalProperties": {
"type": "string",
"maxLength": 1024
},
"required": [
"name"
]
}
},
"flowVersions": {
"maxItems": 1000,
"type": "array",
"items": {
"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}$"
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
]
}
},
"additionalProperties": {
"type": "string",
"maxLength": 1024
},
"required": [
"version"
]
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"flows": [
{
"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
}
}
],
"flowVersions": []
}
```
## Workflow Import Result
Schema for the result of a workflow import request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"flows": {
"maxItems": 1000,
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
}
}
}
}
}
}
}
}
}
},
"flowVersions": {
"maxItems": 1000,
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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",
"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": [
"mqttTopic"
]
},
"config": {
"type": "object",
"properties": {
"integrationId": {
"type": "string",
"enum": [
"losant",
"local"
]
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"trigger"
]
},
"name": {
"type": "string",
"enum": [
"mqtt"
]
},
"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": [
"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"
},
"dataBits": {
"type": "number"
},
"stopBits": {
"type": "number"
},
"parity": {
"type": "string",
"maxLength": 8
},
"rtscts": {
"type": "boolean"
},
"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"
}
}
}
}
}
}
}
}
}
]
}
},
"importedFlowIdMap": {
"type": "object",
"patternProperties": {
"^[A-Fa-f\\d]{24}$": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"importedVersionIdMap": {
"type": "object",
"patternProperties": {
"^[A-Fa-f\\d]{24}$": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
}
}
```
### Example
```json
{
"flows": [
{
"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
}
}
],
"flowVersions": [],
"importedFlowIdMap": {
"575ed18f7ae143cd83dc4aa6": "575efbcc7ae143cd83dc4aae"
},
"importedVersionIdMap": {}
}
```
## Github Login
Schema for the body of a Github login request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"requestedScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"all.Application",
"all.Application.read",
"all.Device",
"all.Device.read",
"application.*",
"applicationApiToken.*",
"applicationApiTokens.*",
"applicationCertificate.*",
"applicationCertificates.*",
"applicationCertificateAuthority.*",
"applicationCertificateAuthorities.*",
"applicationKey.*",
"applicationKeys.*",
"data.*",
"dataTable.*",
"dataTables.*",
"dataTableRow.*",
"dataTableRows.*",
"device.*",
"deviceRecipe.*",
"deviceRecipes.*",
"devices.*",
"edgeDeployments.*",
"event.*",
"events.*",
"experience.*",
"experienceDomain.*",
"experienceDomains.*",
"experienceEndpoint.*",
"experienceEndpoints.*",
"experienceGroup.*",
"experienceGroups.*",
"experienceSlug.*",
"experienceSlugs.*",
"experienceUser.*",
"experienceUsers.*",
"experienceVersion.*",
"experienceVersions.*",
"experienceView.*",
"experienceViews.*",
"integration.*",
"integrations.*",
"file.*",
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
"notebook.*",
"notebooks.*",
"webhook.*",
"webhooks.*",
"application.applyTemplate",
"application.archiveData",
"application.backfillArchiveData",
"application.clone",
"application.export",
"application.import",
"application.fullEventsArchive",
"application.fullDataTablesArchive",
"application.debug",
"application.delete",
"application.get",
"application.mqttPublishMessage",
"application.mqttSubscriptionStream",
"application.patch",
"application.payloadCounts",
"application.search",
"applicationApiToken.delete",
"applicationApiToken.get",
"applicationApiToken.patch",
"applicationApiTokens.get",
"applicationApiTokens.post",
"applicationCertificate.delete",
"applicationCertificate.get",
"applicationCertificate.patch",
"applicationCertificates.get",
"applicationCertificates.post",
"applicationCertificateAuthority.delete",
"applicationCertificateAuthority.get",
"applicationCertificateAuthority.patch",
"applicationCertificateAuthorities.get",
"applicationCertificateAuthorities.post",
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
"data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
"dataTable.patch",
"dataTable.removeColumn",
"dataTableRow.delete",
"dataTableRow.get",
"dataTableRow.patch",
"dataTableRows.get",
"dataTableRows.post",
"dataTableRows.query",
"dataTableRows.export",
"dataTableRows.delete",
"dataTableRows.truncate",
"dataTables.get",
"dataTables.post",
"device.commandStream",
"device.debug",
"device.delete",
"device.export",
"device.get",
"device.getCommand",
"device.getCompositeState",
"device.getLogEntries",
"device.getState",
"device.patch",
"device.removeData",
"device.sendCommand",
"device.sendState",
"device.setConnectionStatus",
"device.stateStream",
"deviceRecipe.bulkCreate",
"deviceRecipe.delete",
"deviceRecipe.get",
"deviceRecipe.patch",
"deviceRecipes.get",
"deviceRecipes.post",
"devices.patch",
"devices.delete",
"devices.removeData",
"devices.detailedSummary",
"devices.export",
"devices.get",
"devices.post",
"devices.sendCommand",
"edgeDeployments.get",
"edgeDeployments.release",
"edgeDeployments.remove",
"edgeDeployments.replace",
"event.delete",
"event.get",
"event.patch",
"events.delete",
"events.get",
"events.mostRecentBySeverity",
"events.patch",
"events.post",
"events.export",
"experience.delete",
"experience.bootstrap",
"experienceDomain.delete",
"experienceDomain.get",
"experienceDomain.patch",
"experienceDomains.get",
"experienceDomains.post",
"experienceEndpoint.delete",
"experienceEndpoint.get",
"experienceEndpoint.linkedResources",
"experienceEndpoint.patch",
"experienceEndpoints.get",
"experienceEndpoints.post",
"experienceEndpoints.stats",
"experienceGroup.delete",
"experienceGroup.get",
"experienceGroup.patch",
"experienceGroups.detailedSummary",
"experienceGroups.get",
"experienceGroups.post",
"experienceSlug.delete",
"experienceSlug.get",
"experienceSlug.patch",
"experienceSlugs.get",
"experienceSlugs.post",
"experienceUser.delete",
"experienceUser.get",
"experienceUser.patch",
"experienceUsers.detailedSummary",
"experienceUsers.get",
"experienceUsers.post",
"experienceVersion.delete",
"experienceVersion.get",
"experienceVersion.patch",
"experienceVersions.get",
"experienceVersions.post",
"experienceView.debug",
"experienceView.delete",
"experienceView.get",
"experienceView.linkedResources",
"experienceView.patch",
"experienceViews.debug",
"experienceViews.detailedSummary",
"experienceViews.get",
"experienceViews.post",
"file.get",
"file.patch",
"file.move",
"file.delete",
"file.upload",
"files.get",
"files.post",
"flow.clearStorageEntries",
"flow.debug",
"flow.delete",
"flow.errors",
"flow.get",
"flow.getStorageEntries",
"flow.log",
"flow.patch",
"flow.pressVirtualButton",
"flow.setStorageEntry",
"flow.stats",
"flows.get",
"flows.getByVersion",
"flows.import",
"flows.post",
"flowVersion.delete",
"flowVersion.errors",
"flowVersion.get",
"flowVersion.log",
"flowVersion.patch",
"flowVersion.stats",
"flowVersions.get",
"flowVersions.post",
"integration.delete",
"integration.get",
"integration.patch",
"integrations.get",
"integrations.post",
"notebook.delete",
"notebook.execute",
"notebook.get",
"notebook.logs",
"notebook.patch",
"notebook.requestInputDataExport",
"notebook.upload",
"notebooks.get",
"notebooks.post",
"webhook.delete",
"webhook.get",
"webhook.patch",
"webhooks.get",
"webhooks.post"
]
},
{
"type": "string",
"enum": [
"all.Organization",
"all.Organization.read",
"applications.*",
"auditLog.*",
"auditLogs.*",
"dashboard.*",
"dashboards.*",
"org.*",
"applications.get",
"applications.post",
"applications.import",
"applications.detailedSummary",
"auditLog.get",
"auditLogs.get",
"dashboard.patch",
"dashboard.delete",
"dashboard.sendReport",
"dashboards.get",
"dashboards.post",
"org.get",
"org.patch",
"org.delete",
"org.pendingInvites",
"org.inviteMember",
"org.revokeInvite",
"org.modifyMember",
"org.removeMember",
"org.payloadCounts",
"org.invoices",
"org.currentCard",
"org.chargeDetails",
"org.transferResources"
]
}
]
},
{
"type": "string",
"enum": [
"all.User",
"all.User.read",
"applicationTemplate.*",
"applicationTemplate.get",
"applicationTemplates.*",
"applicationTemplates.get",
"applicationTemplates.getCategories",
"applicationTemplates.getUniqueKeywords",
"me.*",
"orgs.*",
"me.get",
"me.patch",
"me.delete",
"me.verifyEmail",
"me.changePassword",
"me.enableTwoFactorAuth",
"me.disableTwoFactorAuth",
"me.disconnectGithub",
"me.connectGithub",
"me.addRecentItem",
"me.fetchRecentItems",
"me.payloadCounts",
"me.transferResources",
"orgs.get",
"orgs.post"
]
}
]
}
},
"tokenTTL": {
"type": "integer",
"minimum": 0
}
},
"required": [
"accessToken"
],
"additionalProperties": false
}
```
### Example
```json
{
"accessToken": "the github access token"
}
```
## Integration
Schema for a single Integration
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"integrationId": {
"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": 1024
},
"integrationType": {
"type": "string",
"enum": [
"googlePubSub",
"meridian",
"mqtt",
"particle"
]
},
"enabled": {
"type": "boolean"
},
"topics": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"googlePubSubConfig": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"projectId",
"keyJson"
]
},
"mqttConfig": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"username": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"clean": {
"type": "boolean"
},
"port": {
"type": "number",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"type": "string",
"enum": [
"mqtt",
"mqtts",
"ws",
"wss"
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"privateKey": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"certificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"caCertificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"port",
"protocol",
"host"
]
},
"particleConfig": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"productSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"orgSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"deviceNameOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"accessToken"
]
},
"meridianConfig": {
"type": "object",
"properties": {
"authenticationToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"locationId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"assetUpdates": {
"type": "boolean"
},
"zoneUpdates": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"authenticationToken",
"locationId"
]
},
"status": {
"lastKeepAlive": {
"type": [
"number"
]
},
"nextAttempt": {
"type": [
"number"
]
},
"connectInfo": {
"type": "object",
"properties": {
"ts": {
"type": [
"number",
"null"
]
}
}
},
"disconnectInfo": {
"type": "object",
"properties": {
"ts": {
"type": [
"number",
"null"
]
},
"error": {
"type": "string"
}
}
}
}
}
}
```
### Example
```json
{
"id": "58ec07f20c747f65243d0d76",
"integrationId": "58ec07f20c747f65243d0d76",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "Example Integrations",
"integrationType": "mqtt",
"enabled": true,
"topics": [
"myTopic"
],
"mqttConfig": {
"clientId": "exampleClientId",
"username": "exampleUsername",
"password": "examplePassword",
"port": 8883,
"protocol": "mqtts",
"host": "broker.example.com"
},
"status": {
"lastKeepAlive": 1491863679994,
"connectInfo": {
"ts": 1490629589313
},
"disconnectInfo": {
"ts": 1490629587190,
"error": "Keepalive Timeout"
}
}
}
```
## Integration Patch
Schema for the body of an Integration modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"integrationType": {
"type": "string",
"enum": [
"googlePubSub",
"meridian",
"mqtt",
"particle"
]
},
"enabled": {
"type": "boolean"
},
"topics": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"googlePubSubConfig": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"projectId",
"keyJson"
]
},
"mqttConfig": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"username": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"clean": {
"type": "boolean"
},
"port": {
"type": "number",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"type": "string",
"enum": [
"mqtt",
"mqtts",
"ws",
"wss"
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"privateKey": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"certificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"caCertificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"port",
"protocol",
"host"
]
},
"particleConfig": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"productSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"orgSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"deviceNameOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"accessToken"
]
},
"meridianConfig": {
"type": "object",
"properties": {
"authenticationToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"locationId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"assetUpdates": {
"type": "boolean"
},
"zoneUpdates": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"authenticationToken",
"locationId"
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"topics": [
"differentTopic"
]
}
```
## Integration Post
Schema for the body of an Integration creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"integrationType": {
"type": "string",
"enum": [
"googlePubSub",
"meridian",
"mqtt",
"particle"
]
},
"enabled": {
"type": "boolean"
},
"topics": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"googlePubSubConfig": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"projectId",
"keyJson"
]
},
"mqttConfig": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"username": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"clean": {
"type": "boolean"
},
"port": {
"type": "number",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"type": "string",
"enum": [
"mqtt",
"mqtts",
"ws",
"wss"
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"privateKey": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"certificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"caCertificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"port",
"protocol",
"host"
]
},
"particleConfig": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"productSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"orgSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"deviceNameOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"accessToken"
]
},
"meridianConfig": {
"type": "object",
"properties": {
"authenticationToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"locationId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"assetUpdates": {
"type": "boolean"
},
"zoneUpdates": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"authenticationToken",
"locationId"
]
}
},
"additionalProperties": false,
"required": [
"name",
"integrationType"
]
}
```
### Example
```json
{
"name": "Example Integrations",
"integrationType": "mqtt",
"topics": [
"myTopic"
],
"mqttConfig": {
"clientId": "exampleClientId",
"username": "exampleUsername",
"password": "examplePassword",
"port": 8883,
"protocol": "mqtts",
"host": "broker.example.com"
}
}
```
## Integrations
Schema for a collection of Integrations
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Integration",
"description": "Schema for a single Integration",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"integrationId": {
"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": 1024
},
"integrationType": {
"type": "string",
"enum": [
"googlePubSub",
"meridian",
"mqtt",
"particle"
]
},
"enabled": {
"type": "boolean"
},
"topics": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"googlePubSubConfig": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"keyJson": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"projectId",
"keyJson"
]
},
"mqttConfig": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"username": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"clean": {
"type": "boolean"
},
"port": {
"type": "number",
"minimum": 1,
"maximum": 65535
},
"protocol": {
"type": "string",
"enum": [
"mqtt",
"mqtts",
"ws",
"wss"
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"privateKey": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"certificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
},
"caCertificate": {
"type": "string",
"maxLength": 32767,
"minLength": 4
}
},
"additionalProperties": false,
"required": [
"port",
"protocol",
"host"
]
},
"particleConfig": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"productSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"orgSlugOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"deviceNameOrId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"additionalProperties": false,
"required": [
"accessToken"
]
},
"meridianConfig": {
"type": "object",
"properties": {
"authenticationToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"locationId": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"assetUpdates": {
"type": "boolean"
},
"zoneUpdates": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"authenticationToken",
"locationId"
]
},
"status": {
"lastKeepAlive": {
"type": [
"number"
]
},
"nextAttempt": {
"type": [
"number"
]
},
"connectInfo": {
"type": "object",
"properties": {
"ts": {
"type": [
"number",
"null"
]
}
}
},
"disconnectInfo": {
"type": "object",
"properties": {
"ts": {
"type": [
"number",
"null"
]
},
"error": {
"type": "string"
}
}
}
}
}
}
},
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "58ec07f20c747f65243d0d76",
"integrationId": "58ec07f20c747f65243d0d76",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "Example Integrations",
"integrationType": "mqtt",
"enabled": true,
"topics": [
"myTopic"
],
"mqttConfig": {
"clientId": "exampleClientId",
"username": "exampleUsername",
"password": "examplePassword",
"port": 8883,
"protocol": "mqtts",
"host": "broker.example.com"
},
"status": {
"lastKeepAlive": 1491863679994,
"connectInfo": {
"ts": 1490629589313
},
"disconnectInfo": {
"ts": 1490629587190,
"error": "Keepalive Timeout"
}
}
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Job Enqueued API Result
Schema for the result of an job being queued
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"jobQueued": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"jobQueued": true
}
```
## Last Value Data
Schema for the result of a last value query
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"patternProperties": {
"^[A-Fa-f\\d]{24}$": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"data": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"number",
"string",
"boolean"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"data",
"time"
]
}
},
"additionalProperties": false
}
```
### Example
```json
{
"575ecf887ae143cd83dc4aa2": {
"time": "2016-06-13T04:00:00.000Z",
"data": {
"voltage": 12
}
},
"575ef5c97ae143cd83dc4aac": {
"time": "2016-06-12T08:30:00.000Z",
"data": {
"voltage": 19
}
}
}
```
## Last Value Query
Schema for the body of a last value query request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"attribute": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
}
},
"additionalProperties": false
}
```
### Example
```json
{
"deviceIds": [
"575ecf887ae143cd83dc4aa2",
"575ef5c97ae143cd83dc4aac"
],
"attribute": "voltage"
}
```
## Me
Schema for information about the currently authenticated user
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"userId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"creationDate": {
"type": "string",
"format": "date-time"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"passwordLastUpdated": {
"type": "string",
"format": "date-time"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"companyName": {
"type": "string",
"maxLength": 1024
},
"title": {
"type": "string",
"maxLength": 1024
},
"phoneNumber": {
"type": "string",
"maxLength": 1024
},
"location": {
"type": "string",
"maxLength": 1024
},
"url": {
"type": "string",
"maxLength": 1024
},
"tokenCutoff": {
"type": "string",
"format": "date-time"
},
"emailVerified": {
"type": "boolean"
},
"twoFactorAuthEnabled": {
"type": "boolean"
},
"fullName": {
"type": "string"
},
"githubName": {
"type": "string"
},
"avatarUrl": {
"type": "string",
"format": "url"
},
"limits": {
"apitoken": {
"type": "number"
},
"application": {
"type": "number"
},
"applicationkey": {
"type": "number"
},
"dashboard": {
"type": "number"
},
"datatable": {
"type": "number"
},
"device": {
"type": "number"
},
"devicerecipe": {
"type": "number"
},
"experiencedomain": {
"type": "number"
},
"experienceendpoint": {
"type": "number"
},
"experiencegroup": {
"type": "number"
},
"experienceslug": {
"type": "number"
},
"experienceuser": {
"type": "number"
},
"experienceversion": {
"type": "number"
},
"experienceview": {
"type": "number"
},
"file": {
"type": "number"
},
"flow": {
"type": "number"
},
"integration": {
"type": "number"
},
"notebook": {
"type": "number"
},
"webhook": {
"type": "number"
},
"dataTTL": {
"type": "number"
},
"payload": {
"type": "number"
},
"notebookMinutesPerRun": {
"type": "number"
},
"notebookMinutesPerMonth": {
"type": "number"
},
"notebookInParallel": {
"type": "number"
}
},
"recentDashboards": {
"title": "Recent Item List",
"description": "Schema for an array of recent items",
"type": "object",
"properties": {
"itemType": {
"type": "string",
"enum": [
"application",
"device",
"flow",
"dashboard",
"organization"
]
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
}
}
},
"recentApplications": {
"title": "Recent Item List",
"description": "Schema for an array of recent items",
"type": "object",
"properties": {
"itemType": {
"type": "string",
"enum": [
"application",
"device",
"flow",
"dashboard",
"organization"
]
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
}
}
},
"recentOrganizations": {
"title": "Recent Item List",
"description": "Schema for an array of recent items",
"type": "object",
"properties": {
"itemType": {
"type": "string",
"enum": [
"application",
"device",
"flow",
"dashboard",
"organization"
]
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
}
}
},
"summary": {
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
"appCount": {
"type": "number"
},
"dashCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceSlugCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"keyCount": {
"type": "number"
},
"orgCount": {
"type": "number"
},
"payloadCount": {
"title": "Payload Counts",
"description": "Schema for the result of a payload count request",
"type": "object",
"properties": {
"mqttOut": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"mqttIn": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"dataTable": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceState": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceCommand": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"webhook": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"timer": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"event": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"virtualButton": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceConnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceDisconnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"endpoint": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"integration": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
}
}
},
"storageStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"size": {
"type": "number"
}
}
},
"webhookCount": {
"type": "number"
}
}
},
"currentPeriodStart": {
"type": "string",
"format": "date-time"
},
"currentPeriodEnd": {
"type": "string",
"format": "date-time"
},
"ssoLinked": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"id": "575ed70c7ae143cd83dc4aa9",
"userId": "575ed70c7ae143cd83dc4aa9",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
"email": "example@losant.com",
"firstName": "Example",
"lastName": "Name",
"companyName": "Losant IoT, Inc.",
"url": "https://www.losant.com",
"emailVerified": true,
"twoFactorAuthEnabled": false,
"fullName": "Example Name",
"summary": {
"appCount": 8,
"dashCount": 5,
"orgCount": 2,
"deviceCount": 12,
"flowCount": 3,
"webhookCount": 0,
"keyCount": 2,
"deviceRecipeCount": 0
},
"ssoLinked": false
}
```
## Me Patch
Schema for the body of request to modify the current user
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"companyName": {
"type": "string",
"maxLength": 1024
},
"title": {
"type": "string",
"maxLength": 1024
},
"phoneNumber": {
"type": "string",
"maxLength": 1024
},
"location": {
"type": "string",
"maxLength": 1024
},
"url": {
"type": "string",
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 2048,
"pattern": "^(?=.*[A-Z])(?=.*[^A-z0-9])(?=.*[0-9])(?=.*[a-z]).{12,}$"
},
"tokenCutoff": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"email": "example@losant.com",
"firstName": "Example",
"lastName": "Name",
"companyName": "Losant IoT, Inc.",
"url": "https://www.losant.com",
"password": "my new password"
}
```
## MQTT Publish Body
Schema for the body an MQTT Publish Message request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"topic": {
"type": "string",
"minLength": 1,
"maxLength": 230
},
"message": {
"type": "string",
"maxLength": 32767
}
},
"required": [
"topic",
"message"
],
"additionalProperties": false
}
```
### Example
```json
{
"topic": "an/mqtt/topic",
"message": "The MQTT message!"
}
```
## Multi Device Command
Schema for the body of a request to send a command to multiple Devices
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"time": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"payload": {},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"deviceQuery": {
"title": "Advanced Device Query",
"description": "Schema for advanced device queries",
"type": "object",
"properties": {
"$and": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$or": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"$nor": {
"type": "array",
"items": {
"$ref": "#/definitions/advancedDeviceQuery"
},
"maxItems": 100
},
"id": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"creationDate": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"lastUpdated": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"name": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"deviceClass": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"gatewayId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"parentId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"ancestorId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"attributeName": {
"oneOf": [
{
"type": [
"string",
"number",
"boolean",
"null"
]
},
{
"type": "object",
"properties": {
"$eq": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$ne": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lt": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$gte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$lte": {
"type": [
"string",
"number",
"boolean",
"null"
]
},
"$startsWith": {
"type": "string",
"minLength": 1
},
"$endsWith": {
"type": "string",
"minLength": 1
},
"$contains": {
"type": "string",
"minLength": 1
},
"$ci": {
"type": "boolean"
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": [
"string",
"number",
"boolean"
]
}
}
},
"additionalProperties": false
}
]
},
"experienceUserId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"experienceGroupId": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$ne": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "null"
}
]
},
"$in": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"$nin": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
},
"additionalProperties": false,
"minProperties": 1,
"maxProperties": 1
}
]
},
"tags": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
},
{
"type": "object",
"properties": {
"$eq": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$eq"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"$ne": {
"oneOf": [
{
"type": "object",
"properties": {
"$tagKey": {
"type": "string",
"maxLength": 255
},
"$tagValue": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false,
"minProperties": 1
},
{
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
]
}
},
"required": [
"$ne"
],
"additionalProperties": false
}
]
}
},
"additionalProperties": false
}
},
"required": [
"name"
],
"additionalProperties": false
}
```
### Example
```json
{
"time": "2016-06-13T04:00:00.000Z",
"name": "myCommand",
"payload": [
1,
1,
2,
3,
5
],
"deviceTags": [
{
"key": "floor",
"value": 8
}
]
}
```
## Notebook
Schema for a single Notebook
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"notebookId": {
"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": 1024
},
"description": {
"type": "string",
"maxLength": 32767
},
"jupyterFileName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"jupyterFileUrl": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceData"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"attributes": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceConnectionHistory"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceMetadata"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"eventData"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"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
}
},
"required": [
"inputType",
"fileName",
"sourceUrl"
],
"additionalProperties": false
}
]
}
},
"outputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"createMissingColumns": {
"type": "boolean"
},
"truncateExistingTable": {
"type": "boolean"
}
},
"required": [
"fileName",
"outputType",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"file"
]
},
"fileName": {
"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
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType",
"destinationFileNameTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"directory"
]
},
"directoryName": {
"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
}
},
"required": [
"directoryName",
"outputType",
"destinationDirectoryTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"executionResult"
]
},
"fileName": {
"type": "string",
"enum": [
"result.html",
"result.pdf",
"result.ipynb",
"result.error.log",
"result.log"
]
},
"destinationDirectoryTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType"
],
"additionalProperties": false
}
]
}
}
}
}
```
### Example
```json
{
"id": "5c782b8d4f3a8e51c1db42e4",
"notebookId": "5c782b8d4f3a8e51c1db42e4",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "Example Notebook",
"jupyterFileName": "myNotebook.ipynb",
"jupyterFileUrl": "https://mystoragedomain.com/myNotebook.ipynb",
"inputs": [
{
"fileName": "deviceDataWithAttributes",
"inputType": "deviceData",
"attributes": [
"aNumber"
],
"deviceIds": [
"5c926894a111ea00063978ac"
],
"deviceTags": [],
"start": -10368000000,
"end": 0
},
{
"fileName": "dataTableWithQuery",
"inputType": "dataTable",
"dataTableId": "5c91584211126400069179c1",
"queryJson": "{\n \"$or\": [\n {\n \"createdAt\": {\n \"$gt\": \"12345\"\n }\n }\n ]\n}"
},
{
"fileName": "deviceMetaData",
"inputType": "deviceMetadata",
"deviceIds": [
"5c926894a111ea00063978ac"
],
"deviceTags": [
{
"key": "aTag",
"value": "and value"
}
]
},
{
"fileName": "deviceDataAllAttributes",
"inputType": "deviceData",
"attributes": [],
"deviceIds": [],
"deviceTags": [
{
"value": "and value"
}
],
"start": -43200000,
"end": 0
},
{
"fileName": "anExternalUrl",
"inputType": "externalUrl",
"sourceUrl": "https://foo.com"
}
],
"outputs": [
{
"fileName": "result.html",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.html"
},
{
"fileName": "result.pdf",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.pdf"
},
{
"fileName": "result.ipynb",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.ipynb"
},
{
"fileName": "result.error.log",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.error.log"
},
{
"fileName": "result.log",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.log"
},
{
"fileName": "myDataTableFile.csv",
"outputType": "dataTable",
"dataTableId": "5c925132a111ea00063978a7",
"createMissingColumns": true,
"truncateExistingTable": false
},
{
"fileName": "myDataTableFileTwo.csv",
"outputType": "dataTable",
"dataTableId": "5c91584211126400069179c1",
"createMissingColumns": false,
"truncateExistingTable": true
},
{
"fileName": "myApplicationFile.png",
"outputType": "file",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "myApplicationFile.png"
},
{
"directoryName": "myApplicationFolder",
"outputType": "directory",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}"
}
]
}
```
## Notebook Data Export Options
Schema for the options for a Notebook data export request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"relativeTo": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"templateContext": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
```
### Example
```json
{
"email": "user@example.com"
}
```
## Notebook Execution Logs
Schema for a set of Notebook execution logs
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"notebookExecutionId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"notebookId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"applicationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"status": {
"type": "string",
"enum": [
"queued",
"inProgress",
"completed",
"errored",
"timeout"
]
},
"executionRelativeTo": {
"type": "string",
"format": "date-time"
},
"maxAllowedRunMinutes": {
"type": "number"
},
"sourceType": {
"type": "string",
"enum": [
"flow",
"user",
"device",
"apiToken",
"notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"runQueuedAt": {
"type": "string",
"format": "date-time"
},
"runStartedAt": {
"type": "string",
"format": "date-time"
},
"inputsCompletedAt": {
"type": "string",
"format": "date-time"
},
"notebookCompletedAt": {
"type": "string",
"format": "date-time"
},
"outputsCompletedAt": {
"type": "string",
"format": "date-time"
},
"templateContext": {
"type": "string",
"maxLength": 32767
},
"inputInfo": {
"type": "object",
"patternProperties": {
".*": {
"type": "object",
"properties": {
"size": {
"type": "number"
},
"url": {
"type": "string"
}
}
}
}
},
"outputInfo": {
"type": "object",
"patternProperties": {
".*": {
"type": "object",
"properties": {
"size": {
"type": "number"
},
"url": {
"type": "string"
},
"contentType": {
"type": "string"
}
}
}
}
},
"executionErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
```
### Example
```json
[
{
"id": "5c7d3f9cd32c87a49f04c260",
"notebookExecutionId": "5c7d3f9cd32c87a49f04c260",
"notebookId": "5c782b8d4f3a8e51c1db42e4",
"applicationId": "575ec8687ae143cd83dc4a97",
"runStartedAt": "2016-06-13T04:00:00.000Z",
"runQueuedAt": "2016-06-13T03:59:00.000Z",
"sourceId": "575ed70c7ae143cd83dc4aa9",
"sourceType": "user",
"status": "inProgress",
"maxAllowedRunMinutes": 5,
"inputInfo": {},
"outputInfo": {},
"executionErrors": []
}
]
```
## Notebook Execution Options
Schema for the options for a Notebook execution request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"relativeTo": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"$date": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"$date"
]
}
]
},
"templateContext": {
"type": "string",
"maxLength": 32767
}
},
"additionalProperties": false
}
```
### Example
```json
{
"relativeTo": 1570549199451
}
```
## Notebook Patch
Schema for the body of a Notebook modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"description": {
"type": "string",
"maxLength": 32767
},
"inputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceData"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"attributes": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceConnectionHistory"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceMetadata"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"eventData"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"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
}
},
"required": [
"inputType",
"fileName",
"sourceUrl"
],
"additionalProperties": false
}
]
}
},
"outputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"createMissingColumns": {
"type": "boolean"
},
"truncateExistingTable": {
"type": "boolean"
}
},
"required": [
"fileName",
"outputType",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"file"
]
},
"fileName": {
"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
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType",
"destinationFileNameTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"directory"
]
},
"directoryName": {
"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
}
},
"required": [
"directoryName",
"outputType",
"destinationDirectoryTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"executionResult"
]
},
"fileName": {
"type": "string",
"enum": [
"result.html",
"result.pdf",
"result.ipynb",
"result.error.log",
"result.log"
]
},
"destinationDirectoryTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "New Notebook Name"
}
```
## Notebook Post
Schema for the body of an Notebook creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"description": {
"type": "string",
"maxLength": 32767
},
"inputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceData"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"attributes": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceConnectionHistory"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceMetadata"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"eventData"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"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
}
},
"required": [
"inputType",
"fileName",
"sourceUrl"
],
"additionalProperties": false
}
]
}
},
"outputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"createMissingColumns": {
"type": "boolean"
},
"truncateExistingTable": {
"type": "boolean"
}
},
"required": [
"fileName",
"outputType",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"file"
]
},
"fileName": {
"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
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType",
"destinationFileNameTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"directory"
]
},
"directoryName": {
"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
}
},
"required": [
"directoryName",
"outputType",
"destinationDirectoryTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"executionResult"
]
},
"fileName": {
"type": "string",
"enum": [
"result.html",
"result.pdf",
"result.ipynb",
"result.error.log",
"result.log"
]
},
"destinationDirectoryTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType"
],
"additionalProperties": false
}
]
}
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "Example Notebook"
}
```
## Notebooks
Schema for a collection of Notebooks
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Notebook",
"description": "Schema for a single Notebook",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"notebookId": {
"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": 1024
},
"description": {
"type": "string",
"maxLength": 32767
},
"jupyterFileName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"jupyterFileUrl": {
"type": "string"
},
"inputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceData"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"attributes": {
"type": "array",
"maxItems": 100,
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceConnectionHistory"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
},
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"inputType",
"fileName",
"start",
"end"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"deviceMetadata"
]
},
"fileName": {
"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": {
"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
}
},
"deviceIds": {
"type": "array",
"maxItems": 100,
"items": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
}
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"inputType",
"fileName",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"inputType": {
"type": "string",
"enum": [
"eventData"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"queryJson": {
"type": "string",
"maxLength": 8192
}
},
"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
}
},
"required": [
"inputType",
"fileName",
"sourceUrl"
],
"additionalProperties": false
}
]
}
},
"outputs": {
"type": "array",
"items": {
"maxItems": 100,
"oneOf": [
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"dataTable"
]
},
"fileName": {
"oneOf": [
{
"type": "string",
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"dataTableId": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string",
"minLength": 4,
"maxLength": 255,
"pattern": ".*{{.+}}.*"
}
]
},
"createMissingColumns": {
"type": "boolean"
},
"truncateExistingTable": {
"type": "boolean"
}
},
"required": [
"fileName",
"outputType",
"dataTableId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"file"
]
},
"fileName": {
"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
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType",
"destinationFileNameTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"directory"
]
},
"directoryName": {
"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
}
},
"required": [
"directoryName",
"outputType",
"destinationDirectoryTemplate"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"outputType": {
"type": "string",
"enum": [
"executionResult"
]
},
"fileName": {
"type": "string",
"enum": [
"result.html",
"result.pdf",
"result.ipynb",
"result.error.log",
"result.log"
]
},
"destinationDirectoryTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"destinationFileNameTemplate": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"fileName",
"outputType"
],
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "5c782b8d4f3a8e51c1db42e4",
"notebookId": "5c782b8d4f3a8e51c1db42e4",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "Example Notebook",
"jupyterFileName": "myNotebook.ipynb",
"jupyterFileUrl": "https://mystoragedomain.com/myNotebook.ipynb",
"inputs": [
{
"fileName": "deviceDataWithAttributes",
"inputType": "deviceData",
"attributes": [
"aNumber"
],
"deviceIds": [
"5c926894a111ea00063978ac"
],
"deviceTags": [],
"start": -10368000000,
"end": 0
},
{
"fileName": "dataTableWithQuery",
"inputType": "dataTable",
"dataTableId": "5c91584211126400069179c1",
"queryJson": "{\n \"$or\": [\n {\n \"createdAt\": {\n \"$gt\": \"12345\"\n }\n }\n ]\n}"
},
{
"fileName": "deviceMetaData",
"inputType": "deviceMetadata",
"deviceIds": [
"5c926894a111ea00063978ac"
],
"deviceTags": [
{
"key": "aTag",
"value": "and value"
}
]
},
{
"fileName": "deviceDataAllAttributes",
"inputType": "deviceData",
"attributes": [],
"deviceIds": [],
"deviceTags": [
{
"value": "and value"
}
],
"start": -43200000,
"end": 0
},
{
"fileName": "anExternalUrl",
"inputType": "externalUrl",
"sourceUrl": "https://foo.com"
}
],
"outputs": [
{
"fileName": "result.html",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.html"
},
{
"fileName": "result.pdf",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.pdf"
},
{
"fileName": "result.ipynb",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.ipynb"
},
{
"fileName": "result.error.log",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.error.log"
},
{
"fileName": "result.log",
"outputType": "executionResult",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "result.log"
},
{
"fileName": "myDataTableFile.csv",
"outputType": "dataTable",
"dataTableId": "5c925132a111ea00063978a7",
"createMissingColumns": true,
"truncateExistingTable": false
},
{
"fileName": "myDataTableFileTwo.csv",
"outputType": "dataTable",
"dataTableId": "5c91584211126400069179c1",
"createMissingColumns": false,
"truncateExistingTable": true
},
{
"fileName": "myApplicationFile.png",
"outputType": "file",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
"destinationFileNameTemplate": "myApplicationFile.png"
},
{
"directoryName": "myApplicationFolder",
"outputType": "directory",
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}"
}
]
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```
## Organization
Schema for a single Organization
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"orgId": {
"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
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"avatarUrl": {
"type": "string",
"format": "url"
},
"role": {
"type": "string",
"enum": [
"admin",
"edit",
"collaborate",
"view",
"none"
]
},
"applicationRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"dashboardRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
}
}
}
},
"limits": {
"apitoken": {
"type": "number"
},
"application": {
"type": "number"
},
"applicationkey": {
"type": "number"
},
"dashboard": {
"type": "number"
},
"datatable": {
"type": "number"
},
"device": {
"type": "number"
},
"devicerecipe": {
"type": "number"
},
"experiencedomain": {
"type": "number"
},
"experienceendpoint": {
"type": "number"
},
"experiencegroup": {
"type": "number"
},
"experienceslug": {
"type": "number"
},
"experienceuser": {
"type": "number"
},
"experienceversion": {
"type": "number"
},
"experienceview": {
"type": "number"
},
"file": {
"type": "number"
},
"flow": {
"type": "number"
},
"integration": {
"type": "number"
},
"notebook": {
"type": "number"
},
"webhook": {
"type": "number"
},
"dataTTL": {
"type": "number"
},
"member": {
"type": "number"
},
"payload": {
"type": "number"
},
"notebookMinutesPerRun": {
"type": "number"
},
"notebookMinutesPerMonth": {
"type": "number"
},
"notebookInParallel": {
"type": "number"
}
},
"summary": {
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
"appCount": {
"type": "number"
},
"dashCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"experienceDomainCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceSlugCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"keyCount": {
"type": "number"
},
"memberCount": {
"type": "number"
},
"payloadCount": {
"title": "Payload Counts",
"description": "Schema for the result of a payload count request",
"type": "object",
"properties": {
"mqttOut": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"mqttIn": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"dataTable": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceState": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceCommand": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"webhook": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"timer": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"event": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"virtualButton": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceConnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceDisconnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"endpoint": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"integration": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
}
}
},
"pendingInviteCount": {
"type": "number"
},
"storageStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"size": {
"type": "number"
}
}
},
"webhookCount": {
"type": "number"
}
}
},
"planId": {
"type": "string",
"maxLength": 1024
},
"billingEmail": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"subscriptionStatus": {
"type": "string",
"enum": [
"trialing",
"active",
"past_due",
"canceled",
"unpaid"
]
},
"currentPeriodStart": {
"type": "string",
"format": "date-time"
},
"currentPeriodEnd": {
"type": "string",
"format": "date-time"
},
"isEnterprise": {
"type": "boolean"
},
"iconColor": {
"type": "string",
"maxLength": 64
},
"whitelistedEmailDomains": {
"type": "array",
"items": {
"type": "string",
"maxLength": 45,
"minLength": 3
}
}
}
}
```
### Example
```json
{
"id": "575ed6e87ae143cd83dc4aa8",
"orgId": "575ed6e87ae143cd83dc4aa8",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Organization",
"description": "My organization description",
"members": [
{
"userId": "575ed70c7ae143cd83dc4aa9",
"firstName": "Example",
"lastName": "Name",
"email": "example@losant.com",
"role": "admin"
},
{
"userId": "575ef90f7ae143cd83dc4aad",
"firstName": "Other View",
"lastName": "Only User",
"email": "viewer@losant.com",
"role": "view"
}
],
"summary": {
"appCount": 2,
"dashCount": 1,
"deviceCount": 12,
"flowCount": 3,
"webhookCount": 0,
"keyCount": 2,
"deviceRecipeCount": 0
}
}
```
## Organization Invitation Action
Schema for the body of a request to accept or reject an invitation
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"token": {
"type": "string",
"minLength": 1
},
"accept": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"email",
"token",
"accept"
]
}
```
### Example
```json
{
"email": "invitedUser@losant.com",
"token": "the_invitation_token",
"accept": true
}
```
## Organization Invitation Information
Schema for information about an invitation
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"orgName": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"role": {
"type": "string",
"enum": [
"admin",
"edit",
"collaborate",
"view",
"none"
]
},
"inviteDate": {
"type": "string",
"format": "date-time"
},
"ttl": {
"type": "number"
},
"disallowTransfer": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"orgName": "My Organization",
"email": "invitedUser@losant.com",
"role": "edit",
"inviteDate": "2016-05-13T04:00:00.000Z",
"ttl": 4233600000,
"disallowTransfer": true
}
```
## Organization Invitation Post
Schema for the body of a request to send an invitation
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"role": {
"type": "string",
"enum": [
"admin",
"edit",
"collaborate",
"view",
"none"
]
},
"applicationRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"dashboardRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"disallowTransfer": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"email",
"role"
]
}
```
### Example
```json
{
"email": "invitedUser@losant.com",
"role": "edit"
}
```
## Organization Invitation Result
Schema for the result of accepting/rejecting an invitation
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"accepted": {
"type": "boolean"
},
"orgId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
}
}
```
### Example
```json
{
"accepted": true,
"orgId": "575ed6e87ae143cd83dc4aa8"
}
```
## Organization Invitations
Schema for an array of pending invitations to an Organization
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"role": {
"type": "string",
"enum": [
"admin",
"edit",
"collaborate",
"view",
"none"
]
},
"applicationRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"dashboardRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"inviteDate": {
"type": "string",
"format": "date-time"
},
"ttl": {
"type": "number"
},
"hasExpired": {
"type": "boolean"
},
"disallowTransfer": {
"type": "boolean"
}
}
}
}
```
### Example
```json
[
{
"id": "575ed71e7ae143cd83dc4aaa",
"email": "invitedUser@losant.com",
"role": "edit",
"applicationRoles": [
{
"resourceId": "575ec8687ae143cd83dc4a97",
"role": "view"
}
],
"dashboardRoles": [
{
"resourceId": "575ece2b7ae143cd83dc4a9b",
"role": "none"
}
],
"inviteDate": "2016-05-13T04:00:00.000Z",
"ttl": 4233600000,
"hasExpired": true,
"disallowTransfer": false
}
]
```
## Organization Member Patch
Schema for the body of a request to modify an Organization member
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"userId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"admin",
"edit",
"collaborate",
"view",
"none"
]
},
"applicationRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"dashboardRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
}
},
"additionalProperties": false,
"required": [
"userId"
]
}
```
### Example
```json
{
"userId": "575ef90f7ae143cd83dc4aad",
"role": "view"
}
```
## Organization Patch
Schema for the body of an Organization modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"planId": {
"type": "string",
"maxLength": 1024
},
"billingEmail": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"cardToken": {
"type": "string",
"maxLength": 1024
},
"iconColor": {
"type": "string",
"maxLength": 64
},
"whitelistedEmailDomains": {
"type": "array",
"maxItems": 25,
"items": {
"type": "string",
"maxLength": 45,
"minLength": 3
}
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Organization",
"description": "Description of my updated organization"
}
```
## Organization Post
Schema for the body of an Organization creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"planId": {
"type": "string",
"maxLength": 1024
},
"billingEmail": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"cardToken": {
"type": "string",
"maxLength": 1024
},
"iconColor": {
"type": "string",
"maxLength": 64
}
},
"additionalProperties": false,
"required": [
"name"
]
}
```
### Example
```json
{
"name": "My New Organization",
"description": "Description of my new organization"
}
```
## Organizations
Schema for a collection of Organizations
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Organization",
"description": "Schema for a single Organization",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"orgId": {
"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
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"avatarUrl": {
"type": "string",
"format": "url"
},
"role": {
"type": "string",
"enum": [
"admin",
"edit",
"collaborate",
"view",
"none"
]
},
"applicationRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
},
"dashboardRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"role": {
"type": "string",
"enum": [
"collaborate",
"view",
"none"
]
}
},
"required": [
"resourceId",
"role"
],
"additionalProperties": false
},
"maxItems": 1000
}
}
}
},
"limits": {
"apitoken": {
"type": "number"
},
"application": {
"type": "number"
},
"applicationkey": {
"type": "number"
},
"dashboard": {
"type": "number"
},
"datatable": {
"type": "number"
},
"device": {
"type": "number"
},
"devicerecipe": {
"type": "number"
},
"experiencedomain": {
"type": "number"
},
"experienceendpoint": {
"type": "number"
},
"experiencegroup": {
"type": "number"
},
"experienceslug": {
"type": "number"
},
"experienceuser": {
"type": "number"
},
"experienceversion": {
"type": "number"
},
"experienceview": {
"type": "number"
},
"file": {
"type": "number"
},
"flow": {
"type": "number"
},
"integration": {
"type": "number"
},
"notebook": {
"type": "number"
},
"webhook": {
"type": "number"
},
"dataTTL": {
"type": "number"
},
"member": {
"type": "number"
},
"payload": {
"type": "number"
},
"notebookMinutesPerRun": {
"type": "number"
},
"notebookMinutesPerMonth": {
"type": "number"
},
"notebookInParallel": {
"type": "number"
}
},
"summary": {
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
"appCount": {
"type": "number"
},
"dashCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
"experienceDomainCount": {
"type": "number"
},
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
},
"experienceSlugCount": {
"type": "number"
},
"experienceUserCount": {
"type": "number"
},
"experienceVersionCount": {
"type": "number"
},
"experienceViewCount": {
"type": "number"
},
"fileCount": {
"type": "number"
},
"flowCount": {
"type": "number"
},
"integrationCount": {
"type": "number"
},
"keyCount": {
"type": "number"
},
"memberCount": {
"type": "number"
},
"payloadCount": {
"title": "Payload Counts",
"description": "Schema for the result of a payload count request",
"type": "object",
"properties": {
"mqttOut": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"mqttIn": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"dataTable": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceState": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceCommand": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"webhook": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"timer": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"event": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"virtualButton": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceConnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceDisconnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"endpoint": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"integration": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
}
}
},
"pendingInviteCount": {
"type": "number"
},
"storageStats": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"size": {
"type": "number"
}
}
},
"webhookCount": {
"type": "number"
}
}
},
"planId": {
"type": "string",
"maxLength": 1024
},
"billingEmail": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"subscriptionStatus": {
"type": "string",
"enum": [
"trialing",
"active",
"past_due",
"canceled",
"unpaid"
]
},
"currentPeriodStart": {
"type": "string",
"format": "date-time"
},
"currentPeriodEnd": {
"type": "string",
"format": "date-time"
},
"isEnterprise": {
"type": "boolean"
},
"iconColor": {
"type": "string",
"maxLength": 64
},
"whitelistedEmailDomains": {
"type": "array",
"items": {
"type": "string",
"maxLength": 45,
"minLength": 3
}
}
}
}
},
"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",
""
]
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ed6e87ae143cd83dc4aa8",
"orgId": "575ed6e87ae143cd83dc4aa8",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Organization",
"description": "My organization description",
"members": [
{
"userId": "575ed70c7ae143cd83dc4aa9",
"firstName": "Example",
"lastName": "Name",
"email": "example@losant.com",
"role": "admin"
},
{
"userId": "575ef90f7ae143cd83dc4aad",
"firstName": "Other View",
"lastName": "Only User",
"email": "viewer@losant.com",
"role": "view"
}
],
"summary": {
"appCount": 2,
"dashCount": 1,
"deviceCount": 12,
"flowCount": 3,
"webhookCount": 0,
"keyCount": 2,
"deviceRecipeCount": 0
}
}
],
"count": 1,
"totalCount": 2,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc"
}
```
## Password Reset Finish
Schema for the body of a request to complete the reset password flow
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 2048,
"pattern": "^(?=.*[A-Z])(?=.*[^A-z0-9])(?=.*[0-9])(?=.*[a-z]).{12,}$"
}
},
"required": [
"token",
"email",
"password"
],
"additionalProperties": false
}
```
### Example
```json
{
"token": "the_password_reset_token",
"email": "example@losant.com",
"password": "the new password"
}
```
## Password Reset Input
Schema for the body of a request to start the reset password flow
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
}
},
"required": [
"email"
],
"additionalProperties": false
}
```
### Example
```json
{
"email": "example@losant.com"
}
```
## Password Reset Response
Schema for result of a successful password reset
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"accountIsLocked": {
"type": "boolean"
},
"twoFactorAuthEnabled": {
"type": "boolean"
}
}
}
```
### Example
```json
{
"success": true,
"accountIsLocked": false,
"twoFactorAuthEnabled": false
}
```
## Payload Counts
Schema for the result of a payload count request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"mqttOut": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"mqttIn": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"dataTable": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceState": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceCommand": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"webhook": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"timer": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"event": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"virtualButton": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceConnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"deviceDisconnect": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"endpoint": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
},
"integration": {
"type": "object",
"patternProperties": {
".*": {
"type": "number"
}
}
}
}
}
```
### Example
```json
{
"timer": {
"timer.flow": 19772
},
"deviceState": {
"flow.flow": 5215,
"device.mqtt": 1244049
},
"mqttOut": {
"device.mqtt": 12
},
"webhook": {
"public.rest": 1713284
},
"deviceConnect": {
"device.mqtt": 1016
},
"deviceDisconnect": {
"device.mqtt": 1016
}
}
```
## Recent Item
Schema for the body of a request to add a recent item
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"itemType": {
"type": "string",
"enum": [
"application",
"device",
"flow",
"dashboard",
"organization"
]
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"itemId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"required": [
"itemType",
"itemId"
]
}
```
### Example
```json
{
"itemType": "device",
"parentId": "575ec8687ae143cd83dc4a97",
"itemId": "575ecf887ae143cd83dc4aa2"
}
```
## Recent Item List
Schema for an array of recent items
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"itemType": {
"type": "string",
"enum": [
"application",
"device",
"flow",
"dashboard",
"organization"
]
},
"parentId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
}
}
}
```
### Example
```json
{
"itemType": "application",
"items": [
{
"id": "575ec8687ae143cd83dc4a97",
"name": "My Application"
},
{
"id": "575efbcc7ae143cd83dc4aae",
"name": "My Other Application"
}
]
}
```
## Resource Transfer
Schema for the body of a resource transfer request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"destinationId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"destinationType": {
"type": "string",
"enum": [
"user",
"organization"
]
},
"applicationIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"dashboardIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"strict": {
"type": "boolean"
}
},
"additionalProperties": false,
"required": [
"destinationId",
"destinationType"
]
}
```
### Example
```json
{
"destinationId": "575ed6e87ae143cd83dc4aa8",
"destinationType": "organization",
"applicationIds": [
"575ec8687ae143cd83dc4a97"
]
}
```
## SAML Response
SAML Response body for login
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"SAMLResponse": {
"type": "string",
"minLength": 4,
"maxLength": 100000
},
"SAMLDomain": {
"type": "string",
"maxLength": 45,
"minLength": 3
}
},
"required": [
"SAMLResponse",
"SAMLDomain"
],
"additionalProperties": false
}
```
### Example
```json
{
"SAMLResponse": "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoy...",
"SAMLDomain": "losant.com"
}
```
## SSO Request
SSO Request built from the SP and IDP config
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ssoType": {
"type": "string",
"enum": [
"SAML"
]
},
"ssoRequest": {
"type": "string",
"maxLength": 32767
}
},
"required": [
"ssoType",
"ssoRequest"
]
}
```
### Example
```json
{
"ssoType": "SAML",
"ssoRequest": "http://localhost:8080/simplesaml/saml2/idp/SSOService.php?SAMLRequest=fZJdT8MgFIb%2..."
}
```
## Success
Schema for reporting a successful operation
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
}
}
}
```
### Example
```json
{
"success": true
}
```
## Template Keywords
Schema for a collection of template keywords
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"keywords": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"maxItems": 100
}
},
"additionalProperties": false
}
```
### Example
```json
{
"keywords": [
"gps",
"featured"
]
}
```
## Time Series Data
Schema for the result of a time series query
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"resolution": {
"type": "number"
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"devices": {
"type": "object",
"patternProperties": {
"^[A-Fa-f\\d]{24}$": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"points": {
"type": "array",
"items": {
"type": "object",
"properties": {
"time": {
"type": "string",
"format": "date-time"
},
"data": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": [
"number",
"string",
"boolean"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"data",
"time"
]
}
}
},
"additionalProperties": false,
"required": [
"name",
"points"
]
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"start",
"end",
"resolution",
"aggregation",
"devices"
]
}
```
### Example
```json
{
"start": "2016-06-15T03:50:00.000Z",
"end": "2016-06-15T04:00:00.000Z",
"resolution": 300000,
"aggregation": "MEAN",
"devices": {
"575ecf887ae143cd83dc4aa2": {
"name": "My Device",
"points": [
{
"time": "2016-06-15T03:50:00.000Z",
"data": {
"voltage": 10.3
}
},
{
"time": "2016-06-15T03:55:00.000Z",
"data": {
"voltage": 12.7
}
}
]
},
"575ef5c97ae143cd83dc4aac": {
"name": "My Other Device",
"points": [
{
"time": "2016-06-15T03:50:00.000Z",
"data": {
"voltage": 10.3
}
},
{
"time": "2016-06-15T03:55:00.000Z",
"data": {
"voltage": 12.7
}
}
]
}
}
}
```
## Time Series Query
Schema for the body of a time series query request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
},
"duration": {
"type": "number"
},
"resolution": {
"type": "number"
},
"aggregation": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"FIRST",
"LAST",
"COUNT",
"MAX",
"MIN",
"MEDIAN",
"MEAN",
"SUM",
"STD_DEV"
]
},
{
"type": "string",
"enum": [
"NONE"
]
}
]
},
"options": {
"type": "object",
"additionalProperties": false
}
},
"additionalProperties": false,
"required": [
"type"
]
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"TIMEATVALUE"
]
},
"options": {
"type": "object",
"properties": {
"value": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"additionalProperties": false,
"required": [
"value"
]
}
},
"additionalProperties": false,
"required": [
"type",
"options"
]
}
]
},
"attributes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
}
},
"deviceTags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
},
"maxItems": 100
},
"deviceIds": {
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"maxItems": 1000
},
"limit": {
"type": "number"
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "asc"
}
},
"additionalProperties": false
}
```
### Example
```json
{
"end": 0,
"duration": 600000,
"resolution": 300000,
"aggregation": "MEAN",
"attributes": [
"voltage"
],
"deviceTags": [
{
"key": "floor",
"value": "8"
}
]
}
```
## User Credentials
Schema for the body of a User authentication request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"password": {
"type": "string",
"minLength": 8,
"maxLength": 2048
},
"twoFactorCode": {
"type": "string",
"maxLength": 2048
},
"requestedScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"all.Application",
"all.Application.read",
"all.Device",
"all.Device.read",
"application.*",
"applicationApiToken.*",
"applicationApiTokens.*",
"applicationCertificate.*",
"applicationCertificates.*",
"applicationCertificateAuthority.*",
"applicationCertificateAuthorities.*",
"applicationKey.*",
"applicationKeys.*",
"data.*",
"dataTable.*",
"dataTables.*",
"dataTableRow.*",
"dataTableRows.*",
"device.*",
"deviceRecipe.*",
"deviceRecipes.*",
"devices.*",
"edgeDeployments.*",
"event.*",
"events.*",
"experience.*",
"experienceDomain.*",
"experienceDomains.*",
"experienceEndpoint.*",
"experienceEndpoints.*",
"experienceGroup.*",
"experienceGroups.*",
"experienceSlug.*",
"experienceSlugs.*",
"experienceUser.*",
"experienceUsers.*",
"experienceVersion.*",
"experienceVersions.*",
"experienceView.*",
"experienceViews.*",
"integration.*",
"integrations.*",
"file.*",
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
"notebook.*",
"notebooks.*",
"webhook.*",
"webhooks.*",
"application.applyTemplate",
"application.archiveData",
"application.backfillArchiveData",
"application.clone",
"application.export",
"application.import",
"application.fullEventsArchive",
"application.fullDataTablesArchive",
"application.debug",
"application.delete",
"application.get",
"application.mqttPublishMessage",
"application.mqttSubscriptionStream",
"application.patch",
"application.payloadCounts",
"application.search",
"applicationApiToken.delete",
"applicationApiToken.get",
"applicationApiToken.patch",
"applicationApiTokens.get",
"applicationApiTokens.post",
"applicationCertificate.delete",
"applicationCertificate.get",
"applicationCertificate.patch",
"applicationCertificates.get",
"applicationCertificates.post",
"applicationCertificateAuthority.delete",
"applicationCertificateAuthority.get",
"applicationCertificateAuthority.patch",
"applicationCertificateAuthorities.get",
"applicationCertificateAuthorities.post",
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
"data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
"dataTable.patch",
"dataTable.removeColumn",
"dataTableRow.delete",
"dataTableRow.get",
"dataTableRow.patch",
"dataTableRows.get",
"dataTableRows.post",
"dataTableRows.query",
"dataTableRows.export",
"dataTableRows.delete",
"dataTableRows.truncate",
"dataTables.get",
"dataTables.post",
"device.commandStream",
"device.debug",
"device.delete",
"device.export",
"device.get",
"device.getCommand",
"device.getCompositeState",
"device.getLogEntries",
"device.getState",
"device.patch",
"device.removeData",
"device.sendCommand",
"device.sendState",
"device.setConnectionStatus",
"device.stateStream",
"deviceRecipe.bulkCreate",
"deviceRecipe.delete",
"deviceRecipe.get",
"deviceRecipe.patch",
"deviceRecipes.get",
"deviceRecipes.post",
"devices.patch",
"devices.delete",
"devices.removeData",
"devices.detailedSummary",
"devices.export",
"devices.get",
"devices.post",
"devices.sendCommand",
"edgeDeployments.get",
"edgeDeployments.release",
"edgeDeployments.remove",
"edgeDeployments.replace",
"event.delete",
"event.get",
"event.patch",
"events.delete",
"events.get",
"events.mostRecentBySeverity",
"events.patch",
"events.post",
"events.export",
"experience.delete",
"experience.bootstrap",
"experienceDomain.delete",
"experienceDomain.get",
"experienceDomain.patch",
"experienceDomains.get",
"experienceDomains.post",
"experienceEndpoint.delete",
"experienceEndpoint.get",
"experienceEndpoint.linkedResources",
"experienceEndpoint.patch",
"experienceEndpoints.get",
"experienceEndpoints.post",
"experienceEndpoints.stats",
"experienceGroup.delete",
"experienceGroup.get",
"experienceGroup.patch",
"experienceGroups.detailedSummary",
"experienceGroups.get",
"experienceGroups.post",
"experienceSlug.delete",
"experienceSlug.get",
"experienceSlug.patch",
"experienceSlugs.get",
"experienceSlugs.post",
"experienceUser.delete",
"experienceUser.get",
"experienceUser.patch",
"experienceUsers.detailedSummary",
"experienceUsers.get",
"experienceUsers.post",
"experienceVersion.delete",
"experienceVersion.get",
"experienceVersion.patch",
"experienceVersions.get",
"experienceVersions.post",
"experienceView.debug",
"experienceView.delete",
"experienceView.get",
"experienceView.linkedResources",
"experienceView.patch",
"experienceViews.debug",
"experienceViews.detailedSummary",
"experienceViews.get",
"experienceViews.post",
"file.get",
"file.patch",
"file.move",
"file.delete",
"file.upload",
"files.get",
"files.post",
"flow.clearStorageEntries",
"flow.debug",
"flow.delete",
"flow.errors",
"flow.get",
"flow.getStorageEntries",
"flow.log",
"flow.patch",
"flow.pressVirtualButton",
"flow.setStorageEntry",
"flow.stats",
"flows.get",
"flows.getByVersion",
"flows.import",
"flows.post",
"flowVersion.delete",
"flowVersion.errors",
"flowVersion.get",
"flowVersion.log",
"flowVersion.patch",
"flowVersion.stats",
"flowVersions.get",
"flowVersions.post",
"integration.delete",
"integration.get",
"integration.patch",
"integrations.get",
"integrations.post",
"notebook.delete",
"notebook.execute",
"notebook.get",
"notebook.logs",
"notebook.patch",
"notebook.requestInputDataExport",
"notebook.upload",
"notebooks.get",
"notebooks.post",
"webhook.delete",
"webhook.get",
"webhook.patch",
"webhooks.get",
"webhooks.post"
]
},
{
"type": "string",
"enum": [
"all.Organization",
"all.Organization.read",
"applications.*",
"auditLog.*",
"auditLogs.*",
"dashboard.*",
"dashboards.*",
"org.*",
"applications.get",
"applications.post",
"applications.import",
"applications.detailedSummary",
"auditLog.get",
"auditLogs.get",
"dashboard.patch",
"dashboard.delete",
"dashboard.sendReport",
"dashboards.get",
"dashboards.post",
"org.get",
"org.patch",
"org.delete",
"org.pendingInvites",
"org.inviteMember",
"org.revokeInvite",
"org.modifyMember",
"org.removeMember",
"org.payloadCounts",
"org.invoices",
"org.currentCard",
"org.chargeDetails",
"org.transferResources"
]
}
]
},
{
"type": "string",
"enum": [
"all.User",
"all.User.read",
"applicationTemplate.*",
"applicationTemplate.get",
"applicationTemplates.*",
"applicationTemplates.get",
"applicationTemplates.getCategories",
"applicationTemplates.getUniqueKeywords",
"me.*",
"orgs.*",
"me.get",
"me.patch",
"me.delete",
"me.verifyEmail",
"me.changePassword",
"me.enableTwoFactorAuth",
"me.disableTwoFactorAuth",
"me.disconnectGithub",
"me.connectGithub",
"me.addRecentItem",
"me.fetchRecentItems",
"me.payloadCounts",
"me.transferResources",
"orgs.get",
"orgs.post"
]
}
]
}
},
"tokenTTL": {
"type": "integer",
"minimum": 0
}
},
"required": [
"email",
"password"
],
"additionalProperties": false
}
```
### Example
```json
{
"email": "example@losant.com",
"password": "this is the password"
}
```
## User Post
Schema for the body of a User creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 1024
},
"firstName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"lastName": {
"type": "string",
"minLength": 1,
"maxLength": 1024
},
"companyName": {
"type": "string",
"maxLength": 1024
},
"title": {
"type": "string",
"maxLength": 1024
},
"phoneNumber": {
"type": "string",
"maxLength": 1024
},
"location": {
"type": "string",
"maxLength": 1024
},
"url": {
"type": "string",
"maxLength": 1024
},
"oauth": {
"type": "object",
"properties": {
"service": {
"enum": [
"github"
]
},
"accessToken": {
"type": "string",
"minLength": 1,
"maxLength": 1024
}
},
"required": [
"service",
"accessToken"
]
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 2048,
"pattern": "^(?=.*[A-Z])(?=.*[^A-z0-9])(?=.*[0-9])(?=.*[a-z]).{12,}$"
},
"acceptTerms": {
"enum": [
"on"
]
},
"hsToken": {
"type": "string",
"maxLength": 1024
},
"iotJourneyStage": {
"type": "string",
"maxLength": 1024
},
"requestedScopes": {
"type": "array",
"uniqueItems": true,
"items": {
"oneOf": [
{
"oneOf": [
{
"type": "string",
"enum": [
"all.Application",
"all.Application.read",
"all.Device",
"all.Device.read",
"application.*",
"applicationApiToken.*",
"applicationApiTokens.*",
"applicationCertificate.*",
"applicationCertificates.*",
"applicationCertificateAuthority.*",
"applicationCertificateAuthorities.*",
"applicationKey.*",
"applicationKeys.*",
"data.*",
"dataTable.*",
"dataTables.*",
"dataTableRow.*",
"dataTableRows.*",
"device.*",
"deviceRecipe.*",
"deviceRecipes.*",
"devices.*",
"edgeDeployments.*",
"event.*",
"events.*",
"experience.*",
"experienceDomain.*",
"experienceDomains.*",
"experienceEndpoint.*",
"experienceEndpoints.*",
"experienceGroup.*",
"experienceGroups.*",
"experienceSlug.*",
"experienceSlugs.*",
"experienceUser.*",
"experienceUsers.*",
"experienceVersion.*",
"experienceVersions.*",
"experienceView.*",
"experienceViews.*",
"integration.*",
"integrations.*",
"file.*",
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
"notebook.*",
"notebooks.*",
"webhook.*",
"webhooks.*",
"application.applyTemplate",
"application.archiveData",
"application.backfillArchiveData",
"application.clone",
"application.export",
"application.import",
"application.fullEventsArchive",
"application.fullDataTablesArchive",
"application.debug",
"application.delete",
"application.get",
"application.mqttPublishMessage",
"application.mqttSubscriptionStream",
"application.patch",
"application.payloadCounts",
"application.search",
"applicationApiToken.delete",
"applicationApiToken.get",
"applicationApiToken.patch",
"applicationApiTokens.get",
"applicationApiTokens.post",
"applicationCertificate.delete",
"applicationCertificate.get",
"applicationCertificate.patch",
"applicationCertificates.get",
"applicationCertificates.post",
"applicationCertificateAuthority.delete",
"applicationCertificateAuthority.get",
"applicationCertificateAuthority.patch",
"applicationCertificateAuthorities.get",
"applicationCertificateAuthorities.post",
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
"data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
"dataTable.patch",
"dataTable.removeColumn",
"dataTableRow.delete",
"dataTableRow.get",
"dataTableRow.patch",
"dataTableRows.get",
"dataTableRows.post",
"dataTableRows.query",
"dataTableRows.export",
"dataTableRows.delete",
"dataTableRows.truncate",
"dataTables.get",
"dataTables.post",
"device.commandStream",
"device.debug",
"device.delete",
"device.export",
"device.get",
"device.getCommand",
"device.getCompositeState",
"device.getLogEntries",
"device.getState",
"device.patch",
"device.removeData",
"device.sendCommand",
"device.sendState",
"device.setConnectionStatus",
"device.stateStream",
"deviceRecipe.bulkCreate",
"deviceRecipe.delete",
"deviceRecipe.get",
"deviceRecipe.patch",
"deviceRecipes.get",
"deviceRecipes.post",
"devices.patch",
"devices.delete",
"devices.removeData",
"devices.detailedSummary",
"devices.export",
"devices.get",
"devices.post",
"devices.sendCommand",
"edgeDeployments.get",
"edgeDeployments.release",
"edgeDeployments.remove",
"edgeDeployments.replace",
"event.delete",
"event.get",
"event.patch",
"events.delete",
"events.get",
"events.mostRecentBySeverity",
"events.patch",
"events.post",
"events.export",
"experience.delete",
"experience.bootstrap",
"experienceDomain.delete",
"experienceDomain.get",
"experienceDomain.patch",
"experienceDomains.get",
"experienceDomains.post",
"experienceEndpoint.delete",
"experienceEndpoint.get",
"experienceEndpoint.linkedResources",
"experienceEndpoint.patch",
"experienceEndpoints.get",
"experienceEndpoints.post",
"experienceEndpoints.stats",
"experienceGroup.delete",
"experienceGroup.get",
"experienceGroup.patch",
"experienceGroups.detailedSummary",
"experienceGroups.get",
"experienceGroups.post",
"experienceSlug.delete",
"experienceSlug.get",
"experienceSlug.patch",
"experienceSlugs.get",
"experienceSlugs.post",
"experienceUser.delete",
"experienceUser.get",
"experienceUser.patch",
"experienceUsers.detailedSummary",
"experienceUsers.get",
"experienceUsers.post",
"experienceVersion.delete",
"experienceVersion.get",
"experienceVersion.patch",
"experienceVersions.get",
"experienceVersions.post",
"experienceView.debug",
"experienceView.delete",
"experienceView.get",
"experienceView.linkedResources",
"experienceView.patch",
"experienceViews.debug",
"experienceViews.detailedSummary",
"experienceViews.get",
"experienceViews.post",
"file.get",
"file.patch",
"file.move",
"file.delete",
"file.upload",
"files.get",
"files.post",
"flow.clearStorageEntries",
"flow.debug",
"flow.delete",
"flow.errors",
"flow.get",
"flow.getStorageEntries",
"flow.log",
"flow.patch",
"flow.pressVirtualButton",
"flow.setStorageEntry",
"flow.stats",
"flows.get",
"flows.getByVersion",
"flows.import",
"flows.post",
"flowVersion.delete",
"flowVersion.errors",
"flowVersion.get",
"flowVersion.log",
"flowVersion.patch",
"flowVersion.stats",
"flowVersions.get",
"flowVersions.post",
"integration.delete",
"integration.get",
"integration.patch",
"integrations.get",
"integrations.post",
"notebook.delete",
"notebook.execute",
"notebook.get",
"notebook.logs",
"notebook.patch",
"notebook.requestInputDataExport",
"notebook.upload",
"notebooks.get",
"notebooks.post",
"webhook.delete",
"webhook.get",
"webhook.patch",
"webhooks.get",
"webhooks.post"
]
},
{
"type": "string",
"enum": [
"all.Organization",
"all.Organization.read",
"applications.*",
"auditLog.*",
"auditLogs.*",
"dashboard.*",
"dashboards.*",
"org.*",
"applications.get",
"applications.post",
"applications.import",
"applications.detailedSummary",
"auditLog.get",
"auditLogs.get",
"dashboard.patch",
"dashboard.delete",
"dashboard.sendReport",
"dashboards.get",
"dashboards.post",
"org.get",
"org.patch",
"org.delete",
"org.pendingInvites",
"org.inviteMember",
"org.revokeInvite",
"org.modifyMember",
"org.removeMember",
"org.payloadCounts",
"org.invoices",
"org.currentCard",
"org.chargeDetails",
"org.transferResources"
]
}
]
},
{
"type": "string",
"enum": [
"all.User",
"all.User.read",
"applicationTemplate.*",
"applicationTemplate.get",
"applicationTemplates.*",
"applicationTemplates.get",
"applicationTemplates.getCategories",
"applicationTemplates.getUniqueKeywords",
"me.*",
"orgs.*",
"me.get",
"me.patch",
"me.delete",
"me.verifyEmail",
"me.changePassword",
"me.enableTwoFactorAuth",
"me.disableTwoFactorAuth",
"me.disconnectGithub",
"me.connectGithub",
"me.addRecentItem",
"me.fetchRecentItems",
"me.payloadCounts",
"me.transferResources",
"orgs.get",
"orgs.post"
]
}
]
}
},
"tokenTTL": {
"type": "integer",
"minimum": 0
}
},
"anyOf": [
{
"required": [
"email",
"firstName",
"lastName",
"password",
"acceptTerms"
]
},
{
"required": [
"email",
"firstName",
"lastName",
"oauth",
"acceptTerms"
]
}
]
}
```
### Example
```json
{
"email": "example@losant.com",
"firstName": "Example",
"lastName": "Name",
"companyName": "Losant IoT, Inc.",
"url": "https://www.losant.com",
"password": "the new password",
"acceptTerms": "on"
}
```
## Validate Context Error
Schema for the result of a validateContext call when invalid context is passed
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"message": {
"type": "string"
},
"ctx": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"anyOf": [
[
{
"type": "string",
"maxLength": 32767
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
],
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
}
}
}
]
}
},
"additionalProperties": false
}
}
}
```
### Example
```json
{
"type": "Validation",
"message": "deviceId-noValidationNoFullDevice (589de9bca1975a00017b22ff) is not a valid deviceId",
"ctx": {
"deviceId-withIdAndTagValidationAndIncludeFullDevice": {
"id": "589de9bca1975a00017b2295",
"name": "Cincinnati",
"tags": {
"type": [
"Weather Station"
],
"region": [
"Midwest"
],
"DeviceRecipe": [
"Weather Station"
]
}
},
"deviceId-noValidationNoFullDevice": "589de9bca1975a00017b2296",
"deviceAttribute": "dew-point",
"deviceTag-withValidation": {
"key": "DeviceRecipe",
"value": "Weather Station"
},
"deviceTag-noValidation": {
"key": "DeviceRecipe",
"value": "Weather Station"
}
}
}
```
## Validate Context Success
Schema for the result of a successful validateContext call
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"success": {
"type": "boolean",
"enum": [
true
]
},
"ctx": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"anyOf": [
[
{
"type": "string",
"maxLength": 32767
},
{
"type": "number"
},
{
"type": "object",
"properties": {
"key": {
"type": "string",
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"additionalProperties": false
}
],
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"maxLength": 32767
},
"tags": {
"type": "object",
"patternProperties": {
"^[0-9a-zA-Z_-]{1,255}$": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
}
}
}
]
}
},
"additionalProperties": false
}
}
}
```
### Example
```json
{
"success": true,
"ctx": {
"deviceId-withIdAndTagValidationAndIncludeFullDevice": {
"id": "589de9bca1975a00017b2295",
"name": "Cincinnati",
"tags": {
"type": [
"Weather Station"
],
"region": [
"Midwest"
],
"DeviceRecipe": [
"Weather Station"
]
}
},
"deviceId-noValidationNoFullDevice": "589de9bca1975a00017b2296",
"deviceAttribute": "dew-point",
"deviceTag-withValidation": {
"key": "DeviceRecipe",
"value": "Weather Station"
},
"deviceTag-noValidation": {
"key": "DeviceRecipe",
"value": "Weather Station"
}
}
}
```
## Validation Error
Schema for validation errors returned by the API
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"type": {
"type": "string"
},
"message": {
"type": "string"
},
"validationErrors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"id": {
"oneOf": [
{
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
{
"type": "string"
}
]
},
"message": {
"type": "string"
}
}
}
}
}
}
```
### Example
```json
{
"type": "Validation",
"message": "Too many validation errors occurred.",
"validationErrors": [
{
"type": "Notebook",
"id": "575ec8687ae143cd83dc4a97",
"name": "myNote",
"message": "Specified Data Table ID for data table output does not exist"
}
]
}
```
## Virtual Button Press
Schema for the body of a request to press a Workflow virtual button
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"key": {
"type": "string"
},
"payload": {},
"meta": {},
"flowVersion": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"deviceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
}
},
"required": [
"key"
],
"additionalProperties": false
}
```
### Example
```json
{
"key": "575ed18f7ae143cd83dc4aa6-SJaEw_dV",
"payload": {
"some": "data"
}
}
```
## Webhook
Schema for a single Webhook
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"webhookId": {
"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
},
"token": {
"type": "string",
"minLength": 1
},
"responseCode": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"verificationType": {
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
"twilio",
"alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
},
"waitForReply": {
"type": "boolean"
},
"basicAuthUsername": {
"type": "string",
"maxLength": 255
},
"basicAuthPassword": {
"type": "string",
"maxLength": 255
}
}
}
```
### Example
```json
{
"id": "575ed78e7ae143cd83dc4aab",
"webhookId": "575ed78e7ae143cd83dc4aab",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Webhook",
"token": "the_webhook_token",
"responseCode": 200
}
```
## Webhook Patch
Schema for the body of a Webhook modification request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"responseCode": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"verificationType": {
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
"twilio",
"alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
},
"waitForReply": {
"type": "boolean"
},
"basicAuthUsername": {
"type": "string",
"maxLength": 255
},
"basicAuthPassword": {
"type": "string",
"maxLength": 255
}
},
"additionalProperties": false
}
```
### Example
```json
{
"name": "My Updated Webhook",
"responseCode": 201
}
```
## Webhook Post
Schema for the body of a Webhook creation request
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"responseCode": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"verificationType": {
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
"twilio",
"alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
},
"waitForReply": {
"type": "boolean"
},
"basicAuthUsername": {
"type": "string",
"maxLength": 255
},
"basicAuthPassword": {
"type": "string",
"maxLength": 255
}
},
"required": [
"name"
],
"additionalProperties": false
}
```
### Example
```json
{
"name": "My New Webhook"
}
```
## Webhooks
Schema for a collection of Webhooks
### Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"title": "Webhook",
"description": "Schema for a single Webhook",
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
},
"webhookId": {
"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
},
"token": {
"type": "string",
"minLength": 1
},
"responseCode": {
"type": "integer",
"minimum": 100,
"maximum": 599
},
"verificationType": {
"type": "string",
"enum": [
"facebook",
"fitbit",
"none",
"twilio",
"alexa"
]
},
"verificationCode": {
"type": "string",
"maxLength": 32767
},
"waitForReply": {
"type": "boolean"
},
"basicAuthUsername": {
"type": "string",
"maxLength": 255
},
"basicAuthPassword": {
"type": "string",
"maxLength": 255
}
}
}
},
"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}$"
}
}
}
```
### Example
```json
{
"items": [
{
"id": "575ed78e7ae143cd83dc4aab",
"webhookId": "575ed78e7ae143cd83dc4aab",
"applicationId": "575ec8687ae143cd83dc4a97",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
"name": "My Webhook",
"token": "the_webhook_token",
"responseCode": 200
}
],
"count": 1,
"totalCount": 4,
"perPage": 1,
"page": 0,
"sortField": "name",
"sortDirection": "asc",
"applicationId": "575ec8687ae143cd83dc4a97"
}
```