docs/_schemas.md in losant_rest-1.8.3 vs docs/_schemas.md in losant_rest-1.8.4
- old
+ new
@@ -34,14 +34,14 @@
* [Data Table Query](#data-table-query)
* [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 Row Insert Update](#data-table-row-insert-update)
* [Data Table Rows](#data-table-rows)
* [Data Table Rows Delete](#data-table-rows-delete)
-* [Data Table Export](#data-table-export)
+* [Data Table Rows Export](#data-table-rows-export)
* [Data Tables](#data-tables)
* [Device](#device)
* [Device Command](#device-command)
* [Device Commands](#device-commands)
* [Device Connection Status](#device-connection-status)
@@ -55,11 +55,11 @@
* [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)
-* [Single or Multiple Device States](#single-or-multiple-device-states)
+* [Device State or States](#device-state-or-states)
* [Device States](#device-states)
* [Device Tag Filter](#device-tag-filter)
* [Devices](#devices)
* [Disable Two Factor Auth](#disable-two-factor-auth)
* [Edge Deployment](#edge-deployment)
@@ -106,11 +106,11 @@
* [Experience View Post](#experience-view-post)
* [Experience Views](#experience-views)
* [File Schema](#file-schema)
* [File Patch](#file-patch)
* [File Post](#file-post)
-* [File Post Response](#file-post-response)
+* [File Upload Post Response](#file-upload-post-response)
* [Files Schema](#files-schema)
* [Workflow](#workflow)
* [Workflow Log](#workflow-log)
* [Workflow Patch](#workflow-patch)
* [Workflow Post](#workflow-post)
@@ -120,11 +120,11 @@
* [Workflow Version](#workflow-version)
* [Workflow Version Patch](#workflow-version-patch)
* [Workflow Version Post](#workflow-version-post)
* [Workflow Versions](#workflow-versions)
* [Workflows](#workflows)
-* [Workflow Import](#workflow-import)
+* [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)
@@ -1923,16 +1923,16 @@
"type": "string"
},
"_type": {
"type": "string",
"enum": [
- "applicationKey",
+ "applicationApiToken",
"dashboard",
"dataTable",
"deviceRecipe",
"device",
- "domain",
+ "experienceDomain",
"event",
"experienceEndpoint",
"experienceGroup",
"experienceSlug",
"experienceUser",
@@ -4613,11 +4613,16 @@
"name": "My Data Table",
"columns": [
{
"name": "myColumn1",
"dataType": "string",
- "defaultValue": "aDefault"
+ "constraint": "unique"
+ },
+ {
+ "name": "myColumn2",
+ "dataType": "number",
+ "constraint": "optional"
}
]
}
```
@@ -4672,11 +4677,11 @@
```
### <a name="data-table-column-example"></a> Example
```json
{
- "name": "myOptionalColumn",
+ "name": "myColumn3",
"dataType": "string",
"constraint": "optional",
"defaultValue": "aDefault"
}
```
@@ -4796,10 +4801,15 @@
"columns": [
{
"name": "myColumn1",
"dataType": "string",
"constraint": "unique"
+ },
+ {
+ "name": "myColumn2",
+ "dataType": "number",
+ "constraint": "optional"
}
]
}
```
@@ -4903,16 +4913,16 @@
```json
{
"$or": [
{
- "myCol1": {
- "$ne": 0
+ "myColumn1": {
+ "$ne": "myValue"
}
},
{
- "myCol2": 5
+ "myColumn2": 5
}
]
}
```
@@ -4959,11 +4969,12 @@
```json
{
"id": "596fbb703fc088453872e609",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
- "myColumn": "myValue"
+ "myColumn1": "myValue",
+ "myColumn2": 5
}
```
<br/>
@@ -4976,11 +4987,11 @@
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
- "title": "Data Table Row Insert/Update",
+ "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": [
@@ -5019,11 +5030,11 @@
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
{
- "title": "Data Table Row Insert/Update",
+ "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": [
@@ -5039,11 +5050,11 @@
{
"title": "Data Table Row Insert Multiple",
"description": "Schema for inserting data table rows",
"type": "array",
"items": {
- "title": "Data Table Row Insert/Update",
+ "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": [
@@ -5137,21 +5148,22 @@
```json
{
"id": "596fbb703fc088453872e609",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
- "myColumn": "myValue"
+ "myColumn1": "myValue",
+ "myColumn2": 5
}
```
<br/>
-## Data Table Row Insert/Update
+## Data Table Row Insert Update
Schema for inserting or updating a data table row
-### <a name="data-table-row-insert/update-schema"></a> Schema
+### <a name="data-table-row-insert-update-schema"></a> Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
@@ -5166,11 +5178,11 @@
}
},
"additionalProperties": false
}
```
-### <a name="data-table-row-insert/update-example"></a> Example
+### <a name="data-table-row-insert-update-example"></a> Example
```json
{
"myColumn1": "myValue"
}
@@ -5261,11 +5273,12 @@
"items": [
{
"id": "596fbb703fc088453872e609",
"creationDate": "2016-06-13T04:00:00.000Z",
"lastUpdated": "2016-06-13T04:00:00.000Z",
- "myColumn": "myValue"
+ "myColumn1": "myValue",
+ "myColumn2": 5
}
],
"count": 1,
"totalCount": 4,
"offset": 0,
@@ -5304,15 +5317,15 @@
}
```
<br/>
-## Data Table Export
+## Data Table Rows Export
Schema for the body of a data table export
-### <a name="data-table-export-schema"></a> Schema
+### <a name="data-table-rows-export-schema"></a> Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
@@ -5432,24 +5445,24 @@
}
},
"additionalProperties": false
}
```
-### <a name="data-table-export-example"></a> Example
+### <a name="data-table-rows-export-example"></a> Example
```json
{
"email": "email@example.com",
"query": {
"$or": [
{
- "myCol1": {
- "$ne": 0
+ "myColumn1": {
+ "$ne": "myValue"
}
},
{
- "myCol2": 5
+ "myColumn2": 5
}
]
},
"queryOptions": {
"limit": 10000
@@ -5602,11 +5615,16 @@
"name": "My Data Table",
"columns": [
{
"name": "myColumn1",
"dataType": "string",
- "defaultValue": "aDefault"
+ "constraint": "unique"
+ },
+ {
+ "name": "myColumn2",
+ "dataType": "number",
+ "constraint": "optional"
}
]
}
],
"count": 1,
@@ -7212,15 +7230,15 @@
}
```
<br/>
-## Single or Multiple Device States
+## Device State or States
Schema for a single device state or an array of device states
-### <a name="single-or-multiple-device-states-schema"></a> Schema
+### <a name="device-state-or-states-schema"></a> Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"oneOf": [
@@ -7340,11 +7358,11 @@
}
}
]
}
```
-### <a name="single-or-multiple-device-states-example"></a> Example
+### <a name="device-state-or-states-example"></a> Example
```json
{
"time": "2016-06-13T04:00:00.000Z",
"data": {
@@ -12142,15 +12160,15 @@
}
```
<br/>
-## File Post Response
+## File Upload Post Response
Schema to upload the file to s3
-### <a name="file-post-response-schema"></a> Schema
+### <a name="file-upload-post-response-schema"></a> Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
@@ -12259,11 +12277,11 @@
}
}
}
}
```
-### <a name="file-post-response-example"></a> Example
+### <a name="file-upload-post-response-example"></a> Example
```json
{
"id": "575ec8687ae143cd83dc4a97",
"applicationId": "575ec8687ae143cd83dc4a97",
@@ -12561,10 +12579,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -13180,10 +13199,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -13672,10 +13692,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -14304,10 +14325,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -14833,10 +14855,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -15065,10 +15088,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -15582,10 +15606,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -16111,10 +16136,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -16410,10 +16436,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -16941,15 +16968,15 @@
}
```
<br/>
-## Workflow Import
+## Workflows Import Post
Schema for the body of a workflow import request
-### <a name="workflow-import-schema"></a> Schema
+### <a name="workflows-import-post-schema"></a> Schema
```json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
@@ -17013,10 +17040,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -17523,10 +17551,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -17948,11 +17977,11 @@
}
},
"additionalProperties": false
}
```
-### <a name="workflow-import-example"></a> Example
+### <a name="workflows-import-post-example"></a> Example
```json
{
"flows": [
{
@@ -18080,10 +18109,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -18609,10 +18639,11 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]
@@ -19138,9 +19169,10 @@
"fileWatch",
"integration",
"mqttTopic",
"redis",
"request",
+ "serial",
"timer",
"udp",
"virtualButton",
"webhook"
]