losant_rest 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a00e4f322e3eb13ed7039b50b7b585832628db3118a8946740e14f55286fbd99
-  data.tar.gz: ca6b8e733ad3c4ecec741b5c2f1ea68f220753e4735edb6e7dddc2242a318c78
+  metadata.gz: bd48938b608d6a1b8a68dea90a7f7df3b6a89b50c70daeae0847d92c5a11a346
+  data.tar.gz: 65dc220f3a4d835bafcda0c174d6880c82d6ec6d0baab3db6713fced112116f0
 SHA512:
-  metadata.gz: de8652209e1d56f331536e4c0fddee0f6da015cd0a6aee44e8a1897832608aaed1cc1bce9e9ecee353eeb3e187ea09ceb7ad5cf88b7aea73f826744cc9ab0037
-  data.tar.gz: 515ccf96d76c92e0c95e92bde9bea98b3530540c90954085b17235e5c74d557eda2add037b3b2d1ab701ff1fafc68e02b6394ce686d82ce6716d314ebf33f89a
+  metadata.gz: 3b5822b47e60014744dc0d55c812b568dc084b866a7670f4a7b3a40589aab68083cb9fae2bd8a80d7f40e6cf6c3f637e65dddf0c801497713661b84b15168b7e
+  data.tar.gz: aa51d1b563f5c2c6e0601493fd475fd8630aca36309ba9fb85885e39cf40deb192fc43b0d978b323738198fe730fb0785e4a016aac73808abd5b6a62304d638d

data/docs/_schemas.md

@@ -12,6 +12,7 @@
 *   [Application Keys](#application-keys)
 *   [Application Patch](#application-patch)
 *   [Application Post](#application-post)
+*   [Application Search Result](#application-search-result)
 *   [Applications](#applications)
 *   [Audit Log](#audit-log)
 *   [Audit Log Filter](#audit-log-filter)
@@ -536,6 +537,14 @@ Schema for a single Application
         "organization"
       ]
     },
+    "organizationName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "organizationIconColor": {
+      "type": "string"
+    },
     "name": {
       "type": "string",
       "minLength": 1,
@@ -896,6 +905,7 @@ Schema for the body of an Application API Token creation request
           "application.mqttSubscriptionStream",
           "application.patch",
           "application.payloadCounts",
+          "application.search",
           "applicationApiToken.delete",
           "applicationApiToken.get",
           "applicationApiToken.patch",
@@ -1883,6 +1893,83 @@ Schema for the body of an Application creation request
 
 <br/>
 
+## Application Search Result
+
+Results of a search of an application&#x27;s resources
+
+### <a name="application-search-result-schema"></a> 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": [
+          "applicationKey",
+          "dashboard",
+          "dataTable",
+          "deviceRecipe",
+          "device",
+          "domain",
+          "event",
+          "experienceEndpoint",
+          "experienceGroup",
+          "experienceSlug",
+          "experienceUser",
+          "experienceVersion",
+          "experienceView",
+          "file",
+          "flow",
+          "integration",
+          "webhook"
+        ]
+      }
+    },
+    "required": [
+      "id",
+      "name",
+      "_type"
+    ]
+  }
+}
+```
+### <a name="application-search-result-example"></a> Example
+
+```json
+[
+  {
+    "type": "device",
+    "name": "My Device #1",
+    "metadata": {
+      "descriptor": "a basic description of device #1"
+    },
+    "id": "575ec8687ae143cd83dc4a97"
+  }
+]
+```
+
+<br/>
+
 ## Applications
 
 Schema for a collection of Applications
@@ -1928,6 +2015,14 @@ Schema for a collection of Applications
               "organization"
             ]
           },
+          "organizationName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "organizationIconColor": {
+            "type": "string"
+          },
           "name": {
             "type": "string",
             "minLength": 1,
@@ -3042,6 +3137,23 @@ Schema for a single Dashboard
         "organization"
       ]
     },
+    "organizationName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "organizationIconColor": {
+      "type": "string"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
     "name": {
       "type": "string",
       "minLength": 1,
@@ -3703,6 +3815,10 @@ Schema for the body of a Dashboard creation request
       "type": "string",
       "pattern": "^[A-Fa-f\\d]{24}$"
     },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
     "name": {
       "type": "string",
       "minLength": 1,
@@ -4034,6 +4150,23 @@ Schema for a collection of Dashboards
               "organization"
             ]
           },
+          "organizationName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "organizationIconColor": {
+            "type": "string"
+          },
+          "applicationId": {
+            "type": "string",
+            "pattern": "^[A-Fa-f\\d]{24}$"
+          },
+          "applicationName": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
           "name": {
             "type": "string",
             "minLength": 1,
@@ -4329,6 +4462,14 @@ Schema for a collection of Dashboards
         "asc",
         "desc"
       ]
+    },
+    "orgId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
+    },
+    "applicationId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
     }
   }
 }
@@ -12404,6 +12545,7 @@ Schema for a single Workflow
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -12419,8 +12561,8 @@ Schema for a single Workflow
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",
@@ -13022,6 +13164,7 @@ Schema for the body of a Workflow modification request
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -13037,8 +13180,8 @@ Schema for the body of a Workflow modification request
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",
@@ -13513,6 +13656,7 @@ Schema for the body of a Workflow creation request
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -13528,8 +13672,8 @@ Schema for the body of a Workflow creation request
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",
@@ -14144,6 +14288,7 @@ Schema for a single Workflow Version
               "type": {
                 "type": "string",
                 "enum": [
+                  "customNodeStart",
                   "dataTable",
                   "deviceCommand",
                   "deviceId",
@@ -14159,8 +14304,8 @@ Schema for a single Workflow Version
                   "fileWatch",
                   "integration",
                   "mqttTopic",
+                  "redis",
                   "request",
-                  "customNodeStart",
                   "timer",
                   "udp",
                   "virtualButton",
@@ -14672,6 +14817,7 @@ Schema for a single Workflow Version
               "type": {
                 "type": "string",
                 "enum": [
+                  "customNodeStart",
                   "dataTable",
                   "deviceCommand",
                   "deviceId",
@@ -14687,8 +14833,8 @@ Schema for a single Workflow Version
                   "fileWatch",
                   "integration",
                   "mqttTopic",
+                  "redis",
                   "request",
-                  "customNodeStart",
                   "timer",
                   "udp",
                   "virtualButton",
@@ -14903,6 +15049,7 @@ Schema for the body of a Workflow Version creation request
           "type": {
             "type": "string",
             "enum": [
+              "customNodeStart",
               "dataTable",
               "deviceCommand",
               "deviceId",
@@ -14918,8 +15065,8 @@ Schema for the body of a Workflow Version creation request
               "fileWatch",
               "integration",
               "mqttTopic",
+              "redis",
               "request",
-              "customNodeStart",
               "timer",
               "udp",
               "virtualButton",
@@ -15419,6 +15566,7 @@ Schema for a collection of Workflow Versions
                     "type": {
                       "type": "string",
                       "enum": [
+                        "customNodeStart",
                         "dataTable",
                         "deviceCommand",
                         "deviceId",
@@ -15434,8 +15582,8 @@ Schema for a collection of Workflow Versions
                         "fileWatch",
                         "integration",
                         "mqttTopic",
+                        "redis",
                         "request",
-                        "customNodeStart",
                         "timer",
                         "udp",
                         "virtualButton",
@@ -15947,6 +16095,7 @@ Schema for a collection of Workflow Versions
                     "type": {
                       "type": "string",
                       "enum": [
+                        "customNodeStart",
                         "dataTable",
                         "deviceCommand",
                         "deviceId",
@@ -15962,8 +16111,8 @@ Schema for a collection of Workflow Versions
                         "fileWatch",
                         "integration",
                         "mqttTopic",
+                        "redis",
                         "request",
-                        "customNodeStart",
                         "timer",
                         "udp",
                         "virtualButton",
@@ -16245,6 +16394,7 @@ Schema for a collection of Workflows
                 "type": {
                   "type": "string",
                   "enum": [
+                    "customNodeStart",
                     "dataTable",
                     "deviceCommand",
                     "deviceId",
@@ -16260,8 +16410,8 @@ Schema for a collection of Workflows
                     "fileWatch",
                     "integration",
                     "mqttTopic",
+                    "redis",
                     "request",
-                    "customNodeStart",
                     "timer",
                     "udp",
                     "virtualButton",
@@ -16847,6 +16997,7 @@ Schema for the body of a workflow import request
                 "type": {
                   "type": "string",
                   "enum": [
+                    "customNodeStart",
                     "dataTable",
                     "deviceCommand",
                     "deviceId",
@@ -16862,8 +17013,8 @@ Schema for the body of a workflow import request
                     "fileWatch",
                     "integration",
                     "mqttTopic",
+                    "redis",
                     "request",
-                    "customNodeStart",
                     "timer",
                     "udp",
                     "virtualButton",
@@ -17356,6 +17507,7 @@ Schema for the body of a workflow import request
                 "type": {
                   "type": "string",
                   "enum": [
+                    "customNodeStart",
                     "dataTable",
                     "deviceCommand",
                     "deviceId",
@@ -17371,8 +17523,8 @@ Schema for the body of a workflow import request
                     "fileWatch",
                     "integration",
                     "mqttTopic",
+                    "redis",
                     "request",
-                    "customNodeStart",
                     "timer",
                     "udp",
                     "virtualButton",
@@ -17912,6 +18064,7 @@ Schema for the result of a workflow import request
                 "type": {
                   "type": "string",
                   "enum": [
+                    "customNodeStart",
                     "dataTable",
                     "deviceCommand",
                     "deviceId",
@@ -17927,8 +18080,8 @@ Schema for the result of a workflow import request
                     "fileWatch",
                     "integration",
                     "mqttTopic",
+                    "redis",
                     "request",
-                    "customNodeStart",
                     "timer",
                     "udp",
                     "virtualButton",
@@ -18440,6 +18593,7 @@ Schema for the result of a workflow import request
                     "type": {
                       "type": "string",
                       "enum": [
+                        "customNodeStart",
                         "dataTable",
                         "deviceCommand",
                         "deviceId",
@@ -18455,8 +18609,8 @@ Schema for the result of a workflow import request
                         "fileWatch",
                         "integration",
                         "mqttTopic",
+                        "redis",
                         "request",
-                        "customNodeStart",
                         "timer",
                         "udp",
                         "virtualButton",
@@ -18968,6 +19122,7 @@ Schema for the result of a workflow import request
                     "type": {
                       "type": "string",
                       "enum": [
+                        "customNodeStart",
                         "dataTable",
                         "deviceCommand",
                         "deviceId",
@@ -18983,8 +19138,8 @@ Schema for the result of a workflow import request
                         "fileWatch",
                         "integration",
                         "mqttTopic",
+                        "redis",
                         "request",
-                        "customNodeStart",
                         "timer",
                         "udp",
                         "virtualButton",
@@ -19244,6 +19399,7 @@ Schema for the body of a Github login request
                   "application.mqttSubscriptionStream",
                   "application.patch",
                   "application.payloadCounts",
+                  "application.search",
                   "applicationApiToken.delete",
                   "applicationApiToken.get",
                   "applicationApiToken.patch",
@@ -19406,6 +19562,7 @@ Schema for the body of a Github login request
                   "solutionUsers.*",
                   "applications.get",
                   "applications.post",
+                  "applications.detailedSummary",
                   "auditLog.get",
                   "auditLogs.get",
                   "dashboard.patch",
@@ -20437,7 +20594,35 @@ Schema for a collection of Integrations
 {
   "items": [
     {
-      "$ref": "#/examples/integrations"
+      "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,
@@ -24470,6 +24655,7 @@ Schema for the result of a time series query
         "MEDIAN",
         "MEAN",
         "SUM",
+        "STD_DEV",
         "NONE"
       ]
     },
@@ -24618,6 +24804,7 @@ Schema for the body of a time series query request
         "MEDIAN",
         "MEAN",
         "SUM",
+        "STD_DEV",
         "NONE"
       ]
     },
@@ -24782,6 +24969,7 @@ Schema for the body of a User authentication request
                   "application.mqttSubscriptionStream",
                   "application.patch",
                   "application.payloadCounts",
+                  "application.search",
                   "applicationApiToken.delete",
                   "applicationApiToken.get",
                   "applicationApiToken.patch",
@@ -24944,6 +25132,7 @@ Schema for the body of a User authentication request
                   "solutionUsers.*",
                   "applications.get",
                   "applications.post",
+                  "applications.detailedSummary",
                   "auditLog.get",
                   "auditLogs.get",
                   "dashboard.patch",
@@ -25174,6 +25363,7 @@ Schema for the body of a User creation request
                   "application.mqttSubscriptionStream",
                   "application.patch",
                   "application.payloadCounts",
+                  "application.search",
                   "applicationApiToken.delete",
                   "applicationApiToken.get",
                   "applicationApiToken.patch",
@@ -25336,6 +25526,7 @@ Schema for the body of a User creation request
                   "solutionUsers.*",
                   "applications.get",
                   "applications.post",
+                  "applications.detailedSummary",
                   "auditLog.get",
                   "auditLogs.get",
                   "dashboard.patch",
@@ -25461,6 +25652,10 @@ Schema for the body of a request to press a Workflow virtual button
       "type": "string",
       "minLength": 1,
       "maxLength": 255
+    },
+    "deviceId": {
+      "type": "string",
+      "pattern": "^[A-Fa-f\\d]{24}$"
     }
   },
   "required": [