losant_rest 1.8.5 → 1.8.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +2209 -127
- data/docs/application.md +4 -2
- data/docs/applications.md +4 -2
- data/docs/data.md +41 -0
- data/docs/me.md +4 -2
- data/docs/notebook.md +305 -0
- data/docs/notebooks.md +93 -0
- data/docs/org.md +8 -2
- data/docs/orgs.md +4 -2
- data/lib/losant_rest/application.rb +6 -2
- data/lib/losant_rest/applications.rb +6 -2
- data/lib/losant_rest/client.rb +10 -2
- data/lib/losant_rest/data.rb +47 -0
- data/lib/losant_rest/me.rb +6 -2
- data/lib/losant_rest/notebook.rb +322 -0
- data/lib/losant_rest/notebooks.rb +136 -0
- data/lib/losant_rest/org.rb +14 -2
- data/lib/losant_rest/orgs.rb +6 -2
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +2 -0
- data/schemas/application.json +15 -4
- data/schemas/applicationApiTokenPost.json +12 -0
- data/schemas/applications.json +15 -4
- data/schemas/dataExport.json +65 -0
- data/schemas/deviceCredentials.json +1 -0
- data/schemas/edgeDeployment.json +2 -1
- data/schemas/edgeDeployments.json +2 -1
- data/schemas/event.json +4 -2
- data/schemas/events.json +4 -2
- data/schemas/file.json +2 -1
- data/schemas/fileUploadPostResponse.json +20 -26
- data/schemas/files.json +2 -1
- data/schemas/flow.json +1 -0
- data/schemas/flowPatch.json +1 -0
- data/schemas/flowPost.json +1 -0
- data/schemas/flowVersion.json +2 -0
- data/schemas/flowVersionPost.json +1 -0
- data/schemas/flowVersions.json +2 -0
- data/schemas/flows.json +1 -0
- data/schemas/flowsImportPost.json +2 -0
- data/schemas/flowsImportResult.json +3 -0
- data/schemas/githubLogin.json +12 -0
- data/schemas/me.json +28 -8
- data/schemas/notebook.json +322 -0
- data/schemas/notebookDataExportOptions.json +34 -0
- data/schemas/notebookExecutionLogs.json +125 -0
- data/schemas/notebookExecutionOptions.json +29 -0
- data/schemas/notebookPatch.json +295 -0
- data/schemas/notebookPost.json +298 -0
- data/schemas/notebooks.json +364 -0
- data/schemas/org.json +27 -10
- data/schemas/orgs.json +27 -10
- data/schemas/userCredentials.json +12 -0
- data/schemas/userPost.json +12 -0
- metadata +14 -2
data/docs/_schemas.md
CHANGED
@@ -28,6 +28,7 @@
|
|
28
28
|
* [Dashboard Post](#dashboard-post)
|
29
29
|
* [Dashboard Send Report](#dashboard-send-report)
|
30
30
|
* [Dashboards](#dashboards)
|
31
|
+
* [Data Export](#data-export)
|
31
32
|
* [Data Table](#data-table)
|
32
33
|
* [Data Table Column](#data-table-column)
|
33
34
|
* [Data Table Patch](#data-table-patch)
|
@@ -136,6 +137,13 @@
|
|
136
137
|
* [Me Patch](#me-patch)
|
137
138
|
* [MQTT Publish Body](#mqtt-publish-body)
|
138
139
|
* [Multi Device Command](#multi-device-command)
|
140
|
+
* [Notebook](#notebook)
|
141
|
+
* [Notebook Data Export Options](#notebook-data-export-options)
|
142
|
+
* [Notebook Execution Logs](#notebook-execution-logs)
|
143
|
+
* [Notebook Execution Options](#notebook-execution-options)
|
144
|
+
* [Notebook Patch](#notebook-patch)
|
145
|
+
* [Notebook Post](#notebook-post)
|
146
|
+
* [Notebooks](#notebooks)
|
139
147
|
* [Organization](#organization)
|
140
148
|
* [Organization Invitation Action](#organization-invitation-action)
|
141
149
|
* [Organization Invitation Information](#organization-invitation-information)
|
@@ -603,15 +611,12 @@ Schema for a single Application
|
|
603
611
|
"apiTokenCount": {
|
604
612
|
"type": "number"
|
605
613
|
},
|
606
|
-
"
|
614
|
+
"dataTableCount": {
|
607
615
|
"type": "number"
|
608
616
|
},
|
609
617
|
"deviceCount": {
|
610
618
|
"type": "number"
|
611
619
|
},
|
612
|
-
"dataTableCount": {
|
613
|
-
"type": "number"
|
614
|
-
},
|
615
620
|
"deviceRecipeCount": {
|
616
621
|
"type": "number"
|
617
622
|
},
|
@@ -648,6 +653,20 @@ Schema for a single Application
|
|
648
653
|
"integrationCount": {
|
649
654
|
"type": "number"
|
650
655
|
},
|
656
|
+
"keyCount": {
|
657
|
+
"type": "number"
|
658
|
+
},
|
659
|
+
"storageStats": {
|
660
|
+
"type": "object",
|
661
|
+
"properties": {
|
662
|
+
"count": {
|
663
|
+
"type": "number"
|
664
|
+
},
|
665
|
+
"size": {
|
666
|
+
"type": "number"
|
667
|
+
}
|
668
|
+
}
|
669
|
+
},
|
651
670
|
"webhookCount": {
|
652
671
|
"type": "number"
|
653
672
|
}
|
@@ -897,6 +916,8 @@ Schema for the body of an Application API Token creation request
|
|
897
916
|
"flows.*",
|
898
917
|
"flowVersion.*",
|
899
918
|
"flowVersions.*",
|
919
|
+
"notebook.*",
|
920
|
+
"notebooks.*",
|
900
921
|
"webhook.*",
|
901
922
|
"webhooks.*",
|
902
923
|
"application.archiveData",
|
@@ -919,6 +940,7 @@ Schema for the body of an Application API Token creation request
|
|
919
940
|
"applicationKey.patch",
|
920
941
|
"applicationKeys.get",
|
921
942
|
"applicationKeys.post",
|
943
|
+
"data.export",
|
922
944
|
"data.lastValueQuery",
|
923
945
|
"data.timeSeriesQuery",
|
924
946
|
"dataTable.addColumn",
|
@@ -1047,6 +1069,15 @@ Schema for the body of an Application API Token creation request
|
|
1047
1069
|
"integration.patch",
|
1048
1070
|
"integrations.get",
|
1049
1071
|
"integrations.post",
|
1072
|
+
"notebook.delete",
|
1073
|
+
"notebook.execute",
|
1074
|
+
"notebook.get",
|
1075
|
+
"notebook.logs",
|
1076
|
+
"notebook.patch",
|
1077
|
+
"notebook.requestInputDataExport",
|
1078
|
+
"notebook.upload",
|
1079
|
+
"notebooks.get",
|
1080
|
+
"notebooks.post",
|
1050
1081
|
"webhook.delete",
|
1051
1082
|
"webhook.get",
|
1052
1083
|
"webhook.patch",
|
@@ -2081,15 +2112,12 @@ Schema for a collection of Applications
|
|
2081
2112
|
"apiTokenCount": {
|
2082
2113
|
"type": "number"
|
2083
2114
|
},
|
2084
|
-
"
|
2115
|
+
"dataTableCount": {
|
2085
2116
|
"type": "number"
|
2086
2117
|
},
|
2087
2118
|
"deviceCount": {
|
2088
2119
|
"type": "number"
|
2089
2120
|
},
|
2090
|
-
"dataTableCount": {
|
2091
|
-
"type": "number"
|
2092
|
-
},
|
2093
2121
|
"deviceRecipeCount": {
|
2094
2122
|
"type": "number"
|
2095
2123
|
},
|
@@ -2126,6 +2154,20 @@ Schema for a collection of Applications
|
|
2126
2154
|
"integrationCount": {
|
2127
2155
|
"type": "number"
|
2128
2156
|
},
|
2157
|
+
"keyCount": {
|
2158
|
+
"type": "number"
|
2159
|
+
},
|
2160
|
+
"storageStats": {
|
2161
|
+
"type": "object",
|
2162
|
+
"properties": {
|
2163
|
+
"count": {
|
2164
|
+
"type": "number"
|
2165
|
+
},
|
2166
|
+
"size": {
|
2167
|
+
"type": "number"
|
2168
|
+
}
|
2169
|
+
}
|
2170
|
+
},
|
2129
2171
|
"webhookCount": {
|
2130
2172
|
"type": "number"
|
2131
2173
|
}
|
@@ -4762,6 +4804,101 @@ Schema for a collection of Dashboards
|
|
4762
4804
|
|
4763
4805
|
<br/>
|
4764
4806
|
|
4807
|
+
## Data Export
|
4808
|
+
|
4809
|
+
Schema for exporting data devices query
|
4810
|
+
|
4811
|
+
### <a name="data-export-schema"></a> Schema
|
4812
|
+
|
4813
|
+
```json
|
4814
|
+
{
|
4815
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
4816
|
+
"type": "object",
|
4817
|
+
"properties": {
|
4818
|
+
"email": {
|
4819
|
+
"type": "string",
|
4820
|
+
"format": "email",
|
4821
|
+
"maxLength": 1024
|
4822
|
+
},
|
4823
|
+
"deviceIds": {
|
4824
|
+
"type": "array",
|
4825
|
+
"items": {
|
4826
|
+
"type": "string",
|
4827
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4828
|
+
},
|
4829
|
+
"maxItems": 1000
|
4830
|
+
},
|
4831
|
+
"deviceTags": {
|
4832
|
+
"type": "array",
|
4833
|
+
"items": {
|
4834
|
+
"type": "object",
|
4835
|
+
"properties": {
|
4836
|
+
"key": {
|
4837
|
+
"type": "string",
|
4838
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4839
|
+
},
|
4840
|
+
"value": {
|
4841
|
+
"type": "string",
|
4842
|
+
"minLength": 1,
|
4843
|
+
"maxLength": 255
|
4844
|
+
}
|
4845
|
+
},
|
4846
|
+
"additionalProperties": false
|
4847
|
+
},
|
4848
|
+
"maxItems": 100
|
4849
|
+
},
|
4850
|
+
"attributes": {
|
4851
|
+
"type": "array",
|
4852
|
+
"items": {
|
4853
|
+
"type": "string",
|
4854
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4855
|
+
}
|
4856
|
+
},
|
4857
|
+
"start": {
|
4858
|
+
"type": "number"
|
4859
|
+
},
|
4860
|
+
"end": {
|
4861
|
+
"type": "number"
|
4862
|
+
},
|
4863
|
+
"options": {
|
4864
|
+
"type": "object",
|
4865
|
+
"properties": {
|
4866
|
+
"includeDate": {
|
4867
|
+
"type": "boolean",
|
4868
|
+
"default": true
|
4869
|
+
},
|
4870
|
+
"includeID": {
|
4871
|
+
"type": "boolean",
|
4872
|
+
"default": true
|
4873
|
+
}
|
4874
|
+
}
|
4875
|
+
}
|
4876
|
+
},
|
4877
|
+
"additionalProperties": false
|
4878
|
+
}
|
4879
|
+
```
|
4880
|
+
### <a name="data-export-example"></a> Example
|
4881
|
+
|
4882
|
+
```json
|
4883
|
+
{
|
4884
|
+
"email": "example@losant.com",
|
4885
|
+
"deviceIds": [
|
4886
|
+
"575ecf887ae143cd83dc4aa2",
|
4887
|
+
"575ef5c97ae143cd83dc4aac"
|
4888
|
+
],
|
4889
|
+
"attributes": [
|
4890
|
+
"voltage"
|
4891
|
+
],
|
4892
|
+
"end": 0,
|
4893
|
+
"options": {
|
4894
|
+
"includeDate": false,
|
4895
|
+
"includeID": true
|
4896
|
+
}
|
4897
|
+
}
|
4898
|
+
```
|
4899
|
+
|
4900
|
+
<br/>
|
4901
|
+
|
4765
4902
|
## Data Table
|
4766
4903
|
|
4767
4904
|
Schema for a single Data Table
|
@@ -6363,6 +6500,7 @@ Schema for the body of a Device authentication request
|
|
6363
6500
|
"enum": [
|
6364
6501
|
"all.Device",
|
6365
6502
|
"all.Device.read",
|
6503
|
+
"data.export",
|
6366
6504
|
"data.timeSeriesQuery",
|
6367
6505
|
"data.lastValueQuery",
|
6368
6506
|
"device.commandStream",
|
@@ -8104,7 +8242,8 @@ Schema for a single deployment of an edge workflow to an edge device
|
|
8104
8242
|
"flow",
|
8105
8243
|
"user",
|
8106
8244
|
"device",
|
8107
|
-
"apiToken"
|
8245
|
+
"apiToken",
|
8246
|
+
"notebook"
|
8108
8247
|
]
|
8109
8248
|
},
|
8110
8249
|
"sourceId": {
|
@@ -8431,7 +8570,8 @@ Schema for a collection of Edge Deployments
|
|
8431
8570
|
"flow",
|
8432
8571
|
"user",
|
8433
8572
|
"device",
|
8434
|
-
"apiToken"
|
8573
|
+
"apiToken",
|
8574
|
+
"notebook"
|
8435
8575
|
]
|
8436
8576
|
},
|
8437
8577
|
"sourceId": {
|
@@ -8694,7 +8834,8 @@ Schema for a single Event
|
|
8694
8834
|
"flow",
|
8695
8835
|
"user",
|
8696
8836
|
"device",
|
8697
|
-
"apiToken"
|
8837
|
+
"apiToken",
|
8838
|
+
"notebook"
|
8698
8839
|
]
|
8699
8840
|
},
|
8700
8841
|
"sourceId": {
|
@@ -8739,7 +8880,8 @@ Schema for a single Event
|
|
8739
8880
|
"flow",
|
8740
8881
|
"user",
|
8741
8882
|
"device",
|
8742
|
-
"apiToken"
|
8883
|
+
"apiToken",
|
8884
|
+
"notebook"
|
8743
8885
|
]
|
8744
8886
|
},
|
8745
8887
|
"sourceId": {
|
@@ -8946,7 +9088,8 @@ Schema for a collection of Events
|
|
8946
9088
|
"flow",
|
8947
9089
|
"user",
|
8948
9090
|
"device",
|
8949
|
-
"apiToken"
|
9091
|
+
"apiToken",
|
9092
|
+
"notebook"
|
8950
9093
|
]
|
8951
9094
|
},
|
8952
9095
|
"sourceId": {
|
@@ -8991,7 +9134,8 @@ Schema for a collection of Events
|
|
8991
9134
|
"flow",
|
8992
9135
|
"user",
|
8993
9136
|
"device",
|
8994
|
-
"apiToken"
|
9137
|
+
"apiToken",
|
9138
|
+
"notebook"
|
8995
9139
|
]
|
8996
9140
|
},
|
8997
9141
|
"sourceId": {
|
@@ -12209,7 +12353,8 @@ Schema for a single file
|
|
12209
12353
|
"flow",
|
12210
12354
|
"user",
|
12211
12355
|
"device",
|
12212
|
-
"apiToken"
|
12356
|
+
"apiToken",
|
12357
|
+
"notebook"
|
12213
12358
|
]
|
12214
12359
|
},
|
12215
12360
|
"status": {
|
@@ -12435,7 +12580,8 @@ Schema to upload the file to s3
|
|
12435
12580
|
"flow",
|
12436
12581
|
"user",
|
12437
12582
|
"device",
|
12438
|
-
"apiToken"
|
12583
|
+
"apiToken",
|
12584
|
+
"notebook"
|
12439
12585
|
]
|
12440
12586
|
},
|
12441
12587
|
"status": {
|
@@ -12482,32 +12628,25 @@ Schema to upload the file to s3
|
|
12482
12628
|
}
|
12483
12629
|
},
|
12484
12630
|
"upload": {
|
12485
|
-
"
|
12486
|
-
|
12487
|
-
|
12488
|
-
|
12489
|
-
|
12490
|
-
"
|
12491
|
-
"
|
12492
|
-
|
12493
|
-
|
12494
|
-
|
12495
|
-
|
12496
|
-
},
|
12497
|
-
"X-Amz-Algorithm": {
|
12498
|
-
"type": "string"
|
12499
|
-
},
|
12500
|
-
"X-Amz-Credential": {
|
12501
|
-
"type": "string"
|
12502
|
-
},
|
12503
|
-
"X-Amz-Date": {
|
12504
|
-
"type": "string"
|
12505
|
-
},
|
12506
|
-
"Policy": {
|
12507
|
-
"type": "string"
|
12631
|
+
"type": "object",
|
12632
|
+
"properties": {
|
12633
|
+
"url": {
|
12634
|
+
"type": "string"
|
12635
|
+
},
|
12636
|
+
"fields": {
|
12637
|
+
"type": "object",
|
12638
|
+
"patternProperties": {
|
12639
|
+
"^.*$": {
|
12640
|
+
"type": "string"
|
12641
|
+
}
|
12508
12642
|
},
|
12509
|
-
"
|
12510
|
-
"
|
12643
|
+
"properties": {
|
12644
|
+
"key": {
|
12645
|
+
"type": "string"
|
12646
|
+
},
|
12647
|
+
"bucket": {
|
12648
|
+
"type": "string"
|
12649
|
+
}
|
12511
12650
|
}
|
12512
12651
|
}
|
12513
12652
|
}
|
@@ -12592,7 +12731,8 @@ Schema for a collection of files
|
|
12592
12731
|
"flow",
|
12593
12732
|
"user",
|
12594
12733
|
"device",
|
12595
|
-
"apiToken"
|
12734
|
+
"apiToken",
|
12735
|
+
"notebook"
|
12596
12736
|
]
|
12597
12737
|
},
|
12598
12738
|
"status": {
|
@@ -12815,6 +12955,7 @@ Schema for a single Workflow
|
|
12815
12955
|
"fileWatch",
|
12816
12956
|
"integration",
|
12817
12957
|
"mqttTopic",
|
12958
|
+
"notebook",
|
12818
12959
|
"redis",
|
12819
12960
|
"request",
|
12820
12961
|
"serial",
|
@@ -13435,6 +13576,7 @@ Schema for the body of a Workflow modification request
|
|
13435
13576
|
"fileWatch",
|
13436
13577
|
"integration",
|
13437
13578
|
"mqttTopic",
|
13579
|
+
"notebook",
|
13438
13580
|
"redis",
|
13439
13581
|
"request",
|
13440
13582
|
"serial",
|
@@ -13928,6 +14070,7 @@ Schema for the body of a Workflow creation request
|
|
13928
14070
|
"fileWatch",
|
13929
14071
|
"integration",
|
13930
14072
|
"mqttTopic",
|
14073
|
+
"notebook",
|
13931
14074
|
"redis",
|
13932
14075
|
"request",
|
13933
14076
|
"serial",
|
@@ -14561,6 +14704,7 @@ Schema for a single Workflow Version
|
|
14561
14704
|
"fileWatch",
|
14562
14705
|
"integration",
|
14563
14706
|
"mqttTopic",
|
14707
|
+
"notebook",
|
14564
14708
|
"redis",
|
14565
14709
|
"request",
|
14566
14710
|
"serial",
|
@@ -15091,6 +15235,7 @@ Schema for a single Workflow Version
|
|
15091
15235
|
"fileWatch",
|
15092
15236
|
"integration",
|
15093
15237
|
"mqttTopic",
|
15238
|
+
"notebook",
|
15094
15239
|
"redis",
|
15095
15240
|
"request",
|
15096
15241
|
"serial",
|
@@ -15324,6 +15469,7 @@ Schema for the body of a Workflow Version creation request
|
|
15324
15469
|
"fileWatch",
|
15325
15470
|
"integration",
|
15326
15471
|
"mqttTopic",
|
15472
|
+
"notebook",
|
15327
15473
|
"redis",
|
15328
15474
|
"request",
|
15329
15475
|
"serial",
|
@@ -15842,6 +15988,7 @@ Schema for a collection of Workflow Versions
|
|
15842
15988
|
"fileWatch",
|
15843
15989
|
"integration",
|
15844
15990
|
"mqttTopic",
|
15991
|
+
"notebook",
|
15845
15992
|
"redis",
|
15846
15993
|
"request",
|
15847
15994
|
"serial",
|
@@ -16372,6 +16519,7 @@ Schema for a collection of Workflow Versions
|
|
16372
16519
|
"fileWatch",
|
16373
16520
|
"integration",
|
16374
16521
|
"mqttTopic",
|
16522
|
+
"notebook",
|
16375
16523
|
"redis",
|
16376
16524
|
"request",
|
16377
16525
|
"serial",
|
@@ -16672,6 +16820,7 @@ Schema for a collection of Workflows
|
|
16672
16820
|
"fileWatch",
|
16673
16821
|
"integration",
|
16674
16822
|
"mqttTopic",
|
16823
|
+
"notebook",
|
16675
16824
|
"redis",
|
16676
16825
|
"request",
|
16677
16826
|
"serial",
|
@@ -17276,6 +17425,7 @@ Schema for the body of a workflow import request
|
|
17276
17425
|
"fileWatch",
|
17277
17426
|
"integration",
|
17278
17427
|
"mqttTopic",
|
17428
|
+
"notebook",
|
17279
17429
|
"redis",
|
17280
17430
|
"request",
|
17281
17431
|
"serial",
|
@@ -17787,6 +17937,7 @@ Schema for the body of a workflow import request
|
|
17787
17937
|
"fileWatch",
|
17788
17938
|
"integration",
|
17789
17939
|
"mqttTopic",
|
17940
|
+
"notebook",
|
17790
17941
|
"redis",
|
17791
17942
|
"request",
|
17792
17943
|
"serial",
|
@@ -18345,6 +18496,7 @@ Schema for the result of a workflow import request
|
|
18345
18496
|
"fileWatch",
|
18346
18497
|
"integration",
|
18347
18498
|
"mqttTopic",
|
18499
|
+
"notebook",
|
18348
18500
|
"redis",
|
18349
18501
|
"request",
|
18350
18502
|
"serial",
|
@@ -18875,6 +19027,7 @@ Schema for the result of a workflow import request
|
|
18875
19027
|
"fileWatch",
|
18876
19028
|
"integration",
|
18877
19029
|
"mqttTopic",
|
19030
|
+
"notebook",
|
18878
19031
|
"redis",
|
18879
19032
|
"request",
|
18880
19033
|
"serial",
|
@@ -19405,6 +19558,7 @@ Schema for the result of a workflow import request
|
|
19405
19558
|
"fileWatch",
|
19406
19559
|
"integration",
|
19407
19560
|
"mqttTopic",
|
19561
|
+
"notebook",
|
19408
19562
|
"redis",
|
19409
19563
|
"request",
|
19410
19564
|
"serial",
|
@@ -19656,6 +19810,8 @@ Schema for the body of a Github login request
|
|
19656
19810
|
"flows.*",
|
19657
19811
|
"flowVersion.*",
|
19658
19812
|
"flowVersions.*",
|
19813
|
+
"notebook.*",
|
19814
|
+
"notebooks.*",
|
19659
19815
|
"webhook.*",
|
19660
19816
|
"webhooks.*",
|
19661
19817
|
"application.archiveData",
|
@@ -19678,6 +19834,7 @@ Schema for the body of a Github login request
|
|
19678
19834
|
"applicationKey.patch",
|
19679
19835
|
"applicationKeys.get",
|
19680
19836
|
"applicationKeys.post",
|
19837
|
+
"data.export",
|
19681
19838
|
"data.lastValueQuery",
|
19682
19839
|
"data.timeSeriesQuery",
|
19683
19840
|
"dataTable.addColumn",
|
@@ -19806,6 +19963,15 @@ Schema for the body of a Github login request
|
|
19806
19963
|
"integration.patch",
|
19807
19964
|
"integrations.get",
|
19808
19965
|
"integrations.post",
|
19966
|
+
"notebook.delete",
|
19967
|
+
"notebook.execute",
|
19968
|
+
"notebook.get",
|
19969
|
+
"notebook.logs",
|
19970
|
+
"notebook.patch",
|
19971
|
+
"notebook.requestInputDataExport",
|
19972
|
+
"notebook.upload",
|
19973
|
+
"notebooks.get",
|
19974
|
+
"notebooks.post",
|
19809
19975
|
"webhook.delete",
|
19810
19976
|
"webhook.get",
|
19811
19977
|
"webhook.patch",
|
@@ -21170,6 +21336,9 @@ Schema for information about the currently authenticated user
|
|
21170
21336
|
"integration": {
|
21171
21337
|
"type": "number"
|
21172
21338
|
},
|
21339
|
+
"notebook": {
|
21340
|
+
"type": "number"
|
21341
|
+
},
|
21173
21342
|
"webhook": {
|
21174
21343
|
"type": "number"
|
21175
21344
|
},
|
@@ -21178,6 +21347,15 @@ Schema for information about the currently authenticated user
|
|
21178
21347
|
},
|
21179
21348
|
"payload": {
|
21180
21349
|
"type": "number"
|
21350
|
+
},
|
21351
|
+
"notebookMinutesPerRun": {
|
21352
|
+
"type": "number"
|
21353
|
+
},
|
21354
|
+
"notebookMinutesPerMonth": {
|
21355
|
+
"type": "number"
|
21356
|
+
},
|
21357
|
+
"notebookInParallel": {
|
21358
|
+
"type": "number"
|
21181
21359
|
}
|
21182
21360
|
},
|
21183
21361
|
"recentDashboards": {
|
@@ -21303,9 +21481,6 @@ Schema for information about the currently authenticated user
|
|
21303
21481
|
"appCount": {
|
21304
21482
|
"type": "number"
|
21305
21483
|
},
|
21306
|
-
"keyCount": {
|
21307
|
-
"type": "number"
|
21308
|
-
},
|
21309
21484
|
"dashCount": {
|
21310
21485
|
"type": "number"
|
21311
21486
|
},
|
@@ -21318,9 +21493,6 @@ Schema for information about the currently authenticated user
|
|
21318
21493
|
"deviceRecipeCount": {
|
21319
21494
|
"type": "number"
|
21320
21495
|
},
|
21321
|
-
"experienceDomainCount": {
|
21322
|
-
"type": "number"
|
21323
|
-
},
|
21324
21496
|
"experienceEndpointCount": {
|
21325
21497
|
"type": "number"
|
21326
21498
|
},
|
@@ -21345,6 +21517,12 @@ Schema for information about the currently authenticated user
|
|
21345
21517
|
"flowCount": {
|
21346
21518
|
"type": "number"
|
21347
21519
|
},
|
21520
|
+
"integrationCount": {
|
21521
|
+
"type": "number"
|
21522
|
+
},
|
21523
|
+
"keyCount": {
|
21524
|
+
"type": "number"
|
21525
|
+
},
|
21348
21526
|
"orgCount": {
|
21349
21527
|
"type": "number"
|
21350
21528
|
},
|
@@ -21459,8 +21637,16 @@ Schema for information about the currently authenticated user
|
|
21459
21637
|
}
|
21460
21638
|
}
|
21461
21639
|
},
|
21462
|
-
"
|
21463
|
-
"type": "
|
21640
|
+
"storageStats": {
|
21641
|
+
"type": "object",
|
21642
|
+
"properties": {
|
21643
|
+
"count": {
|
21644
|
+
"type": "number"
|
21645
|
+
},
|
21646
|
+
"size": {
|
21647
|
+
"type": "number"
|
21648
|
+
}
|
21649
|
+
}
|
21464
21650
|
},
|
21465
21651
|
"webhookCount": {
|
21466
21652
|
"type": "number"
|
@@ -21721,11 +21907,11 @@ Schema for the body of a request to send a command to multiple Devices
|
|
21721
21907
|
|
21722
21908
|
<br/>
|
21723
21909
|
|
21724
|
-
##
|
21910
|
+
## Notebook
|
21725
21911
|
|
21726
|
-
Schema for a single
|
21912
|
+
Schema for a single Notebook
|
21727
21913
|
|
21728
|
-
### <a name="
|
21914
|
+
### <a name="notebook-schema"></a> Schema
|
21729
21915
|
|
21730
21916
|
```json
|
21731
21917
|
{
|
@@ -21736,7 +21922,11 @@ Schema for a single Organization
|
|
21736
21922
|
"type": "string",
|
21737
21923
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
21738
21924
|
},
|
21739
|
-
"
|
21925
|
+
"notebookId": {
|
21926
|
+
"type": "string",
|
21927
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
21928
|
+
},
|
21929
|
+
"applicationId": {
|
21740
21930
|
"type": "string",
|
21741
21931
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
21742
21932
|
},
|
@@ -21751,67 +21941,1901 @@ Schema for a single Organization
|
|
21751
21941
|
"name": {
|
21752
21942
|
"type": "string",
|
21753
21943
|
"minLength": 1,
|
21754
|
-
"maxLength":
|
21944
|
+
"maxLength": 1024
|
21755
21945
|
},
|
21756
21946
|
"description": {
|
21757
21947
|
"type": "string",
|
21758
21948
|
"maxLength": 32767
|
21759
21949
|
},
|
21760
|
-
"
|
21761
|
-
"type": "
|
21950
|
+
"jupyterFileName": {
|
21951
|
+
"type": "string",
|
21952
|
+
"minLength": 1,
|
21953
|
+
"maxLength": 1024
|
21762
21954
|
},
|
21763
|
-
"
|
21955
|
+
"jupyterFileUrl": {
|
21956
|
+
"type": "string"
|
21957
|
+
},
|
21958
|
+
"inputs": {
|
21764
21959
|
"type": "array",
|
21765
21960
|
"items": {
|
21766
|
-
"
|
21767
|
-
"
|
21768
|
-
|
21769
|
-
"type": "
|
21770
|
-
"
|
21771
|
-
|
21772
|
-
|
21773
|
-
|
21774
|
-
|
21775
|
-
|
21776
|
-
|
21777
|
-
|
21778
|
-
|
21779
|
-
|
21780
|
-
|
21781
|
-
|
21782
|
-
|
21783
|
-
|
21784
|
-
|
21785
|
-
|
21786
|
-
|
21787
|
-
|
21788
|
-
|
21789
|
-
|
21790
|
-
|
21791
|
-
|
21792
|
-
|
21793
|
-
|
21794
|
-
|
21795
|
-
|
21796
|
-
|
21797
|
-
|
21798
|
-
|
21799
|
-
|
21800
|
-
|
21801
|
-
|
21802
|
-
|
21803
|
-
|
21804
|
-
|
21805
|
-
|
21806
|
-
"
|
21807
|
-
|
21808
|
-
|
21809
|
-
|
21810
|
-
"
|
21811
|
-
|
21812
|
-
"
|
21813
|
-
|
21814
|
-
|
21961
|
+
"maxItems": 100,
|
21962
|
+
"oneOf": [
|
21963
|
+
{
|
21964
|
+
"type": "object",
|
21965
|
+
"properties": {
|
21966
|
+
"inputType": {
|
21967
|
+
"type": "string",
|
21968
|
+
"enum": [
|
21969
|
+
"deviceData"
|
21970
|
+
]
|
21971
|
+
},
|
21972
|
+
"fileName": {
|
21973
|
+
"type": "string",
|
21974
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
21975
|
+
},
|
21976
|
+
"deviceTags": {
|
21977
|
+
"type": "array",
|
21978
|
+
"items": {
|
21979
|
+
"type": "object",
|
21980
|
+
"properties": {
|
21981
|
+
"key": {
|
21982
|
+
"type": "string",
|
21983
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
21984
|
+
},
|
21985
|
+
"value": {
|
21986
|
+
"type": "string",
|
21987
|
+
"minLength": 1,
|
21988
|
+
"maxLength": 255
|
21989
|
+
}
|
21990
|
+
},
|
21991
|
+
"additionalProperties": false
|
21992
|
+
},
|
21993
|
+
"maxItems": 100
|
21994
|
+
},
|
21995
|
+
"deviceIds": {
|
21996
|
+
"type": "array",
|
21997
|
+
"items": {
|
21998
|
+
"type": "string",
|
21999
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22000
|
+
},
|
22001
|
+
"maxItems": 1000
|
22002
|
+
},
|
22003
|
+
"attributes": {
|
22004
|
+
"type": "array",
|
22005
|
+
"maxItems": 100,
|
22006
|
+
"items": {
|
22007
|
+
"type": "string",
|
22008
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22009
|
+
}
|
22010
|
+
},
|
22011
|
+
"start": {
|
22012
|
+
"type": "number"
|
22013
|
+
},
|
22014
|
+
"end": {
|
22015
|
+
"type": "number"
|
22016
|
+
}
|
22017
|
+
},
|
22018
|
+
"required": [
|
22019
|
+
"inputType",
|
22020
|
+
"fileName",
|
22021
|
+
"start",
|
22022
|
+
"end"
|
22023
|
+
],
|
22024
|
+
"additionalProperties": false
|
22025
|
+
},
|
22026
|
+
{
|
22027
|
+
"type": "object",
|
22028
|
+
"properties": {
|
22029
|
+
"inputType": {
|
22030
|
+
"type": "string",
|
22031
|
+
"enum": [
|
22032
|
+
"deviceMetadata"
|
22033
|
+
]
|
22034
|
+
},
|
22035
|
+
"fileName": {
|
22036
|
+
"type": "string",
|
22037
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22038
|
+
},
|
22039
|
+
"deviceTags": {
|
22040
|
+
"type": "array",
|
22041
|
+
"items": {
|
22042
|
+
"type": "object",
|
22043
|
+
"properties": {
|
22044
|
+
"key": {
|
22045
|
+
"type": "string",
|
22046
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22047
|
+
},
|
22048
|
+
"value": {
|
22049
|
+
"type": "string",
|
22050
|
+
"minLength": 1,
|
22051
|
+
"maxLength": 255
|
22052
|
+
}
|
22053
|
+
},
|
22054
|
+
"additionalProperties": false
|
22055
|
+
},
|
22056
|
+
"maxItems": 100
|
22057
|
+
},
|
22058
|
+
"deviceIds": {
|
22059
|
+
"type": "array",
|
22060
|
+
"items": {
|
22061
|
+
"type": "string",
|
22062
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22063
|
+
},
|
22064
|
+
"maxItems": 1000
|
22065
|
+
}
|
22066
|
+
},
|
22067
|
+
"required": [
|
22068
|
+
"inputType",
|
22069
|
+
"fileName"
|
22070
|
+
],
|
22071
|
+
"additionalProperties": false
|
22072
|
+
},
|
22073
|
+
{
|
22074
|
+
"type": "object",
|
22075
|
+
"properties": {
|
22076
|
+
"inputType": {
|
22077
|
+
"type": "string",
|
22078
|
+
"enum": [
|
22079
|
+
"dataTable"
|
22080
|
+
]
|
22081
|
+
},
|
22082
|
+
"fileName": {
|
22083
|
+
"type": "string",
|
22084
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22085
|
+
},
|
22086
|
+
"dataTableId": {
|
22087
|
+
"type": "string",
|
22088
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22089
|
+
},
|
22090
|
+
"queryJson": {
|
22091
|
+
"type": "string",
|
22092
|
+
"maxLength": 32767
|
22093
|
+
}
|
22094
|
+
},
|
22095
|
+
"required": [
|
22096
|
+
"inputType",
|
22097
|
+
"fileName",
|
22098
|
+
"dataTableId"
|
22099
|
+
],
|
22100
|
+
"additionalProperties": false
|
22101
|
+
},
|
22102
|
+
{
|
22103
|
+
"type": "object",
|
22104
|
+
"properties": {
|
22105
|
+
"inputType": {
|
22106
|
+
"type": "string",
|
22107
|
+
"enum": [
|
22108
|
+
"externalUrl"
|
22109
|
+
]
|
22110
|
+
},
|
22111
|
+
"fileName": {
|
22112
|
+
"type": "string",
|
22113
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22114
|
+
},
|
22115
|
+
"sourceUrl": {
|
22116
|
+
"type": "string",
|
22117
|
+
"minLength": 1,
|
22118
|
+
"maxLength": 1024
|
22119
|
+
}
|
22120
|
+
},
|
22121
|
+
"required": [
|
22122
|
+
"inputType",
|
22123
|
+
"fileName",
|
22124
|
+
"sourceUrl"
|
22125
|
+
],
|
22126
|
+
"additionalProperties": false
|
22127
|
+
}
|
22128
|
+
]
|
22129
|
+
}
|
22130
|
+
},
|
22131
|
+
"outputs": {
|
22132
|
+
"type": "array",
|
22133
|
+
"items": {
|
22134
|
+
"maxItems": 100,
|
22135
|
+
"oneOf": [
|
22136
|
+
{
|
22137
|
+
"type": "object",
|
22138
|
+
"properties": {
|
22139
|
+
"outputType": {
|
22140
|
+
"type": "string",
|
22141
|
+
"enum": [
|
22142
|
+
"dataTable"
|
22143
|
+
]
|
22144
|
+
},
|
22145
|
+
"fileName": {
|
22146
|
+
"type": "string",
|
22147
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22148
|
+
},
|
22149
|
+
"dataTableId": {
|
22150
|
+
"type": "string",
|
22151
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22152
|
+
},
|
22153
|
+
"createMissingColumns": {
|
22154
|
+
"type": "boolean"
|
22155
|
+
},
|
22156
|
+
"truncateExistingTable": {
|
22157
|
+
"type": "boolean"
|
22158
|
+
}
|
22159
|
+
},
|
22160
|
+
"required": [
|
22161
|
+
"fileName",
|
22162
|
+
"outputType",
|
22163
|
+
"dataTableId"
|
22164
|
+
],
|
22165
|
+
"additionalProperties": false
|
22166
|
+
},
|
22167
|
+
{
|
22168
|
+
"type": "object",
|
22169
|
+
"properties": {
|
22170
|
+
"outputType": {
|
22171
|
+
"type": "string",
|
22172
|
+
"enum": [
|
22173
|
+
"file"
|
22174
|
+
]
|
22175
|
+
},
|
22176
|
+
"fileName": {
|
22177
|
+
"type": "string",
|
22178
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22179
|
+
},
|
22180
|
+
"destinationDirectoryTemplate": {
|
22181
|
+
"type": "string",
|
22182
|
+
"minLength": 1,
|
22183
|
+
"maxLength": 1024
|
22184
|
+
},
|
22185
|
+
"destinationFileNameTemplate": {
|
22186
|
+
"type": "string",
|
22187
|
+
"minLength": 1,
|
22188
|
+
"maxLength": 1024
|
22189
|
+
}
|
22190
|
+
},
|
22191
|
+
"required": [
|
22192
|
+
"fileName",
|
22193
|
+
"outputType",
|
22194
|
+
"destinationFileNameTemplate"
|
22195
|
+
],
|
22196
|
+
"additionalProperties": false
|
22197
|
+
},
|
22198
|
+
{
|
22199
|
+
"type": "object",
|
22200
|
+
"properties": {
|
22201
|
+
"outputType": {
|
22202
|
+
"type": "string",
|
22203
|
+
"enum": [
|
22204
|
+
"executionResult"
|
22205
|
+
]
|
22206
|
+
},
|
22207
|
+
"fileName": {
|
22208
|
+
"type": "string",
|
22209
|
+
"enum": [
|
22210
|
+
"result.html",
|
22211
|
+
"result.pdf",
|
22212
|
+
"result.ipynb",
|
22213
|
+
"result.error.log",
|
22214
|
+
"result.log"
|
22215
|
+
]
|
22216
|
+
},
|
22217
|
+
"destinationDirectoryTemplate": {
|
22218
|
+
"type": "string",
|
22219
|
+
"minLength": 1,
|
22220
|
+
"maxLength": 1024
|
22221
|
+
},
|
22222
|
+
"destinationFileNameTemplate": {
|
22223
|
+
"type": "string",
|
22224
|
+
"minLength": 1,
|
22225
|
+
"maxLength": 1024
|
22226
|
+
}
|
22227
|
+
},
|
22228
|
+
"required": [
|
22229
|
+
"fileName",
|
22230
|
+
"outputType"
|
22231
|
+
],
|
22232
|
+
"additionalProperties": false
|
22233
|
+
}
|
22234
|
+
]
|
22235
|
+
}
|
22236
|
+
}
|
22237
|
+
}
|
22238
|
+
}
|
22239
|
+
```
|
22240
|
+
### <a name="notebook-example"></a> Example
|
22241
|
+
|
22242
|
+
```json
|
22243
|
+
{
|
22244
|
+
"id": "5c782b8d4f3a8e51c1db42e4",
|
22245
|
+
"notebookId": "5c782b8d4f3a8e51c1db42e4",
|
22246
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
22247
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
22248
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
22249
|
+
"name": "Example Notebook",
|
22250
|
+
"jupyterFileName": "myNotebook.ipynb",
|
22251
|
+
"jupyterFileUrl": "https://mystoragedomain.com/myNotebook.ipynb",
|
22252
|
+
"inputs": [
|
22253
|
+
{
|
22254
|
+
"fileName": "deviceDataWithAttributes",
|
22255
|
+
"inputType": "deviceData",
|
22256
|
+
"attributes": [
|
22257
|
+
"aNumber"
|
22258
|
+
],
|
22259
|
+
"deviceIds": [
|
22260
|
+
"5c926894a111ea00063978ac"
|
22261
|
+
],
|
22262
|
+
"deviceTags": [],
|
22263
|
+
"start": -10368000000,
|
22264
|
+
"end": 0
|
22265
|
+
},
|
22266
|
+
{
|
22267
|
+
"fileName": "dataTableWithQuery",
|
22268
|
+
"inputType": "dataTable",
|
22269
|
+
"dataTableId": "5c91584211126400069179c1",
|
22270
|
+
"queryJson": "{\n \"$or\": [\n {\n \"createdAt\": {\n \"$gt\": \"12345\"\n }\n }\n ]\n}"
|
22271
|
+
},
|
22272
|
+
{
|
22273
|
+
"fileName": "deviceMetaData",
|
22274
|
+
"inputType": "deviceMetadata",
|
22275
|
+
"deviceIds": [
|
22276
|
+
"5c926894a111ea00063978ac"
|
22277
|
+
],
|
22278
|
+
"deviceTags": [
|
22279
|
+
{
|
22280
|
+
"key": "aTag",
|
22281
|
+
"value": "and value"
|
22282
|
+
}
|
22283
|
+
]
|
22284
|
+
},
|
22285
|
+
{
|
22286
|
+
"fileName": "deviceDataAllAttributes",
|
22287
|
+
"inputType": "deviceData",
|
22288
|
+
"attributes": [],
|
22289
|
+
"deviceIds": [],
|
22290
|
+
"deviceTags": [
|
22291
|
+
{
|
22292
|
+
"value": "and value"
|
22293
|
+
}
|
22294
|
+
],
|
22295
|
+
"start": -43200000,
|
22296
|
+
"end": 0
|
22297
|
+
},
|
22298
|
+
{
|
22299
|
+
"fileName": "anExternalUrl",
|
22300
|
+
"inputType": "externalUrl",
|
22301
|
+
"sourceUrl": "https://foo.com"
|
22302
|
+
}
|
22303
|
+
],
|
22304
|
+
"outputs": [
|
22305
|
+
{
|
22306
|
+
"fileName": "result.html",
|
22307
|
+
"outputType": "executionResult",
|
22308
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
22309
|
+
"destinationFileNameTemplate": "result.html"
|
22310
|
+
},
|
22311
|
+
{
|
22312
|
+
"fileName": "result.pdf",
|
22313
|
+
"outputType": "executionResult",
|
22314
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
22315
|
+
"destinationFileNameTemplate": "result.pdf"
|
22316
|
+
},
|
22317
|
+
{
|
22318
|
+
"fileName": "result.ipynb",
|
22319
|
+
"outputType": "executionResult",
|
22320
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
22321
|
+
"destinationFileNameTemplate": "result.ipynb"
|
22322
|
+
},
|
22323
|
+
{
|
22324
|
+
"fileName": "result.error.log",
|
22325
|
+
"outputType": "executionResult",
|
22326
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
22327
|
+
"destinationFileNameTemplate": "result.error.log"
|
22328
|
+
},
|
22329
|
+
{
|
22330
|
+
"fileName": "result.log",
|
22331
|
+
"outputType": "executionResult",
|
22332
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
22333
|
+
"destinationFileNameTemplate": "result.log"
|
22334
|
+
},
|
22335
|
+
{
|
22336
|
+
"fileName": "myDataTableFile.csv",
|
22337
|
+
"outputType": "dataTable",
|
22338
|
+
"dataTableId": "5c925132a111ea00063978a7",
|
22339
|
+
"createMissingColumns": true,
|
22340
|
+
"truncateExistingTable": false
|
22341
|
+
},
|
22342
|
+
{
|
22343
|
+
"fileName": "myDataTableFileTwo.csv",
|
22344
|
+
"outputType": "dataTable",
|
22345
|
+
"dataTableId": "5c91584211126400069179c1",
|
22346
|
+
"createMissingColumns": false,
|
22347
|
+
"truncateExistingTable": true
|
22348
|
+
},
|
22349
|
+
{
|
22350
|
+
"fileName": "myApplicationFile.png",
|
22351
|
+
"outputType": "file",
|
22352
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
22353
|
+
"destinationFileNameTemplate": "myApplicationFile.png"
|
22354
|
+
}
|
22355
|
+
]
|
22356
|
+
}
|
22357
|
+
```
|
22358
|
+
|
22359
|
+
<br/>
|
22360
|
+
|
22361
|
+
## Notebook Data Export Options
|
22362
|
+
|
22363
|
+
Schema for the options for a Notebook data export request
|
22364
|
+
|
22365
|
+
### <a name="notebook-data-export-options-schema"></a> Schema
|
22366
|
+
|
22367
|
+
```json
|
22368
|
+
{
|
22369
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
22370
|
+
"type": "object",
|
22371
|
+
"properties": {
|
22372
|
+
"email": {
|
22373
|
+
"type": "string",
|
22374
|
+
"format": "email",
|
22375
|
+
"maxLength": 1024
|
22376
|
+
},
|
22377
|
+
"relativeTo": {
|
22378
|
+
"oneOf": [
|
22379
|
+
{
|
22380
|
+
"type": "string"
|
22381
|
+
},
|
22382
|
+
{
|
22383
|
+
"type": "number"
|
22384
|
+
},
|
22385
|
+
{
|
22386
|
+
"type": "object",
|
22387
|
+
"properties": {
|
22388
|
+
"$date": {
|
22389
|
+
"type": "string"
|
22390
|
+
}
|
22391
|
+
},
|
22392
|
+
"additionalProperties": false,
|
22393
|
+
"required": [
|
22394
|
+
"$date"
|
22395
|
+
]
|
22396
|
+
}
|
22397
|
+
]
|
22398
|
+
}
|
22399
|
+
},
|
22400
|
+
"additionalProperties": false
|
22401
|
+
}
|
22402
|
+
```
|
22403
|
+
### <a name="notebook-data-export-options-example"></a> Example
|
22404
|
+
|
22405
|
+
```json
|
22406
|
+
{
|
22407
|
+
"email": "user@example.com"
|
22408
|
+
}
|
22409
|
+
```
|
22410
|
+
|
22411
|
+
<br/>
|
22412
|
+
|
22413
|
+
## Notebook Execution Logs
|
22414
|
+
|
22415
|
+
Schema for a set of Notebook execution logs
|
22416
|
+
|
22417
|
+
### <a name="notebook-execution-logs-schema"></a> Schema
|
22418
|
+
|
22419
|
+
```json
|
22420
|
+
{
|
22421
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
22422
|
+
"type": "array",
|
22423
|
+
"items": {
|
22424
|
+
"type": "object",
|
22425
|
+
"properties": {
|
22426
|
+
"id": {
|
22427
|
+
"type": "string",
|
22428
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22429
|
+
},
|
22430
|
+
"notebookExecutionId": {
|
22431
|
+
"type": "string",
|
22432
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22433
|
+
},
|
22434
|
+
"notebookId": {
|
22435
|
+
"type": "string",
|
22436
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22437
|
+
},
|
22438
|
+
"applicationId": {
|
22439
|
+
"type": "string",
|
22440
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22441
|
+
},
|
22442
|
+
"status": {
|
22443
|
+
"type": "string",
|
22444
|
+
"enum": [
|
22445
|
+
"queued",
|
22446
|
+
"inProgress",
|
22447
|
+
"completed",
|
22448
|
+
"errored",
|
22449
|
+
"timeout"
|
22450
|
+
]
|
22451
|
+
},
|
22452
|
+
"executionRelativeTo": {
|
22453
|
+
"type": "string",
|
22454
|
+
"format": "date-time"
|
22455
|
+
},
|
22456
|
+
"maxAllowedRunMinutes": {
|
22457
|
+
"type": "number"
|
22458
|
+
},
|
22459
|
+
"sourceType": {
|
22460
|
+
"type": "string",
|
22461
|
+
"enum": [
|
22462
|
+
"flow",
|
22463
|
+
"user",
|
22464
|
+
"device",
|
22465
|
+
"apiToken",
|
22466
|
+
"notebook"
|
22467
|
+
]
|
22468
|
+
},
|
22469
|
+
"sourceId": {
|
22470
|
+
"type": "string",
|
22471
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22472
|
+
},
|
22473
|
+
"runQueuedAt": {
|
22474
|
+
"type": "string",
|
22475
|
+
"format": "date-time"
|
22476
|
+
},
|
22477
|
+
"runStartedAt": {
|
22478
|
+
"type": "string",
|
22479
|
+
"format": "date-time"
|
22480
|
+
},
|
22481
|
+
"inputsCompletedAt": {
|
22482
|
+
"type": "string",
|
22483
|
+
"format": "date-time"
|
22484
|
+
},
|
22485
|
+
"notebookCompletedAt": {
|
22486
|
+
"type": "string",
|
22487
|
+
"format": "date-time"
|
22488
|
+
},
|
22489
|
+
"outputsCompletedAt": {
|
22490
|
+
"type": "string",
|
22491
|
+
"format": "date-time"
|
22492
|
+
},
|
22493
|
+
"inputInfo": {
|
22494
|
+
"type": "object",
|
22495
|
+
"patternProperties": {
|
22496
|
+
".*": {
|
22497
|
+
"type": "object",
|
22498
|
+
"properties": {
|
22499
|
+
"size": {
|
22500
|
+
"type": "number"
|
22501
|
+
},
|
22502
|
+
"url": {
|
22503
|
+
"type": "string"
|
22504
|
+
}
|
22505
|
+
}
|
22506
|
+
}
|
22507
|
+
}
|
22508
|
+
},
|
22509
|
+
"outputInfo": {
|
22510
|
+
"type": "object",
|
22511
|
+
"patternProperties": {
|
22512
|
+
".*": {
|
22513
|
+
"type": "object",
|
22514
|
+
"properties": {
|
22515
|
+
"size": {
|
22516
|
+
"type": "number"
|
22517
|
+
},
|
22518
|
+
"url": {
|
22519
|
+
"type": "string"
|
22520
|
+
},
|
22521
|
+
"contentType": {
|
22522
|
+
"type": "string"
|
22523
|
+
}
|
22524
|
+
}
|
22525
|
+
}
|
22526
|
+
}
|
22527
|
+
},
|
22528
|
+
"executionErrors": {
|
22529
|
+
"type": "array",
|
22530
|
+
"items": {
|
22531
|
+
"type": "object",
|
22532
|
+
"properties": {
|
22533
|
+
"name": {
|
22534
|
+
"type": "string"
|
22535
|
+
},
|
22536
|
+
"message": {
|
22537
|
+
"type": "string"
|
22538
|
+
}
|
22539
|
+
}
|
22540
|
+
}
|
22541
|
+
}
|
22542
|
+
}
|
22543
|
+
}
|
22544
|
+
}
|
22545
|
+
```
|
22546
|
+
### <a name="notebook-execution-logs-example"></a> Example
|
22547
|
+
|
22548
|
+
```json
|
22549
|
+
[
|
22550
|
+
{
|
22551
|
+
"id": "5c7d3f9cd32c87a49f04c260",
|
22552
|
+
"notebookExecutionId": "5c7d3f9cd32c87a49f04c260",
|
22553
|
+
"notebookId": "5c782b8d4f3a8e51c1db42e4",
|
22554
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
22555
|
+
"runStartedAt": "2016-06-13T04:00:00.000Z",
|
22556
|
+
"runQueuedAt": "2016-06-13T03:59:00.000Z",
|
22557
|
+
"sourceId": "575ed70c7ae143cd83dc4aa9",
|
22558
|
+
"sourceType": "user",
|
22559
|
+
"status": "inProgress",
|
22560
|
+
"maxAllowedRunMinutes": 5,
|
22561
|
+
"inputInfo": {},
|
22562
|
+
"outputInfo": {},
|
22563
|
+
"executionErrors": []
|
22564
|
+
}
|
22565
|
+
]
|
22566
|
+
```
|
22567
|
+
|
22568
|
+
<br/>
|
22569
|
+
|
22570
|
+
## Notebook Execution Options
|
22571
|
+
|
22572
|
+
Schema for the options for a Notebook execution request
|
22573
|
+
|
22574
|
+
### <a name="notebook-execution-options-schema"></a> Schema
|
22575
|
+
|
22576
|
+
```json
|
22577
|
+
{
|
22578
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
22579
|
+
"type": "object",
|
22580
|
+
"properties": {
|
22581
|
+
"relativeTo": {
|
22582
|
+
"oneOf": [
|
22583
|
+
{
|
22584
|
+
"type": "string"
|
22585
|
+
},
|
22586
|
+
{
|
22587
|
+
"type": "number"
|
22588
|
+
},
|
22589
|
+
{
|
22590
|
+
"type": "object",
|
22591
|
+
"properties": {
|
22592
|
+
"$date": {
|
22593
|
+
"type": "string"
|
22594
|
+
}
|
22595
|
+
},
|
22596
|
+
"additionalProperties": false,
|
22597
|
+
"required": [
|
22598
|
+
"$date"
|
22599
|
+
]
|
22600
|
+
}
|
22601
|
+
]
|
22602
|
+
}
|
22603
|
+
},
|
22604
|
+
"additionalProperties": false
|
22605
|
+
}
|
22606
|
+
```
|
22607
|
+
### <a name="notebook-execution-options-example"></a> Example
|
22608
|
+
|
22609
|
+
```json
|
22610
|
+
{}
|
22611
|
+
```
|
22612
|
+
|
22613
|
+
<br/>
|
22614
|
+
|
22615
|
+
## Notebook Patch
|
22616
|
+
|
22617
|
+
Schema for the body of a Notebook modification request
|
22618
|
+
|
22619
|
+
### <a name="notebook-patch-schema"></a> Schema
|
22620
|
+
|
22621
|
+
```json
|
22622
|
+
{
|
22623
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
22624
|
+
"type": "object",
|
22625
|
+
"properties": {
|
22626
|
+
"name": {
|
22627
|
+
"type": "string",
|
22628
|
+
"minLength": 1,
|
22629
|
+
"maxLength": 1024
|
22630
|
+
},
|
22631
|
+
"description": {
|
22632
|
+
"type": "string",
|
22633
|
+
"maxLength": 32767
|
22634
|
+
},
|
22635
|
+
"inputs": {
|
22636
|
+
"type": "array",
|
22637
|
+
"items": {
|
22638
|
+
"maxItems": 100,
|
22639
|
+
"oneOf": [
|
22640
|
+
{
|
22641
|
+
"type": "object",
|
22642
|
+
"properties": {
|
22643
|
+
"inputType": {
|
22644
|
+
"type": "string",
|
22645
|
+
"enum": [
|
22646
|
+
"deviceData"
|
22647
|
+
]
|
22648
|
+
},
|
22649
|
+
"fileName": {
|
22650
|
+
"type": "string",
|
22651
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22652
|
+
},
|
22653
|
+
"deviceTags": {
|
22654
|
+
"type": "array",
|
22655
|
+
"items": {
|
22656
|
+
"type": "object",
|
22657
|
+
"properties": {
|
22658
|
+
"key": {
|
22659
|
+
"type": "string",
|
22660
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22661
|
+
},
|
22662
|
+
"value": {
|
22663
|
+
"type": "string",
|
22664
|
+
"minLength": 1,
|
22665
|
+
"maxLength": 255
|
22666
|
+
}
|
22667
|
+
},
|
22668
|
+
"additionalProperties": false
|
22669
|
+
},
|
22670
|
+
"maxItems": 100
|
22671
|
+
},
|
22672
|
+
"deviceIds": {
|
22673
|
+
"type": "array",
|
22674
|
+
"items": {
|
22675
|
+
"type": "string",
|
22676
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22677
|
+
},
|
22678
|
+
"maxItems": 1000
|
22679
|
+
},
|
22680
|
+
"attributes": {
|
22681
|
+
"type": "array",
|
22682
|
+
"maxItems": 100,
|
22683
|
+
"items": {
|
22684
|
+
"type": "string",
|
22685
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22686
|
+
}
|
22687
|
+
},
|
22688
|
+
"start": {
|
22689
|
+
"type": "number"
|
22690
|
+
},
|
22691
|
+
"end": {
|
22692
|
+
"type": "number"
|
22693
|
+
}
|
22694
|
+
},
|
22695
|
+
"required": [
|
22696
|
+
"inputType",
|
22697
|
+
"fileName",
|
22698
|
+
"start",
|
22699
|
+
"end"
|
22700
|
+
],
|
22701
|
+
"additionalProperties": false
|
22702
|
+
},
|
22703
|
+
{
|
22704
|
+
"type": "object",
|
22705
|
+
"properties": {
|
22706
|
+
"inputType": {
|
22707
|
+
"type": "string",
|
22708
|
+
"enum": [
|
22709
|
+
"deviceMetadata"
|
22710
|
+
]
|
22711
|
+
},
|
22712
|
+
"fileName": {
|
22713
|
+
"type": "string",
|
22714
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22715
|
+
},
|
22716
|
+
"deviceTags": {
|
22717
|
+
"type": "array",
|
22718
|
+
"items": {
|
22719
|
+
"type": "object",
|
22720
|
+
"properties": {
|
22721
|
+
"key": {
|
22722
|
+
"type": "string",
|
22723
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22724
|
+
},
|
22725
|
+
"value": {
|
22726
|
+
"type": "string",
|
22727
|
+
"minLength": 1,
|
22728
|
+
"maxLength": 255
|
22729
|
+
}
|
22730
|
+
},
|
22731
|
+
"additionalProperties": false
|
22732
|
+
},
|
22733
|
+
"maxItems": 100
|
22734
|
+
},
|
22735
|
+
"deviceIds": {
|
22736
|
+
"type": "array",
|
22737
|
+
"items": {
|
22738
|
+
"type": "string",
|
22739
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22740
|
+
},
|
22741
|
+
"maxItems": 1000
|
22742
|
+
}
|
22743
|
+
},
|
22744
|
+
"required": [
|
22745
|
+
"inputType",
|
22746
|
+
"fileName"
|
22747
|
+
],
|
22748
|
+
"additionalProperties": false
|
22749
|
+
},
|
22750
|
+
{
|
22751
|
+
"type": "object",
|
22752
|
+
"properties": {
|
22753
|
+
"inputType": {
|
22754
|
+
"type": "string",
|
22755
|
+
"enum": [
|
22756
|
+
"dataTable"
|
22757
|
+
]
|
22758
|
+
},
|
22759
|
+
"fileName": {
|
22760
|
+
"type": "string",
|
22761
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22762
|
+
},
|
22763
|
+
"dataTableId": {
|
22764
|
+
"type": "string",
|
22765
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22766
|
+
},
|
22767
|
+
"queryJson": {
|
22768
|
+
"type": "string",
|
22769
|
+
"maxLength": 32767
|
22770
|
+
}
|
22771
|
+
},
|
22772
|
+
"required": [
|
22773
|
+
"inputType",
|
22774
|
+
"fileName",
|
22775
|
+
"dataTableId"
|
22776
|
+
],
|
22777
|
+
"additionalProperties": false
|
22778
|
+
},
|
22779
|
+
{
|
22780
|
+
"type": "object",
|
22781
|
+
"properties": {
|
22782
|
+
"inputType": {
|
22783
|
+
"type": "string",
|
22784
|
+
"enum": [
|
22785
|
+
"externalUrl"
|
22786
|
+
]
|
22787
|
+
},
|
22788
|
+
"fileName": {
|
22789
|
+
"type": "string",
|
22790
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22791
|
+
},
|
22792
|
+
"sourceUrl": {
|
22793
|
+
"type": "string",
|
22794
|
+
"minLength": 1,
|
22795
|
+
"maxLength": 1024
|
22796
|
+
}
|
22797
|
+
},
|
22798
|
+
"required": [
|
22799
|
+
"inputType",
|
22800
|
+
"fileName",
|
22801
|
+
"sourceUrl"
|
22802
|
+
],
|
22803
|
+
"additionalProperties": false
|
22804
|
+
}
|
22805
|
+
]
|
22806
|
+
}
|
22807
|
+
},
|
22808
|
+
"outputs": {
|
22809
|
+
"type": "array",
|
22810
|
+
"items": {
|
22811
|
+
"maxItems": 100,
|
22812
|
+
"oneOf": [
|
22813
|
+
{
|
22814
|
+
"type": "object",
|
22815
|
+
"properties": {
|
22816
|
+
"outputType": {
|
22817
|
+
"type": "string",
|
22818
|
+
"enum": [
|
22819
|
+
"dataTable"
|
22820
|
+
]
|
22821
|
+
},
|
22822
|
+
"fileName": {
|
22823
|
+
"type": "string",
|
22824
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22825
|
+
},
|
22826
|
+
"dataTableId": {
|
22827
|
+
"type": "string",
|
22828
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22829
|
+
},
|
22830
|
+
"createMissingColumns": {
|
22831
|
+
"type": "boolean"
|
22832
|
+
},
|
22833
|
+
"truncateExistingTable": {
|
22834
|
+
"type": "boolean"
|
22835
|
+
}
|
22836
|
+
},
|
22837
|
+
"required": [
|
22838
|
+
"fileName",
|
22839
|
+
"outputType",
|
22840
|
+
"dataTableId"
|
22841
|
+
],
|
22842
|
+
"additionalProperties": false
|
22843
|
+
},
|
22844
|
+
{
|
22845
|
+
"type": "object",
|
22846
|
+
"properties": {
|
22847
|
+
"outputType": {
|
22848
|
+
"type": "string",
|
22849
|
+
"enum": [
|
22850
|
+
"file"
|
22851
|
+
]
|
22852
|
+
},
|
22853
|
+
"fileName": {
|
22854
|
+
"type": "string",
|
22855
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22856
|
+
},
|
22857
|
+
"destinationDirectoryTemplate": {
|
22858
|
+
"type": "string",
|
22859
|
+
"minLength": 1,
|
22860
|
+
"maxLength": 1024
|
22861
|
+
},
|
22862
|
+
"destinationFileNameTemplate": {
|
22863
|
+
"type": "string",
|
22864
|
+
"minLength": 1,
|
22865
|
+
"maxLength": 1024
|
22866
|
+
}
|
22867
|
+
},
|
22868
|
+
"required": [
|
22869
|
+
"fileName",
|
22870
|
+
"outputType",
|
22871
|
+
"destinationFileNameTemplate"
|
22872
|
+
],
|
22873
|
+
"additionalProperties": false
|
22874
|
+
},
|
22875
|
+
{
|
22876
|
+
"type": "object",
|
22877
|
+
"properties": {
|
22878
|
+
"outputType": {
|
22879
|
+
"type": "string",
|
22880
|
+
"enum": [
|
22881
|
+
"executionResult"
|
22882
|
+
]
|
22883
|
+
},
|
22884
|
+
"fileName": {
|
22885
|
+
"type": "string",
|
22886
|
+
"enum": [
|
22887
|
+
"result.html",
|
22888
|
+
"result.pdf",
|
22889
|
+
"result.ipynb",
|
22890
|
+
"result.error.log",
|
22891
|
+
"result.log"
|
22892
|
+
]
|
22893
|
+
},
|
22894
|
+
"destinationDirectoryTemplate": {
|
22895
|
+
"type": "string",
|
22896
|
+
"minLength": 1,
|
22897
|
+
"maxLength": 1024
|
22898
|
+
},
|
22899
|
+
"destinationFileNameTemplate": {
|
22900
|
+
"type": "string",
|
22901
|
+
"minLength": 1,
|
22902
|
+
"maxLength": 1024
|
22903
|
+
}
|
22904
|
+
},
|
22905
|
+
"required": [
|
22906
|
+
"fileName",
|
22907
|
+
"outputType"
|
22908
|
+
],
|
22909
|
+
"additionalProperties": false
|
22910
|
+
}
|
22911
|
+
]
|
22912
|
+
}
|
22913
|
+
}
|
22914
|
+
},
|
22915
|
+
"additionalProperties": false
|
22916
|
+
}
|
22917
|
+
```
|
22918
|
+
### <a name="notebook-patch-example"></a> Example
|
22919
|
+
|
22920
|
+
```json
|
22921
|
+
{
|
22922
|
+
"name": "New Notebook Name"
|
22923
|
+
}
|
22924
|
+
```
|
22925
|
+
|
22926
|
+
<br/>
|
22927
|
+
|
22928
|
+
## Notebook Post
|
22929
|
+
|
22930
|
+
Schema for the body of an Notebook creation request
|
22931
|
+
|
22932
|
+
### <a name="notebook-post-schema"></a> Schema
|
22933
|
+
|
22934
|
+
```json
|
22935
|
+
{
|
22936
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
22937
|
+
"type": "object",
|
22938
|
+
"properties": {
|
22939
|
+
"name": {
|
22940
|
+
"type": "string",
|
22941
|
+
"minLength": 1,
|
22942
|
+
"maxLength": 1024
|
22943
|
+
},
|
22944
|
+
"description": {
|
22945
|
+
"type": "string",
|
22946
|
+
"maxLength": 32767
|
22947
|
+
},
|
22948
|
+
"inputs": {
|
22949
|
+
"type": "array",
|
22950
|
+
"items": {
|
22951
|
+
"maxItems": 100,
|
22952
|
+
"oneOf": [
|
22953
|
+
{
|
22954
|
+
"type": "object",
|
22955
|
+
"properties": {
|
22956
|
+
"inputType": {
|
22957
|
+
"type": "string",
|
22958
|
+
"enum": [
|
22959
|
+
"deviceData"
|
22960
|
+
]
|
22961
|
+
},
|
22962
|
+
"fileName": {
|
22963
|
+
"type": "string",
|
22964
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
22965
|
+
},
|
22966
|
+
"deviceTags": {
|
22967
|
+
"type": "array",
|
22968
|
+
"items": {
|
22969
|
+
"type": "object",
|
22970
|
+
"properties": {
|
22971
|
+
"key": {
|
22972
|
+
"type": "string",
|
22973
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22974
|
+
},
|
22975
|
+
"value": {
|
22976
|
+
"type": "string",
|
22977
|
+
"minLength": 1,
|
22978
|
+
"maxLength": 255
|
22979
|
+
}
|
22980
|
+
},
|
22981
|
+
"additionalProperties": false
|
22982
|
+
},
|
22983
|
+
"maxItems": 100
|
22984
|
+
},
|
22985
|
+
"deviceIds": {
|
22986
|
+
"type": "array",
|
22987
|
+
"items": {
|
22988
|
+
"type": "string",
|
22989
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
22990
|
+
},
|
22991
|
+
"maxItems": 1000
|
22992
|
+
},
|
22993
|
+
"attributes": {
|
22994
|
+
"type": "array",
|
22995
|
+
"maxItems": 100,
|
22996
|
+
"items": {
|
22997
|
+
"type": "string",
|
22998
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
22999
|
+
}
|
23000
|
+
},
|
23001
|
+
"start": {
|
23002
|
+
"type": "number"
|
23003
|
+
},
|
23004
|
+
"end": {
|
23005
|
+
"type": "number"
|
23006
|
+
}
|
23007
|
+
},
|
23008
|
+
"required": [
|
23009
|
+
"inputType",
|
23010
|
+
"fileName",
|
23011
|
+
"start",
|
23012
|
+
"end"
|
23013
|
+
],
|
23014
|
+
"additionalProperties": false
|
23015
|
+
},
|
23016
|
+
{
|
23017
|
+
"type": "object",
|
23018
|
+
"properties": {
|
23019
|
+
"inputType": {
|
23020
|
+
"type": "string",
|
23021
|
+
"enum": [
|
23022
|
+
"deviceMetadata"
|
23023
|
+
]
|
23024
|
+
},
|
23025
|
+
"fileName": {
|
23026
|
+
"type": "string",
|
23027
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23028
|
+
},
|
23029
|
+
"deviceTags": {
|
23030
|
+
"type": "array",
|
23031
|
+
"items": {
|
23032
|
+
"type": "object",
|
23033
|
+
"properties": {
|
23034
|
+
"key": {
|
23035
|
+
"type": "string",
|
23036
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
23037
|
+
},
|
23038
|
+
"value": {
|
23039
|
+
"type": "string",
|
23040
|
+
"minLength": 1,
|
23041
|
+
"maxLength": 255
|
23042
|
+
}
|
23043
|
+
},
|
23044
|
+
"additionalProperties": false
|
23045
|
+
},
|
23046
|
+
"maxItems": 100
|
23047
|
+
},
|
23048
|
+
"deviceIds": {
|
23049
|
+
"type": "array",
|
23050
|
+
"items": {
|
23051
|
+
"type": "string",
|
23052
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23053
|
+
},
|
23054
|
+
"maxItems": 1000
|
23055
|
+
}
|
23056
|
+
},
|
23057
|
+
"required": [
|
23058
|
+
"inputType",
|
23059
|
+
"fileName"
|
23060
|
+
],
|
23061
|
+
"additionalProperties": false
|
23062
|
+
},
|
23063
|
+
{
|
23064
|
+
"type": "object",
|
23065
|
+
"properties": {
|
23066
|
+
"inputType": {
|
23067
|
+
"type": "string",
|
23068
|
+
"enum": [
|
23069
|
+
"dataTable"
|
23070
|
+
]
|
23071
|
+
},
|
23072
|
+
"fileName": {
|
23073
|
+
"type": "string",
|
23074
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23075
|
+
},
|
23076
|
+
"dataTableId": {
|
23077
|
+
"type": "string",
|
23078
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23079
|
+
},
|
23080
|
+
"queryJson": {
|
23081
|
+
"type": "string",
|
23082
|
+
"maxLength": 32767
|
23083
|
+
}
|
23084
|
+
},
|
23085
|
+
"required": [
|
23086
|
+
"inputType",
|
23087
|
+
"fileName",
|
23088
|
+
"dataTableId"
|
23089
|
+
],
|
23090
|
+
"additionalProperties": false
|
23091
|
+
},
|
23092
|
+
{
|
23093
|
+
"type": "object",
|
23094
|
+
"properties": {
|
23095
|
+
"inputType": {
|
23096
|
+
"type": "string",
|
23097
|
+
"enum": [
|
23098
|
+
"externalUrl"
|
23099
|
+
]
|
23100
|
+
},
|
23101
|
+
"fileName": {
|
23102
|
+
"type": "string",
|
23103
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23104
|
+
},
|
23105
|
+
"sourceUrl": {
|
23106
|
+
"type": "string",
|
23107
|
+
"minLength": 1,
|
23108
|
+
"maxLength": 1024
|
23109
|
+
}
|
23110
|
+
},
|
23111
|
+
"required": [
|
23112
|
+
"inputType",
|
23113
|
+
"fileName",
|
23114
|
+
"sourceUrl"
|
23115
|
+
],
|
23116
|
+
"additionalProperties": false
|
23117
|
+
}
|
23118
|
+
]
|
23119
|
+
}
|
23120
|
+
},
|
23121
|
+
"outputs": {
|
23122
|
+
"type": "array",
|
23123
|
+
"items": {
|
23124
|
+
"maxItems": 100,
|
23125
|
+
"oneOf": [
|
23126
|
+
{
|
23127
|
+
"type": "object",
|
23128
|
+
"properties": {
|
23129
|
+
"outputType": {
|
23130
|
+
"type": "string",
|
23131
|
+
"enum": [
|
23132
|
+
"dataTable"
|
23133
|
+
]
|
23134
|
+
},
|
23135
|
+
"fileName": {
|
23136
|
+
"type": "string",
|
23137
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23138
|
+
},
|
23139
|
+
"dataTableId": {
|
23140
|
+
"type": "string",
|
23141
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23142
|
+
},
|
23143
|
+
"createMissingColumns": {
|
23144
|
+
"type": "boolean"
|
23145
|
+
},
|
23146
|
+
"truncateExistingTable": {
|
23147
|
+
"type": "boolean"
|
23148
|
+
}
|
23149
|
+
},
|
23150
|
+
"required": [
|
23151
|
+
"fileName",
|
23152
|
+
"outputType",
|
23153
|
+
"dataTableId"
|
23154
|
+
],
|
23155
|
+
"additionalProperties": false
|
23156
|
+
},
|
23157
|
+
{
|
23158
|
+
"type": "object",
|
23159
|
+
"properties": {
|
23160
|
+
"outputType": {
|
23161
|
+
"type": "string",
|
23162
|
+
"enum": [
|
23163
|
+
"file"
|
23164
|
+
]
|
23165
|
+
},
|
23166
|
+
"fileName": {
|
23167
|
+
"type": "string",
|
23168
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23169
|
+
},
|
23170
|
+
"destinationDirectoryTemplate": {
|
23171
|
+
"type": "string",
|
23172
|
+
"minLength": 1,
|
23173
|
+
"maxLength": 1024
|
23174
|
+
},
|
23175
|
+
"destinationFileNameTemplate": {
|
23176
|
+
"type": "string",
|
23177
|
+
"minLength": 1,
|
23178
|
+
"maxLength": 1024
|
23179
|
+
}
|
23180
|
+
},
|
23181
|
+
"required": [
|
23182
|
+
"fileName",
|
23183
|
+
"outputType",
|
23184
|
+
"destinationFileNameTemplate"
|
23185
|
+
],
|
23186
|
+
"additionalProperties": false
|
23187
|
+
},
|
23188
|
+
{
|
23189
|
+
"type": "object",
|
23190
|
+
"properties": {
|
23191
|
+
"outputType": {
|
23192
|
+
"type": "string",
|
23193
|
+
"enum": [
|
23194
|
+
"executionResult"
|
23195
|
+
]
|
23196
|
+
},
|
23197
|
+
"fileName": {
|
23198
|
+
"type": "string",
|
23199
|
+
"enum": [
|
23200
|
+
"result.html",
|
23201
|
+
"result.pdf",
|
23202
|
+
"result.ipynb",
|
23203
|
+
"result.error.log",
|
23204
|
+
"result.log"
|
23205
|
+
]
|
23206
|
+
},
|
23207
|
+
"destinationDirectoryTemplate": {
|
23208
|
+
"type": "string",
|
23209
|
+
"minLength": 1,
|
23210
|
+
"maxLength": 1024
|
23211
|
+
},
|
23212
|
+
"destinationFileNameTemplate": {
|
23213
|
+
"type": "string",
|
23214
|
+
"minLength": 1,
|
23215
|
+
"maxLength": 1024
|
23216
|
+
}
|
23217
|
+
},
|
23218
|
+
"required": [
|
23219
|
+
"fileName",
|
23220
|
+
"outputType"
|
23221
|
+
],
|
23222
|
+
"additionalProperties": false
|
23223
|
+
}
|
23224
|
+
]
|
23225
|
+
}
|
23226
|
+
}
|
23227
|
+
},
|
23228
|
+
"additionalProperties": false,
|
23229
|
+
"required": [
|
23230
|
+
"name"
|
23231
|
+
]
|
23232
|
+
}
|
23233
|
+
```
|
23234
|
+
### <a name="notebook-post-example"></a> Example
|
23235
|
+
|
23236
|
+
```json
|
23237
|
+
{
|
23238
|
+
"name": "Example Notebook"
|
23239
|
+
}
|
23240
|
+
```
|
23241
|
+
|
23242
|
+
<br/>
|
23243
|
+
|
23244
|
+
## Notebooks
|
23245
|
+
|
23246
|
+
Schema for a collection of Notebooks
|
23247
|
+
|
23248
|
+
### <a name="notebooks-schema"></a> Schema
|
23249
|
+
|
23250
|
+
```json
|
23251
|
+
{
|
23252
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
23253
|
+
"type": "object",
|
23254
|
+
"properties": {
|
23255
|
+
"items": {
|
23256
|
+
"type": "array",
|
23257
|
+
"items": {
|
23258
|
+
"title": "Notebook",
|
23259
|
+
"description": "Schema for a single Notebook",
|
23260
|
+
"type": "object",
|
23261
|
+
"properties": {
|
23262
|
+
"id": {
|
23263
|
+
"type": "string",
|
23264
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23265
|
+
},
|
23266
|
+
"notebookId": {
|
23267
|
+
"type": "string",
|
23268
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23269
|
+
},
|
23270
|
+
"applicationId": {
|
23271
|
+
"type": "string",
|
23272
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23273
|
+
},
|
23274
|
+
"creationDate": {
|
23275
|
+
"type": "string",
|
23276
|
+
"format": "date-time"
|
23277
|
+
},
|
23278
|
+
"lastUpdated": {
|
23279
|
+
"type": "string",
|
23280
|
+
"format": "date-time"
|
23281
|
+
},
|
23282
|
+
"name": {
|
23283
|
+
"type": "string",
|
23284
|
+
"minLength": 1,
|
23285
|
+
"maxLength": 1024
|
23286
|
+
},
|
23287
|
+
"description": {
|
23288
|
+
"type": "string",
|
23289
|
+
"maxLength": 32767
|
23290
|
+
},
|
23291
|
+
"jupyterFileName": {
|
23292
|
+
"type": "string",
|
23293
|
+
"minLength": 1,
|
23294
|
+
"maxLength": 1024
|
23295
|
+
},
|
23296
|
+
"jupyterFileUrl": {
|
23297
|
+
"type": "string"
|
23298
|
+
},
|
23299
|
+
"inputs": {
|
23300
|
+
"type": "array",
|
23301
|
+
"items": {
|
23302
|
+
"maxItems": 100,
|
23303
|
+
"oneOf": [
|
23304
|
+
{
|
23305
|
+
"type": "object",
|
23306
|
+
"properties": {
|
23307
|
+
"inputType": {
|
23308
|
+
"type": "string",
|
23309
|
+
"enum": [
|
23310
|
+
"deviceData"
|
23311
|
+
]
|
23312
|
+
},
|
23313
|
+
"fileName": {
|
23314
|
+
"type": "string",
|
23315
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23316
|
+
},
|
23317
|
+
"deviceTags": {
|
23318
|
+
"type": "array",
|
23319
|
+
"items": {
|
23320
|
+
"type": "object",
|
23321
|
+
"properties": {
|
23322
|
+
"key": {
|
23323
|
+
"type": "string",
|
23324
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
23325
|
+
},
|
23326
|
+
"value": {
|
23327
|
+
"type": "string",
|
23328
|
+
"minLength": 1,
|
23329
|
+
"maxLength": 255
|
23330
|
+
}
|
23331
|
+
},
|
23332
|
+
"additionalProperties": false
|
23333
|
+
},
|
23334
|
+
"maxItems": 100
|
23335
|
+
},
|
23336
|
+
"deviceIds": {
|
23337
|
+
"type": "array",
|
23338
|
+
"items": {
|
23339
|
+
"type": "string",
|
23340
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23341
|
+
},
|
23342
|
+
"maxItems": 1000
|
23343
|
+
},
|
23344
|
+
"attributes": {
|
23345
|
+
"type": "array",
|
23346
|
+
"maxItems": 100,
|
23347
|
+
"items": {
|
23348
|
+
"type": "string",
|
23349
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
23350
|
+
}
|
23351
|
+
},
|
23352
|
+
"start": {
|
23353
|
+
"type": "number"
|
23354
|
+
},
|
23355
|
+
"end": {
|
23356
|
+
"type": "number"
|
23357
|
+
}
|
23358
|
+
},
|
23359
|
+
"required": [
|
23360
|
+
"inputType",
|
23361
|
+
"fileName",
|
23362
|
+
"start",
|
23363
|
+
"end"
|
23364
|
+
],
|
23365
|
+
"additionalProperties": false
|
23366
|
+
},
|
23367
|
+
{
|
23368
|
+
"type": "object",
|
23369
|
+
"properties": {
|
23370
|
+
"inputType": {
|
23371
|
+
"type": "string",
|
23372
|
+
"enum": [
|
23373
|
+
"deviceMetadata"
|
23374
|
+
]
|
23375
|
+
},
|
23376
|
+
"fileName": {
|
23377
|
+
"type": "string",
|
23378
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23379
|
+
},
|
23380
|
+
"deviceTags": {
|
23381
|
+
"type": "array",
|
23382
|
+
"items": {
|
23383
|
+
"type": "object",
|
23384
|
+
"properties": {
|
23385
|
+
"key": {
|
23386
|
+
"type": "string",
|
23387
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
23388
|
+
},
|
23389
|
+
"value": {
|
23390
|
+
"type": "string",
|
23391
|
+
"minLength": 1,
|
23392
|
+
"maxLength": 255
|
23393
|
+
}
|
23394
|
+
},
|
23395
|
+
"additionalProperties": false
|
23396
|
+
},
|
23397
|
+
"maxItems": 100
|
23398
|
+
},
|
23399
|
+
"deviceIds": {
|
23400
|
+
"type": "array",
|
23401
|
+
"items": {
|
23402
|
+
"type": "string",
|
23403
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23404
|
+
},
|
23405
|
+
"maxItems": 1000
|
23406
|
+
}
|
23407
|
+
},
|
23408
|
+
"required": [
|
23409
|
+
"inputType",
|
23410
|
+
"fileName"
|
23411
|
+
],
|
23412
|
+
"additionalProperties": false
|
23413
|
+
},
|
23414
|
+
{
|
23415
|
+
"type": "object",
|
23416
|
+
"properties": {
|
23417
|
+
"inputType": {
|
23418
|
+
"type": "string",
|
23419
|
+
"enum": [
|
23420
|
+
"dataTable"
|
23421
|
+
]
|
23422
|
+
},
|
23423
|
+
"fileName": {
|
23424
|
+
"type": "string",
|
23425
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23426
|
+
},
|
23427
|
+
"dataTableId": {
|
23428
|
+
"type": "string",
|
23429
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23430
|
+
},
|
23431
|
+
"queryJson": {
|
23432
|
+
"type": "string",
|
23433
|
+
"maxLength": 32767
|
23434
|
+
}
|
23435
|
+
},
|
23436
|
+
"required": [
|
23437
|
+
"inputType",
|
23438
|
+
"fileName",
|
23439
|
+
"dataTableId"
|
23440
|
+
],
|
23441
|
+
"additionalProperties": false
|
23442
|
+
},
|
23443
|
+
{
|
23444
|
+
"type": "object",
|
23445
|
+
"properties": {
|
23446
|
+
"inputType": {
|
23447
|
+
"type": "string",
|
23448
|
+
"enum": [
|
23449
|
+
"externalUrl"
|
23450
|
+
]
|
23451
|
+
},
|
23452
|
+
"fileName": {
|
23453
|
+
"type": "string",
|
23454
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23455
|
+
},
|
23456
|
+
"sourceUrl": {
|
23457
|
+
"type": "string",
|
23458
|
+
"minLength": 1,
|
23459
|
+
"maxLength": 1024
|
23460
|
+
}
|
23461
|
+
},
|
23462
|
+
"required": [
|
23463
|
+
"inputType",
|
23464
|
+
"fileName",
|
23465
|
+
"sourceUrl"
|
23466
|
+
],
|
23467
|
+
"additionalProperties": false
|
23468
|
+
}
|
23469
|
+
]
|
23470
|
+
}
|
23471
|
+
},
|
23472
|
+
"outputs": {
|
23473
|
+
"type": "array",
|
23474
|
+
"items": {
|
23475
|
+
"maxItems": 100,
|
23476
|
+
"oneOf": [
|
23477
|
+
{
|
23478
|
+
"type": "object",
|
23479
|
+
"properties": {
|
23480
|
+
"outputType": {
|
23481
|
+
"type": "string",
|
23482
|
+
"enum": [
|
23483
|
+
"dataTable"
|
23484
|
+
]
|
23485
|
+
},
|
23486
|
+
"fileName": {
|
23487
|
+
"type": "string",
|
23488
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23489
|
+
},
|
23490
|
+
"dataTableId": {
|
23491
|
+
"type": "string",
|
23492
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23493
|
+
},
|
23494
|
+
"createMissingColumns": {
|
23495
|
+
"type": "boolean"
|
23496
|
+
},
|
23497
|
+
"truncateExistingTable": {
|
23498
|
+
"type": "boolean"
|
23499
|
+
}
|
23500
|
+
},
|
23501
|
+
"required": [
|
23502
|
+
"fileName",
|
23503
|
+
"outputType",
|
23504
|
+
"dataTableId"
|
23505
|
+
],
|
23506
|
+
"additionalProperties": false
|
23507
|
+
},
|
23508
|
+
{
|
23509
|
+
"type": "object",
|
23510
|
+
"properties": {
|
23511
|
+
"outputType": {
|
23512
|
+
"type": "string",
|
23513
|
+
"enum": [
|
23514
|
+
"file"
|
23515
|
+
]
|
23516
|
+
},
|
23517
|
+
"fileName": {
|
23518
|
+
"type": "string",
|
23519
|
+
"pattern": "^[0-9a-zA-Z_.-]{1,255}$"
|
23520
|
+
},
|
23521
|
+
"destinationDirectoryTemplate": {
|
23522
|
+
"type": "string",
|
23523
|
+
"minLength": 1,
|
23524
|
+
"maxLength": 1024
|
23525
|
+
},
|
23526
|
+
"destinationFileNameTemplate": {
|
23527
|
+
"type": "string",
|
23528
|
+
"minLength": 1,
|
23529
|
+
"maxLength": 1024
|
23530
|
+
}
|
23531
|
+
},
|
23532
|
+
"required": [
|
23533
|
+
"fileName",
|
23534
|
+
"outputType",
|
23535
|
+
"destinationFileNameTemplate"
|
23536
|
+
],
|
23537
|
+
"additionalProperties": false
|
23538
|
+
},
|
23539
|
+
{
|
23540
|
+
"type": "object",
|
23541
|
+
"properties": {
|
23542
|
+
"outputType": {
|
23543
|
+
"type": "string",
|
23544
|
+
"enum": [
|
23545
|
+
"executionResult"
|
23546
|
+
]
|
23547
|
+
},
|
23548
|
+
"fileName": {
|
23549
|
+
"type": "string",
|
23550
|
+
"enum": [
|
23551
|
+
"result.html",
|
23552
|
+
"result.pdf",
|
23553
|
+
"result.ipynb",
|
23554
|
+
"result.error.log",
|
23555
|
+
"result.log"
|
23556
|
+
]
|
23557
|
+
},
|
23558
|
+
"destinationDirectoryTemplate": {
|
23559
|
+
"type": "string",
|
23560
|
+
"minLength": 1,
|
23561
|
+
"maxLength": 1024
|
23562
|
+
},
|
23563
|
+
"destinationFileNameTemplate": {
|
23564
|
+
"type": "string",
|
23565
|
+
"minLength": 1,
|
23566
|
+
"maxLength": 1024
|
23567
|
+
}
|
23568
|
+
},
|
23569
|
+
"required": [
|
23570
|
+
"fileName",
|
23571
|
+
"outputType"
|
23572
|
+
],
|
23573
|
+
"additionalProperties": false
|
23574
|
+
}
|
23575
|
+
]
|
23576
|
+
}
|
23577
|
+
}
|
23578
|
+
}
|
23579
|
+
}
|
23580
|
+
},
|
23581
|
+
"count": {
|
23582
|
+
"type": "integer"
|
23583
|
+
},
|
23584
|
+
"totalCount": {
|
23585
|
+
"type": "integer"
|
23586
|
+
},
|
23587
|
+
"perPage": {
|
23588
|
+
"type": "integer"
|
23589
|
+
},
|
23590
|
+
"page": {
|
23591
|
+
"type": "integer"
|
23592
|
+
},
|
23593
|
+
"filter": {
|
23594
|
+
"type": "string"
|
23595
|
+
},
|
23596
|
+
"filterField": {
|
23597
|
+
"type": "string"
|
23598
|
+
},
|
23599
|
+
"sortField": {
|
23600
|
+
"type": "string"
|
23601
|
+
},
|
23602
|
+
"sortDirection": {
|
23603
|
+
"type": "string",
|
23604
|
+
"enum": [
|
23605
|
+
"asc",
|
23606
|
+
"desc"
|
23607
|
+
]
|
23608
|
+
},
|
23609
|
+
"applicationId": {
|
23610
|
+
"type": "string",
|
23611
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23612
|
+
}
|
23613
|
+
}
|
23614
|
+
}
|
23615
|
+
```
|
23616
|
+
### <a name="notebooks-example"></a> Example
|
23617
|
+
|
23618
|
+
```json
|
23619
|
+
{
|
23620
|
+
"items": [
|
23621
|
+
{
|
23622
|
+
"id": "5c782b8d4f3a8e51c1db42e4",
|
23623
|
+
"notebookId": "5c782b8d4f3a8e51c1db42e4",
|
23624
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
23625
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
23626
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
23627
|
+
"name": "Example Notebook",
|
23628
|
+
"jupyterFileName": "myNotebook.ipynb",
|
23629
|
+
"jupyterFileUrl": "https://mystoragedomain.com/myNotebook.ipynb",
|
23630
|
+
"inputs": [
|
23631
|
+
{
|
23632
|
+
"fileName": "deviceDataWithAttributes",
|
23633
|
+
"inputType": "deviceData",
|
23634
|
+
"attributes": [
|
23635
|
+
"aNumber"
|
23636
|
+
],
|
23637
|
+
"deviceIds": [
|
23638
|
+
"5c926894a111ea00063978ac"
|
23639
|
+
],
|
23640
|
+
"deviceTags": [],
|
23641
|
+
"start": -10368000000,
|
23642
|
+
"end": 0
|
23643
|
+
},
|
23644
|
+
{
|
23645
|
+
"fileName": "dataTableWithQuery",
|
23646
|
+
"inputType": "dataTable",
|
23647
|
+
"dataTableId": "5c91584211126400069179c1",
|
23648
|
+
"queryJson": "{\n \"$or\": [\n {\n \"createdAt\": {\n \"$gt\": \"12345\"\n }\n }\n ]\n}"
|
23649
|
+
},
|
23650
|
+
{
|
23651
|
+
"fileName": "deviceMetaData",
|
23652
|
+
"inputType": "deviceMetadata",
|
23653
|
+
"deviceIds": [
|
23654
|
+
"5c926894a111ea00063978ac"
|
23655
|
+
],
|
23656
|
+
"deviceTags": [
|
23657
|
+
{
|
23658
|
+
"key": "aTag",
|
23659
|
+
"value": "and value"
|
23660
|
+
}
|
23661
|
+
]
|
23662
|
+
},
|
23663
|
+
{
|
23664
|
+
"fileName": "deviceDataAllAttributes",
|
23665
|
+
"inputType": "deviceData",
|
23666
|
+
"attributes": [],
|
23667
|
+
"deviceIds": [],
|
23668
|
+
"deviceTags": [
|
23669
|
+
{
|
23670
|
+
"value": "and value"
|
23671
|
+
}
|
23672
|
+
],
|
23673
|
+
"start": -43200000,
|
23674
|
+
"end": 0
|
23675
|
+
},
|
23676
|
+
{
|
23677
|
+
"fileName": "anExternalUrl",
|
23678
|
+
"inputType": "externalUrl",
|
23679
|
+
"sourceUrl": "https://foo.com"
|
23680
|
+
}
|
23681
|
+
],
|
23682
|
+
"outputs": [
|
23683
|
+
{
|
23684
|
+
"fileName": "result.html",
|
23685
|
+
"outputType": "executionResult",
|
23686
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
23687
|
+
"destinationFileNameTemplate": "result.html"
|
23688
|
+
},
|
23689
|
+
{
|
23690
|
+
"fileName": "result.pdf",
|
23691
|
+
"outputType": "executionResult",
|
23692
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
23693
|
+
"destinationFileNameTemplate": "result.pdf"
|
23694
|
+
},
|
23695
|
+
{
|
23696
|
+
"fileName": "result.ipynb",
|
23697
|
+
"outputType": "executionResult",
|
23698
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
23699
|
+
"destinationFileNameTemplate": "result.ipynb"
|
23700
|
+
},
|
23701
|
+
{
|
23702
|
+
"fileName": "result.error.log",
|
23703
|
+
"outputType": "executionResult",
|
23704
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
23705
|
+
"destinationFileNameTemplate": "result.error.log"
|
23706
|
+
},
|
23707
|
+
{
|
23708
|
+
"fileName": "result.log",
|
23709
|
+
"outputType": "executionResult",
|
23710
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
23711
|
+
"destinationFileNameTemplate": "result.log"
|
23712
|
+
},
|
23713
|
+
{
|
23714
|
+
"fileName": "myDataTableFile.csv",
|
23715
|
+
"outputType": "dataTable",
|
23716
|
+
"dataTableId": "5c925132a111ea00063978a7",
|
23717
|
+
"createMissingColumns": true,
|
23718
|
+
"truncateExistingTable": false
|
23719
|
+
},
|
23720
|
+
{
|
23721
|
+
"fileName": "myDataTableFileTwo.csv",
|
23722
|
+
"outputType": "dataTable",
|
23723
|
+
"dataTableId": "5c91584211126400069179c1",
|
23724
|
+
"createMissingColumns": false,
|
23725
|
+
"truncateExistingTable": true
|
23726
|
+
},
|
23727
|
+
{
|
23728
|
+
"fileName": "myApplicationFile.png",
|
23729
|
+
"outputType": "file",
|
23730
|
+
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}",
|
23731
|
+
"destinationFileNameTemplate": "myApplicationFile.png"
|
23732
|
+
}
|
23733
|
+
]
|
23734
|
+
}
|
23735
|
+
],
|
23736
|
+
"count": 1,
|
23737
|
+
"totalCount": 4,
|
23738
|
+
"perPage": 1,
|
23739
|
+
"page": 0,
|
23740
|
+
"sortField": "name",
|
23741
|
+
"sortDirection": "asc",
|
23742
|
+
"applicationId": "575ec8687ae143cd83dc4a97"
|
23743
|
+
}
|
23744
|
+
```
|
23745
|
+
|
23746
|
+
<br/>
|
23747
|
+
|
23748
|
+
## Organization
|
23749
|
+
|
23750
|
+
Schema for a single Organization
|
23751
|
+
|
23752
|
+
### <a name="organization-schema"></a> Schema
|
23753
|
+
|
23754
|
+
```json
|
23755
|
+
{
|
23756
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
23757
|
+
"type": "object",
|
23758
|
+
"properties": {
|
23759
|
+
"id": {
|
23760
|
+
"type": "string",
|
23761
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23762
|
+
},
|
23763
|
+
"orgId": {
|
23764
|
+
"type": "string",
|
23765
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23766
|
+
},
|
23767
|
+
"creationDate": {
|
23768
|
+
"type": "string",
|
23769
|
+
"format": "date-time"
|
23770
|
+
},
|
23771
|
+
"lastUpdated": {
|
23772
|
+
"type": "string",
|
23773
|
+
"format": "date-time"
|
23774
|
+
},
|
23775
|
+
"name": {
|
23776
|
+
"type": "string",
|
23777
|
+
"minLength": 1,
|
23778
|
+
"maxLength": 255
|
23779
|
+
},
|
23780
|
+
"description": {
|
23781
|
+
"type": "string",
|
23782
|
+
"maxLength": 32767
|
23783
|
+
},
|
23784
|
+
"solutionsEnabled": {
|
23785
|
+
"type": "boolean"
|
23786
|
+
},
|
23787
|
+
"members": {
|
23788
|
+
"type": "array",
|
23789
|
+
"items": {
|
23790
|
+
"type": "object",
|
23791
|
+
"properties": {
|
23792
|
+
"userId": {
|
23793
|
+
"type": "string",
|
23794
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23795
|
+
},
|
23796
|
+
"firstName": {
|
23797
|
+
"type": "string",
|
23798
|
+
"minLength": 1,
|
23799
|
+
"maxLength": 1024
|
23800
|
+
},
|
23801
|
+
"lastName": {
|
23802
|
+
"type": "string",
|
23803
|
+
"minLength": 1,
|
23804
|
+
"maxLength": 1024
|
23805
|
+
},
|
23806
|
+
"email": {
|
23807
|
+
"type": "string",
|
23808
|
+
"format": "email",
|
23809
|
+
"maxLength": 1024
|
23810
|
+
},
|
23811
|
+
"avatarUrl": {
|
23812
|
+
"type": "string",
|
23813
|
+
"format": "url"
|
23814
|
+
},
|
23815
|
+
"role": {
|
23816
|
+
"type": "string",
|
23817
|
+
"enum": [
|
23818
|
+
"admin",
|
23819
|
+
"edit",
|
23820
|
+
"collaborate",
|
23821
|
+
"view",
|
23822
|
+
"none"
|
23823
|
+
]
|
23824
|
+
},
|
23825
|
+
"applicationRoles": {
|
23826
|
+
"type": "array",
|
23827
|
+
"items": {
|
23828
|
+
"type": "object",
|
23829
|
+
"properties": {
|
23830
|
+
"resourceId": {
|
23831
|
+
"type": "string",
|
23832
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
23833
|
+
},
|
23834
|
+
"role": {
|
23835
|
+
"type": "string",
|
23836
|
+
"enum": [
|
23837
|
+
"collaborate",
|
23838
|
+
"view",
|
21815
23839
|
"none"
|
21816
23840
|
]
|
21817
23841
|
}
|
@@ -21902,10 +23926,10 @@ Schema for a single Organization
|
|
21902
23926
|
"flow": {
|
21903
23927
|
"type": "number"
|
21904
23928
|
},
|
21905
|
-
"
|
23929
|
+
"integration": {
|
21906
23930
|
"type": "number"
|
21907
23931
|
},
|
21908
|
-
"
|
23932
|
+
"notebook": {
|
21909
23933
|
"type": "number"
|
21910
23934
|
},
|
21911
23935
|
"webhook": {
|
@@ -21919,6 +23943,15 @@ Schema for a single Organization
|
|
21919
23943
|
},
|
21920
23944
|
"payload": {
|
21921
23945
|
"type": "number"
|
23946
|
+
},
|
23947
|
+
"notebookMinutesPerRun": {
|
23948
|
+
"type": "number"
|
23949
|
+
},
|
23950
|
+
"notebookMinutesPerMonth": {
|
23951
|
+
"type": "number"
|
23952
|
+
},
|
23953
|
+
"notebookInParallel": {
|
23954
|
+
"type": "number"
|
21922
23955
|
}
|
21923
23956
|
},
|
21924
23957
|
"summary": {
|
@@ -21930,9 +23963,6 @@ Schema for a single Organization
|
|
21930
23963
|
"appCount": {
|
21931
23964
|
"type": "number"
|
21932
23965
|
},
|
21933
|
-
"keyCount": {
|
21934
|
-
"type": "number"
|
21935
|
-
},
|
21936
23966
|
"dashCount": {
|
21937
23967
|
"type": "number"
|
21938
23968
|
},
|
@@ -21972,10 +24002,13 @@ Schema for a single Organization
|
|
21972
24002
|
"flowCount": {
|
21973
24003
|
"type": "number"
|
21974
24004
|
},
|
21975
|
-
"
|
24005
|
+
"integrationCount": {
|
21976
24006
|
"type": "number"
|
21977
24007
|
},
|
21978
|
-
"
|
24008
|
+
"keyCount": {
|
24009
|
+
"type": "number"
|
24010
|
+
},
|
24011
|
+
"memberCount": {
|
21979
24012
|
"type": "number"
|
21980
24013
|
},
|
21981
24014
|
"payloadCount": {
|
@@ -22089,11 +24122,19 @@ Schema for a single Organization
|
|
22089
24122
|
}
|
22090
24123
|
}
|
22091
24124
|
},
|
22092
|
-
"
|
24125
|
+
"pendingInviteCount": {
|
22093
24126
|
"type": "number"
|
22094
24127
|
},
|
22095
|
-
"
|
22096
|
-
"type": "
|
24128
|
+
"storageStats": {
|
24129
|
+
"type": "object",
|
24130
|
+
"properties": {
|
24131
|
+
"count": {
|
24132
|
+
"type": "number"
|
24133
|
+
},
|
24134
|
+
"size": {
|
24135
|
+
"type": "number"
|
24136
|
+
}
|
24137
|
+
}
|
22097
24138
|
},
|
22098
24139
|
"webhookCount": {
|
22099
24140
|
"type": "number"
|
@@ -22908,10 +24949,10 @@ Schema for a collection of Organizations
|
|
22908
24949
|
"flow": {
|
22909
24950
|
"type": "number"
|
22910
24951
|
},
|
22911
|
-
"
|
24952
|
+
"integration": {
|
22912
24953
|
"type": "number"
|
22913
24954
|
},
|
22914
|
-
"
|
24955
|
+
"notebook": {
|
22915
24956
|
"type": "number"
|
22916
24957
|
},
|
22917
24958
|
"webhook": {
|
@@ -22925,6 +24966,15 @@ Schema for a collection of Organizations
|
|
22925
24966
|
},
|
22926
24967
|
"payload": {
|
22927
24968
|
"type": "number"
|
24969
|
+
},
|
24970
|
+
"notebookMinutesPerRun": {
|
24971
|
+
"type": "number"
|
24972
|
+
},
|
24973
|
+
"notebookMinutesPerMonth": {
|
24974
|
+
"type": "number"
|
24975
|
+
},
|
24976
|
+
"notebookInParallel": {
|
24977
|
+
"type": "number"
|
22928
24978
|
}
|
22929
24979
|
},
|
22930
24980
|
"summary": {
|
@@ -22936,9 +24986,6 @@ Schema for a collection of Organizations
|
|
22936
24986
|
"appCount": {
|
22937
24987
|
"type": "number"
|
22938
24988
|
},
|
22939
|
-
"keyCount": {
|
22940
|
-
"type": "number"
|
22941
|
-
},
|
22942
24989
|
"dashCount": {
|
22943
24990
|
"type": "number"
|
22944
24991
|
},
|
@@ -22978,10 +25025,13 @@ Schema for a collection of Organizations
|
|
22978
25025
|
"flowCount": {
|
22979
25026
|
"type": "number"
|
22980
25027
|
},
|
22981
|
-
"
|
25028
|
+
"integrationCount": {
|
22982
25029
|
"type": "number"
|
22983
25030
|
},
|
22984
|
-
"
|
25031
|
+
"keyCount": {
|
25032
|
+
"type": "number"
|
25033
|
+
},
|
25034
|
+
"memberCount": {
|
22985
25035
|
"type": "number"
|
22986
25036
|
},
|
22987
25037
|
"payloadCount": {
|
@@ -23095,11 +25145,19 @@ Schema for a collection of Organizations
|
|
23095
25145
|
}
|
23096
25146
|
}
|
23097
25147
|
},
|
23098
|
-
"
|
25148
|
+
"pendingInviteCount": {
|
23099
25149
|
"type": "number"
|
23100
25150
|
},
|
23101
|
-
"
|
23102
|
-
"type": "
|
25151
|
+
"storageStats": {
|
25152
|
+
"type": "object",
|
25153
|
+
"properties": {
|
25154
|
+
"count": {
|
25155
|
+
"type": "number"
|
25156
|
+
},
|
25157
|
+
"size": {
|
25158
|
+
"type": "number"
|
25159
|
+
}
|
25160
|
+
}
|
23103
25161
|
},
|
23104
25162
|
"webhookCount": {
|
23105
25163
|
"type": "number"
|
@@ -25227,6 +27285,8 @@ Schema for the body of a User authentication request
|
|
25227
27285
|
"flows.*",
|
25228
27286
|
"flowVersion.*",
|
25229
27287
|
"flowVersions.*",
|
27288
|
+
"notebook.*",
|
27289
|
+
"notebooks.*",
|
25230
27290
|
"webhook.*",
|
25231
27291
|
"webhooks.*",
|
25232
27292
|
"application.archiveData",
|
@@ -25249,6 +27309,7 @@ Schema for the body of a User authentication request
|
|
25249
27309
|
"applicationKey.patch",
|
25250
27310
|
"applicationKeys.get",
|
25251
27311
|
"applicationKeys.post",
|
27312
|
+
"data.export",
|
25252
27313
|
"data.lastValueQuery",
|
25253
27314
|
"data.timeSeriesQuery",
|
25254
27315
|
"dataTable.addColumn",
|
@@ -25377,6 +27438,15 @@ Schema for the body of a User authentication request
|
|
25377
27438
|
"integration.patch",
|
25378
27439
|
"integrations.get",
|
25379
27440
|
"integrations.post",
|
27441
|
+
"notebook.delete",
|
27442
|
+
"notebook.execute",
|
27443
|
+
"notebook.get",
|
27444
|
+
"notebook.logs",
|
27445
|
+
"notebook.patch",
|
27446
|
+
"notebook.requestInputDataExport",
|
27447
|
+
"notebook.upload",
|
27448
|
+
"notebooks.get",
|
27449
|
+
"notebooks.post",
|
25380
27450
|
"webhook.delete",
|
25381
27451
|
"webhook.get",
|
25382
27452
|
"webhook.patch",
|
@@ -25622,6 +27692,8 @@ Schema for the body of a User creation request
|
|
25622
27692
|
"flows.*",
|
25623
27693
|
"flowVersion.*",
|
25624
27694
|
"flowVersions.*",
|
27695
|
+
"notebook.*",
|
27696
|
+
"notebooks.*",
|
25625
27697
|
"webhook.*",
|
25626
27698
|
"webhooks.*",
|
25627
27699
|
"application.archiveData",
|
@@ -25644,6 +27716,7 @@ Schema for the body of a User creation request
|
|
25644
27716
|
"applicationKey.patch",
|
25645
27717
|
"applicationKeys.get",
|
25646
27718
|
"applicationKeys.post",
|
27719
|
+
"data.export",
|
25647
27720
|
"data.lastValueQuery",
|
25648
27721
|
"data.timeSeriesQuery",
|
25649
27722
|
"dataTable.addColumn",
|
@@ -25772,6 +27845,15 @@ Schema for the body of a User creation request
|
|
25772
27845
|
"integration.patch",
|
25773
27846
|
"integrations.get",
|
25774
27847
|
"integrations.post",
|
27848
|
+
"notebook.delete",
|
27849
|
+
"notebook.execute",
|
27850
|
+
"notebook.get",
|
27851
|
+
"notebook.logs",
|
27852
|
+
"notebook.patch",
|
27853
|
+
"notebook.requestInputDataExport",
|
27854
|
+
"notebook.upload",
|
27855
|
+
"notebooks.get",
|
27856
|
+
"notebooks.post",
|
25775
27857
|
"webhook.delete",
|
25776
27858
|
"webhook.get",
|
25777
27859
|
"webhook.patch",
|