losant_rest 1.17.5 → 1.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +707 -99
  3. data/docs/application.md +43 -0
  4. data/docs/applicationDashboards.md +1 -1
  5. data/docs/dashboards.md +1 -1
  6. data/docs/device.md +44 -0
  7. data/docs/devices.md +46 -0
  8. data/docs/instance.md +43 -0
  9. data/docs/instanceOrg.md +46 -0
  10. data/docs/me.md +41 -0
  11. data/docs/org.md +43 -0
  12. data/lib/losant_rest/application.rb +54 -0
  13. data/lib/losant_rest/application_dashboards.rb +1 -1
  14. data/lib/losant_rest/client.rb +2 -2
  15. data/lib/losant_rest/dashboards.rb +1 -1
  16. data/lib/losant_rest/device.rb +52 -0
  17. data/lib/losant_rest/devices.rb +61 -0
  18. data/lib/losant_rest/instance.rb +54 -0
  19. data/lib/losant_rest/instance_org.rb +56 -0
  20. data/lib/losant_rest/me.rb +51 -0
  21. data/lib/losant_rest/org.rb +54 -0
  22. data/lib/losant_rest/version.rb +1 -1
  23. data/schemas/advancedFlowQuery.json +103 -0
  24. data/schemas/advancedFlowVersionQuery.json +103 -0
  25. data/schemas/apiTokenPost.json +7 -0
  26. data/schemas/compositeDevicesState.json +97 -0
  27. data/schemas/deviceCredentials.json +1 -0
  28. data/schemas/edgeDeployment.json +7 -0
  29. data/schemas/edgeDeployments.json +7 -0
  30. data/schemas/experienceLinkedResources.json +3 -1
  31. data/schemas/flow.json +3 -1
  32. data/schemas/flowPost.json +3 -1
  33. data/schemas/flowVersionsDeletePost.json +103 -0
  34. data/schemas/flows.json +3 -1
  35. data/schemas/flowsImportPost.json +3 -1
  36. data/schemas/flowsImportResult.json +3 -1
  37. data/schemas/githubLogin.json +7 -0
  38. data/schemas/instanceCustomNode.json +1 -0
  39. data/schemas/instanceCustomNodePatch.json +1 -0
  40. data/schemas/instanceCustomNodePost.json +1 -0
  41. data/schemas/instanceCustomNodes.json +1 -0
  42. data/schemas/lastValueQuery.json +3 -0
  43. data/schemas/notebookExecutionOptions.json +10 -0
  44. data/schemas/payloadCountsBreakdown.json +53 -0
  45. data/schemas/samlResponse.json +7 -0
  46. data/schemas/userCredentials.json +7 -0
  47. data/schemas/userPost.json +7 -0
  48. metadata +4 -2
data/docs/_schemas.md CHANGED
@@ -53,6 +53,7 @@
53
53
  * [Bulk Deletion Response](#bulk-deletion-response)
54
54
  * [Change Password](#change-password)
55
55
  * [Composite Device State](#composite-device-state)
56
+ * [Devices Composite State](#devices-composite-state)
56
57
  * [Dashboard](#dashboard)
57
58
  * [Dashboard Context Instance](#dashboard-context-instance)
58
59
  * [Dashboard Patch](#dashboard-patch)
@@ -248,6 +249,7 @@
248
249
  * [Password Reset Finish](#password-reset-finish)
249
250
  * [Password Reset Input](#password-reset-input)
250
251
  * [Password Reset Response](#password-reset-response)
252
+ * [Payload Counts Breakdown](#payload-counts-breakdown)
251
253
  * [Payload Stats](#payload-stats)
252
254
  * [Recent Item](#recent-item)
253
255
  * [Recent Item List](#recent-item-list)
@@ -7133,6 +7135,109 @@ Schema for advanced workflow queries
7133
7135
  "additionalProperties": false
7134
7136
  }
7135
7137
  ]
7138
+ },
7139
+ "customNodeSupports": {
7140
+ "oneOf": [
7141
+ {
7142
+ "type": [
7143
+ "string",
7144
+ "number",
7145
+ "boolean",
7146
+ "null"
7147
+ ]
7148
+ },
7149
+ {
7150
+ "type": "object",
7151
+ "properties": {
7152
+ "$eq": {
7153
+ "type": [
7154
+ "string",
7155
+ "number",
7156
+ "boolean",
7157
+ "null"
7158
+ ]
7159
+ },
7160
+ "$ne": {
7161
+ "type": [
7162
+ "string",
7163
+ "number",
7164
+ "boolean",
7165
+ "null"
7166
+ ]
7167
+ },
7168
+ "$gt": {
7169
+ "type": [
7170
+ "string",
7171
+ "number",
7172
+ "boolean",
7173
+ "null"
7174
+ ]
7175
+ },
7176
+ "$lt": {
7177
+ "type": [
7178
+ "string",
7179
+ "number",
7180
+ "boolean",
7181
+ "null"
7182
+ ]
7183
+ },
7184
+ "$gte": {
7185
+ "type": [
7186
+ "string",
7187
+ "number",
7188
+ "boolean",
7189
+ "null"
7190
+ ]
7191
+ },
7192
+ "$lte": {
7193
+ "type": [
7194
+ "string",
7195
+ "number",
7196
+ "boolean",
7197
+ "null"
7198
+ ]
7199
+ },
7200
+ "$startsWith": {
7201
+ "type": "string",
7202
+ "minLength": 1
7203
+ },
7204
+ "$endsWith": {
7205
+ "type": "string",
7206
+ "minLength": 1
7207
+ },
7208
+ "$contains": {
7209
+ "type": "string",
7210
+ "minLength": 1
7211
+ },
7212
+ "$ci": {
7213
+ "type": "boolean"
7214
+ },
7215
+ "$in": {
7216
+ "type": "array",
7217
+ "maxItems": 100,
7218
+ "items": {
7219
+ "type": [
7220
+ "string",
7221
+ "number",
7222
+ "boolean"
7223
+ ]
7224
+ }
7225
+ },
7226
+ "$nin": {
7227
+ "type": "array",
7228
+ "maxItems": 100,
7229
+ "items": {
7230
+ "type": [
7231
+ "string",
7232
+ "number",
7233
+ "boolean"
7234
+ ]
7235
+ }
7236
+ }
7237
+ },
7238
+ "additionalProperties": false
7239
+ }
7240
+ ]
7136
7241
  }
7137
7242
  },
7138
7243
  "additionalProperties": false
@@ -8129,6 +8234,109 @@ Schema for advanced workflow queries
8129
8234
  "additionalProperties": false
8130
8235
  }
8131
8236
  ]
8237
+ },
8238
+ "customNodeSupports": {
8239
+ "oneOf": [
8240
+ {
8241
+ "type": [
8242
+ "string",
8243
+ "number",
8244
+ "boolean",
8245
+ "null"
8246
+ ]
8247
+ },
8248
+ {
8249
+ "type": "object",
8250
+ "properties": {
8251
+ "$eq": {
8252
+ "type": [
8253
+ "string",
8254
+ "number",
8255
+ "boolean",
8256
+ "null"
8257
+ ]
8258
+ },
8259
+ "$ne": {
8260
+ "type": [
8261
+ "string",
8262
+ "number",
8263
+ "boolean",
8264
+ "null"
8265
+ ]
8266
+ },
8267
+ "$gt": {
8268
+ "type": [
8269
+ "string",
8270
+ "number",
8271
+ "boolean",
8272
+ "null"
8273
+ ]
8274
+ },
8275
+ "$lt": {
8276
+ "type": [
8277
+ "string",
8278
+ "number",
8279
+ "boolean",
8280
+ "null"
8281
+ ]
8282
+ },
8283
+ "$gte": {
8284
+ "type": [
8285
+ "string",
8286
+ "number",
8287
+ "boolean",
8288
+ "null"
8289
+ ]
8290
+ },
8291
+ "$lte": {
8292
+ "type": [
8293
+ "string",
8294
+ "number",
8295
+ "boolean",
8296
+ "null"
8297
+ ]
8298
+ },
8299
+ "$startsWith": {
8300
+ "type": "string",
8301
+ "minLength": 1
8302
+ },
8303
+ "$endsWith": {
8304
+ "type": "string",
8305
+ "minLength": 1
8306
+ },
8307
+ "$contains": {
8308
+ "type": "string",
8309
+ "minLength": 1
8310
+ },
8311
+ "$ci": {
8312
+ "type": "boolean"
8313
+ },
8314
+ "$in": {
8315
+ "type": "array",
8316
+ "maxItems": 100,
8317
+ "items": {
8318
+ "type": [
8319
+ "string",
8320
+ "number",
8321
+ "boolean"
8322
+ ]
8323
+ }
8324
+ },
8325
+ "$nin": {
8326
+ "type": "array",
8327
+ "maxItems": 100,
8328
+ "items": {
8329
+ "type": [
8330
+ "string",
8331
+ "number",
8332
+ "boolean"
8333
+ ]
8334
+ }
8335
+ }
8336
+ },
8337
+ "additionalProperties": false
8338
+ }
8339
+ ]
8132
8340
  }
8133
8341
  },
8134
8342
  "additionalProperties": false
@@ -8568,6 +8776,7 @@ Schema for the body of an API Token creation request
8568
8776
  "application.mqttSubscriptionStream",
8569
8777
  "application.patch",
8570
8778
  "application.payloadCounts",
8779
+ "application.payloadCountsBreakdown",
8571
8780
  "application.deviceCounts",
8572
8781
  "application.notebookMinuteCounts",
8573
8782
  "application.search",
@@ -8627,6 +8836,7 @@ Schema for the body of an API Token creation request
8627
8836
  "device.getState",
8628
8837
  "device.patch",
8629
8838
  "device.payloadCounts",
8839
+ "device.payloadCountsBreakdown",
8630
8840
  "device.removeData",
8631
8841
  "device.sendCommand",
8632
8842
  "device.sendState",
@@ -8646,6 +8856,7 @@ Schema for the body of an API Token creation request
8646
8856
  "devices.deviceNames",
8647
8857
  "devices.export",
8648
8858
  "devices.get",
8859
+ "devices.getCompositeState",
8649
8860
  "devices.payloadCounts",
8650
8861
  "devices.post",
8651
8862
  "devices.sendCommand",
@@ -8810,6 +9021,7 @@ Schema for the body of an API Token creation request
8810
9021
  "org.modifyMember",
8811
9022
  "org.removeMember",
8812
9023
  "org.payloadCounts",
9024
+ "org.payloadCountsBreakdown",
8813
9025
  "org.deviceCounts",
8814
9026
  "org.notebookMinuteCounts",
8815
9027
  "org.invoices",
@@ -8830,12 +9042,14 @@ Schema for the body of an API Token creation request
8830
9042
  "instance.patch",
8831
9043
  "instance.historicalSummaries",
8832
9044
  "instance.generateReport",
9045
+ "instance.payloadCountsBreakdown",
8833
9046
  "instance.deviceCounts",
8834
9047
  "instance.notebookMinuteCounts",
8835
9048
  "instanceOrg.*",
8836
9049
  "instanceOrg.get",
8837
9050
  "instanceOrg.patch",
8838
9051
  "instanceOrg.delete",
9052
+ "instanceOrg.payloadCountsBreakdown",
8839
9053
  "instanceOrg.deviceCounts",
8840
9054
  "instanceOrg.notebookMinuteCounts",
8841
9055
  "instanceOrgs.*",
@@ -8921,6 +9135,7 @@ Schema for the body of an API Token creation request
8921
9135
  "me.addRecentItem",
8922
9136
  "me.fetchRecentItems",
8923
9137
  "me.payloadCounts",
9138
+ "me.payloadCountsBreakdown",
8924
9139
  "me.deviceCounts",
8925
9140
  "me.notebookMinuteCounts",
8926
9141
  "me.transferResources",
@@ -20492,6 +20707,143 @@ Schema for a composite Device state
20492
20707
 
20493
20708
  <br/>
20494
20709
 
20710
+ ## Devices Composite State
20711
+
20712
+ Schema for a collection of Composite Device State
20713
+
20714
+ ### <a name="devices-composite-state-schema"></a> Schema
20715
+
20716
+ ```json
20717
+ {
20718
+ "$schema": "http://json-schema.org/draft-07/schema#",
20719
+ "type": "object",
20720
+ "properties": {
20721
+ "items": {
20722
+ "type": "array",
20723
+ "items": {
20724
+ "type": "object",
20725
+ "properties": {
20726
+ "id": {
20727
+ "type": "string",
20728
+ "pattern": "^[A-Fa-f\\d]{24}$"
20729
+ },
20730
+ "name": {
20731
+ "type": "string",
20732
+ "minLength": 1,
20733
+ "maxLength": 255
20734
+ },
20735
+ "compositeState": {
20736
+ "title": "Composite Device State",
20737
+ "description": "Schema for a composite Device state",
20738
+ "type": "object",
20739
+ "patternProperties": {
20740
+ "^[0-9a-zA-Z_-]{1,255}$": {
20741
+ "type": "object",
20742
+ "properties": {
20743
+ "value": {
20744
+ "type": [
20745
+ "number",
20746
+ "string",
20747
+ "boolean"
20748
+ ]
20749
+ },
20750
+ "time": {
20751
+ "oneOf": [
20752
+ {
20753
+ "type": "string"
20754
+ },
20755
+ {
20756
+ "type": "number"
20757
+ },
20758
+ {
20759
+ "type": "object",
20760
+ "properties": {
20761
+ "$date": {
20762
+ "type": "string"
20763
+ }
20764
+ },
20765
+ "additionalProperties": false,
20766
+ "required": [
20767
+ "$date"
20768
+ ]
20769
+ }
20770
+ ]
20771
+ }
20772
+ }
20773
+ }
20774
+ },
20775
+ "additionalProperties": false
20776
+ }
20777
+ }
20778
+ }
20779
+ },
20780
+ "count": {
20781
+ "type": "integer"
20782
+ },
20783
+ "totalCount": {
20784
+ "type": "integer"
20785
+ },
20786
+ "perPage": {
20787
+ "type": "integer"
20788
+ },
20789
+ "page": {
20790
+ "type": "integer"
20791
+ },
20792
+ "sortField": {
20793
+ "type": "string"
20794
+ },
20795
+ "sortDirection": {
20796
+ "type": "string",
20797
+ "enum": [
20798
+ "asc",
20799
+ "desc",
20800
+ "ASC",
20801
+ "DESC",
20802
+ ""
20803
+ ]
20804
+ },
20805
+ "applicationId": {
20806
+ "type": "string",
20807
+ "pattern": "^[A-Fa-f\\d]{24}$"
20808
+ },
20809
+ "query": {
20810
+ "type": "object"
20811
+ }
20812
+ }
20813
+ }
20814
+ ```
20815
+ ### <a name="devices-composite-state-example"></a> Example
20816
+
20817
+ ```json
20818
+ {
20819
+ "items": [
20820
+ {
20821
+ "id": "575ecf887ae143cd83dc4aa2",
20822
+ "name": "My Device",
20823
+ "compositeState": {
20824
+ "voltage": {
20825
+ "time": "2016-06-13T04:00:00.000Z",
20826
+ "value": 22.4
20827
+ },
20828
+ "loaded": {
20829
+ "time": "2016-06-13T03:00:00.000Z",
20830
+ "value": false
20831
+ }
20832
+ }
20833
+ }
20834
+ ],
20835
+ "count": 1,
20836
+ "totalCount": 4,
20837
+ "perPage": 1,
20838
+ "page": 0,
20839
+ "sortField": "name",
20840
+ "sortDirection": "asc",
20841
+ "applicationId": "575ec8687ae143cd83dc4a97"
20842
+ }
20843
+ ```
20844
+
20845
+ <br/>
20846
+
20495
20847
  ## Dashboard
20496
20848
 
20497
20849
  Schema for a single Dashboard
@@ -49288,6 +49640,7 @@ Schema for the body of a device authentication request
49288
49640
  "device.sendCommand",
49289
49641
  "device.setConnectionStatus",
49290
49642
  "devices.get",
49643
+ "devices.getCompositeState",
49291
49644
  "devices.sendCommand"
49292
49645
  ]
49293
49646
  }
@@ -61219,6 +61572,13 @@ Schema for a single deployment of an edge workflow to an edge device
61219
61572
  "minLength": 1,
61220
61573
  "maxLength": 255
61221
61574
  },
61575
+ "flowClass": {
61576
+ "type": "string",
61577
+ "enum": [
61578
+ "edge",
61579
+ "customNode"
61580
+ ]
61581
+ },
61222
61582
  "fileName": {
61223
61583
  "type": "string",
61224
61584
  "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
@@ -61592,6 +61952,13 @@ Schema for a collection of Edge Deployments
61592
61952
  "minLength": 1,
61593
61953
  "maxLength": 255
61594
61954
  },
61955
+ "flowClass": {
61956
+ "type": "string",
61957
+ "enum": [
61958
+ "edge",
61959
+ "customNode"
61960
+ ]
61961
+ },
61595
61962
  "fileName": {
61596
61963
  "type": "string",
61597
61964
  "pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
@@ -69670,10 +70037,12 @@ The body of an experience linked resources response
69670
70037
  },
69671
70038
  "customNodeSupports": {
69672
70039
  "type": "array",
70040
+ "maxItems": 1,
69673
70041
  "items": {
69674
70042
  "type": "string",
69675
70043
  "enum": [
69676
- "cloud"
70044
+ "cloud",
70045
+ "edge"
69677
70046
  ]
69678
70047
  }
69679
70048
  },
@@ -79945,10 +80314,12 @@ Schema for a single Workflow
79945
80314
  },
79946
80315
  "customNodeSupports": {
79947
80316
  "type": "array",
80317
+ "maxItems": 1,
79948
80318
  "items": {
79949
80319
  "type": "string",
79950
80320
  "enum": [
79951
- "cloud"
80321
+ "cloud",
80322
+ "edge"
79952
80323
  ]
79953
80324
  }
79954
80325
  },
@@ -85567,10 +85938,12 @@ Schema for the body of a Workflow creation request
85567
85938
  },
85568
85939
  "customNodeSupports": {
85569
85940
  "type": "array",
85941
+ "maxItems": 1,
85570
85942
  "items": {
85571
85943
  "type": "string",
85572
85944
  "enum": [
85573
- "cloud"
85945
+ "cloud",
85946
+ "edge"
85574
85947
  ]
85575
85948
  }
85576
85949
  }
@@ -99604,10 +99977,113 @@ Schema for the body of a bulk flow versions delete request
99604
99977
  "type": "string",
99605
99978
  "maxLength": 255
99606
99979
  },
99607
- "key": {
99608
- "type": "string",
99609
- "pattern": "^[0-9a-zA-Z_-]{1,255}$"
99610
- },
99980
+ "key": {
99981
+ "type": "string",
99982
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
99983
+ },
99984
+ "config": {
99985
+ "type": "object",
99986
+ "patternProperties": {
99987
+ "^[0-9a-zA-Z_-]{1,255}$": {
99988
+ "type": [
99989
+ "string",
99990
+ "number",
99991
+ "boolean",
99992
+ "null"
99993
+ ],
99994
+ "maxLength": 1024
99995
+ }
99996
+ }
99997
+ }
99998
+ },
99999
+ "required": [
100000
+ "type"
100001
+ ],
100002
+ "additionalProperties": false
100003
+ }
100004
+ },
100005
+ "required": [
100006
+ "$ne"
100007
+ ],
100008
+ "additionalProperties": false
100009
+ }
100010
+ ]
100011
+ },
100012
+ "nodes": {
100013
+ "oneOf": [
100014
+ {
100015
+ "type": "object",
100016
+ "properties": {
100017
+ "type": {
100018
+ "type": "string",
100019
+ "maxLength": 255
100020
+ },
100021
+ "config": {
100022
+ "type": "object",
100023
+ "patternProperties": {
100024
+ "^[0-9a-zA-Z_-]{1,255}$": {
100025
+ "type": [
100026
+ "string",
100027
+ "number",
100028
+ "boolean",
100029
+ "null"
100030
+ ],
100031
+ "maxLength": 1024
100032
+ }
100033
+ }
100034
+ }
100035
+ },
100036
+ "required": [
100037
+ "type"
100038
+ ],
100039
+ "additionalProperties": false
100040
+ },
100041
+ {
100042
+ "type": "object",
100043
+ "properties": {
100044
+ "$eq": {
100045
+ "type": "object",
100046
+ "properties": {
100047
+ "type": {
100048
+ "type": "string",
100049
+ "maxLength": 255
100050
+ },
100051
+ "config": {
100052
+ "type": "object",
100053
+ "patternProperties": {
100054
+ "^[0-9a-zA-Z_-]{1,255}$": {
100055
+ "type": [
100056
+ "string",
100057
+ "number",
100058
+ "boolean",
100059
+ "null"
100060
+ ],
100061
+ "maxLength": 1024
100062
+ }
100063
+ }
100064
+ }
100065
+ },
100066
+ "required": [
100067
+ "type"
100068
+ ],
100069
+ "additionalProperties": false
100070
+ }
100071
+ },
100072
+ "required": [
100073
+ "$eq"
100074
+ ],
100075
+ "additionalProperties": false
100076
+ },
100077
+ {
100078
+ "type": "object",
100079
+ "properties": {
100080
+ "$ne": {
100081
+ "type": "object",
100082
+ "properties": {
100083
+ "type": {
100084
+ "type": "string",
100085
+ "maxLength": 255
100086
+ },
99611
100087
  "config": {
99612
100088
  "type": "object",
99613
100089
  "patternProperties": {
@@ -99636,105 +100112,105 @@ Schema for the body of a bulk flow versions delete request
99636
100112
  }
99637
100113
  ]
99638
100114
  },
99639
- "nodes": {
100115
+ "customNodeSupports": {
99640
100116
  "oneOf": [
99641
100117
  {
99642
- "type": "object",
99643
- "properties": {
99644
- "type": {
99645
- "type": "string",
99646
- "maxLength": 255
99647
- },
99648
- "config": {
99649
- "type": "object",
99650
- "patternProperties": {
99651
- "^[0-9a-zA-Z_-]{1,255}$": {
99652
- "type": [
99653
- "string",
99654
- "number",
99655
- "boolean",
99656
- "null"
99657
- ],
99658
- "maxLength": 1024
99659
- }
99660
- }
99661
- }
99662
- },
99663
- "required": [
99664
- "type"
99665
- ],
99666
- "additionalProperties": false
100118
+ "type": [
100119
+ "string",
100120
+ "number",
100121
+ "boolean",
100122
+ "null"
100123
+ ]
99667
100124
  },
99668
100125
  {
99669
100126
  "type": "object",
99670
100127
  "properties": {
99671
100128
  "$eq": {
99672
- "type": "object",
99673
- "properties": {
99674
- "type": {
99675
- "type": "string",
99676
- "maxLength": 255
99677
- },
99678
- "config": {
99679
- "type": "object",
99680
- "patternProperties": {
99681
- "^[0-9a-zA-Z_-]{1,255}$": {
99682
- "type": [
99683
- "string",
99684
- "number",
99685
- "boolean",
99686
- "null"
99687
- ],
99688
- "maxLength": 1024
99689
- }
99690
- }
99691
- }
99692
- },
99693
- "required": [
99694
- "type"
99695
- ],
99696
- "additionalProperties": false
99697
- }
99698
- },
99699
- "required": [
99700
- "$eq"
99701
- ],
99702
- "additionalProperties": false
99703
- },
99704
- {
99705
- "type": "object",
99706
- "properties": {
100129
+ "type": [
100130
+ "string",
100131
+ "number",
100132
+ "boolean",
100133
+ "null"
100134
+ ]
100135
+ },
99707
100136
  "$ne": {
99708
- "type": "object",
99709
- "properties": {
99710
- "type": {
99711
- "type": "string",
99712
- "maxLength": 255
99713
- },
99714
- "config": {
99715
- "type": "object",
99716
- "patternProperties": {
99717
- "^[0-9a-zA-Z_-]{1,255}$": {
99718
- "type": [
99719
- "string",
99720
- "number",
99721
- "boolean",
99722
- "null"
99723
- ],
99724
- "maxLength": 1024
99725
- }
99726
- }
99727
- }
99728
- },
99729
- "required": [
99730
- "type"
99731
- ],
99732
- "additionalProperties": false
100137
+ "type": [
100138
+ "string",
100139
+ "number",
100140
+ "boolean",
100141
+ "null"
100142
+ ]
100143
+ },
100144
+ "$gt": {
100145
+ "type": [
100146
+ "string",
100147
+ "number",
100148
+ "boolean",
100149
+ "null"
100150
+ ]
100151
+ },
100152
+ "$lt": {
100153
+ "type": [
100154
+ "string",
100155
+ "number",
100156
+ "boolean",
100157
+ "null"
100158
+ ]
100159
+ },
100160
+ "$gte": {
100161
+ "type": [
100162
+ "string",
100163
+ "number",
100164
+ "boolean",
100165
+ "null"
100166
+ ]
100167
+ },
100168
+ "$lte": {
100169
+ "type": [
100170
+ "string",
100171
+ "number",
100172
+ "boolean",
100173
+ "null"
100174
+ ]
100175
+ },
100176
+ "$startsWith": {
100177
+ "type": "string",
100178
+ "minLength": 1
100179
+ },
100180
+ "$endsWith": {
100181
+ "type": "string",
100182
+ "minLength": 1
100183
+ },
100184
+ "$contains": {
100185
+ "type": "string",
100186
+ "minLength": 1
100187
+ },
100188
+ "$ci": {
100189
+ "type": "boolean"
100190
+ },
100191
+ "$in": {
100192
+ "type": "array",
100193
+ "maxItems": 100,
100194
+ "items": {
100195
+ "type": [
100196
+ "string",
100197
+ "number",
100198
+ "boolean"
100199
+ ]
100200
+ }
100201
+ },
100202
+ "$nin": {
100203
+ "type": "array",
100204
+ "maxItems": 100,
100205
+ "items": {
100206
+ "type": [
100207
+ "string",
100208
+ "number",
100209
+ "boolean"
100210
+ ]
100211
+ }
99733
100212
  }
99734
100213
  },
99735
- "required": [
99736
- "$ne"
99737
- ],
99738
100214
  "additionalProperties": false
99739
100215
  }
99740
100216
  ]
@@ -102459,10 +102935,12 @@ Schema for a collection of Workflows
102459
102935
  },
102460
102936
  "customNodeSupports": {
102461
102937
  "type": "array",
102938
+ "maxItems": 1,
102462
102939
  "items": {
102463
102940
  "type": "string",
102464
102941
  "enum": [
102465
- "cloud"
102942
+ "cloud",
102943
+ "edge"
102466
102944
  ]
102467
102945
  }
102468
102946
  },
@@ -105299,10 +105777,12 @@ Schema for the body of a workflow import request
105299
105777
  },
105300
105778
  "customNodeSupports": {
105301
105779
  "type": "array",
105780
+ "maxItems": 1,
105302
105781
  "items": {
105303
105782
  "type": "string",
105304
105783
  "enum": [
105305
- "cloud"
105784
+ "cloud",
105785
+ "edge"
105306
105786
  ]
105307
105787
  }
105308
105788
  }
@@ -110667,10 +111147,12 @@ Schema for the result of a workflow import request
110667
111147
  },
110668
111148
  "customNodeSupports": {
110669
111149
  "type": "array",
111150
+ "maxItems": 1,
110670
111151
  "items": {
110671
111152
  "type": "string",
110672
111153
  "enum": [
110673
- "cloud"
111154
+ "cloud",
111155
+ "edge"
110674
111156
  ]
110675
111157
  }
110676
111158
  },
@@ -115965,6 +116447,7 @@ Schema for the body of a Github login request
115965
116447
  "application.mqttSubscriptionStream",
115966
116448
  "application.patch",
115967
116449
  "application.payloadCounts",
116450
+ "application.payloadCountsBreakdown",
115968
116451
  "application.deviceCounts",
115969
116452
  "application.notebookMinuteCounts",
115970
116453
  "application.search",
@@ -116024,6 +116507,7 @@ Schema for the body of a Github login request
116024
116507
  "device.getState",
116025
116508
  "device.patch",
116026
116509
  "device.payloadCounts",
116510
+ "device.payloadCountsBreakdown",
116027
116511
  "device.removeData",
116028
116512
  "device.sendCommand",
116029
116513
  "device.sendState",
@@ -116043,6 +116527,7 @@ Schema for the body of a Github login request
116043
116527
  "devices.deviceNames",
116044
116528
  "devices.export",
116045
116529
  "devices.get",
116530
+ "devices.getCompositeState",
116046
116531
  "devices.payloadCounts",
116047
116532
  "devices.post",
116048
116533
  "devices.sendCommand",
@@ -116207,6 +116692,7 @@ Schema for the body of a Github login request
116207
116692
  "org.modifyMember",
116208
116693
  "org.removeMember",
116209
116694
  "org.payloadCounts",
116695
+ "org.payloadCountsBreakdown",
116210
116696
  "org.deviceCounts",
116211
116697
  "org.notebookMinuteCounts",
116212
116698
  "org.invoices",
@@ -116227,12 +116713,14 @@ Schema for the body of a Github login request
116227
116713
  "instance.patch",
116228
116714
  "instance.historicalSummaries",
116229
116715
  "instance.generateReport",
116716
+ "instance.payloadCountsBreakdown",
116230
116717
  "instance.deviceCounts",
116231
116718
  "instance.notebookMinuteCounts",
116232
116719
  "instanceOrg.*",
116233
116720
  "instanceOrg.get",
116234
116721
  "instanceOrg.patch",
116235
116722
  "instanceOrg.delete",
116723
+ "instanceOrg.payloadCountsBreakdown",
116236
116724
  "instanceOrg.deviceCounts",
116237
116725
  "instanceOrg.notebookMinuteCounts",
116238
116726
  "instanceOrgs.*",
@@ -116318,6 +116806,7 @@ Schema for the body of a Github login request
116318
116806
  "me.addRecentItem",
116319
116807
  "me.fetchRecentItems",
116320
116808
  "me.payloadCounts",
116809
+ "me.payloadCountsBreakdown",
116321
116810
  "me.deviceCounts",
116322
116811
  "me.notebookMinuteCounts",
116323
116812
  "me.transferResources",
@@ -118747,6 +119236,7 @@ Schema for a single Instance Custom Node
118747
119236
  },
118748
119237
  "customNodeSupports": {
118749
119238
  "type": "array",
119239
+ "maxItems": 1,
118750
119240
  "items": {
118751
119241
  "type": "string",
118752
119242
  "enum": [
@@ -119522,6 +120012,7 @@ Schema for the body of a Instance Custom Node modification request
119522
120012
  },
119523
120013
  "customNodeSupports": {
119524
120014
  "type": "array",
120015
+ "maxItems": 1,
119525
120016
  "items": {
119526
120017
  "type": "string",
119527
120018
  "enum": [
@@ -120222,6 +120713,7 @@ Schema for the body of a Instance Custom Node creation request
120222
120713
  },
120223
120714
  "customNodeSupports": {
120224
120715
  "type": "array",
120716
+ "maxItems": 1,
120225
120717
  "items": {
120226
120718
  "type": "string",
120227
120719
  "enum": [
@@ -120803,6 +121295,7 @@ Schema for a collection of Custom Nodes within an instance
120803
121295
  },
120804
121296
  "customNodeSupports": {
120805
121297
  "type": "array",
121298
+ "maxItems": 1,
120806
121299
  "items": {
120807
121300
  "type": "string",
120808
121301
  "enum": [
@@ -127473,6 +127966,9 @@ Schema for the body of a last value query request
127473
127966
  }
127474
127967
  },
127475
127968
  "additionalProperties": false
127969
+ },
127970
+ "end": {
127971
+ "type": "number"
127476
127972
  }
127477
127973
  },
127478
127974
  "additionalProperties": false
@@ -130909,6 +131405,16 @@ Schema for the options for a Notebook execution request
130909
131405
  "templateContext": {
130910
131406
  "type": "string",
130911
131407
  "maxLength": 32767
131408
+ },
131409
+ "email": {
131410
+ "type": "string",
131411
+ "format": "email",
131412
+ "maxLength": 1024
131413
+ },
131414
+ "callbackUrl": {
131415
+ "type": "string",
131416
+ "format": "uri",
131417
+ "maxLength": 1024
130912
131418
  }
130913
131419
  },
130914
131420
  "additionalProperties": false
@@ -136234,6 +136740,87 @@ Schema for result of a successful password reset
136234
136740
 
136235
136741
  <br/>
136236
136742
 
136743
+ ## Payload Counts Breakdown
136744
+
136745
+ Schema for the result of a payload counts breakdown request
136746
+
136747
+ ### <a name="payload-counts-breakdown-schema"></a> Schema
136748
+
136749
+ ```json
136750
+ {
136751
+ "$schema": "http://json-schema.org/draft-07/schema#",
136752
+ "type": "object",
136753
+ "properties": {
136754
+ "start": {
136755
+ "type": "string",
136756
+ "format": "date-time"
136757
+ },
136758
+ "end": {
136759
+ "type": "string",
136760
+ "format": "date-time"
136761
+ },
136762
+ "resolution": {
136763
+ "type": "number",
136764
+ "enum": [
136765
+ 86400000,
136766
+ 3600000
136767
+ ]
136768
+ },
136769
+ "asBytes": {
136770
+ "type": "boolean",
136771
+ "enum": [
136772
+ true,
136773
+ false
136774
+ ]
136775
+ },
136776
+ "includeNonBillable": {
136777
+ "type": "boolean",
136778
+ "enum": [
136779
+ true,
136780
+ false
136781
+ ]
136782
+ },
136783
+ "counts": {
136784
+ "type": "array",
136785
+ "items": {
136786
+ "type": "object",
136787
+ "properties": {
136788
+ "date": {
136789
+ "type": "string",
136790
+ "format": "date-time"
136791
+ },
136792
+ "payloads": {
136793
+ "type": "integer"
136794
+ },
136795
+ "bytes": {
136796
+ "type": "number"
136797
+ }
136798
+ }
136799
+ }
136800
+ }
136801
+ }
136802
+ }
136803
+ ```
136804
+ ### <a name="payload-counts-breakdown-example"></a> Example
136805
+
136806
+ ```json
136807
+ {
136808
+ "start": "1999-05-20T05:00:00.000Z",
136809
+ "end": "1999-06-20T04:59:59.999Z",
136810
+ "asBytes": true,
136811
+ "includeNonBillable": true,
136812
+ "resolution": 3600000,
136813
+ "counts": [
136814
+ {
136815
+ "date": "1999-06-20T00:00:00.000Z",
136816
+ "value": 17
136817
+ }
136818
+ ]
136819
+ }
136820
+ ```
136821
+
136822
+ <br/>
136823
+
136237
136824
  ## Payload Stats
136238
136825
 
136239
136826
  Schema for the result of a payload stats request
@@ -137429,6 +138016,7 @@ SAML Response body for login
137429
138016
  "application.mqttSubscriptionStream",
137430
138017
  "application.patch",
137431
138018
  "application.payloadCounts",
138019
+ "application.payloadCountsBreakdown",
137432
138020
  "application.deviceCounts",
137433
138021
  "application.notebookMinuteCounts",
137434
138022
  "application.search",
@@ -137488,6 +138076,7 @@ SAML Response body for login
137488
138076
  "device.getState",
137489
138077
  "device.patch",
137490
138078
  "device.payloadCounts",
138079
+ "device.payloadCountsBreakdown",
137491
138080
  "device.removeData",
137492
138081
  "device.sendCommand",
137493
138082
  "device.sendState",
@@ -137507,6 +138096,7 @@ SAML Response body for login
137507
138096
  "devices.deviceNames",
137508
138097
  "devices.export",
137509
138098
  "devices.get",
138099
+ "devices.getCompositeState",
137510
138100
  "devices.payloadCounts",
137511
138101
  "devices.post",
137512
138102
  "devices.sendCommand",
@@ -137671,6 +138261,7 @@ SAML Response body for login
137671
138261
  "org.modifyMember",
137672
138262
  "org.removeMember",
137673
138263
  "org.payloadCounts",
138264
+ "org.payloadCountsBreakdown",
137674
138265
  "org.deviceCounts",
137675
138266
  "org.notebookMinuteCounts",
137676
138267
  "org.invoices",
@@ -137691,12 +138282,14 @@ SAML Response body for login
137691
138282
  "instance.patch",
137692
138283
  "instance.historicalSummaries",
137693
138284
  "instance.generateReport",
138285
+ "instance.payloadCountsBreakdown",
137694
138286
  "instance.deviceCounts",
137695
138287
  "instance.notebookMinuteCounts",
137696
138288
  "instanceOrg.*",
137697
138289
  "instanceOrg.get",
137698
138290
  "instanceOrg.patch",
137699
138291
  "instanceOrg.delete",
138292
+ "instanceOrg.payloadCountsBreakdown",
137700
138293
  "instanceOrg.deviceCounts",
137701
138294
  "instanceOrg.notebookMinuteCounts",
137702
138295
  "instanceOrgs.*",
@@ -137782,6 +138375,7 @@ SAML Response body for login
137782
138375
  "me.addRecentItem",
137783
138376
  "me.fetchRecentItems",
137784
138377
  "me.payloadCounts",
138378
+ "me.payloadCountsBreakdown",
137785
138379
  "me.deviceCounts",
137786
138380
  "me.notebookMinuteCounts",
137787
138381
  "me.transferResources",
@@ -140204,6 +140798,7 @@ Schema for the body of a User authentication request
140204
140798
  "application.mqttSubscriptionStream",
140205
140799
  "application.patch",
140206
140800
  "application.payloadCounts",
140801
+ "application.payloadCountsBreakdown",
140207
140802
  "application.deviceCounts",
140208
140803
  "application.notebookMinuteCounts",
140209
140804
  "application.search",
@@ -140263,6 +140858,7 @@ Schema for the body of a User authentication request
140263
140858
  "device.getState",
140264
140859
  "device.patch",
140265
140860
  "device.payloadCounts",
140861
+ "device.payloadCountsBreakdown",
140266
140862
  "device.removeData",
140267
140863
  "device.sendCommand",
140268
140864
  "device.sendState",
@@ -140282,6 +140878,7 @@ Schema for the body of a User authentication request
140282
140878
  "devices.deviceNames",
140283
140879
  "devices.export",
140284
140880
  "devices.get",
140881
+ "devices.getCompositeState",
140285
140882
  "devices.payloadCounts",
140286
140883
  "devices.post",
140287
140884
  "devices.sendCommand",
@@ -140446,6 +141043,7 @@ Schema for the body of a User authentication request
140446
141043
  "org.modifyMember",
140447
141044
  "org.removeMember",
140448
141045
  "org.payloadCounts",
141046
+ "org.payloadCountsBreakdown",
140449
141047
  "org.deviceCounts",
140450
141048
  "org.notebookMinuteCounts",
140451
141049
  "org.invoices",
@@ -140466,12 +141064,14 @@ Schema for the body of a User authentication request
140466
141064
  "instance.patch",
140467
141065
  "instance.historicalSummaries",
140468
141066
  "instance.generateReport",
141067
+ "instance.payloadCountsBreakdown",
140469
141068
  "instance.deviceCounts",
140470
141069
  "instance.notebookMinuteCounts",
140471
141070
  "instanceOrg.*",
140472
141071
  "instanceOrg.get",
140473
141072
  "instanceOrg.patch",
140474
141073
  "instanceOrg.delete",
141074
+ "instanceOrg.payloadCountsBreakdown",
140475
141075
  "instanceOrg.deviceCounts",
140476
141076
  "instanceOrg.notebookMinuteCounts",
140477
141077
  "instanceOrgs.*",
@@ -140557,6 +141157,7 @@ Schema for the body of a User authentication request
140557
141157
  "me.addRecentItem",
140558
141158
  "me.fetchRecentItems",
140559
141159
  "me.payloadCounts",
141160
+ "me.payloadCountsBreakdown",
140560
141161
  "me.deviceCounts",
140561
141162
  "me.notebookMinuteCounts",
140562
141163
  "me.transferResources",
@@ -140759,6 +141360,7 @@ Schema for the body of a User creation request
140759
141360
  "application.mqttSubscriptionStream",
140760
141361
  "application.patch",
140761
141362
  "application.payloadCounts",
141363
+ "application.payloadCountsBreakdown",
140762
141364
  "application.deviceCounts",
140763
141365
  "application.notebookMinuteCounts",
140764
141366
  "application.search",
@@ -140818,6 +141420,7 @@ Schema for the body of a User creation request
140818
141420
  "device.getState",
140819
141421
  "device.patch",
140820
141422
  "device.payloadCounts",
141423
+ "device.payloadCountsBreakdown",
140821
141424
  "device.removeData",
140822
141425
  "device.sendCommand",
140823
141426
  "device.sendState",
@@ -140837,6 +141440,7 @@ Schema for the body of a User creation request
140837
141440
  "devices.deviceNames",
140838
141441
  "devices.export",
140839
141442
  "devices.get",
141443
+ "devices.getCompositeState",
140840
141444
  "devices.payloadCounts",
140841
141445
  "devices.post",
140842
141446
  "devices.sendCommand",
@@ -141001,6 +141605,7 @@ Schema for the body of a User creation request
141001
141605
  "org.modifyMember",
141002
141606
  "org.removeMember",
141003
141607
  "org.payloadCounts",
141608
+ "org.payloadCountsBreakdown",
141004
141609
  "org.deviceCounts",
141005
141610
  "org.notebookMinuteCounts",
141006
141611
  "org.invoices",
@@ -141021,12 +141626,14 @@ Schema for the body of a User creation request
141021
141626
  "instance.patch",
141022
141627
  "instance.historicalSummaries",
141023
141628
  "instance.generateReport",
141629
+ "instance.payloadCountsBreakdown",
141024
141630
  "instance.deviceCounts",
141025
141631
  "instance.notebookMinuteCounts",
141026
141632
  "instanceOrg.*",
141027
141633
  "instanceOrg.get",
141028
141634
  "instanceOrg.patch",
141029
141635
  "instanceOrg.delete",
141636
+ "instanceOrg.payloadCountsBreakdown",
141030
141637
  "instanceOrg.deviceCounts",
141031
141638
  "instanceOrg.notebookMinuteCounts",
141032
141639
  "instanceOrgs.*",
@@ -141112,6 +141719,7 @@ Schema for the body of a User creation request
141112
141719
  "me.addRecentItem",
141113
141720
  "me.fetchRecentItems",
141114
141721
  "me.payloadCounts",
141722
+ "me.payloadCountsBreakdown",
141115
141723
  "me.deviceCounts",
141116
141724
  "me.notebookMinuteCounts",
141117
141725
  "me.transferResources",