docs/_schemas.md in losant_rest-1.8.5 vs docs/_schemas.md in losant_rest-1.8.6
- old
+ new
@@ -26,10 +26,11 @@
* [Dashboard Context Instance](#dashboard-context-instance)
* [Dashboard Patch](#dashboard-patch)
* [Dashboard Post](#dashboard-post)
* [Dashboard Send Report](#dashboard-send-report)
* [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 Query](#data-table-query)
@@ -134,10 +135,17 @@
* [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)
@@ -601,19 +609,16 @@
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
- "keyCount": {
+ "dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
- "dataTableCount": {
- "type": "number"
- },
"deviceRecipeCount": {
"type": "number"
},
"eventCount": {
"type": "number"
@@ -646,10 +651,24 @@
"type": "number"
},
"integrationCount": {
"type": "number"
},
+ "keyCount": {
+ "type": "number"
+ },
+ "storageStats": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "size": {
+ "type": "number"
+ }
+ }
+ },
"webhookCount": {
"type": "number"
}
}
},
@@ -895,10 +914,12 @@
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
+ "notebook.*",
+ "notebooks.*",
"webhook.*",
"webhooks.*",
"application.archiveData",
"application.backfillArchiveData",
"application.debug",
@@ -917,10 +938,11 @@
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
+ "data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
@@ -1045,10 +1067,19 @@
"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"
@@ -2079,19 +2110,16 @@
"type": "object",
"properties": {
"apiTokenCount": {
"type": "number"
},
- "keyCount": {
+ "dataTableCount": {
"type": "number"
},
"deviceCount": {
"type": "number"
},
- "dataTableCount": {
- "type": "number"
- },
"deviceRecipeCount": {
"type": "number"
},
"eventCount": {
"type": "number"
@@ -2124,10 +2152,24 @@
"type": "number"
},
"integrationCount": {
"type": "number"
},
+ "keyCount": {
+ "type": "number"
+ },
+ "storageStats": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "size": {
+ "type": "number"
+ }
+ }
+ },
"webhookCount": {
"type": "number"
}
}
},
@@ -4760,10 +4802,105 @@
}
```
<br/>
+## Data Export
+
+Schema for exporting data devices query
+
+### <a name="data-export-schema"></a> Schema
+
+```json
+{
+ "$schema": "http://json-schema.org/draft-04/schema#",
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string",
+ "format": "email",
+ "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
+ },
+ "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
+ }
+ }
+ }
+ },
+ "additionalProperties": false
+}
+```
+### <a name="data-export-example"></a> Example
+
+```json
+{
+ "email": "example@losant.com",
+ "deviceIds": [
+ "575ecf887ae143cd83dc4aa2",
+ "575ef5c97ae143cd83dc4aac"
+ ],
+ "attributes": [
+ "voltage"
+ ],
+ "end": 0,
+ "options": {
+ "includeDate": false,
+ "includeID": true
+ }
+}
+```
+
+<br/>
+
## Data Table
Schema for a single Data Table
### <a name="data-table-schema"></a> Schema
@@ -6361,10 +6498,11 @@
"items": {
"type": "string",
"enum": [
"all.Device",
"all.Device.read",
+ "data.export",
"data.timeSeriesQuery",
"data.lastValueQuery",
"device.commandStream",
"device.get",
"device.getCompositeState",
@@ -8102,11 +8240,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
@@ -8429,11 +8568,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
@@ -8692,11 +8832,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
@@ -8737,11 +8878,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
@@ -8944,11 +9086,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
@@ -8989,11 +9132,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"sourceId": {
"type": "string",
"pattern": "^[A-Fa-f\\d]{24}$"
@@ -12207,11 +12351,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"status": {
"type": "string",
"enum": [
@@ -12433,11 +12578,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"status": {
"type": "string",
"enum": [
@@ -12480,36 +12626,29 @@
"type": "number"
}
}
},
"upload": {
- "url": {
- "type": "string"
- },
- "fields": {
- "type": "object",
- "properties": {
- "key": {
- "type": "string"
+ "type": "object",
+ "properties": {
+ "url": {
+ "type": "string"
+ },
+ "fields": {
+ "type": "object",
+ "patternProperties": {
+ "^.*$": {
+ "type": "string"
+ }
},
- "bucket": {
- "type": "string"
- },
- "X-Amz-Algorithm": {
- "type": "string"
- },
- "X-Amz-Credential": {
- "type": "string"
- },
- "X-Amz-Date": {
- "type": "string"
- },
- "Policy": {
- "type": "string"
- },
- "X-Amz-Signature": {
- "type": "string"
+ "properties": {
+ "key": {
+ "type": "string"
+ },
+ "bucket": {
+ "type": "string"
+ }
}
}
}
}
}
@@ -12590,11 +12729,12 @@
"type": "string",
"enum": [
"flow",
"user",
"device",
- "apiToken"
+ "apiToken",
+ "notebook"
]
},
"status": {
"type": "string",
"enum": [
@@ -12813,10 +12953,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -13433,10 +13574,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -13926,10 +14068,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -14559,10 +14702,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -15089,10 +15233,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -15322,10 +15467,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -15840,10 +15986,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -16370,10 +16517,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -16670,10 +16818,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -17274,10 +17423,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -17785,10 +17935,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -18343,10 +18494,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -18873,10 +19025,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -19403,10 +19556,11 @@
"endpoint",
"event",
"fileWatch",
"integration",
"mqttTopic",
+ "notebook",
"redis",
"request",
"serial",
"timer",
"udp",
@@ -19654,10 +19808,12 @@
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
+ "notebook.*",
+ "notebooks.*",
"webhook.*",
"webhooks.*",
"application.archiveData",
"application.backfillArchiveData",
"application.debug",
@@ -19676,10 +19832,11 @@
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
+ "data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
@@ -19804,10 +19961,19 @@
"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"
@@ -21168,18 +21334,30 @@
"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",
@@ -21301,13 +21479,10 @@
"type": "number"
},
"appCount": {
"type": "number"
},
- "keyCount": {
- "type": "number"
- },
"dashCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
@@ -21316,13 +21491,10 @@
"type": "number"
},
"deviceRecipeCount": {
"type": "number"
},
- "experienceDomainCount": {
- "type": "number"
- },
"experienceEndpointCount": {
"type": "number"
},
"experienceGroupCount": {
"type": "number"
@@ -21343,10 +21515,16 @@
"type": "number"
},
"flowCount": {
"type": "number"
},
+ "integrationCount": {
+ "type": "number"
+ },
+ "keyCount": {
+ "type": "number"
+ },
"orgCount": {
"type": "number"
},
"payloadCount": {
"title": "Payload Counts",
@@ -21457,12 +21635,20 @@
}
}
}
}
},
- "integrationCount": {
- "type": "number"
+ "storageStats": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "size": {
+ "type": "number"
+ }
+ }
},
"webhookCount": {
"type": "number"
}
}
@@ -21719,10 +21905,1848 @@
}
```
<br/>
+## Notebook
+
+Schema for a single Notebook
+
+### <a name="notebook-schema"></a> 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": {
+ "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
+ },
+ "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": [
+ "deviceMetadata"
+ ]
+ },
+ "fileName": {
+ "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
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "dataTable"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "queryJson": {
+ "type": "string",
+ "maxLength": 32767
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "externalUrl"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "createMissingColumns": {
+ "type": "boolean"
+ },
+ "truncateExistingTable": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "fileName",
+ "outputType",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "outputType": {
+ "type": "string",
+ "enum": [
+ "file"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": [
+ "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
+ }
+ ]
+ }
+ }
+ }
+}
+```
+### <a name="notebook-example"></a> 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"
+ }
+ ]
+}
+```
+
+<br/>
+
+## Notebook Data Export Options
+
+Schema for the options for a Notebook data export request
+
+### <a name="notebook-data-export-options-schema"></a> 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"
+ ]
+ }
+ ]
+ }
+ },
+ "additionalProperties": false
+}
+```
+### <a name="notebook-data-export-options-example"></a> Example
+
+```json
+{
+ "email": "user@example.com"
+}
+```
+
+<br/>
+
+## Notebook Execution Logs
+
+Schema for a set of Notebook execution logs
+
+### <a name="notebook-execution-logs-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}$"
+ },
+ "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"
+ },
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+}
+```
+### <a name="notebook-execution-logs-example"></a> 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": []
+ }
+]
+```
+
+<br/>
+
+## Notebook Execution Options
+
+Schema for the options for a Notebook execution request
+
+### <a name="notebook-execution-options-schema"></a> 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"
+ ]
+ }
+ ]
+ }
+ },
+ "additionalProperties": false
+}
+```
+### <a name="notebook-execution-options-example"></a> Example
+
+```json
+{}
+```
+
+<br/>
+
+## Notebook Patch
+
+Schema for the body of a Notebook modification request
+
+### <a name="notebook-patch-schema"></a> 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": {
+ "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
+ },
+ "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": [
+ "deviceMetadata"
+ ]
+ },
+ "fileName": {
+ "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
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "dataTable"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "queryJson": {
+ "type": "string",
+ "maxLength": 32767
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "externalUrl"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "createMissingColumns": {
+ "type": "boolean"
+ },
+ "truncateExistingTable": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "fileName",
+ "outputType",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "outputType": {
+ "type": "string",
+ "enum": [
+ "file"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": [
+ "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
+}
+```
+### <a name="notebook-patch-example"></a> Example
+
+```json
+{
+ "name": "New Notebook Name"
+}
+```
+
+<br/>
+
+## Notebook Post
+
+Schema for the body of an Notebook creation request
+
+### <a name="notebook-post-schema"></a> 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": {
+ "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
+ },
+ "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": [
+ "deviceMetadata"
+ ]
+ },
+ "fileName": {
+ "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
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "dataTable"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "queryJson": {
+ "type": "string",
+ "maxLength": 32767
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "externalUrl"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "createMissingColumns": {
+ "type": "boolean"
+ },
+ "truncateExistingTable": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "fileName",
+ "outputType",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "outputType": {
+ "type": "string",
+ "enum": [
+ "file"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": [
+ "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"
+ ]
+}
+```
+### <a name="notebook-post-example"></a> Example
+
+```json
+{
+ "name": "Example Notebook"
+}
+```
+
+<br/>
+
+## Notebooks
+
+Schema for a collection of Notebooks
+
+### <a name="notebooks-schema"></a> 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": {
+ "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
+ },
+ "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": [
+ "deviceMetadata"
+ ]
+ },
+ "fileName": {
+ "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
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "dataTable"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "queryJson": {
+ "type": "string",
+ "maxLength": 32767
+ }
+ },
+ "required": [
+ "inputType",
+ "fileName",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "inputType": {
+ "type": "string",
+ "enum": [
+ "externalUrl"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "dataTableId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ },
+ "createMissingColumns": {
+ "type": "boolean"
+ },
+ "truncateExistingTable": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "fileName",
+ "outputType",
+ "dataTableId"
+ ],
+ "additionalProperties": false
+ },
+ {
+ "type": "object",
+ "properties": {
+ "outputType": {
+ "type": "string",
+ "enum": [
+ "file"
+ ]
+ },
+ "fileName": {
+ "type": "string",
+ "pattern": "^[0-9a-zA-Z_.-]{1,255}$"
+ },
+ "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": [
+ "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"
+ ]
+ },
+ "applicationId": {
+ "type": "string",
+ "pattern": "^[A-Fa-f\\d]{24}$"
+ }
+ }
+}
+```
+### <a name="notebooks-example"></a> 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"
+ }
+ ]
+ }
+ ],
+ "count": 1,
+ "totalCount": 4,
+ "perPage": 1,
+ "page": 0,
+ "sortField": "name",
+ "sortDirection": "asc",
+ "applicationId": "575ec8687ae143cd83dc4a97"
+}
+```
+
+<br/>
+
## Organization
Schema for a single Organization
### <a name="organization-schema"></a> Schema
@@ -21900,14 +23924,14 @@
"type": "number"
},
"flow": {
"type": "number"
},
- "solution": {
+ "integration": {
"type": "number"
},
- "integration": {
+ "notebook": {
"type": "number"
},
"webhook": {
"type": "number"
},
@@ -21917,10 +23941,19 @@
"member": {
"type": "number"
},
"payload": {
"type": "number"
+ },
+ "notebookMinutesPerRun": {
+ "type": "number"
+ },
+ "notebookMinutesPerMonth": {
+ "type": "number"
+ },
+ "notebookInParallel": {
+ "type": "number"
}
},
"summary": {
"type": "object",
"properties": {
@@ -21928,13 +23961,10 @@
"type": "number"
},
"appCount": {
"type": "number"
},
- "keyCount": {
- "type": "number"
- },
"dashCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
@@ -21970,16 +24000,19 @@
"type": "number"
},
"flowCount": {
"type": "number"
},
- "memberCount": {
+ "integrationCount": {
"type": "number"
},
- "pendingInviteCount": {
+ "keyCount": {
"type": "number"
},
+ "memberCount": {
+ "type": "number"
+ },
"payloadCount": {
"title": "Payload Counts",
"description": "Schema for the result of a payload count request",
"type": "object",
"properties": {
@@ -22087,15 +24120,23 @@
}
}
}
}
},
- "solutionCount": {
+ "pendingInviteCount": {
"type": "number"
},
- "integrationCount": {
- "type": "number"
+ "storageStats": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "size": {
+ "type": "number"
+ }
+ }
},
"webhookCount": {
"type": "number"
}
}
@@ -22906,14 +24947,14 @@
"type": "number"
},
"flow": {
"type": "number"
},
- "solution": {
+ "integration": {
"type": "number"
},
- "integration": {
+ "notebook": {
"type": "number"
},
"webhook": {
"type": "number"
},
@@ -22923,10 +24964,19 @@
"member": {
"type": "number"
},
"payload": {
"type": "number"
+ },
+ "notebookMinutesPerRun": {
+ "type": "number"
+ },
+ "notebookMinutesPerMonth": {
+ "type": "number"
+ },
+ "notebookInParallel": {
+ "type": "number"
}
},
"summary": {
"type": "object",
"properties": {
@@ -22934,13 +24984,10 @@
"type": "number"
},
"appCount": {
"type": "number"
},
- "keyCount": {
- "type": "number"
- },
"dashCount": {
"type": "number"
},
"dataTableCount": {
"type": "number"
@@ -22976,16 +25023,19 @@
"type": "number"
},
"flowCount": {
"type": "number"
},
- "memberCount": {
+ "integrationCount": {
"type": "number"
},
- "pendingInviteCount": {
+ "keyCount": {
"type": "number"
},
+ "memberCount": {
+ "type": "number"
+ },
"payloadCount": {
"title": "Payload Counts",
"description": "Schema for the result of a payload count request",
"type": "object",
"properties": {
@@ -23093,15 +25143,23 @@
}
}
}
}
},
- "solutionCount": {
+ "pendingInviteCount": {
"type": "number"
},
- "integrationCount": {
- "type": "number"
+ "storageStats": {
+ "type": "object",
+ "properties": {
+ "count": {
+ "type": "number"
+ },
+ "size": {
+ "type": "number"
+ }
+ }
},
"webhookCount": {
"type": "number"
}
}
@@ -25225,10 +27283,12 @@
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
+ "notebook.*",
+ "notebooks.*",
"webhook.*",
"webhooks.*",
"application.archiveData",
"application.backfillArchiveData",
"application.debug",
@@ -25247,10 +27307,11 @@
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
+ "data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
@@ -25375,10 +27436,19 @@
"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"
@@ -25620,10 +27690,12 @@
"files.*",
"flow.*",
"flows.*",
"flowVersion.*",
"flowVersions.*",
+ "notebook.*",
+ "notebooks.*",
"webhook.*",
"webhooks.*",
"application.archiveData",
"application.backfillArchiveData",
"application.debug",
@@ -25642,10 +27714,11 @@
"applicationKey.delete",
"applicationKey.get",
"applicationKey.patch",
"applicationKeys.get",
"applicationKeys.post",
+ "data.export",
"data.lastValueQuery",
"data.timeSeriesQuery",
"dataTable.addColumn",
"dataTable.delete",
"dataTable.get",
@@ -25770,9 +27843,18 @@
"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"