losant_rest 1.21.2 → 1.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
data/docs/_schemas.md CHANGED
@@ -87,7 +87,11 @@
87
87
  * [Debug Exclude Node IDs](#debug-exclude-node-ids)
88
88
  * [Debug Levels](#debug-levels)
89
89
  * [Device](#device)
90
+ * [Device Attribute](#device-attribute)
90
91
  * [Device Attribute Data Type Filter](#device-attribute-data-type-filter)
92
+ * [Device Attribute Patch](#device-attribute-patch)
93
+ * [Device Attribute Post](#device-attribute-post)
94
+ * [Device Attributes](#device-attributes)
91
95
  * [Device Class Filter](#device-class-filter)
92
96
  * [Device Command](#device-command)
93
97
  * [Device Commands](#device-commands)
@@ -13183,6 +13187,8 @@ Schema for the body of an API Token creation request
13183
13187
  "deviceRecipe.*",
13184
13188
  "deviceRecipes.*",
13185
13189
  "devices.*",
13190
+ "deviceAttribute.*",
13191
+ "deviceAttributes.*",
13186
13192
  "edgeDeployment.*",
13187
13193
  "edgeDeployments.*",
13188
13194
  "embeddedDeployment.*",
@@ -13329,6 +13335,11 @@ Schema for the body of an API Token creation request
13329
13335
  "devices.sendCommand",
13330
13336
  "devices.tagKeys",
13331
13337
  "devices.tagValues",
13338
+ "deviceAttribute.get",
13339
+ "deviceAttribute.patch",
13340
+ "deviceAttribute.delete",
13341
+ "deviceAttributes.get",
13342
+ "deviceAttributes.post",
13332
13343
  "edgeDeployment.get",
13333
13344
  "edgeDeployments.get",
13334
13345
  "edgeDeployments.release",
@@ -22507,6 +22518,35 @@ Schema for the body of an application export request
22507
22518
  "forceJob": {
22508
22519
  "type": "boolean",
22509
22520
  "default": false
22521
+ },
22522
+ "exportType": {
22523
+ "type": "string",
22524
+ "enum": [
22525
+ "zip",
22526
+ "repo"
22527
+ ],
22528
+ "default": "zip"
22529
+ },
22530
+ "credentialName": {
22531
+ "type": "string",
22532
+ "maxLength": 255
22533
+ },
22534
+ "repo": {
22535
+ "type": "object",
22536
+ "properties": {
22537
+ "branch": {
22538
+ "type": "string",
22539
+ "maxLength": 255
22540
+ },
22541
+ "directory": {
22542
+ "type": "string",
22543
+ "maxLength": 1024
22544
+ },
22545
+ "commitMessage": {
22546
+ "type": "string",
22547
+ "maxLength": 1024
22548
+ }
22549
+ }
22510
22550
  }
22511
22551
  },
22512
22552
  "additionalProperties": false
@@ -22635,7 +22675,8 @@ Schema for a list Application import executions
22635
22675
  "enum": [
22636
22676
  "importBundle",
22637
22677
  "importUrl",
22638
- "fromApplication"
22678
+ "fromApplication",
22679
+ "repository"
22639
22680
  ]
22640
22681
  },
22641
22682
  "importExecutionId": {
@@ -22821,6 +22862,22 @@ Schema for a list Application import executions
22821
22862
  "type": "string",
22822
22863
  "format": "uri",
22823
22864
  "maxLength": 1024
22865
+ },
22866
+ "credentialName": {
22867
+ "type": "string"
22868
+ },
22869
+ "repo": {
22870
+ "type": "object",
22871
+ "properties": {
22872
+ "branch": {
22873
+ "type": "string",
22874
+ "maxLength": 255
22875
+ },
22876
+ "directory": {
22877
+ "type": "string",
22878
+ "maxLength": 1024
22879
+ }
22880
+ }
22824
22881
  }
22825
22882
  }
22826
22883
  }
@@ -26473,7 +26530,9 @@ Schema for a single Credential
26473
26530
  "whatsapp",
26474
26531
  "sql",
26475
26532
  "mongodb",
26476
- "mailgun"
26533
+ "mailgun",
26534
+ "snowflake",
26535
+ "git"
26477
26536
  ]
26478
26537
  },
26479
26538
  "awsConfig": {
@@ -26673,6 +26732,69 @@ Schema for a single Credential
26673
26732
  "type": "object",
26674
26733
  "properties": {},
26675
26734
  "additionalProperties": false
26735
+ },
26736
+ "snowflakeConfig": {
26737
+ "type": "object",
26738
+ "properties": {
26739
+ "host": {
26740
+ "type": "string",
26741
+ "minLength": 1,
26742
+ "maxLength": 128
26743
+ },
26744
+ "username": {
26745
+ "type": "string",
26746
+ "minLength": 1,
26747
+ "maxLength": 128
26748
+ },
26749
+ "publicKey": {
26750
+ "type": "string",
26751
+ "minLength": 1,
26752
+ "maxLength": 8192
26753
+ }
26754
+ },
26755
+ "required": [
26756
+ "host",
26757
+ "username",
26758
+ "publicKey"
26759
+ ],
26760
+ "additionalProperties": false
26761
+ },
26762
+ "gitConfig": {
26763
+ "type": "object",
26764
+ "properties": {
26765
+ "type": {
26766
+ "type": "string",
26767
+ "enum": [
26768
+ "ssh-key",
26769
+ "http-password"
26770
+ ]
26771
+ },
26772
+ "cloneUrl": {
26773
+ "type": "string",
26774
+ "minLength": 5,
26775
+ "maxLength": 1024
26776
+ },
26777
+ "publicKey": {
26778
+ "type": "string",
26779
+ "maxLength": 8192
26780
+ },
26781
+ "username": {
26782
+ "type": "string",
26783
+ "maxLength": 128
26784
+ },
26785
+ "committerName": {
26786
+ "type": "string",
26787
+ "maxLength": 128
26788
+ },
26789
+ "committerEmail": {
26790
+ "type": "string",
26791
+ "maxLength": 128
26792
+ }
26793
+ },
26794
+ "required": [
26795
+ "type",
26796
+ "cloneUrl"
26797
+ ]
26676
26798
  }
26677
26799
  },
26678
26800
  "additionalProperties": false,
@@ -36458,6 +36580,66 @@ Schema for a Credential update request
36458
36580
  }
36459
36581
  },
36460
36582
  "additionalProperties": false
36583
+ },
36584
+ "snowflakeConfig": {
36585
+ "type": "object",
36586
+ "properties": {
36587
+ "host": {
36588
+ "type": "string",
36589
+ "minLength": 1,
36590
+ "maxLength": 128
36591
+ },
36592
+ "username": {
36593
+ "type": "string",
36594
+ "minLength": 1,
36595
+ "maxLength": 128
36596
+ },
36597
+ "privateKey": {
36598
+ "type": "string",
36599
+ "maxLength": 8196
36600
+ },
36601
+ "generatePrivateKey": {
36602
+ "type": "boolean"
36603
+ }
36604
+ },
36605
+ "additionalProperties": false
36606
+ },
36607
+ "gitConfig": {
36608
+ "type": "object",
36609
+ "properties": {
36610
+ "type": {
36611
+ "type": "string",
36612
+ "enum": [
36613
+ "ssh-key",
36614
+ "http-password"
36615
+ ]
36616
+ },
36617
+ "cloneUrl": {
36618
+ "type": "string",
36619
+ "minLength": 5,
36620
+ "maxLength": 1024
36621
+ },
36622
+ "username": {
36623
+ "type": "string",
36624
+ "maxLength": 128
36625
+ },
36626
+ "committerName": {
36627
+ "type": "string",
36628
+ "maxLength": 128
36629
+ },
36630
+ "committerEmail": {
36631
+ "type": "string",
36632
+ "maxLength": 128
36633
+ },
36634
+ "generatePrivateKey": {
36635
+ "type": "boolean"
36636
+ },
36637
+ "secretValue": {
36638
+ "type": "string",
36639
+ "maxLength": 8196
36640
+ }
36641
+ },
36642
+ "additionalProperties": false
36461
36643
  }
36462
36644
  },
36463
36645
  "additionalProperties": false
@@ -36514,7 +36696,9 @@ Schema for a Credential creation request
36514
36696
  "whatsapp",
36515
36697
  "sql",
36516
36698
  "mongodb",
36517
- "mailgun"
36699
+ "mailgun",
36700
+ "snowflake",
36701
+ "git"
36518
36702
  ]
36519
36703
  },
36520
36704
  "awsConfig": {
@@ -36779,12 +36963,12 @@ Schema for a Credential creation request
36779
36963
  "type": "string",
36780
36964
  "minLength": 1,
36781
36965
  "maxLength": 2048
36782
- },
36783
- "required": [
36784
- "connectionUri"
36785
- ]
36966
+ }
36786
36967
  },
36787
- "additionalProperties": false
36968
+ "additionalProperties": false,
36969
+ "required": [
36970
+ "connectionUri"
36971
+ ]
36788
36972
  },
36789
36973
  "mailgunConfig": {
36790
36974
  "type": "object",
@@ -36799,6 +36983,97 @@ Schema for a Credential creation request
36799
36983
  "required": [
36800
36984
  "apiKey"
36801
36985
  ]
36986
+ },
36987
+ "snowflakeConfig": {
36988
+ "type": "object",
36989
+ "properties": {
36990
+ "host": {
36991
+ "type": "string",
36992
+ "minLength": 1,
36993
+ "maxLength": 128
36994
+ },
36995
+ "username": {
36996
+ "type": "string",
36997
+ "minLength": 1,
36998
+ "maxLength": 128
36999
+ },
37000
+ "privateKey": {
37001
+ "type": "string",
37002
+ "maxLength": 8196
37003
+ },
37004
+ "generatePrivateKey": {
37005
+ "type": "boolean"
37006
+ }
37007
+ },
37008
+ "additionalProperties": false,
37009
+ "anyOf": [
37010
+ {
37011
+ "required": [
37012
+ "host",
37013
+ "username",
37014
+ "privateKey"
37015
+ ]
37016
+ },
37017
+ {
37018
+ "required": [
37019
+ "host",
37020
+ "username",
37021
+ "generatePrivateKey"
37022
+ ]
37023
+ }
37024
+ ]
37025
+ },
37026
+ "gitConfig": {
37027
+ "type": "object",
37028
+ "properties": {
37029
+ "type": {
37030
+ "type": "string",
37031
+ "enum": [
37032
+ "ssh-key",
37033
+ "http-password"
37034
+ ]
37035
+ },
37036
+ "cloneUrl": {
37037
+ "type": "string",
37038
+ "minLength": 5,
37039
+ "maxLength": 1024
37040
+ },
37041
+ "username": {
37042
+ "type": "string",
37043
+ "maxLength": 128
37044
+ },
37045
+ "committerName": {
37046
+ "type": "string",
37047
+ "maxLength": 128
37048
+ },
37049
+ "committerEmail": {
37050
+ "type": "string",
37051
+ "maxLength": 128
37052
+ },
37053
+ "generatePrivateKey": {
37054
+ "type": "boolean"
37055
+ },
37056
+ "secretValue": {
37057
+ "type": "string",
37058
+ "maxLength": 8196
37059
+ }
37060
+ },
37061
+ "additionalProperties": false,
37062
+ "anyOf": [
37063
+ {
37064
+ "required": [
37065
+ "type",
37066
+ "cloneUrl",
37067
+ "generatePrivateKey"
37068
+ ]
37069
+ },
37070
+ {
37071
+ "required": [
37072
+ "type",
37073
+ "cloneUrl"
37074
+ ]
37075
+ }
37076
+ ]
36802
37077
  }
36803
37078
  },
36804
37079
  "additionalProperties": false,
@@ -36908,7 +37183,9 @@ Schema for a collection of Credentials
36908
37183
  "whatsapp",
36909
37184
  "sql",
36910
37185
  "mongodb",
36911
- "mailgun"
37186
+ "mailgun",
37187
+ "snowflake",
37188
+ "git"
36912
37189
  ]
36913
37190
  },
36914
37191
  "awsConfig": {
@@ -37108,6 +37385,69 @@ Schema for a collection of Credentials
37108
37385
  "type": "object",
37109
37386
  "properties": {},
37110
37387
  "additionalProperties": false
37388
+ },
37389
+ "snowflakeConfig": {
37390
+ "type": "object",
37391
+ "properties": {
37392
+ "host": {
37393
+ "type": "string",
37394
+ "minLength": 1,
37395
+ "maxLength": 128
37396
+ },
37397
+ "username": {
37398
+ "type": "string",
37399
+ "minLength": 1,
37400
+ "maxLength": 128
37401
+ },
37402
+ "publicKey": {
37403
+ "type": "string",
37404
+ "minLength": 1,
37405
+ "maxLength": 8192
37406
+ }
37407
+ },
37408
+ "required": [
37409
+ "host",
37410
+ "username",
37411
+ "publicKey"
37412
+ ],
37413
+ "additionalProperties": false
37414
+ },
37415
+ "gitConfig": {
37416
+ "type": "object",
37417
+ "properties": {
37418
+ "type": {
37419
+ "type": "string",
37420
+ "enum": [
37421
+ "ssh-key",
37422
+ "http-password"
37423
+ ]
37424
+ },
37425
+ "cloneUrl": {
37426
+ "type": "string",
37427
+ "minLength": 5,
37428
+ "maxLength": 1024
37429
+ },
37430
+ "publicKey": {
37431
+ "type": "string",
37432
+ "maxLength": 8192
37433
+ },
37434
+ "username": {
37435
+ "type": "string",
37436
+ "maxLength": 128
37437
+ },
37438
+ "committerName": {
37439
+ "type": "string",
37440
+ "maxLength": 128
37441
+ },
37442
+ "committerEmail": {
37443
+ "type": "string",
37444
+ "maxLength": 128
37445
+ }
37446
+ },
37447
+ "required": [
37448
+ "type",
37449
+ "cloneUrl"
37450
+ ]
37111
37451
  }
37112
37452
  },
37113
37453
  "additionalProperties": false,
@@ -66468,7 +66808,6 @@ Schema for a single Device
66468
66808
  "type": "object",
66469
66809
  "additionalProperties": false
66470
66810
  },
66471
- "additionalProperties": false,
66472
66811
  "maxItems": 0
66473
66812
  },
66474
66813
  "childAttributes": {
@@ -66640,6 +66979,155 @@ Schema for a single Device
66640
66979
 
66641
66980
  <br/>
66642
66981
 
66982
+ ## Device Attribute
66983
+
66984
+ Schema for a single Device Attribute
66985
+
66986
+ ### <a name="device-attribute-schema"></a> Schema
66987
+
66988
+ ```json
66989
+ {
66990
+ "$schema": "http://json-schema.org/draft-07/schema#",
66991
+ "type": "object",
66992
+ "properties": {
66993
+ "name": {
66994
+ "type": "string",
66995
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
66996
+ },
66997
+ "dataType": {
66998
+ "type": "string",
66999
+ "enum": [
67000
+ "string",
67001
+ "number",
67002
+ "gps",
67003
+ "boolean",
67004
+ "blob"
67005
+ ]
67006
+ },
67007
+ "contentType": {
67008
+ "type": "string",
67009
+ "maxLength": 64
67010
+ },
67011
+ "description": {
67012
+ "type": "string",
67013
+ "maxLength": 32767
67014
+ },
67015
+ "attributeTags": {
67016
+ "type": "object",
67017
+ "patternProperties": {
67018
+ "^[0-9a-zA-Z_-]{1,255}$": {
67019
+ "type": "string",
67020
+ "minLength": 1,
67021
+ "maxLength": 255
67022
+ }
67023
+ },
67024
+ "additionalProperties": false
67025
+ },
67026
+ "system": {
67027
+ "type": "object",
67028
+ "properties": {
67029
+ "aggregation": {
67030
+ "type": "string",
67031
+ "enum": [
67032
+ "FIRST",
67033
+ "LAST",
67034
+ "COUNT",
67035
+ "MAX",
67036
+ "MIN",
67037
+ "MEDIAN",
67038
+ "MEAN",
67039
+ "SUM",
67040
+ "STD_DEV"
67041
+ ]
67042
+ },
67043
+ "aggregationOptions": {
67044
+ "type": "array",
67045
+ "items": {
67046
+ "type": "object",
67047
+ "additionalProperties": false
67048
+ },
67049
+ "maxItems": 0
67050
+ },
67051
+ "childAttributes": {
67052
+ "type": "array",
67053
+ "items": {
67054
+ "type": "object",
67055
+ "properties": {
67056
+ "name": {
67057
+ "type": "string",
67058
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67059
+ },
67060
+ "mode": {
67061
+ "type": "string",
67062
+ "enum": [
67063
+ "all",
67064
+ "whitelist",
67065
+ "blacklist"
67066
+ ]
67067
+ },
67068
+ "deviceIds": {
67069
+ "type": "array",
67070
+ "items": {
67071
+ "type": "string",
67072
+ "pattern": "^[A-Fa-f\\d]{24}$"
67073
+ },
67074
+ "maxItems": 1000
67075
+ },
67076
+ "deviceTags": {
67077
+ "type": "array",
67078
+ "items": {
67079
+ "type": "object",
67080
+ "properties": {
67081
+ "key": {
67082
+ "type": "string",
67083
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67084
+ },
67085
+ "value": {
67086
+ "type": "string",
67087
+ "minLength": 1,
67088
+ "maxLength": 255
67089
+ }
67090
+ },
67091
+ "additionalProperties": false
67092
+ },
67093
+ "maxItems": 100
67094
+ }
67095
+ },
67096
+ "required": [
67097
+ "name",
67098
+ "mode"
67099
+ ],
67100
+ "additionalProperties": false
67101
+ },
67102
+ "maxItems": 256
67103
+ }
67104
+ },
67105
+ "additionalProperties": false
67106
+ },
67107
+ "applicationId": {
67108
+ "type": "string",
67109
+ "pattern": "^[A-Fa-f\\d]{24}$"
67110
+ },
67111
+ "deviceId": {
67112
+ "type": "string",
67113
+ "pattern": "^[A-Fa-f\\d]{24}$"
67114
+ }
67115
+ }
67116
+ }
67117
+ ```
67118
+ ### <a name="device-attribute-example"></a> Example
67119
+
67120
+ ```json
67121
+ {
67122
+ "deviceId": "575ecf887ae143cd83dc4aa2",
67123
+ "applicationId": "575ec8687ae143cd83dc4a97",
67124
+ "name": "voltage",
67125
+ "dataType": "number"
67126
+ }
67127
+ ```
67128
+
67129
+ <br/>
67130
+
66643
67131
  ## Device Attribute Data Type Filter
66644
67132
 
66645
67133
  Select one or multiple device attribute data types
@@ -66688,6 +67176,478 @@ Select one or multiple device attribute data types
66688
67176
 
66689
67177
  <br/>
66690
67178
 
67179
+ ## Device Attribute Patch
67180
+
67181
+ Schema for the body of a Device Attribute modification request
67182
+
67183
+ ### <a name="device-attribute-patch-schema"></a> Schema
67184
+
67185
+ ```json
67186
+ {
67187
+ "$schema": "http://json-schema.org/draft-07/schema#",
67188
+ "type": "object",
67189
+ "properties": {
67190
+ "name": {
67191
+ "type": "string",
67192
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67193
+ },
67194
+ "contentType": {
67195
+ "type": "string",
67196
+ "maxLength": 64
67197
+ },
67198
+ "description": {
67199
+ "type": "string",
67200
+ "maxLength": 32767
67201
+ },
67202
+ "attributeTags": {
67203
+ "type": "object",
67204
+ "patternProperties": {
67205
+ "^[0-9a-zA-Z_-]{1,255}$": {
67206
+ "type": "string",
67207
+ "minLength": 1,
67208
+ "maxLength": 255
67209
+ }
67210
+ },
67211
+ "additionalProperties": false
67212
+ },
67213
+ "system": {
67214
+ "type": "object",
67215
+ "properties": {
67216
+ "aggregation": {
67217
+ "type": "string",
67218
+ "enum": [
67219
+ "FIRST",
67220
+ "LAST",
67221
+ "COUNT",
67222
+ "MAX",
67223
+ "MIN",
67224
+ "MEDIAN",
67225
+ "MEAN",
67226
+ "SUM",
67227
+ "STD_DEV"
67228
+ ]
67229
+ },
67230
+ "aggregationOptions": {
67231
+ "type": "array",
67232
+ "items": {
67233
+ "type": "object",
67234
+ "additionalProperties": false
67235
+ },
67236
+ "maxItems": 0
67237
+ },
67238
+ "childAttributes": {
67239
+ "type": "array",
67240
+ "items": {
67241
+ "type": "object",
67242
+ "properties": {
67243
+ "name": {
67244
+ "type": "string",
67245
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67246
+ },
67247
+ "mode": {
67248
+ "type": "string",
67249
+ "enum": [
67250
+ "all",
67251
+ "whitelist",
67252
+ "blacklist"
67253
+ ]
67254
+ },
67255
+ "deviceIds": {
67256
+ "type": "array",
67257
+ "items": {
67258
+ "type": "string",
67259
+ "pattern": "^[A-Fa-f\\d]{24}$"
67260
+ },
67261
+ "maxItems": 1000
67262
+ },
67263
+ "deviceTags": {
67264
+ "type": "array",
67265
+ "items": {
67266
+ "type": "object",
67267
+ "properties": {
67268
+ "key": {
67269
+ "type": "string",
67270
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67271
+ },
67272
+ "value": {
67273
+ "type": "string",
67274
+ "minLength": 1,
67275
+ "maxLength": 255
67276
+ }
67277
+ },
67278
+ "additionalProperties": false
67279
+ },
67280
+ "maxItems": 100
67281
+ }
67282
+ },
67283
+ "required": [
67284
+ "name",
67285
+ "mode"
67286
+ ],
67287
+ "additionalProperties": false
67288
+ },
67289
+ "maxItems": 256
67290
+ }
67291
+ },
67292
+ "additionalProperties": false
67293
+ }
67294
+ },
67295
+ "additionalProperties": false
67296
+ }
67297
+ ```
67298
+ ### <a name="device-attribute-patch-example"></a> Example
67299
+
67300
+ ```json
67301
+ {
67302
+ "description": "my new attribute description"
67303
+ }
67304
+ ```
67305
+
67306
+ <br/>
67307
+
67308
+ ## Device Attribute Post
67309
+
67310
+ Schema for the body of a Device Attribute creation request
67311
+
67312
+ ### <a name="device-attribute-post-schema"></a> Schema
67313
+
67314
+ ```json
67315
+ {
67316
+ "$schema": "http://json-schema.org/draft-07/schema#",
67317
+ "type": "object",
67318
+ "properties": {
67319
+ "name": {
67320
+ "type": "string",
67321
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67322
+ },
67323
+ "dataType": {
67324
+ "type": "string",
67325
+ "enum": [
67326
+ "string",
67327
+ "number",
67328
+ "gps",
67329
+ "boolean",
67330
+ "blob"
67331
+ ]
67332
+ },
67333
+ "contentType": {
67334
+ "type": "string",
67335
+ "maxLength": 64
67336
+ },
67337
+ "description": {
67338
+ "type": "string",
67339
+ "maxLength": 32767
67340
+ },
67341
+ "attributeTags": {
67342
+ "type": "object",
67343
+ "patternProperties": {
67344
+ "^[0-9a-zA-Z_-]{1,255}$": {
67345
+ "type": "string",
67346
+ "minLength": 1,
67347
+ "maxLength": 255
67348
+ }
67349
+ },
67350
+ "additionalProperties": false
67351
+ },
67352
+ "system": {
67353
+ "type": "object",
67354
+ "properties": {
67355
+ "aggregation": {
67356
+ "type": "string",
67357
+ "enum": [
67358
+ "FIRST",
67359
+ "LAST",
67360
+ "COUNT",
67361
+ "MAX",
67362
+ "MIN",
67363
+ "MEDIAN",
67364
+ "MEAN",
67365
+ "SUM",
67366
+ "STD_DEV"
67367
+ ]
67368
+ },
67369
+ "aggregationOptions": {
67370
+ "type": "array",
67371
+ "items": {
67372
+ "type": "object",
67373
+ "additionalProperties": false
67374
+ },
67375
+ "maxItems": 0
67376
+ },
67377
+ "childAttributes": {
67378
+ "type": "array",
67379
+ "items": {
67380
+ "type": "object",
67381
+ "properties": {
67382
+ "name": {
67383
+ "type": "string",
67384
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67385
+ },
67386
+ "mode": {
67387
+ "type": "string",
67388
+ "enum": [
67389
+ "all",
67390
+ "whitelist",
67391
+ "blacklist"
67392
+ ]
67393
+ },
67394
+ "deviceIds": {
67395
+ "type": "array",
67396
+ "items": {
67397
+ "type": "string",
67398
+ "pattern": "^[A-Fa-f\\d]{24}$"
67399
+ },
67400
+ "maxItems": 1000
67401
+ },
67402
+ "deviceTags": {
67403
+ "type": "array",
67404
+ "items": {
67405
+ "type": "object",
67406
+ "properties": {
67407
+ "key": {
67408
+ "type": "string",
67409
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67410
+ },
67411
+ "value": {
67412
+ "type": "string",
67413
+ "minLength": 1,
67414
+ "maxLength": 255
67415
+ }
67416
+ },
67417
+ "additionalProperties": false
67418
+ },
67419
+ "maxItems": 100
67420
+ }
67421
+ },
67422
+ "required": [
67423
+ "name",
67424
+ "mode"
67425
+ ],
67426
+ "additionalProperties": false
67427
+ },
67428
+ "maxItems": 256
67429
+ }
67430
+ },
67431
+ "additionalProperties": false
67432
+ }
67433
+ },
67434
+ "required": [
67435
+ "name",
67436
+ "dataType"
67437
+ ],
67438
+ "additionalProperties": false
67439
+ }
67440
+ ```
67441
+ ### <a name="device-attribute-post-example"></a> Example
67442
+
67443
+ ```json
67444
+ {
67445
+ "name": "voltage",
67446
+ "dataType": "number"
67447
+ }
67448
+ ```
67449
+
67450
+ <br/>
67451
+
67452
+ ## Device Attributes
67453
+
67454
+ Schema for a collection of Device Attributes
67455
+
67456
+ ### <a name="device-attributes-schema"></a> Schema
67457
+
67458
+ ```json
67459
+ {
67460
+ "$schema": "http://json-schema.org/draft-07/schema#",
67461
+ "type": "object",
67462
+ "properties": {
67463
+ "items": {
67464
+ "type": "array",
67465
+ "items": {
67466
+ "title": "Device Attribute",
67467
+ "description": "Schema for a single Device Attribute",
67468
+ "type": "object",
67469
+ "properties": {
67470
+ "name": {
67471
+ "type": "string",
67472
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67473
+ },
67474
+ "dataType": {
67475
+ "type": "string",
67476
+ "enum": [
67477
+ "string",
67478
+ "number",
67479
+ "gps",
67480
+ "boolean",
67481
+ "blob"
67482
+ ]
67483
+ },
67484
+ "contentType": {
67485
+ "type": "string",
67486
+ "maxLength": 64
67487
+ },
67488
+ "description": {
67489
+ "type": "string",
67490
+ "maxLength": 32767
67491
+ },
67492
+ "attributeTags": {
67493
+ "type": "object",
67494
+ "patternProperties": {
67495
+ "^[0-9a-zA-Z_-]{1,255}$": {
67496
+ "type": "string",
67497
+ "minLength": 1,
67498
+ "maxLength": 255
67499
+ }
67500
+ },
67501
+ "additionalProperties": false
67502
+ },
67503
+ "system": {
67504
+ "type": "object",
67505
+ "properties": {
67506
+ "aggregation": {
67507
+ "type": "string",
67508
+ "enum": [
67509
+ "FIRST",
67510
+ "LAST",
67511
+ "COUNT",
67512
+ "MAX",
67513
+ "MIN",
67514
+ "MEDIAN",
67515
+ "MEAN",
67516
+ "SUM",
67517
+ "STD_DEV"
67518
+ ]
67519
+ },
67520
+ "aggregationOptions": {
67521
+ "type": "array",
67522
+ "items": {
67523
+ "type": "object",
67524
+ "additionalProperties": false
67525
+ },
67526
+ "maxItems": 0
67527
+ },
67528
+ "childAttributes": {
67529
+ "type": "array",
67530
+ "items": {
67531
+ "type": "object",
67532
+ "properties": {
67533
+ "name": {
67534
+ "type": "string",
67535
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67536
+ },
67537
+ "mode": {
67538
+ "type": "string",
67539
+ "enum": [
67540
+ "all",
67541
+ "whitelist",
67542
+ "blacklist"
67543
+ ]
67544
+ },
67545
+ "deviceIds": {
67546
+ "type": "array",
67547
+ "items": {
67548
+ "type": "string",
67549
+ "pattern": "^[A-Fa-f\\d]{24}$"
67550
+ },
67551
+ "maxItems": 1000
67552
+ },
67553
+ "deviceTags": {
67554
+ "type": "array",
67555
+ "items": {
67556
+ "type": "object",
67557
+ "properties": {
67558
+ "key": {
67559
+ "type": "string",
67560
+ "pattern": "^[0-9a-zA-Z_-]{1,255}$"
67561
+ },
67562
+ "value": {
67563
+ "type": "string",
67564
+ "minLength": 1,
67565
+ "maxLength": 255
67566
+ }
67567
+ },
67568
+ "additionalProperties": false
67569
+ },
67570
+ "maxItems": 100
67571
+ }
67572
+ },
67573
+ "required": [
67574
+ "name",
67575
+ "mode"
67576
+ ],
67577
+ "additionalProperties": false
67578
+ },
67579
+ "maxItems": 256
67580
+ }
67581
+ },
67582
+ "additionalProperties": false
67583
+ },
67584
+ "applicationId": {
67585
+ "type": "string",
67586
+ "pattern": "^[A-Fa-f\\d]{24}$"
67587
+ },
67588
+ "deviceId": {
67589
+ "type": "string",
67590
+ "pattern": "^[A-Fa-f\\d]{24}$"
67591
+ }
67592
+ }
67593
+ }
67594
+ },
67595
+ "count": {
67596
+ "type": "integer"
67597
+ },
67598
+ "totalCount": {
67599
+ "type": "integer"
67600
+ },
67601
+ "filter": {
67602
+ "type": "string"
67603
+ },
67604
+ "filterField": {
67605
+ "type": "string"
67606
+ },
67607
+ "sortField": {
67608
+ "type": "string"
67609
+ },
67610
+ "sortDirection": {
67611
+ "type": "string",
67612
+ "enum": [
67613
+ "asc",
67614
+ "desc",
67615
+ "ASC",
67616
+ "DESC",
67617
+ ""
67618
+ ]
67619
+ },
67620
+ "applicationId": {
67621
+ "type": "string",
67622
+ "pattern": "^[A-Fa-f\\d]{24}$"
67623
+ },
67624
+ "deviceId": {
67625
+ "type": "string",
67626
+ "pattern": "^[A-Fa-f\\d]{24}$"
67627
+ }
67628
+ }
67629
+ }
67630
+ ```
67631
+ ### <a name="device-attributes-example"></a> Example
67632
+
67633
+ ```json
67634
+ {
67635
+ "items": [
67636
+ {
67637
+ "$ref": "#/examples/deviceAttributes"
67638
+ }
67639
+ ],
67640
+ "count": 1,
67641
+ "totalCount": 1,
67642
+ "sortField": "name",
67643
+ "sortDirection": "asc",
67644
+ "applicationId": "575ec8687ae143cd83dc4a97",
67645
+ "deviceId": "575ecf887ae143cd83dc4aa2"
67646
+ }
67647
+ ```
67648
+
67649
+ <br/>
67650
+
66691
67651
  ## Device Class Filter
66692
67652
 
66693
67653
  Select one or multiple device classes
@@ -67404,7 +68364,6 @@ Schema for the body of a Device modification request
67404
68364
  "type": "object",
67405
68365
  "additionalProperties": false
67406
68366
  },
67407
- "additionalProperties": false,
67408
68367
  "maxItems": 0
67409
68368
  },
67410
68369
  "childAttributes": {
@@ -67684,7 +68643,6 @@ Schema for the body of a Device creation request
67684
68643
  "type": "object",
67685
68644
  "additionalProperties": false
67686
68645
  },
67687
- "additionalProperties": false,
67688
68646
  "maxItems": 0
67689
68647
  },
67690
68648
  "childAttributes": {
@@ -67951,7 +68909,6 @@ Schema for a single Device Recipe
67951
68909
  "type": "object",
67952
68910
  "additionalProperties": false
67953
68911
  },
67954
- "additionalProperties": false,
67955
68912
  "maxItems": 0
67956
68913
  },
67957
68914
  "childAttributes": {
@@ -68313,7 +69270,6 @@ Schema for the body of a Device Recipe modification request
68313
69270
  "type": "object",
68314
69271
  "additionalProperties": false
68315
69272
  },
68316
- "additionalProperties": false,
68317
69273
  "maxItems": 0
68318
69274
  },
68319
69275
  "childAttributes": {
@@ -68566,7 +69522,6 @@ Schema for the body of a Device Recipe creation request
68566
69522
  "type": "object",
68567
69523
  "additionalProperties": false
68568
69524
  },
68569
- "additionalProperties": false,
68570
69525
  "maxItems": 0
68571
69526
  },
68572
69527
  "childAttributes": {
@@ -68842,7 +69797,6 @@ Schema for a collection of Device Recipes
68842
69797
  "type": "object",
68843
69798
  "additionalProperties": false
68844
69799
  },
68845
- "additionalProperties": false,
68846
69800
  "maxItems": 0
68847
69801
  },
68848
69802
  "childAttributes": {
@@ -69499,7 +70453,6 @@ Schema for a collection of Devices
69499
70453
  "type": "object",
69500
70454
  "additionalProperties": false
69501
70455
  },
69502
- "additionalProperties": false,
69503
70456
  "maxItems": 0
69504
70457
  },
69505
70458
  "childAttributes": {
@@ -76172,7 +77125,6 @@ Schema for the body of a Devices modification request
76172
77125
  "type": "object",
76173
77126
  "additionalProperties": false
76174
77127
  },
76175
- "additionalProperties": false,
76176
77128
  "maxItems": 0
76177
77129
  },
76178
77130
  "childAttributes": {
@@ -78831,7 +79783,6 @@ Schema for the body of a Devices modification request
78831
79783
  "type": "object",
78832
79784
  "additionalProperties": false
78833
79785
  },
78834
- "additionalProperties": false,
78835
79786
  "maxItems": 0
78836
79787
  },
78837
79788
  "childAttributes": {
@@ -78979,7 +79930,6 @@ Schema for the body of a Devices modification request
78979
79930
  "type": "object",
78980
79931
  "additionalProperties": false
78981
79932
  },
78982
- "additionalProperties": false,
78983
79933
  "maxItems": 0
78984
79934
  },
78985
79935
  "childAttributes": {
@@ -142873,6 +143823,8 @@ Schema for the body of a Github login request
142873
143823
  "deviceRecipe.*",
142874
143824
  "deviceRecipes.*",
142875
143825
  "devices.*",
143826
+ "deviceAttribute.*",
143827
+ "deviceAttributes.*",
142876
143828
  "edgeDeployment.*",
142877
143829
  "edgeDeployments.*",
142878
143830
  "embeddedDeployment.*",
@@ -143019,6 +143971,11 @@ Schema for the body of a Github login request
143019
143971
  "devices.sendCommand",
143020
143972
  "devices.tagKeys",
143021
143973
  "devices.tagValues",
143974
+ "deviceAttribute.get",
143975
+ "deviceAttribute.patch",
143976
+ "deviceAttribute.delete",
143977
+ "deviceAttributes.get",
143978
+ "deviceAttributes.post",
143022
143979
  "edgeDeployment.get",
143023
143980
  "edgeDeployments.get",
143024
143981
  "edgeDeployments.release",
@@ -144864,6 +145821,23 @@ Schema for additional application import options
144864
145821
  ]
144865
145822
  },
144866
145823
  "uniqueItems": true
145824
+ },
145825
+ "credentialName": {
145826
+ "type": "string",
145827
+ "maxLength": 255
145828
+ },
145829
+ "repo": {
145830
+ "type": "object",
145831
+ "properties": {
145832
+ "branch": {
145833
+ "type": "string",
145834
+ "maxLength": 255
145835
+ },
145836
+ "directory": {
145837
+ "type": "string",
145838
+ "maxLength": 1024
145839
+ }
145840
+ }
144867
145841
  }
144868
145842
  },
144869
145843
  "additionalProperties": false
@@ -169355,6 +170329,8 @@ SAML Response body for login
169355
170329
  "deviceRecipe.*",
169356
170330
  "deviceRecipes.*",
169357
170331
  "devices.*",
170332
+ "deviceAttribute.*",
170333
+ "deviceAttributes.*",
169358
170334
  "edgeDeployment.*",
169359
170335
  "edgeDeployments.*",
169360
170336
  "embeddedDeployment.*",
@@ -169501,6 +170477,11 @@ SAML Response body for login
169501
170477
  "devices.sendCommand",
169502
170478
  "devices.tagKeys",
169503
170479
  "devices.tagValues",
170480
+ "deviceAttribute.get",
170481
+ "deviceAttribute.patch",
170482
+ "deviceAttribute.delete",
170483
+ "deviceAttributes.get",
170484
+ "deviceAttributes.post",
169504
170485
  "edgeDeployment.get",
169505
170486
  "edgeDeployments.get",
169506
170487
  "edgeDeployments.release",
@@ -172627,6 +173608,8 @@ Schema for the body of a User authentication request
172627
173608
  "deviceRecipe.*",
172628
173609
  "deviceRecipes.*",
172629
173610
  "devices.*",
173611
+ "deviceAttribute.*",
173612
+ "deviceAttributes.*",
172630
173613
  "edgeDeployment.*",
172631
173614
  "edgeDeployments.*",
172632
173615
  "embeddedDeployment.*",
@@ -172773,6 +173756,11 @@ Schema for the body of a User authentication request
172773
173756
  "devices.sendCommand",
172774
173757
  "devices.tagKeys",
172775
173758
  "devices.tagValues",
173759
+ "deviceAttribute.get",
173760
+ "deviceAttribute.patch",
173761
+ "deviceAttribute.delete",
173762
+ "deviceAttributes.get",
173763
+ "deviceAttributes.post",
172776
173764
  "edgeDeployment.get",
172777
173765
  "edgeDeployments.get",
172778
173766
  "edgeDeployments.release",
@@ -173226,6 +174214,8 @@ Schema for the body of a User creation request
173226
174214
  "deviceRecipe.*",
173227
174215
  "deviceRecipes.*",
173228
174216
  "devices.*",
174217
+ "deviceAttribute.*",
174218
+ "deviceAttributes.*",
173229
174219
  "edgeDeployment.*",
173230
174220
  "edgeDeployments.*",
173231
174221
  "embeddedDeployment.*",
@@ -173372,6 +174362,11 @@ Schema for the body of a User creation request
173372
174362
  "devices.sendCommand",
173373
174363
  "devices.tagKeys",
173374
174364
  "devices.tagValues",
174365
+ "deviceAttribute.get",
174366
+ "deviceAttribute.patch",
174367
+ "deviceAttribute.delete",
174368
+ "deviceAttributes.get",
174369
+ "deviceAttributes.post",
173375
174370
  "edgeDeployment.get",
173376
174371
  "edgeDeployments.get",
173377
174372
  "edgeDeployments.release",