losant_rest 1.21.3 → 1.22.1
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.
- checksums.yaml +4 -4
- data/docs/_schemas.md +1796 -152
- data/docs/deviceAttribute.md +139 -0
- data/docs/deviceAttributes.md +96 -0
- data/lib/platform_rest/client.rb +10 -2
- data/lib/platform_rest/device_attribute.rb +182 -0
- data/lib/platform_rest/device_attributes.rb +138 -0
- data/lib/platform_rest/version.rb +1 -1
- data/lib/platform_rest.rb +2 -0
- data/schemas/apiTokenPost.json +8 -0
- data/schemas/applicationDashboardPost.json +120 -0
- data/schemas/applicationExportPost.json +29 -0
- data/schemas/applicationImportExecutions.json +18 -1
- data/schemas/credential.json +39 -1
- data/schemas/credentialPatch.json +37 -0
- data/schemas/credentialPost.json +54 -1
- data/schemas/credentials.json +39 -1
- data/schemas/dashboard.json +120 -0
- data/schemas/dashboardPatch.json +120 -0
- data/schemas/dashboardPost.json +120 -0
- data/schemas/dashboards.json +120 -0
- data/schemas/dataExport.json +4 -0
- data/schemas/device.json +0 -1
- data/schemas/deviceAttribute.json +128 -0
- data/schemas/deviceAttributePatch.json +111 -0
- data/schemas/deviceAttributePost.json +125 -0
- data/schemas/deviceAttributes.json +171 -0
- data/schemas/devicePatch.json +0 -1
- data/schemas/devicePost.json +0 -1
- data/schemas/deviceRecipe.json +0 -1
- data/schemas/deviceRecipePatch.json +0 -1
- data/schemas/deviceRecipePost.json +0 -1
- data/schemas/deviceRecipes.json +0 -1
- data/schemas/devices.json +0 -1
- data/schemas/devicesPatch.json +65 -3
- data/schemas/githubLogin.json +8 -0
- data/schemas/importIntoApplicationOptions.json +17 -0
- data/schemas/samlResponse.json +8 -0
- data/schemas/suggestFunctionPost.json +15 -0
- data/schemas/suggestFunctionResponse.json +37 -0
- data/schemas/userCredentials.json +8 -0
- data/schemas/userPost.json +8 -0
- metadata +12 -2
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)
|
|
@@ -288,6 +292,8 @@
|
|
|
288
292
|
* [SSO Request](#sso-request)
|
|
289
293
|
* [Success](#success)
|
|
290
294
|
* [Success With Execution ID](#success-with-execution-id)
|
|
295
|
+
* [Suggest Function Post](#suggest-function-post)
|
|
296
|
+
* [Suggest Function Respone](#suggest-function-respone)
|
|
291
297
|
* [Tag Keys Response](#tag-keys-response)
|
|
292
298
|
* [Tag Values Response](#tag-values-response)
|
|
293
299
|
* [Template Keywords](#template-keywords)
|
|
@@ -13183,6 +13189,8 @@ Schema for the body of an API Token creation request
|
|
|
13183
13189
|
"deviceRecipe.*",
|
|
13184
13190
|
"deviceRecipes.*",
|
|
13185
13191
|
"devices.*",
|
|
13192
|
+
"deviceAttribute.*",
|
|
13193
|
+
"deviceAttributes.*",
|
|
13186
13194
|
"edgeDeployment.*",
|
|
13187
13195
|
"edgeDeployments.*",
|
|
13188
13196
|
"embeddedDeployment.*",
|
|
@@ -13329,6 +13337,11 @@ Schema for the body of an API Token creation request
|
|
|
13329
13337
|
"devices.sendCommand",
|
|
13330
13338
|
"devices.tagKeys",
|
|
13331
13339
|
"devices.tagValues",
|
|
13340
|
+
"deviceAttribute.get",
|
|
13341
|
+
"deviceAttribute.patch",
|
|
13342
|
+
"deviceAttribute.delete",
|
|
13343
|
+
"deviceAttributes.get",
|
|
13344
|
+
"deviceAttributes.post",
|
|
13332
13345
|
"edgeDeployment.get",
|
|
13333
13346
|
"edgeDeployments.get",
|
|
13334
13347
|
"edgeDeployments.release",
|
|
@@ -13414,6 +13427,7 @@ Schema for the body of an API Token creation request
|
|
|
13414
13427
|
"flow.setStorageEntry",
|
|
13415
13428
|
"flow.getStorageEntriesMetadata",
|
|
13416
13429
|
"flow.stats",
|
|
13430
|
+
"flow.suggestFunction",
|
|
13417
13431
|
"flows.get",
|
|
13418
13432
|
"flows.getByVersion",
|
|
13419
13433
|
"flows.import",
|
|
@@ -17059,6 +17073,45 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
|
17059
17073
|
}
|
|
17060
17074
|
},
|
|
17061
17075
|
"additionalProperties": false
|
|
17076
|
+
},
|
|
17077
|
+
{
|
|
17078
|
+
"type": "object",
|
|
17079
|
+
"properties": {
|
|
17080
|
+
"queryType": {
|
|
17081
|
+
"type": "string",
|
|
17082
|
+
"enum": [
|
|
17083
|
+
"events"
|
|
17084
|
+
]
|
|
17085
|
+
},
|
|
17086
|
+
"id": {
|
|
17087
|
+
"type": "string",
|
|
17088
|
+
"maxLength": 48
|
|
17089
|
+
},
|
|
17090
|
+
"sortField": {
|
|
17091
|
+
"type": "string",
|
|
17092
|
+
"maxLength": 255
|
|
17093
|
+
},
|
|
17094
|
+
"sortDirection": {
|
|
17095
|
+
"type": "string",
|
|
17096
|
+
"maxLength": 255
|
|
17097
|
+
},
|
|
17098
|
+
"page": {
|
|
17099
|
+
"type": "string",
|
|
17100
|
+
"maxLength": 255
|
|
17101
|
+
},
|
|
17102
|
+
"perPage": {
|
|
17103
|
+
"type": "string",
|
|
17104
|
+
"maxLength": 255
|
|
17105
|
+
},
|
|
17106
|
+
"query": {
|
|
17107
|
+
"type": "string",
|
|
17108
|
+
"maxLength": 32767
|
|
17109
|
+
},
|
|
17110
|
+
"includeExtendedEventInfo": {
|
|
17111
|
+
"type": "boolean"
|
|
17112
|
+
}
|
|
17113
|
+
},
|
|
17114
|
+
"additionalProperties": false
|
|
17062
17115
|
}
|
|
17063
17116
|
]
|
|
17064
17117
|
}
|
|
@@ -18732,6 +18785,18 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
|
18732
18785
|
"format": {
|
|
18733
18786
|
"type": "string",
|
|
18734
18787
|
"maxLength": 255
|
|
18788
|
+
},
|
|
18789
|
+
"scale": {
|
|
18790
|
+
"type": "string",
|
|
18791
|
+
"enum": [
|
|
18792
|
+
"linear",
|
|
18793
|
+
"log",
|
|
18794
|
+
"sqrt"
|
|
18795
|
+
],
|
|
18796
|
+
"default": "linear"
|
|
18797
|
+
},
|
|
18798
|
+
"stacked": {
|
|
18799
|
+
"type": "boolean"
|
|
18735
18800
|
}
|
|
18736
18801
|
},
|
|
18737
18802
|
"additionalProperties": false,
|
|
@@ -18739,6 +18804,75 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
|
18739
18804
|
"id"
|
|
18740
18805
|
]
|
|
18741
18806
|
}
|
|
18807
|
+
},
|
|
18808
|
+
"decorators": {
|
|
18809
|
+
"type": "array",
|
|
18810
|
+
"maxItems": 10,
|
|
18811
|
+
"items": {
|
|
18812
|
+
"type": "object",
|
|
18813
|
+
"properties": {
|
|
18814
|
+
"type": {
|
|
18815
|
+
"type": "string",
|
|
18816
|
+
"enum": [
|
|
18817
|
+
"line",
|
|
18818
|
+
"area"
|
|
18819
|
+
]
|
|
18820
|
+
},
|
|
18821
|
+
"yAxisId": {
|
|
18822
|
+
"type": "string",
|
|
18823
|
+
"maxLength": 48
|
|
18824
|
+
},
|
|
18825
|
+
"label": {
|
|
18826
|
+
"type": "string",
|
|
18827
|
+
"maxLength": 255
|
|
18828
|
+
},
|
|
18829
|
+
"color": {
|
|
18830
|
+
"type": "string",
|
|
18831
|
+
"maxLength": 64
|
|
18832
|
+
},
|
|
18833
|
+
"lineStyle": {
|
|
18834
|
+
"type": "string",
|
|
18835
|
+
"enum": [
|
|
18836
|
+
"solid",
|
|
18837
|
+
"dotted",
|
|
18838
|
+
"dashed"
|
|
18839
|
+
]
|
|
18840
|
+
},
|
|
18841
|
+
"lineWeight": {
|
|
18842
|
+
"type": "integer",
|
|
18843
|
+
"minimum": 0,
|
|
18844
|
+
"maximum": 5
|
|
18845
|
+
},
|
|
18846
|
+
"y1": {
|
|
18847
|
+
"oneOf": [
|
|
18848
|
+
{
|
|
18849
|
+
"type": "number"
|
|
18850
|
+
},
|
|
18851
|
+
{
|
|
18852
|
+
"type": "string",
|
|
18853
|
+
"maxLength": 128
|
|
18854
|
+
}
|
|
18855
|
+
]
|
|
18856
|
+
},
|
|
18857
|
+
"y2": {
|
|
18858
|
+
"oneOf": [
|
|
18859
|
+
{
|
|
18860
|
+
"type": "number"
|
|
18861
|
+
},
|
|
18862
|
+
{
|
|
18863
|
+
"type": "string",
|
|
18864
|
+
"maxLength": 128
|
|
18865
|
+
}
|
|
18866
|
+
]
|
|
18867
|
+
}
|
|
18868
|
+
},
|
|
18869
|
+
"required": [
|
|
18870
|
+
"type",
|
|
18871
|
+
"yAxisId",
|
|
18872
|
+
"y1"
|
|
18873
|
+
],
|
|
18874
|
+
"additionalProperties": false
|
|
18875
|
+
}
|
|
18742
18876
|
}
|
|
18743
18877
|
},
|
|
18744
18878
|
"additionalProperties": false
|
|
@@ -22507,6 +22641,35 @@ Schema for the body of an application export request
|
|
|
22507
22641
|
"forceJob": {
|
|
22508
22642
|
"type": "boolean",
|
|
22509
22643
|
"default": false
|
|
22644
|
+
},
|
|
22645
|
+
"exportType": {
|
|
22646
|
+
"type": "string",
|
|
22647
|
+
"enum": [
|
|
22648
|
+
"zip",
|
|
22649
|
+
"repo"
|
|
22650
|
+
],
|
|
22651
|
+
"default": "zip"
|
|
22652
|
+
},
|
|
22653
|
+
"credentialName": {
|
|
22654
|
+
"type": "string",
|
|
22655
|
+
"maxLength": 255
|
|
22656
|
+
},
|
|
22657
|
+
"repo": {
|
|
22658
|
+
"type": "object",
|
|
22659
|
+
"properties": {
|
|
22660
|
+
"branch": {
|
|
22661
|
+
"type": "string",
|
|
22662
|
+
"maxLength": 255
|
|
22663
|
+
},
|
|
22664
|
+
"directory": {
|
|
22665
|
+
"type": "string",
|
|
22666
|
+
"maxLength": 1024
|
|
22667
|
+
},
|
|
22668
|
+
"commitMessage": {
|
|
22669
|
+
"type": "string",
|
|
22670
|
+
"maxLength": 1024
|
|
22671
|
+
}
|
|
22672
|
+
}
|
|
22510
22673
|
}
|
|
22511
22674
|
},
|
|
22512
22675
|
"additionalProperties": false
|
|
@@ -22635,7 +22798,8 @@ Schema for a list Application import executions
|
|
|
22635
22798
|
"enum": [
|
|
22636
22799
|
"importBundle",
|
|
22637
22800
|
"importUrl",
|
|
22638
|
-
"fromApplication"
|
|
22801
|
+
"fromApplication",
|
|
22802
|
+
"repository"
|
|
22639
22803
|
]
|
|
22640
22804
|
},
|
|
22641
22805
|
"importExecutionId": {
|
|
@@ -22821,6 +22985,22 @@ Schema for a list Application import executions
|
|
|
22821
22985
|
"type": "string",
|
|
22822
22986
|
"format": "uri",
|
|
22823
22987
|
"maxLength": 1024
|
|
22988
|
+
},
|
|
22989
|
+
"credentialName": {
|
|
22990
|
+
"type": "string"
|
|
22991
|
+
},
|
|
22992
|
+
"repo": {
|
|
22993
|
+
"type": "object",
|
|
22994
|
+
"properties": {
|
|
22995
|
+
"branch": {
|
|
22996
|
+
"type": "string",
|
|
22997
|
+
"maxLength": 255
|
|
22998
|
+
},
|
|
22999
|
+
"directory": {
|
|
23000
|
+
"type": "string",
|
|
23001
|
+
"maxLength": 1024
|
|
23002
|
+
}
|
|
23003
|
+
}
|
|
22824
23004
|
}
|
|
22825
23005
|
}
|
|
22826
23006
|
}
|
|
@@ -26474,7 +26654,8 @@ Schema for a single Credential
|
|
|
26474
26654
|
"sql",
|
|
26475
26655
|
"mongodb",
|
|
26476
26656
|
"mailgun",
|
|
26477
|
-
"snowflake"
|
|
26657
|
+
"snowflake",
|
|
26658
|
+
"git"
|
|
26478
26659
|
]
|
|
26479
26660
|
},
|
|
26480
26661
|
"awsConfig": {
|
|
@@ -26700,6 +26881,43 @@ Schema for a single Credential
|
|
|
26700
26881
|
"publicKey"
|
|
26701
26882
|
],
|
|
26702
26883
|
"additionalProperties": false
|
|
26884
|
+
},
|
|
26885
|
+
"gitConfig": {
|
|
26886
|
+
"type": "object",
|
|
26887
|
+
"properties": {
|
|
26888
|
+
"type": {
|
|
26889
|
+
"type": "string",
|
|
26890
|
+
"enum": [
|
|
26891
|
+
"ssh-key",
|
|
26892
|
+
"http-password"
|
|
26893
|
+
]
|
|
26894
|
+
},
|
|
26895
|
+
"cloneUrl": {
|
|
26896
|
+
"type": "string",
|
|
26897
|
+
"minLength": 5,
|
|
26898
|
+
"maxLength": 1024
|
|
26899
|
+
},
|
|
26900
|
+
"publicKey": {
|
|
26901
|
+
"type": "string",
|
|
26902
|
+
"maxLength": 8192
|
|
26903
|
+
},
|
|
26904
|
+
"username": {
|
|
26905
|
+
"type": "string",
|
|
26906
|
+
"maxLength": 128
|
|
26907
|
+
},
|
|
26908
|
+
"committerName": {
|
|
26909
|
+
"type": "string",
|
|
26910
|
+
"maxLength": 128
|
|
26911
|
+
},
|
|
26912
|
+
"committerEmail": {
|
|
26913
|
+
"type": "string",
|
|
26914
|
+
"maxLength": 128
|
|
26915
|
+
}
|
|
26916
|
+
},
|
|
26917
|
+
"required": [
|
|
26918
|
+
"type",
|
|
26919
|
+
"cloneUrl"
|
|
26920
|
+
]
|
|
26703
26921
|
}
|
|
26704
26922
|
},
|
|
26705
26923
|
"additionalProperties": false,
|
|
@@ -36508,6 +36726,43 @@ Schema for a Credential update request
|
|
|
36508
36726
|
}
|
|
36509
36727
|
},
|
|
36510
36728
|
"additionalProperties": false
|
|
36729
|
+
},
|
|
36730
|
+
"gitConfig": {
|
|
36731
|
+
"type": "object",
|
|
36732
|
+
"properties": {
|
|
36733
|
+
"type": {
|
|
36734
|
+
"type": "string",
|
|
36735
|
+
"enum": [
|
|
36736
|
+
"ssh-key",
|
|
36737
|
+
"http-password"
|
|
36738
|
+
]
|
|
36739
|
+
},
|
|
36740
|
+
"cloneUrl": {
|
|
36741
|
+
"type": "string",
|
|
36742
|
+
"minLength": 5,
|
|
36743
|
+
"maxLength": 1024
|
|
36744
|
+
},
|
|
36745
|
+
"username": {
|
|
36746
|
+
"type": "string",
|
|
36747
|
+
"maxLength": 128
|
|
36748
|
+
},
|
|
36749
|
+
"committerName": {
|
|
36750
|
+
"type": "string",
|
|
36751
|
+
"maxLength": 128
|
|
36752
|
+
},
|
|
36753
|
+
"committerEmail": {
|
|
36754
|
+
"type": "string",
|
|
36755
|
+
"maxLength": 128
|
|
36756
|
+
},
|
|
36757
|
+
"generatePrivateKey": {
|
|
36758
|
+
"type": "boolean"
|
|
36759
|
+
},
|
|
36760
|
+
"secretValue": {
|
|
36761
|
+
"type": "string",
|
|
36762
|
+
"maxLength": 8196
|
|
36763
|
+
}
|
|
36764
|
+
},
|
|
36765
|
+
"additionalProperties": false
|
|
36511
36766
|
}
|
|
36512
36767
|
},
|
|
36513
36768
|
"additionalProperties": false
|
|
@@ -36565,7 +36820,8 @@ Schema for a Credential creation request
|
|
|
36565
36820
|
"sql",
|
|
36566
36821
|
"mongodb",
|
|
36567
36822
|
"mailgun",
|
|
36568
|
-
"snowflake"
|
|
36823
|
+
"snowflake",
|
|
36824
|
+
"git"
|
|
36569
36825
|
]
|
|
36570
36826
|
},
|
|
36571
36827
|
"awsConfig": {
|
|
@@ -36889,6 +37145,58 @@ Schema for a Credential creation request
|
|
|
36889
37145
|
]
|
|
36890
37146
|
}
|
|
36891
37147
|
]
|
|
37148
|
+
},
|
|
37149
|
+
"gitConfig": {
|
|
37150
|
+
"type": "object",
|
|
37151
|
+
"properties": {
|
|
37152
|
+
"type": {
|
|
37153
|
+
"type": "string",
|
|
37154
|
+
"enum": [
|
|
37155
|
+
"ssh-key",
|
|
37156
|
+
"http-password"
|
|
37157
|
+
]
|
|
37158
|
+
},
|
|
37159
|
+
"cloneUrl": {
|
|
37160
|
+
"type": "string",
|
|
37161
|
+
"minLength": 5,
|
|
37162
|
+
"maxLength": 1024
|
|
37163
|
+
},
|
|
37164
|
+
"username": {
|
|
37165
|
+
"type": "string",
|
|
37166
|
+
"maxLength": 128
|
|
37167
|
+
},
|
|
37168
|
+
"committerName": {
|
|
37169
|
+
"type": "string",
|
|
37170
|
+
"maxLength": 128
|
|
37171
|
+
},
|
|
37172
|
+
"committerEmail": {
|
|
37173
|
+
"type": "string",
|
|
37174
|
+
"maxLength": 128
|
|
37175
|
+
},
|
|
37176
|
+
"generatePrivateKey": {
|
|
37177
|
+
"type": "boolean"
|
|
37178
|
+
},
|
|
37179
|
+
"secretValue": {
|
|
37180
|
+
"type": "string",
|
|
37181
|
+
"maxLength": 8196
|
|
37182
|
+
}
|
|
37183
|
+
},
|
|
37184
|
+
"additionalProperties": false,
|
|
37185
|
+
"anyOf": [
|
|
37186
|
+
{
|
|
37187
|
+
"required": [
|
|
37188
|
+
"type",
|
|
37189
|
+
"cloneUrl",
|
|
37190
|
+
"generatePrivateKey"
|
|
37191
|
+
]
|
|
37192
|
+
},
|
|
37193
|
+
{
|
|
37194
|
+
"required": [
|
|
37195
|
+
"type",
|
|
37196
|
+
"cloneUrl"
|
|
37197
|
+
]
|
|
37198
|
+
}
|
|
37199
|
+
]
|
|
36892
37200
|
}
|
|
36893
37201
|
},
|
|
36894
37202
|
"additionalProperties": false,
|
|
@@ -36999,7 +37307,8 @@ Schema for a collection of Credentials
|
|
|
36999
37307
|
"sql",
|
|
37000
37308
|
"mongodb",
|
|
37001
37309
|
"mailgun",
|
|
37002
|
-
"snowflake"
|
|
37310
|
+
"snowflake",
|
|
37311
|
+
"git"
|
|
37003
37312
|
]
|
|
37004
37313
|
},
|
|
37005
37314
|
"awsConfig": {
|
|
@@ -37225,6 +37534,43 @@ Schema for a collection of Credentials
|
|
|
37225
37534
|
"publicKey"
|
|
37226
37535
|
],
|
|
37227
37536
|
"additionalProperties": false
|
|
37537
|
+
},
|
|
37538
|
+
"gitConfig": {
|
|
37539
|
+
"type": "object",
|
|
37540
|
+
"properties": {
|
|
37541
|
+
"type": {
|
|
37542
|
+
"type": "string",
|
|
37543
|
+
"enum": [
|
|
37544
|
+
"ssh-key",
|
|
37545
|
+
"http-password"
|
|
37546
|
+
]
|
|
37547
|
+
},
|
|
37548
|
+
"cloneUrl": {
|
|
37549
|
+
"type": "string",
|
|
37550
|
+
"minLength": 5,
|
|
37551
|
+
"maxLength": 1024
|
|
37552
|
+
},
|
|
37553
|
+
"publicKey": {
|
|
37554
|
+
"type": "string",
|
|
37555
|
+
"maxLength": 8192
|
|
37556
|
+
},
|
|
37557
|
+
"username": {
|
|
37558
|
+
"type": "string",
|
|
37559
|
+
"maxLength": 128
|
|
37560
|
+
},
|
|
37561
|
+
"committerName": {
|
|
37562
|
+
"type": "string",
|
|
37563
|
+
"maxLength": 128
|
|
37564
|
+
},
|
|
37565
|
+
"committerEmail": {
|
|
37566
|
+
"type": "string",
|
|
37567
|
+
"maxLength": 128
|
|
37568
|
+
}
|
|
37569
|
+
},
|
|
37570
|
+
"required": [
|
|
37571
|
+
"type",
|
|
37572
|
+
"cloneUrl"
|
|
37573
|
+
]
|
|
37228
37574
|
}
|
|
37229
37575
|
},
|
|
37230
37576
|
"additionalProperties": false,
|
|
@@ -38400,6 +38746,45 @@ Schema for a single Dashboard
|
|
|
38400
38746
|
}
|
|
38401
38747
|
},
|
|
38402
38748
|
"additionalProperties": false
|
|
38749
|
+
},
|
|
38750
|
+
{
|
|
38751
|
+
"type": "object",
|
|
38752
|
+
"properties": {
|
|
38753
|
+
"queryType": {
|
|
38754
|
+
"type": "string",
|
|
38755
|
+
"enum": [
|
|
38756
|
+
"events"
|
|
38757
|
+
]
|
|
38758
|
+
},
|
|
38759
|
+
"id": {
|
|
38760
|
+
"type": "string",
|
|
38761
|
+
"maxLength": 48
|
|
38762
|
+
},
|
|
38763
|
+
"sortField": {
|
|
38764
|
+
"type": "string",
|
|
38765
|
+
"maxLength": 255
|
|
38766
|
+
},
|
|
38767
|
+
"sortDirection": {
|
|
38768
|
+
"type": "string",
|
|
38769
|
+
"maxLength": 255
|
|
38770
|
+
},
|
|
38771
|
+
"page": {
|
|
38772
|
+
"type": "string",
|
|
38773
|
+
"maxLength": 255
|
|
38774
|
+
},
|
|
38775
|
+
"perPage": {
|
|
38776
|
+
"type": "string",
|
|
38777
|
+
"maxLength": 255
|
|
38778
|
+
},
|
|
38779
|
+
"query": {
|
|
38780
|
+
"type": "string",
|
|
38781
|
+
"maxLength": 32767
|
|
38782
|
+
},
|
|
38783
|
+
"includeExtendedEventInfo": {
|
|
38784
|
+
"type": "boolean"
|
|
38785
|
+
}
|
|
38786
|
+
},
|
|
38787
|
+
"additionalProperties": false
|
|
38403
38788
|
}
|
|
38404
38789
|
]
|
|
38405
38790
|
}
|
|
@@ -40073,6 +40458,18 @@ Schema for a single Dashboard
|
|
|
40073
40458
|
"format": {
|
|
40074
40459
|
"type": "string",
|
|
40075
40460
|
"maxLength": 255
|
|
40461
|
+
},
|
|
40462
|
+
"scale": {
|
|
40463
|
+
"type": "string",
|
|
40464
|
+
"enum": [
|
|
40465
|
+
"linear",
|
|
40466
|
+
"log",
|
|
40467
|
+
"sqrt"
|
|
40468
|
+
],
|
|
40469
|
+
"default": "linear"
|
|
40470
|
+
},
|
|
40471
|
+
"stacked": {
|
|
40472
|
+
"type": "boolean"
|
|
40076
40473
|
}
|
|
40077
40474
|
},
|
|
40078
40475
|
"additionalProperties": false,
|
|
@@ -40080,6 +40477,75 @@ Schema for a single Dashboard
|
|
|
40080
40477
|
"id"
|
|
40081
40478
|
]
|
|
40082
40479
|
}
|
|
40480
|
+
},
|
|
40481
|
+
"decorators": {
|
|
40482
|
+
"type": "array",
|
|
40483
|
+
"maxItems": 10,
|
|
40484
|
+
"items": {
|
|
40485
|
+
"type": "object",
|
|
40486
|
+
"properties": {
|
|
40487
|
+
"type": {
|
|
40488
|
+
"type": "string",
|
|
40489
|
+
"enum": [
|
|
40490
|
+
"line",
|
|
40491
|
+
"area"
|
|
40492
|
+
]
|
|
40493
|
+
},
|
|
40494
|
+
"yAxisId": {
|
|
40495
|
+
"type": "string",
|
|
40496
|
+
"maxLength": 48
|
|
40497
|
+
},
|
|
40498
|
+
"label": {
|
|
40499
|
+
"type": "string",
|
|
40500
|
+
"maxLength": 255
|
|
40501
|
+
},
|
|
40502
|
+
"color": {
|
|
40503
|
+
"type": "string",
|
|
40504
|
+
"maxLength": 64
|
|
40505
|
+
},
|
|
40506
|
+
"lineStyle": {
|
|
40507
|
+
"type": "string",
|
|
40508
|
+
"enum": [
|
|
40509
|
+
"solid",
|
|
40510
|
+
"dotted",
|
|
40511
|
+
"dashed"
|
|
40512
|
+
]
|
|
40513
|
+
},
|
|
40514
|
+
"lineWeight": {
|
|
40515
|
+
"type": "integer",
|
|
40516
|
+
"minimum": 0,
|
|
40517
|
+
"maximum": 5
|
|
40518
|
+
},
|
|
40519
|
+
"y1": {
|
|
40520
|
+
"oneOf": [
|
|
40521
|
+
{
|
|
40522
|
+
"type": "number"
|
|
40523
|
+
},
|
|
40524
|
+
{
|
|
40525
|
+
"type": "string",
|
|
40526
|
+
"maxLength": 128
|
|
40527
|
+
}
|
|
40528
|
+
]
|
|
40529
|
+
},
|
|
40530
|
+
"y2": {
|
|
40531
|
+
"oneOf": [
|
|
40532
|
+
{
|
|
40533
|
+
"type": "number"
|
|
40534
|
+
},
|
|
40535
|
+
{
|
|
40536
|
+
"type": "string",
|
|
40537
|
+
"maxLength": 128
|
|
40538
|
+
}
|
|
40539
|
+
]
|
|
40540
|
+
}
|
|
40541
|
+
},
|
|
40542
|
+
"required": [
|
|
40543
|
+
"type",
|
|
40544
|
+
"yAxisId",
|
|
40545
|
+
"y1"
|
|
40546
|
+
],
|
|
40547
|
+
"additionalProperties": false
|
|
40548
|
+
}
|
|
40083
40549
|
}
|
|
40084
40550
|
},
|
|
40085
40551
|
"additionalProperties": false
|
|
@@ -44717,6 +45183,45 @@ Schema for the body of a Dashboard modification request
|
|
|
44717
45183
|
}
|
|
44718
45184
|
},
|
|
44719
45185
|
"additionalProperties": false
|
|
45186
|
+
},
|
|
45187
|
+
{
|
|
45188
|
+
"type": "object",
|
|
45189
|
+
"properties": {
|
|
45190
|
+
"queryType": {
|
|
45191
|
+
"type": "string",
|
|
45192
|
+
"enum": [
|
|
45193
|
+
"events"
|
|
45194
|
+
]
|
|
45195
|
+
},
|
|
45196
|
+
"id": {
|
|
45197
|
+
"type": "string",
|
|
45198
|
+
"maxLength": 48
|
|
45199
|
+
},
|
|
45200
|
+
"sortField": {
|
|
45201
|
+
"type": "string",
|
|
45202
|
+
"maxLength": 255
|
|
45203
|
+
},
|
|
45204
|
+
"sortDirection": {
|
|
45205
|
+
"type": "string",
|
|
45206
|
+
"maxLength": 255
|
|
45207
|
+
},
|
|
45208
|
+
"page": {
|
|
45209
|
+
"type": "string",
|
|
45210
|
+
"maxLength": 255
|
|
45211
|
+
},
|
|
45212
|
+
"perPage": {
|
|
45213
|
+
"type": "string",
|
|
45214
|
+
"maxLength": 255
|
|
45215
|
+
},
|
|
45216
|
+
"query": {
|
|
45217
|
+
"type": "string",
|
|
45218
|
+
"maxLength": 32767
|
|
45219
|
+
},
|
|
45220
|
+
"includeExtendedEventInfo": {
|
|
45221
|
+
"type": "boolean"
|
|
45222
|
+
}
|
|
45223
|
+
},
|
|
45224
|
+
"additionalProperties": false
|
|
44720
45225
|
}
|
|
44721
45226
|
]
|
|
44722
45227
|
}
|
|
@@ -46390,6 +46895,18 @@ Schema for the body of a Dashboard modification request
|
|
|
46390
46895
|
"format": {
|
|
46391
46896
|
"type": "string",
|
|
46392
46897
|
"maxLength": 255
|
|
46898
|
+
},
|
|
46899
|
+
"scale": {
|
|
46900
|
+
"type": "string",
|
|
46901
|
+
"enum": [
|
|
46902
|
+
"linear",
|
|
46903
|
+
"log",
|
|
46904
|
+
"sqrt"
|
|
46905
|
+
],
|
|
46906
|
+
"default": "linear"
|
|
46907
|
+
},
|
|
46908
|
+
"stacked": {
|
|
46909
|
+
"type": "boolean"
|
|
46393
46910
|
}
|
|
46394
46911
|
},
|
|
46395
46912
|
"additionalProperties": false,
|
|
@@ -46397,6 +46914,75 @@ Schema for the body of a Dashboard modification request
|
|
|
46397
46914
|
"id"
|
|
46398
46915
|
]
|
|
46399
46916
|
}
|
|
46917
|
+
},
|
|
46918
|
+
"decorators": {
|
|
46919
|
+
"type": "array",
|
|
46920
|
+
"maxItems": 10,
|
|
46921
|
+
"items": {
|
|
46922
|
+
"type": "object",
|
|
46923
|
+
"properties": {
|
|
46924
|
+
"type": {
|
|
46925
|
+
"type": "string",
|
|
46926
|
+
"enum": [
|
|
46927
|
+
"line",
|
|
46928
|
+
"area"
|
|
46929
|
+
]
|
|
46930
|
+
},
|
|
46931
|
+
"yAxisId": {
|
|
46932
|
+
"type": "string",
|
|
46933
|
+
"maxLength": 48
|
|
46934
|
+
},
|
|
46935
|
+
"label": {
|
|
46936
|
+
"type": "string",
|
|
46937
|
+
"maxLength": 255
|
|
46938
|
+
},
|
|
46939
|
+
"color": {
|
|
46940
|
+
"type": "string",
|
|
46941
|
+
"maxLength": 64
|
|
46942
|
+
},
|
|
46943
|
+
"lineStyle": {
|
|
46944
|
+
"type": "string",
|
|
46945
|
+
"enum": [
|
|
46946
|
+
"solid",
|
|
46947
|
+
"dotted",
|
|
46948
|
+
"dashed"
|
|
46949
|
+
]
|
|
46950
|
+
},
|
|
46951
|
+
"lineWeight": {
|
|
46952
|
+
"type": "integer",
|
|
46953
|
+
"minimum": 0,
|
|
46954
|
+
"maximum": 5
|
|
46955
|
+
},
|
|
46956
|
+
"y1": {
|
|
46957
|
+
"oneOf": [
|
|
46958
|
+
{
|
|
46959
|
+
"type": "number"
|
|
46960
|
+
},
|
|
46961
|
+
{
|
|
46962
|
+
"type": "string",
|
|
46963
|
+
"maxLength": 128
|
|
46964
|
+
}
|
|
46965
|
+
]
|
|
46966
|
+
},
|
|
46967
|
+
"y2": {
|
|
46968
|
+
"oneOf": [
|
|
46969
|
+
{
|
|
46970
|
+
"type": "number"
|
|
46971
|
+
},
|
|
46972
|
+
{
|
|
46973
|
+
"type": "string",
|
|
46974
|
+
"maxLength": 128
|
|
46975
|
+
}
|
|
46976
|
+
]
|
|
46977
|
+
}
|
|
46978
|
+
},
|
|
46979
|
+
"required": [
|
|
46980
|
+
"type",
|
|
46981
|
+
"yAxisId",
|
|
46982
|
+
"y1"
|
|
46983
|
+
],
|
|
46984
|
+
"additionalProperties": false
|
|
46985
|
+
}
|
|
46400
46986
|
}
|
|
46401
46987
|
},
|
|
46402
46988
|
"additionalProperties": false
|
|
@@ -51032,6 +51618,45 @@ Schema for the body of a Dashboard creation request
|
|
|
51032
51618
|
}
|
|
51033
51619
|
},
|
|
51034
51620
|
"additionalProperties": false
|
|
51621
|
+
},
|
|
51622
|
+
{
|
|
51623
|
+
"type": "object",
|
|
51624
|
+
"properties": {
|
|
51625
|
+
"queryType": {
|
|
51626
|
+
"type": "string",
|
|
51627
|
+
"enum": [
|
|
51628
|
+
"events"
|
|
51629
|
+
]
|
|
51630
|
+
},
|
|
51631
|
+
"id": {
|
|
51632
|
+
"type": "string",
|
|
51633
|
+
"maxLength": 48
|
|
51634
|
+
},
|
|
51635
|
+
"sortField": {
|
|
51636
|
+
"type": "string",
|
|
51637
|
+
"maxLength": 255
|
|
51638
|
+
},
|
|
51639
|
+
"sortDirection": {
|
|
51640
|
+
"type": "string",
|
|
51641
|
+
"maxLength": 255
|
|
51642
|
+
},
|
|
51643
|
+
"page": {
|
|
51644
|
+
"type": "string",
|
|
51645
|
+
"maxLength": 255
|
|
51646
|
+
},
|
|
51647
|
+
"perPage": {
|
|
51648
|
+
"type": "string",
|
|
51649
|
+
"maxLength": 255
|
|
51650
|
+
},
|
|
51651
|
+
"query": {
|
|
51652
|
+
"type": "string",
|
|
51653
|
+
"maxLength": 32767
|
|
51654
|
+
},
|
|
51655
|
+
"includeExtendedEventInfo": {
|
|
51656
|
+
"type": "boolean"
|
|
51657
|
+
}
|
|
51658
|
+
},
|
|
51659
|
+
"additionalProperties": false
|
|
51035
51660
|
}
|
|
51036
51661
|
]
|
|
51037
51662
|
}
|
|
@@ -52705,6 +53330,18 @@ Schema for the body of a Dashboard creation request
|
|
|
52705
53330
|
"format": {
|
|
52706
53331
|
"type": "string",
|
|
52707
53332
|
"maxLength": 255
|
|
53333
|
+
},
|
|
53334
|
+
"scale": {
|
|
53335
|
+
"type": "string",
|
|
53336
|
+
"enum": [
|
|
53337
|
+
"linear",
|
|
53338
|
+
"log",
|
|
53339
|
+
"sqrt"
|
|
53340
|
+
],
|
|
53341
|
+
"default": "linear"
|
|
53342
|
+
},
|
|
53343
|
+
"stacked": {
|
|
53344
|
+
"type": "boolean"
|
|
52708
53345
|
}
|
|
52709
53346
|
},
|
|
52710
53347
|
"additionalProperties": false,
|
|
@@ -52712,6 +53349,75 @@ Schema for the body of a Dashboard creation request
|
|
|
52712
53349
|
"id"
|
|
52713
53350
|
]
|
|
52714
53351
|
}
|
|
53352
|
+
},
|
|
53353
|
+
"decorators": {
|
|
53354
|
+
"type": "array",
|
|
53355
|
+
"maxItems": 10,
|
|
53356
|
+
"items": {
|
|
53357
|
+
"type": "object",
|
|
53358
|
+
"properties": {
|
|
53359
|
+
"type": {
|
|
53360
|
+
"type": "string",
|
|
53361
|
+
"enum": [
|
|
53362
|
+
"line",
|
|
53363
|
+
"area"
|
|
53364
|
+
]
|
|
53365
|
+
},
|
|
53366
|
+
"yAxisId": {
|
|
53367
|
+
"type": "string",
|
|
53368
|
+
"maxLength": 48
|
|
53369
|
+
},
|
|
53370
|
+
"label": {
|
|
53371
|
+
"type": "string",
|
|
53372
|
+
"maxLength": 255
|
|
53373
|
+
},
|
|
53374
|
+
"color": {
|
|
53375
|
+
"type": "string",
|
|
53376
|
+
"maxLength": 64
|
|
53377
|
+
},
|
|
53378
|
+
"lineStyle": {
|
|
53379
|
+
"type": "string",
|
|
53380
|
+
"enum": [
|
|
53381
|
+
"solid",
|
|
53382
|
+
"dotted",
|
|
53383
|
+
"dashed"
|
|
53384
|
+
]
|
|
53385
|
+
},
|
|
53386
|
+
"lineWeight": {
|
|
53387
|
+
"type": "integer",
|
|
53388
|
+
"minimum": 0,
|
|
53389
|
+
"maximum": 5
|
|
53390
|
+
},
|
|
53391
|
+
"y1": {
|
|
53392
|
+
"oneOf": [
|
|
53393
|
+
{
|
|
53394
|
+
"type": "number"
|
|
53395
|
+
},
|
|
53396
|
+
{
|
|
53397
|
+
"type": "string",
|
|
53398
|
+
"maxLength": 128
|
|
53399
|
+
}
|
|
53400
|
+
]
|
|
53401
|
+
},
|
|
53402
|
+
"y2": {
|
|
53403
|
+
"oneOf": [
|
|
53404
|
+
{
|
|
53405
|
+
"type": "number"
|
|
53406
|
+
},
|
|
53407
|
+
{
|
|
53408
|
+
"type": "string",
|
|
53409
|
+
"maxLength": 128
|
|
53410
|
+
}
|
|
53411
|
+
]
|
|
53412
|
+
}
|
|
53413
|
+
},
|
|
53414
|
+
"required": [
|
|
53415
|
+
"type",
|
|
53416
|
+
"yAxisId",
|
|
53417
|
+
"y1"
|
|
53418
|
+
],
|
|
53419
|
+
"additionalProperties": false
|
|
53420
|
+
}
|
|
52715
53421
|
}
|
|
52716
53422
|
},
|
|
52717
53423
|
"additionalProperties": false
|
|
@@ -57746,6 +58452,45 @@ Schema for a collection of Dashboards
|
|
|
57746
58452
|
}
|
|
57747
58453
|
},
|
|
57748
58454
|
"additionalProperties": false
|
|
58455
|
+
},
|
|
58456
|
+
{
|
|
58457
|
+
"type": "object",
|
|
58458
|
+
"properties": {
|
|
58459
|
+
"queryType": {
|
|
58460
|
+
"type": "string",
|
|
58461
|
+
"enum": [
|
|
58462
|
+
"events"
|
|
58463
|
+
]
|
|
58464
|
+
},
|
|
58465
|
+
"id": {
|
|
58466
|
+
"type": "string",
|
|
58467
|
+
"maxLength": 48
|
|
58468
|
+
},
|
|
58469
|
+
"sortField": {
|
|
58470
|
+
"type": "string",
|
|
58471
|
+
"maxLength": 255
|
|
58472
|
+
},
|
|
58473
|
+
"sortDirection": {
|
|
58474
|
+
"type": "string",
|
|
58475
|
+
"maxLength": 255
|
|
58476
|
+
},
|
|
58477
|
+
"page": {
|
|
58478
|
+
"type": "string",
|
|
58479
|
+
"maxLength": 255
|
|
58480
|
+
},
|
|
58481
|
+
"perPage": {
|
|
58482
|
+
"type": "string",
|
|
58483
|
+
"maxLength": 255
|
|
58484
|
+
},
|
|
58485
|
+
"query": {
|
|
58486
|
+
"type": "string",
|
|
58487
|
+
"maxLength": 32767
|
|
58488
|
+
},
|
|
58489
|
+
"includeExtendedEventInfo": {
|
|
58490
|
+
"type": "boolean"
|
|
58491
|
+
}
|
|
58492
|
+
},
|
|
58493
|
+
"additionalProperties": false
|
|
57749
58494
|
}
|
|
57750
58495
|
]
|
|
57751
58496
|
}
|
|
@@ -59419,6 +60164,18 @@ Schema for a collection of Dashboards
|
|
|
59419
60164
|
"format": {
|
|
59420
60165
|
"type": "string",
|
|
59421
60166
|
"maxLength": 255
|
|
60167
|
+
},
|
|
60168
|
+
"scale": {
|
|
60169
|
+
"type": "string",
|
|
60170
|
+
"enum": [
|
|
60171
|
+
"linear",
|
|
60172
|
+
"log",
|
|
60173
|
+
"sqrt"
|
|
60174
|
+
],
|
|
60175
|
+
"default": "linear"
|
|
60176
|
+
},
|
|
60177
|
+
"stacked": {
|
|
60178
|
+
"type": "boolean"
|
|
59422
60179
|
}
|
|
59423
60180
|
},
|
|
59424
60181
|
"additionalProperties": false,
|
|
@@ -59426,6 +60183,75 @@ Schema for a collection of Dashboards
|
|
|
59426
60183
|
"id"
|
|
59427
60184
|
]
|
|
59428
60185
|
}
|
|
60186
|
+
},
|
|
60187
|
+
"decorators": {
|
|
60188
|
+
"type": "array",
|
|
60189
|
+
"maxItems": 10,
|
|
60190
|
+
"items": {
|
|
60191
|
+
"type": "object",
|
|
60192
|
+
"properties": {
|
|
60193
|
+
"type": {
|
|
60194
|
+
"type": "string",
|
|
60195
|
+
"enum": [
|
|
60196
|
+
"line",
|
|
60197
|
+
"area"
|
|
60198
|
+
]
|
|
60199
|
+
},
|
|
60200
|
+
"yAxisId": {
|
|
60201
|
+
"type": "string",
|
|
60202
|
+
"maxLength": 48
|
|
60203
|
+
},
|
|
60204
|
+
"label": {
|
|
60205
|
+
"type": "string",
|
|
60206
|
+
"maxLength": 255
|
|
60207
|
+
},
|
|
60208
|
+
"color": {
|
|
60209
|
+
"type": "string",
|
|
60210
|
+
"maxLength": 64
|
|
60211
|
+
},
|
|
60212
|
+
"lineStyle": {
|
|
60213
|
+
"type": "string",
|
|
60214
|
+
"enum": [
|
|
60215
|
+
"solid",
|
|
60216
|
+
"dotted",
|
|
60217
|
+
"dashed"
|
|
60218
|
+
]
|
|
60219
|
+
},
|
|
60220
|
+
"lineWeight": {
|
|
60221
|
+
"type": "integer",
|
|
60222
|
+
"minimum": 0,
|
|
60223
|
+
"maximum": 5
|
|
60224
|
+
},
|
|
60225
|
+
"y1": {
|
|
60226
|
+
"oneOf": [
|
|
60227
|
+
{
|
|
60228
|
+
"type": "number"
|
|
60229
|
+
},
|
|
60230
|
+
{
|
|
60231
|
+
"type": "string",
|
|
60232
|
+
"maxLength": 128
|
|
60233
|
+
}
|
|
60234
|
+
]
|
|
60235
|
+
},
|
|
60236
|
+
"y2": {
|
|
60237
|
+
"oneOf": [
|
|
60238
|
+
{
|
|
60239
|
+
"type": "number"
|
|
60240
|
+
},
|
|
60241
|
+
{
|
|
60242
|
+
"type": "string",
|
|
60243
|
+
"maxLength": 128
|
|
60244
|
+
}
|
|
60245
|
+
]
|
|
60246
|
+
}
|
|
60247
|
+
},
|
|
60248
|
+
"required": [
|
|
60249
|
+
"type",
|
|
60250
|
+
"yAxisId",
|
|
60251
|
+
"y1"
|
|
60252
|
+
],
|
|
60253
|
+
"additionalProperties": false
|
|
60254
|
+
}
|
|
59429
60255
|
}
|
|
59430
60256
|
},
|
|
59431
60257
|
"additionalProperties": false
|
|
@@ -65287,6 +66113,10 @@ Schema for exporting data devices query
|
|
|
65287
66113
|
"includeBlobData": {
|
|
65288
66114
|
"type": "boolean",
|
|
65289
66115
|
"default": false
|
|
66116
|
+
},
|
|
66117
|
+
"filePerDevice": {
|
|
66118
|
+
"type": "boolean",
|
|
66119
|
+
"default": false
|
|
65290
66120
|
}
|
|
65291
66121
|
}
|
|
65292
66122
|
}
|
|
@@ -66585,7 +67415,6 @@ Schema for a single Device
|
|
|
66585
67415
|
"type": "object",
|
|
66586
67416
|
"additionalProperties": false
|
|
66587
67417
|
},
|
|
66588
|
-
"additionalProperties": false,
|
|
66589
67418
|
"maxItems": 0
|
|
66590
67419
|
},
|
|
66591
67420
|
"childAttributes": {
|
|
@@ -66644,164 +67473,785 @@ Schema for a single Device
|
|
|
66644
67473
|
},
|
|
66645
67474
|
"additionalProperties": false
|
|
66646
67475
|
}
|
|
66647
|
-
},
|
|
66648
|
-
"required": [
|
|
66649
|
-
"name",
|
|
66650
|
-
"dataType"
|
|
66651
|
-
],
|
|
66652
|
-
"additionalProperties": false
|
|
66653
|
-
},
|
|
66654
|
-
"maxItems": 256
|
|
67476
|
+
},
|
|
67477
|
+
"required": [
|
|
67478
|
+
"name",
|
|
67479
|
+
"dataType"
|
|
67480
|
+
],
|
|
67481
|
+
"additionalProperties": false
|
|
67482
|
+
},
|
|
67483
|
+
"maxItems": 256
|
|
67484
|
+
},
|
|
67485
|
+
"deviceClass": {
|
|
67486
|
+
"type": "string",
|
|
67487
|
+
"enum": [
|
|
67488
|
+
"standalone",
|
|
67489
|
+
"gateway",
|
|
67490
|
+
"peripheral",
|
|
67491
|
+
"floating",
|
|
67492
|
+
"edgeCompute",
|
|
67493
|
+
"system",
|
|
67494
|
+
"embedded"
|
|
67495
|
+
]
|
|
67496
|
+
},
|
|
67497
|
+
"gatewayId": {
|
|
67498
|
+
"type": "string",
|
|
67499
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67500
|
+
},
|
|
67501
|
+
"edgeAgentVersion": {
|
|
67502
|
+
"type": "string",
|
|
67503
|
+
"pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
|
|
67504
|
+
},
|
|
67505
|
+
"connectionInfo": {
|
|
67506
|
+
"type": "object",
|
|
67507
|
+
"properties": {
|
|
67508
|
+
"time": {
|
|
67509
|
+
"type": "string",
|
|
67510
|
+
"format": "date-time"
|
|
67511
|
+
},
|
|
67512
|
+
"connected": {
|
|
67513
|
+
"enum": [
|
|
67514
|
+
1,
|
|
67515
|
+
0,
|
|
67516
|
+
null
|
|
67517
|
+
]
|
|
67518
|
+
}
|
|
67519
|
+
}
|
|
67520
|
+
},
|
|
67521
|
+
"parentId": {
|
|
67522
|
+
"oneOf": [
|
|
67523
|
+
{
|
|
67524
|
+
"type": "string",
|
|
67525
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67526
|
+
},
|
|
67527
|
+
{
|
|
67528
|
+
"type": "null"
|
|
67529
|
+
}
|
|
67530
|
+
]
|
|
67531
|
+
},
|
|
67532
|
+
"ancestorIds": {
|
|
67533
|
+
"type": "array",
|
|
67534
|
+
"items": {
|
|
67535
|
+
"type": "string",
|
|
67536
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67537
|
+
},
|
|
67538
|
+
"maxItems": 1000
|
|
67539
|
+
},
|
|
67540
|
+
"systemInterval": {
|
|
67541
|
+
"type": "integer",
|
|
67542
|
+
"minimum": 5,
|
|
67543
|
+
"maximum": 3600
|
|
67544
|
+
},
|
|
67545
|
+
"keepDuplicates": {
|
|
67546
|
+
"type": "boolean"
|
|
67547
|
+
}
|
|
67548
|
+
}
|
|
67549
|
+
}
|
|
67550
|
+
```
|
|
67551
|
+
### <a name="device-example"></a> Example
|
|
67552
|
+
|
|
67553
|
+
```json
|
|
67554
|
+
{
|
|
67555
|
+
"id": "575ecf887ae143cd83dc4aa2",
|
|
67556
|
+
"deviceId": "575ecf887ae143cd83dc4aa2",
|
|
67557
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
|
67558
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
67559
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
|
67560
|
+
"name": "My Device",
|
|
67561
|
+
"description": "A device description",
|
|
67562
|
+
"tags": [
|
|
67563
|
+
{
|
|
67564
|
+
"key": "TagKey",
|
|
67565
|
+
"value": "TagValue"
|
|
67566
|
+
},
|
|
67567
|
+
{
|
|
67568
|
+
"key": "floor",
|
|
67569
|
+
"value": "8"
|
|
67570
|
+
}
|
|
67571
|
+
],
|
|
67572
|
+
"attributes": [
|
|
67573
|
+
{
|
|
67574
|
+
"name": "voltage",
|
|
67575
|
+
"dataType": "number"
|
|
67576
|
+
}
|
|
67577
|
+
],
|
|
67578
|
+
"parentId": "5d8a0da7ce2f3d37c205d0c5",
|
|
67579
|
+
"deviceClass": "standalone",
|
|
67580
|
+
"connectionInfo": {
|
|
67581
|
+
"time": "2016-06-14T08:15:00.000Z",
|
|
67582
|
+
"connected": 1
|
|
67583
|
+
}
|
|
67584
|
+
}
|
|
67585
|
+
```
|
|
67586
|
+
|
|
67587
|
+
<br/>
|
|
67588
|
+
|
|
67589
|
+
## Device Attribute
|
|
67590
|
+
|
|
67591
|
+
Schema for a single Device Attribute
|
|
67592
|
+
|
|
67593
|
+
### <a name="device-attribute-schema"></a> Schema
|
|
67594
|
+
|
|
67595
|
+
```json
|
|
67596
|
+
{
|
|
67597
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
67598
|
+
"type": "object",
|
|
67599
|
+
"properties": {
|
|
67600
|
+
"name": {
|
|
67601
|
+
"type": "string",
|
|
67602
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67603
|
+
},
|
|
67604
|
+
"dataType": {
|
|
67605
|
+
"type": "string",
|
|
67606
|
+
"enum": [
|
|
67607
|
+
"string",
|
|
67608
|
+
"number",
|
|
67609
|
+
"gps",
|
|
67610
|
+
"boolean",
|
|
67611
|
+
"blob"
|
|
67612
|
+
]
|
|
67613
|
+
},
|
|
67614
|
+
"contentType": {
|
|
67615
|
+
"type": "string",
|
|
67616
|
+
"maxLength": 64
|
|
67617
|
+
},
|
|
67618
|
+
"description": {
|
|
67619
|
+
"type": "string",
|
|
67620
|
+
"maxLength": 32767
|
|
67621
|
+
},
|
|
67622
|
+
"attributeTags": {
|
|
67623
|
+
"type": "object",
|
|
67624
|
+
"patternProperties": {
|
|
67625
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
67626
|
+
"type": "string",
|
|
67627
|
+
"minLength": 1,
|
|
67628
|
+
"maxLength": 255
|
|
67629
|
+
}
|
|
67630
|
+
},
|
|
67631
|
+
"additionalProperties": false
|
|
67632
|
+
},
|
|
67633
|
+
"system": {
|
|
67634
|
+
"type": "object",
|
|
67635
|
+
"properties": {
|
|
67636
|
+
"aggregation": {
|
|
67637
|
+
"type": "string",
|
|
67638
|
+
"enum": [
|
|
67639
|
+
"FIRST",
|
|
67640
|
+
"LAST",
|
|
67641
|
+
"COUNT",
|
|
67642
|
+
"MAX",
|
|
67643
|
+
"MIN",
|
|
67644
|
+
"MEDIAN",
|
|
67645
|
+
"MEAN",
|
|
67646
|
+
"SUM",
|
|
67647
|
+
"STD_DEV"
|
|
67648
|
+
]
|
|
67649
|
+
},
|
|
67650
|
+
"aggregationOptions": {
|
|
67651
|
+
"type": "array",
|
|
67652
|
+
"items": {
|
|
67653
|
+
"type": "object",
|
|
67654
|
+
"additionalProperties": false
|
|
67655
|
+
},
|
|
67656
|
+
"maxItems": 0
|
|
67657
|
+
},
|
|
67658
|
+
"childAttributes": {
|
|
67659
|
+
"type": "array",
|
|
67660
|
+
"items": {
|
|
67661
|
+
"type": "object",
|
|
67662
|
+
"properties": {
|
|
67663
|
+
"name": {
|
|
67664
|
+
"type": "string",
|
|
67665
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67666
|
+
},
|
|
67667
|
+
"mode": {
|
|
67668
|
+
"type": "string",
|
|
67669
|
+
"enum": [
|
|
67670
|
+
"all",
|
|
67671
|
+
"whitelist",
|
|
67672
|
+
"blacklist"
|
|
67673
|
+
]
|
|
67674
|
+
},
|
|
67675
|
+
"deviceIds": {
|
|
67676
|
+
"type": "array",
|
|
67677
|
+
"items": {
|
|
67678
|
+
"type": "string",
|
|
67679
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67680
|
+
},
|
|
67681
|
+
"maxItems": 1000
|
|
67682
|
+
},
|
|
67683
|
+
"deviceTags": {
|
|
67684
|
+
"type": "array",
|
|
67685
|
+
"items": {
|
|
67686
|
+
"type": "object",
|
|
67687
|
+
"properties": {
|
|
67688
|
+
"key": {
|
|
67689
|
+
"type": "string",
|
|
67690
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67691
|
+
},
|
|
67692
|
+
"value": {
|
|
67693
|
+
"type": "string",
|
|
67694
|
+
"minLength": 1,
|
|
67695
|
+
"maxLength": 255
|
|
67696
|
+
}
|
|
67697
|
+
},
|
|
67698
|
+
"additionalProperties": false
|
|
67699
|
+
},
|
|
67700
|
+
"maxItems": 100
|
|
67701
|
+
}
|
|
67702
|
+
},
|
|
67703
|
+
"required": [
|
|
67704
|
+
"name",
|
|
67705
|
+
"mode"
|
|
67706
|
+
],
|
|
67707
|
+
"additionalProperties": false
|
|
67708
|
+
},
|
|
67709
|
+
"maxItems": 256
|
|
67710
|
+
}
|
|
67711
|
+
},
|
|
67712
|
+
"additionalProperties": false
|
|
67713
|
+
},
|
|
67714
|
+
"applicationId": {
|
|
67715
|
+
"type": "string",
|
|
67716
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67717
|
+
},
|
|
67718
|
+
"deviceId": {
|
|
67719
|
+
"type": "string",
|
|
67720
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67721
|
+
}
|
|
67722
|
+
}
|
|
67723
|
+
}
|
|
67724
|
+
```
|
|
67725
|
+
### <a name="device-attribute-example"></a> Example
|
|
67726
|
+
|
|
67727
|
+
```json
|
|
67728
|
+
{
|
|
67729
|
+
"deviceId": "575ecf887ae143cd83dc4aa2",
|
|
67730
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
|
67731
|
+
"name": "voltage",
|
|
67732
|
+
"dataType": "number"
|
|
67733
|
+
}
|
|
67734
|
+
```
|
|
67735
|
+
|
|
67736
|
+
<br/>
|
|
67737
|
+
|
|
67738
|
+
## Device Attribute Data Type Filter
|
|
67739
|
+
|
|
67740
|
+
Select one or multiple device attribute data types
|
|
67741
|
+
|
|
67742
|
+
### <a name="device-attribute-data-type-filter-schema"></a> Schema
|
|
67743
|
+
|
|
67744
|
+
```json
|
|
67745
|
+
{
|
|
67746
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
67747
|
+
"oneOf": [
|
|
67748
|
+
{
|
|
67749
|
+
"type": "string",
|
|
67750
|
+
"enum": [
|
|
67751
|
+
"string",
|
|
67752
|
+
"number",
|
|
67753
|
+
"gps",
|
|
67754
|
+
"boolean",
|
|
67755
|
+
"blob"
|
|
67756
|
+
]
|
|
67757
|
+
},
|
|
67758
|
+
{
|
|
67759
|
+
"type": "array",
|
|
67760
|
+
"minItems": 1,
|
|
67761
|
+
"items": {
|
|
67762
|
+
"type": "string",
|
|
67763
|
+
"enum": [
|
|
67764
|
+
"string",
|
|
67765
|
+
"number",
|
|
67766
|
+
"gps",
|
|
67767
|
+
"boolean",
|
|
67768
|
+
"blob"
|
|
67769
|
+
]
|
|
67770
|
+
}
|
|
67771
|
+
}
|
|
67772
|
+
]
|
|
67773
|
+
}
|
|
67774
|
+
```
|
|
67775
|
+
### <a name="device-attribute-data-type-filter-example"></a> Example
|
|
67776
|
+
|
|
67777
|
+
```json
|
|
67778
|
+
[
|
|
67779
|
+
"number",
|
|
67780
|
+
"blob"
|
|
67781
|
+
]
|
|
67782
|
+
```
|
|
67783
|
+
|
|
67784
|
+
<br/>
|
|
67785
|
+
|
|
67786
|
+
## Device Attribute Patch
|
|
67787
|
+
|
|
67788
|
+
Schema for the body of a Device Attribute modification request
|
|
67789
|
+
|
|
67790
|
+
### <a name="device-attribute-patch-schema"></a> Schema
|
|
67791
|
+
|
|
67792
|
+
```json
|
|
67793
|
+
{
|
|
67794
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
67795
|
+
"type": "object",
|
|
67796
|
+
"properties": {
|
|
67797
|
+
"name": {
|
|
67798
|
+
"type": "string",
|
|
67799
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67800
|
+
},
|
|
67801
|
+
"contentType": {
|
|
67802
|
+
"type": "string",
|
|
67803
|
+
"maxLength": 64
|
|
67804
|
+
},
|
|
67805
|
+
"description": {
|
|
67806
|
+
"type": "string",
|
|
67807
|
+
"maxLength": 32767
|
|
67808
|
+
},
|
|
67809
|
+
"attributeTags": {
|
|
67810
|
+
"type": "object",
|
|
67811
|
+
"patternProperties": {
|
|
67812
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
67813
|
+
"type": "string",
|
|
67814
|
+
"minLength": 1,
|
|
67815
|
+
"maxLength": 255
|
|
67816
|
+
}
|
|
67817
|
+
},
|
|
67818
|
+
"additionalProperties": false
|
|
67819
|
+
},
|
|
67820
|
+
"system": {
|
|
67821
|
+
"type": "object",
|
|
67822
|
+
"properties": {
|
|
67823
|
+
"aggregation": {
|
|
67824
|
+
"type": "string",
|
|
67825
|
+
"enum": [
|
|
67826
|
+
"FIRST",
|
|
67827
|
+
"LAST",
|
|
67828
|
+
"COUNT",
|
|
67829
|
+
"MAX",
|
|
67830
|
+
"MIN",
|
|
67831
|
+
"MEDIAN",
|
|
67832
|
+
"MEAN",
|
|
67833
|
+
"SUM",
|
|
67834
|
+
"STD_DEV"
|
|
67835
|
+
]
|
|
67836
|
+
},
|
|
67837
|
+
"aggregationOptions": {
|
|
67838
|
+
"type": "array",
|
|
67839
|
+
"items": {
|
|
67840
|
+
"type": "object",
|
|
67841
|
+
"additionalProperties": false
|
|
67842
|
+
},
|
|
67843
|
+
"maxItems": 0
|
|
67844
|
+
},
|
|
67845
|
+
"childAttributes": {
|
|
67846
|
+
"type": "array",
|
|
67847
|
+
"items": {
|
|
67848
|
+
"type": "object",
|
|
67849
|
+
"properties": {
|
|
67850
|
+
"name": {
|
|
67851
|
+
"type": "string",
|
|
67852
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67853
|
+
},
|
|
67854
|
+
"mode": {
|
|
67855
|
+
"type": "string",
|
|
67856
|
+
"enum": [
|
|
67857
|
+
"all",
|
|
67858
|
+
"whitelist",
|
|
67859
|
+
"blacklist"
|
|
67860
|
+
]
|
|
67861
|
+
},
|
|
67862
|
+
"deviceIds": {
|
|
67863
|
+
"type": "array",
|
|
67864
|
+
"items": {
|
|
67865
|
+
"type": "string",
|
|
67866
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
67867
|
+
},
|
|
67868
|
+
"maxItems": 1000
|
|
67869
|
+
},
|
|
67870
|
+
"deviceTags": {
|
|
67871
|
+
"type": "array",
|
|
67872
|
+
"items": {
|
|
67873
|
+
"type": "object",
|
|
67874
|
+
"properties": {
|
|
67875
|
+
"key": {
|
|
67876
|
+
"type": "string",
|
|
67877
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67878
|
+
},
|
|
67879
|
+
"value": {
|
|
67880
|
+
"type": "string",
|
|
67881
|
+
"minLength": 1,
|
|
67882
|
+
"maxLength": 255
|
|
67883
|
+
}
|
|
67884
|
+
},
|
|
67885
|
+
"additionalProperties": false
|
|
67886
|
+
},
|
|
67887
|
+
"maxItems": 100
|
|
67888
|
+
}
|
|
67889
|
+
},
|
|
67890
|
+
"required": [
|
|
67891
|
+
"name",
|
|
67892
|
+
"mode"
|
|
67893
|
+
],
|
|
67894
|
+
"additionalProperties": false
|
|
67895
|
+
},
|
|
67896
|
+
"maxItems": 256
|
|
67897
|
+
}
|
|
67898
|
+
},
|
|
67899
|
+
"additionalProperties": false
|
|
67900
|
+
}
|
|
67901
|
+
},
|
|
67902
|
+
"additionalProperties": false
|
|
67903
|
+
}
|
|
67904
|
+
```
|
|
67905
|
+
### <a name="device-attribute-patch-example"></a> Example
|
|
67906
|
+
|
|
67907
|
+
```json
|
|
67908
|
+
{
|
|
67909
|
+
"description": "my new attribute description"
|
|
67910
|
+
}
|
|
67911
|
+
```
|
|
67912
|
+
|
|
67913
|
+
<br/>
|
|
67914
|
+
|
|
67915
|
+
## Device Attribute Post
|
|
67916
|
+
|
|
67917
|
+
Schema for the body of a Device Attribute creation request
|
|
67918
|
+
|
|
67919
|
+
### <a name="device-attribute-post-schema"></a> Schema
|
|
67920
|
+
|
|
67921
|
+
```json
|
|
67922
|
+
{
|
|
67923
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
67924
|
+
"type": "object",
|
|
67925
|
+
"properties": {
|
|
67926
|
+
"name": {
|
|
67927
|
+
"type": "string",
|
|
67928
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67929
|
+
},
|
|
67930
|
+
"dataType": {
|
|
67931
|
+
"type": "string",
|
|
67932
|
+
"enum": [
|
|
67933
|
+
"string",
|
|
67934
|
+
"number",
|
|
67935
|
+
"gps",
|
|
67936
|
+
"boolean",
|
|
67937
|
+
"blob"
|
|
67938
|
+
]
|
|
67939
|
+
},
|
|
67940
|
+
"contentType": {
|
|
67941
|
+
"type": "string",
|
|
67942
|
+
"maxLength": 64
|
|
67943
|
+
},
|
|
67944
|
+
"description": {
|
|
67945
|
+
"type": "string",
|
|
67946
|
+
"maxLength": 32767
|
|
67947
|
+
},
|
|
67948
|
+
"attributeTags": {
|
|
67949
|
+
"type": "object",
|
|
67950
|
+
"patternProperties": {
|
|
67951
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
67952
|
+
"type": "string",
|
|
67953
|
+
"minLength": 1,
|
|
67954
|
+
"maxLength": 255
|
|
67955
|
+
}
|
|
67956
|
+
},
|
|
67957
|
+
"additionalProperties": false
|
|
67958
|
+
},
|
|
67959
|
+
"system": {
|
|
67960
|
+
"type": "object",
|
|
67961
|
+
"properties": {
|
|
67962
|
+
"aggregation": {
|
|
67963
|
+
"type": "string",
|
|
67964
|
+
"enum": [
|
|
67965
|
+
"FIRST",
|
|
67966
|
+
"LAST",
|
|
67967
|
+
"COUNT",
|
|
67968
|
+
"MAX",
|
|
67969
|
+
"MIN",
|
|
67970
|
+
"MEDIAN",
|
|
67971
|
+
"MEAN",
|
|
67972
|
+
"SUM",
|
|
67973
|
+
"STD_DEV"
|
|
67974
|
+
]
|
|
67975
|
+
},
|
|
67976
|
+
"aggregationOptions": {
|
|
67977
|
+
"type": "array",
|
|
67978
|
+
"items": {
|
|
67979
|
+
"type": "object",
|
|
67980
|
+
"additionalProperties": false
|
|
67981
|
+
},
|
|
67982
|
+
"maxItems": 0
|
|
67983
|
+
},
|
|
67984
|
+
"childAttributes": {
|
|
67985
|
+
"type": "array",
|
|
67986
|
+
"items": {
|
|
67987
|
+
"type": "object",
|
|
67988
|
+
"properties": {
|
|
67989
|
+
"name": {
|
|
67990
|
+
"type": "string",
|
|
67991
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
67992
|
+
},
|
|
67993
|
+
"mode": {
|
|
67994
|
+
"type": "string",
|
|
67995
|
+
"enum": [
|
|
67996
|
+
"all",
|
|
67997
|
+
"whitelist",
|
|
67998
|
+
"blacklist"
|
|
67999
|
+
]
|
|
68000
|
+
},
|
|
68001
|
+
"deviceIds": {
|
|
68002
|
+
"type": "array",
|
|
68003
|
+
"items": {
|
|
68004
|
+
"type": "string",
|
|
68005
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
68006
|
+
},
|
|
68007
|
+
"maxItems": 1000
|
|
68008
|
+
},
|
|
68009
|
+
"deviceTags": {
|
|
68010
|
+
"type": "array",
|
|
68011
|
+
"items": {
|
|
68012
|
+
"type": "object",
|
|
68013
|
+
"properties": {
|
|
68014
|
+
"key": {
|
|
68015
|
+
"type": "string",
|
|
68016
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
68017
|
+
},
|
|
68018
|
+
"value": {
|
|
68019
|
+
"type": "string",
|
|
68020
|
+
"minLength": 1,
|
|
68021
|
+
"maxLength": 255
|
|
68022
|
+
}
|
|
68023
|
+
},
|
|
68024
|
+
"additionalProperties": false
|
|
68025
|
+
},
|
|
68026
|
+
"maxItems": 100
|
|
68027
|
+
}
|
|
68028
|
+
},
|
|
68029
|
+
"required": [
|
|
68030
|
+
"name",
|
|
68031
|
+
"mode"
|
|
68032
|
+
],
|
|
68033
|
+
"additionalProperties": false
|
|
68034
|
+
},
|
|
68035
|
+
"maxItems": 256
|
|
68036
|
+
}
|
|
68037
|
+
},
|
|
68038
|
+
"additionalProperties": false
|
|
68039
|
+
}
|
|
68040
|
+
},
|
|
68041
|
+
"required": [
|
|
68042
|
+
"name",
|
|
68043
|
+
"dataType"
|
|
68044
|
+
],
|
|
68045
|
+
"additionalProperties": false
|
|
68046
|
+
}
|
|
68047
|
+
```
|
|
68048
|
+
### <a name="device-attribute-post-example"></a> Example
|
|
68049
|
+
|
|
68050
|
+
```json
|
|
68051
|
+
{
|
|
68052
|
+
"name": "voltage",
|
|
68053
|
+
"dataType": "number"
|
|
68054
|
+
}
|
|
68055
|
+
```
|
|
68056
|
+
|
|
68057
|
+
<br/>
|
|
68058
|
+
|
|
68059
|
+
## Device Attributes
|
|
68060
|
+
|
|
68061
|
+
Schema for a collection of Device Attributes
|
|
68062
|
+
|
|
68063
|
+
### <a name="device-attributes-schema"></a> Schema
|
|
68064
|
+
|
|
68065
|
+
```json
|
|
68066
|
+
{
|
|
68067
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
68068
|
+
"type": "object",
|
|
68069
|
+
"properties": {
|
|
68070
|
+
"items": {
|
|
68071
|
+
"type": "array",
|
|
68072
|
+
"items": {
|
|
68073
|
+
"title": "Device Attribute",
|
|
68074
|
+
"description": "Schema for a single Device Attribute",
|
|
68075
|
+
"type": "object",
|
|
68076
|
+
"properties": {
|
|
68077
|
+
"name": {
|
|
68078
|
+
"type": "string",
|
|
68079
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
68080
|
+
},
|
|
68081
|
+
"dataType": {
|
|
68082
|
+
"type": "string",
|
|
68083
|
+
"enum": [
|
|
68084
|
+
"string",
|
|
68085
|
+
"number",
|
|
68086
|
+
"gps",
|
|
68087
|
+
"boolean",
|
|
68088
|
+
"blob"
|
|
68089
|
+
]
|
|
68090
|
+
},
|
|
68091
|
+
"contentType": {
|
|
68092
|
+
"type": "string",
|
|
68093
|
+
"maxLength": 64
|
|
68094
|
+
},
|
|
68095
|
+
"description": {
|
|
68096
|
+
"type": "string",
|
|
68097
|
+
"maxLength": 32767
|
|
68098
|
+
},
|
|
68099
|
+
"attributeTags": {
|
|
68100
|
+
"type": "object",
|
|
68101
|
+
"patternProperties": {
|
|
68102
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
|
68103
|
+
"type": "string",
|
|
68104
|
+
"minLength": 1,
|
|
68105
|
+
"maxLength": 255
|
|
68106
|
+
}
|
|
68107
|
+
},
|
|
68108
|
+
"additionalProperties": false
|
|
68109
|
+
},
|
|
68110
|
+
"system": {
|
|
68111
|
+
"type": "object",
|
|
68112
|
+
"properties": {
|
|
68113
|
+
"aggregation": {
|
|
68114
|
+
"type": "string",
|
|
68115
|
+
"enum": [
|
|
68116
|
+
"FIRST",
|
|
68117
|
+
"LAST",
|
|
68118
|
+
"COUNT",
|
|
68119
|
+
"MAX",
|
|
68120
|
+
"MIN",
|
|
68121
|
+
"MEDIAN",
|
|
68122
|
+
"MEAN",
|
|
68123
|
+
"SUM",
|
|
68124
|
+
"STD_DEV"
|
|
68125
|
+
]
|
|
68126
|
+
},
|
|
68127
|
+
"aggregationOptions": {
|
|
68128
|
+
"type": "array",
|
|
68129
|
+
"items": {
|
|
68130
|
+
"type": "object",
|
|
68131
|
+
"additionalProperties": false
|
|
68132
|
+
},
|
|
68133
|
+
"maxItems": 0
|
|
68134
|
+
},
|
|
68135
|
+
"childAttributes": {
|
|
68136
|
+
"type": "array",
|
|
68137
|
+
"items": {
|
|
68138
|
+
"type": "object",
|
|
68139
|
+
"properties": {
|
|
68140
|
+
"name": {
|
|
68141
|
+
"type": "string",
|
|
68142
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
68143
|
+
},
|
|
68144
|
+
"mode": {
|
|
68145
|
+
"type": "string",
|
|
68146
|
+
"enum": [
|
|
68147
|
+
"all",
|
|
68148
|
+
"whitelist",
|
|
68149
|
+
"blacklist"
|
|
68150
|
+
]
|
|
68151
|
+
},
|
|
68152
|
+
"deviceIds": {
|
|
68153
|
+
"type": "array",
|
|
68154
|
+
"items": {
|
|
68155
|
+
"type": "string",
|
|
68156
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
68157
|
+
},
|
|
68158
|
+
"maxItems": 1000
|
|
68159
|
+
},
|
|
68160
|
+
"deviceTags": {
|
|
68161
|
+
"type": "array",
|
|
68162
|
+
"items": {
|
|
68163
|
+
"type": "object",
|
|
68164
|
+
"properties": {
|
|
68165
|
+
"key": {
|
|
68166
|
+
"type": "string",
|
|
68167
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
68168
|
+
},
|
|
68169
|
+
"value": {
|
|
68170
|
+
"type": "string",
|
|
68171
|
+
"minLength": 1,
|
|
68172
|
+
"maxLength": 255
|
|
68173
|
+
}
|
|
68174
|
+
},
|
|
68175
|
+
"additionalProperties": false
|
|
68176
|
+
},
|
|
68177
|
+
"maxItems": 100
|
|
68178
|
+
}
|
|
68179
|
+
},
|
|
68180
|
+
"required": [
|
|
68181
|
+
"name",
|
|
68182
|
+
"mode"
|
|
68183
|
+
],
|
|
68184
|
+
"additionalProperties": false
|
|
68185
|
+
},
|
|
68186
|
+
"maxItems": 256
|
|
68187
|
+
}
|
|
68188
|
+
},
|
|
68189
|
+
"additionalProperties": false
|
|
68190
|
+
},
|
|
68191
|
+
"applicationId": {
|
|
68192
|
+
"type": "string",
|
|
68193
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
68194
|
+
},
|
|
68195
|
+
"deviceId": {
|
|
68196
|
+
"type": "string",
|
|
68197
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
68198
|
+
}
|
|
68199
|
+
}
|
|
68200
|
+
}
|
|
66655
68201
|
},
|
|
66656
|
-
"
|
|
68202
|
+
"count": {
|
|
68203
|
+
"type": "integer"
|
|
68204
|
+
},
|
|
68205
|
+
"totalCount": {
|
|
68206
|
+
"type": "integer"
|
|
68207
|
+
},
|
|
68208
|
+
"filter": {
|
|
68209
|
+
"type": "string"
|
|
68210
|
+
},
|
|
68211
|
+
"filterField": {
|
|
68212
|
+
"type": "string"
|
|
68213
|
+
},
|
|
68214
|
+
"sortField": {
|
|
68215
|
+
"type": "string"
|
|
68216
|
+
},
|
|
68217
|
+
"sortDirection": {
|
|
66657
68218
|
"type": "string",
|
|
66658
68219
|
"enum": [
|
|
66659
|
-
"
|
|
66660
|
-
"
|
|
66661
|
-
"
|
|
66662
|
-
"
|
|
66663
|
-
"
|
|
66664
|
-
"system",
|
|
66665
|
-
"embedded"
|
|
68220
|
+
"asc",
|
|
68221
|
+
"desc",
|
|
68222
|
+
"ASC",
|
|
68223
|
+
"DESC",
|
|
68224
|
+
""
|
|
66666
68225
|
]
|
|
66667
68226
|
},
|
|
66668
|
-
"
|
|
68227
|
+
"applicationId": {
|
|
66669
68228
|
"type": "string",
|
|
66670
68229
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
66671
68230
|
},
|
|
66672
|
-
"
|
|
68231
|
+
"deviceId": {
|
|
66673
68232
|
"type": "string",
|
|
66674
|
-
"pattern": "^
|
|
66675
|
-
},
|
|
66676
|
-
"connectionInfo": {
|
|
66677
|
-
"type": "object",
|
|
66678
|
-
"properties": {
|
|
66679
|
-
"time": {
|
|
66680
|
-
"type": "string",
|
|
66681
|
-
"format": "date-time"
|
|
66682
|
-
},
|
|
66683
|
-
"connected": {
|
|
66684
|
-
"enum": [
|
|
66685
|
-
1,
|
|
66686
|
-
0,
|
|
66687
|
-
null
|
|
66688
|
-
]
|
|
66689
|
-
}
|
|
66690
|
-
}
|
|
66691
|
-
},
|
|
66692
|
-
"parentId": {
|
|
66693
|
-
"oneOf": [
|
|
66694
|
-
{
|
|
66695
|
-
"type": "string",
|
|
66696
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
66697
|
-
},
|
|
66698
|
-
{
|
|
66699
|
-
"type": "null"
|
|
66700
|
-
}
|
|
66701
|
-
]
|
|
66702
|
-
},
|
|
66703
|
-
"ancestorIds": {
|
|
66704
|
-
"type": "array",
|
|
66705
|
-
"items": {
|
|
66706
|
-
"type": "string",
|
|
66707
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
66708
|
-
},
|
|
66709
|
-
"maxItems": 1000
|
|
66710
|
-
},
|
|
66711
|
-
"systemInterval": {
|
|
66712
|
-
"type": "integer",
|
|
66713
|
-
"minimum": 5,
|
|
66714
|
-
"maximum": 3600
|
|
66715
|
-
},
|
|
66716
|
-
"keepDuplicates": {
|
|
66717
|
-
"type": "boolean"
|
|
68233
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
|
66718
68234
|
}
|
|
66719
68235
|
}
|
|
66720
68236
|
}
|
|
66721
68237
|
```
|
|
66722
|
-
### <a name="device-example"></a> Example
|
|
68238
|
+
### <a name="device-attributes-example"></a> Example
|
|
66723
68239
|
|
|
66724
68240
|
```json
|
|
66725
68241
|
{
|
|
66726
|
-
"
|
|
66727
|
-
"deviceId": "575ecf887ae143cd83dc4aa2",
|
|
66728
|
-
"applicationId": "575ec8687ae143cd83dc4a97",
|
|
66729
|
-
"creationDate": "2016-06-13T04:00:00.000Z",
|
|
66730
|
-
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
|
66731
|
-
"name": "My Device",
|
|
66732
|
-
"description": "A device description",
|
|
66733
|
-
"tags": [
|
|
66734
|
-
{
|
|
66735
|
-
"key": "TagKey",
|
|
66736
|
-
"value": "TagValue"
|
|
66737
|
-
},
|
|
66738
|
-
{
|
|
66739
|
-
"key": "floor",
|
|
66740
|
-
"value": "8"
|
|
66741
|
-
}
|
|
66742
|
-
],
|
|
66743
|
-
"attributes": [
|
|
68242
|
+
"items": [
|
|
66744
68243
|
{
|
|
66745
|
-
"
|
|
66746
|
-
"dataType": "number"
|
|
68244
|
+
"$ref": "#/examples/deviceAttributes"
|
|
66747
68245
|
}
|
|
66748
68246
|
],
|
|
66749
|
-
"
|
|
66750
|
-
"
|
|
66751
|
-
"
|
|
66752
|
-
|
|
66753
|
-
|
|
66754
|
-
|
|
66755
|
-
}
|
|
66756
|
-
```
|
|
66757
|
-
|
|
66758
|
-
<br/>
|
|
66759
|
-
|
|
66760
|
-
## Device Attribute Data Type Filter
|
|
66761
|
-
|
|
66762
|
-
Select one or multiple device attribute data types
|
|
66763
|
-
|
|
66764
|
-
### <a name="device-attribute-data-type-filter-schema"></a> Schema
|
|
66765
|
-
|
|
66766
|
-
```json
|
|
66767
|
-
{
|
|
66768
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
66769
|
-
"oneOf": [
|
|
66770
|
-
{
|
|
66771
|
-
"type": "string",
|
|
66772
|
-
"enum": [
|
|
66773
|
-
"string",
|
|
66774
|
-
"number",
|
|
66775
|
-
"gps",
|
|
66776
|
-
"boolean",
|
|
66777
|
-
"blob"
|
|
66778
|
-
]
|
|
66779
|
-
},
|
|
66780
|
-
{
|
|
66781
|
-
"type": "array",
|
|
66782
|
-
"minItems": 1,
|
|
66783
|
-
"items": {
|
|
66784
|
-
"type": "string",
|
|
66785
|
-
"enum": [
|
|
66786
|
-
"string",
|
|
66787
|
-
"number",
|
|
66788
|
-
"gps",
|
|
66789
|
-
"boolean",
|
|
66790
|
-
"blob"
|
|
66791
|
-
]
|
|
66792
|
-
}
|
|
66793
|
-
}
|
|
66794
|
-
]
|
|
68247
|
+
"count": 1,
|
|
68248
|
+
"totalCount": 1,
|
|
68249
|
+
"sortField": "name",
|
|
68250
|
+
"sortDirection": "asc",
|
|
68251
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
|
68252
|
+
"deviceId": "575ecf887ae143cd83dc4aa2"
|
|
66795
68253
|
}
|
|
66796
68254
|
```
|
|
66797
|
-
### <a name="device-attribute-data-type-filter-example"></a> Example
|
|
66798
|
-
|
|
66799
|
-
```json
|
|
66800
|
-
[
|
|
66801
|
-
"number",
|
|
66802
|
-
"blob"
|
|
66803
|
-
]
|
|
66804
|
-
```
|
|
66805
68255
|
|
|
66806
68256
|
<br/>
|
|
66807
68257
|
|
|
@@ -67521,7 +68971,6 @@ Schema for the body of a Device modification request
|
|
|
67521
68971
|
"type": "object",
|
|
67522
68972
|
"additionalProperties": false
|
|
67523
68973
|
},
|
|
67524
|
-
"additionalProperties": false,
|
|
67525
68974
|
"maxItems": 0
|
|
67526
68975
|
},
|
|
67527
68976
|
"childAttributes": {
|
|
@@ -67801,7 +69250,6 @@ Schema for the body of a Device creation request
|
|
|
67801
69250
|
"type": "object",
|
|
67802
69251
|
"additionalProperties": false
|
|
67803
69252
|
},
|
|
67804
|
-
"additionalProperties": false,
|
|
67805
69253
|
"maxItems": 0
|
|
67806
69254
|
},
|
|
67807
69255
|
"childAttributes": {
|
|
@@ -68068,7 +69516,6 @@ Schema for a single Device Recipe
|
|
|
68068
69516
|
"type": "object",
|
|
68069
69517
|
"additionalProperties": false
|
|
68070
69518
|
},
|
|
68071
|
-
"additionalProperties": false,
|
|
68072
69519
|
"maxItems": 0
|
|
68073
69520
|
},
|
|
68074
69521
|
"childAttributes": {
|
|
@@ -68430,7 +69877,6 @@ Schema for the body of a Device Recipe modification request
|
|
|
68430
69877
|
"type": "object",
|
|
68431
69878
|
"additionalProperties": false
|
|
68432
69879
|
},
|
|
68433
|
-
"additionalProperties": false,
|
|
68434
69880
|
"maxItems": 0
|
|
68435
69881
|
},
|
|
68436
69882
|
"childAttributes": {
|
|
@@ -68683,7 +70129,6 @@ Schema for the body of a Device Recipe creation request
|
|
|
68683
70129
|
"type": "object",
|
|
68684
70130
|
"additionalProperties": false
|
|
68685
70131
|
},
|
|
68686
|
-
"additionalProperties": false,
|
|
68687
70132
|
"maxItems": 0
|
|
68688
70133
|
},
|
|
68689
70134
|
"childAttributes": {
|
|
@@ -68959,7 +70404,6 @@ Schema for a collection of Device Recipes
|
|
|
68959
70404
|
"type": "object",
|
|
68960
70405
|
"additionalProperties": false
|
|
68961
70406
|
},
|
|
68962
|
-
"additionalProperties": false,
|
|
68963
70407
|
"maxItems": 0
|
|
68964
70408
|
},
|
|
68965
70409
|
"childAttributes": {
|
|
@@ -69616,7 +71060,6 @@ Schema for a collection of Devices
|
|
|
69616
71060
|
"type": "object",
|
|
69617
71061
|
"additionalProperties": false
|
|
69618
71062
|
},
|
|
69619
|
-
"additionalProperties": false,
|
|
69620
71063
|
"maxItems": 0
|
|
69621
71064
|
},
|
|
69622
71065
|
"childAttributes": {
|
|
@@ -76289,7 +77732,6 @@ Schema for the body of a Devices modification request
|
|
|
76289
77732
|
"type": "object",
|
|
76290
77733
|
"additionalProperties": false
|
|
76291
77734
|
},
|
|
76292
|
-
"additionalProperties": false,
|
|
76293
77735
|
"maxItems": 0
|
|
76294
77736
|
},
|
|
76295
77737
|
"childAttributes": {
|
|
@@ -78738,6 +80180,71 @@ Schema for the body of a Devices modification request
|
|
|
78738
80180
|
],
|
|
78739
80181
|
"additionalProperties": false
|
|
78740
80182
|
},
|
|
80183
|
+
{
|
|
80184
|
+
"type": "object",
|
|
80185
|
+
"properties": {
|
|
80186
|
+
"operation": {
|
|
80187
|
+
"type": "string",
|
|
80188
|
+
"enum": [
|
|
80189
|
+
"set"
|
|
80190
|
+
]
|
|
80191
|
+
},
|
|
80192
|
+
"target": {
|
|
80193
|
+
"type": "string",
|
|
80194
|
+
"enum": [
|
|
80195
|
+
"attributeContentType"
|
|
80196
|
+
]
|
|
80197
|
+
},
|
|
80198
|
+
"attributeName": {
|
|
80199
|
+
"type": "string",
|
|
80200
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
80201
|
+
},
|
|
80202
|
+
"value": {
|
|
80203
|
+
"type": "string",
|
|
80204
|
+
"maxLength": 64,
|
|
80205
|
+
"minLength": 1
|
|
80206
|
+
}
|
|
80207
|
+
},
|
|
80208
|
+
"required": [
|
|
80209
|
+
"operation",
|
|
80210
|
+
"target",
|
|
80211
|
+
"attributeName",
|
|
80212
|
+
"value"
|
|
80213
|
+
],
|
|
80214
|
+
"additionalProperties": false
|
|
80215
|
+
},
|
|
80216
|
+
{
|
|
80217
|
+
"type": "object",
|
|
80218
|
+
"properties": {
|
|
80219
|
+
"operation": {
|
|
80220
|
+
"type": "string",
|
|
80221
|
+
"enum": [
|
|
80222
|
+
"set"
|
|
80223
|
+
]
|
|
80224
|
+
},
|
|
80225
|
+
"target": {
|
|
80226
|
+
"type": "string",
|
|
80227
|
+
"enum": [
|
|
80228
|
+
"attributeName"
|
|
80229
|
+
]
|
|
80230
|
+
},
|
|
80231
|
+
"attributeName": {
|
|
80232
|
+
"type": "string",
|
|
80233
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
80234
|
+
},
|
|
80235
|
+
"value": {
|
|
80236
|
+
"type": "string",
|
|
80237
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
|
80238
|
+
}
|
|
80239
|
+
},
|
|
80240
|
+
"required": [
|
|
80241
|
+
"operation",
|
|
80242
|
+
"target",
|
|
80243
|
+
"attributeName",
|
|
80244
|
+
"value"
|
|
80245
|
+
],
|
|
80246
|
+
"additionalProperties": false
|
|
80247
|
+
},
|
|
78741
80248
|
{
|
|
78742
80249
|
"type": "object",
|
|
78743
80250
|
"properties": {
|
|
@@ -78948,7 +80455,6 @@ Schema for the body of a Devices modification request
|
|
|
78948
80455
|
"type": "object",
|
|
78949
80456
|
"additionalProperties": false
|
|
78950
80457
|
},
|
|
78951
|
-
"additionalProperties": false,
|
|
78952
80458
|
"maxItems": 0
|
|
78953
80459
|
},
|
|
78954
80460
|
"childAttributes": {
|
|
@@ -79096,7 +80602,6 @@ Schema for the body of a Devices modification request
|
|
|
79096
80602
|
"type": "object",
|
|
79097
80603
|
"additionalProperties": false
|
|
79098
80604
|
},
|
|
79099
|
-
"additionalProperties": false,
|
|
79100
80605
|
"maxItems": 0
|
|
79101
80606
|
},
|
|
79102
80607
|
"childAttributes": {
|
|
@@ -142990,6 +144495,8 @@ Schema for the body of a Github login request
|
|
|
142990
144495
|
"deviceRecipe.*",
|
|
142991
144496
|
"deviceRecipes.*",
|
|
142992
144497
|
"devices.*",
|
|
144498
|
+
"deviceAttribute.*",
|
|
144499
|
+
"deviceAttributes.*",
|
|
142993
144500
|
"edgeDeployment.*",
|
|
142994
144501
|
"edgeDeployments.*",
|
|
142995
144502
|
"embeddedDeployment.*",
|
|
@@ -143136,6 +144643,11 @@ Schema for the body of a Github login request
|
|
|
143136
144643
|
"devices.sendCommand",
|
|
143137
144644
|
"devices.tagKeys",
|
|
143138
144645
|
"devices.tagValues",
|
|
144646
|
+
"deviceAttribute.get",
|
|
144647
|
+
"deviceAttribute.patch",
|
|
144648
|
+
"deviceAttribute.delete",
|
|
144649
|
+
"deviceAttributes.get",
|
|
144650
|
+
"deviceAttributes.post",
|
|
143139
144651
|
"edgeDeployment.get",
|
|
143140
144652
|
"edgeDeployments.get",
|
|
143141
144653
|
"edgeDeployments.release",
|
|
@@ -143221,6 +144733,7 @@ Schema for the body of a Github login request
|
|
|
143221
144733
|
"flow.setStorageEntry",
|
|
143222
144734
|
"flow.getStorageEntriesMetadata",
|
|
143223
144735
|
"flow.stats",
|
|
144736
|
+
"flow.suggestFunction",
|
|
143224
144737
|
"flows.get",
|
|
143225
144738
|
"flows.getByVersion",
|
|
143226
144739
|
"flows.import",
|
|
@@ -144981,6 +146494,23 @@ Schema for additional application import options
|
|
|
144981
146494
|
]
|
|
144982
146495
|
},
|
|
144983
146496
|
"uniqueItems": true
|
|
146497
|
+
},
|
|
146498
|
+
"credentialName": {
|
|
146499
|
+
"type": "string",
|
|
146500
|
+
"maxLength": 255
|
|
146501
|
+
},
|
|
146502
|
+
"repo": {
|
|
146503
|
+
"type": "object",
|
|
146504
|
+
"properties": {
|
|
146505
|
+
"branch": {
|
|
146506
|
+
"type": "string",
|
|
146507
|
+
"maxLength": 255
|
|
146508
|
+
},
|
|
146509
|
+
"directory": {
|
|
146510
|
+
"type": "string",
|
|
146511
|
+
"maxLength": 1024
|
|
146512
|
+
}
|
|
146513
|
+
}
|
|
144984
146514
|
}
|
|
144985
146515
|
},
|
|
144986
146516
|
"additionalProperties": false
|
|
@@ -169472,6 +171002,8 @@ SAML Response body for login
|
|
|
169472
171002
|
"deviceRecipe.*",
|
|
169473
171003
|
"deviceRecipes.*",
|
|
169474
171004
|
"devices.*",
|
|
171005
|
+
"deviceAttribute.*",
|
|
171006
|
+
"deviceAttributes.*",
|
|
169475
171007
|
"edgeDeployment.*",
|
|
169476
171008
|
"edgeDeployments.*",
|
|
169477
171009
|
"embeddedDeployment.*",
|
|
@@ -169618,6 +171150,11 @@ SAML Response body for login
|
|
|
169618
171150
|
"devices.sendCommand",
|
|
169619
171151
|
"devices.tagKeys",
|
|
169620
171152
|
"devices.tagValues",
|
|
171153
|
+
"deviceAttribute.get",
|
|
171154
|
+
"deviceAttribute.patch",
|
|
171155
|
+
"deviceAttribute.delete",
|
|
171156
|
+
"deviceAttributes.get",
|
|
171157
|
+
"deviceAttributes.post",
|
|
169621
171158
|
"edgeDeployment.get",
|
|
169622
171159
|
"edgeDeployments.get",
|
|
169623
171160
|
"edgeDeployments.release",
|
|
@@ -169703,6 +171240,7 @@ SAML Response body for login
|
|
|
169703
171240
|
"flow.setStorageEntry",
|
|
169704
171241
|
"flow.getStorageEntriesMetadata",
|
|
169705
171242
|
"flow.stats",
|
|
171243
|
+
"flow.suggestFunction",
|
|
169706
171244
|
"flows.get",
|
|
169707
171245
|
"flows.getByVersion",
|
|
169708
171246
|
"flows.import",
|
|
@@ -170055,6 +171593,96 @@ Schema for reporting a successful operation with a corresponding execution ID
|
|
|
170055
171593
|
|
|
170056
171594
|
<br/>
|
|
170057
171595
|
|
|
171596
|
+
## Suggest Function Post
|
|
171597
|
+
|
|
171598
|
+
Schema for the body of a workflow suggestion function request
|
|
171599
|
+
|
|
171600
|
+
### <a name="suggest-function-post-schema"></a> Schema
|
|
171601
|
+
|
|
171602
|
+
```json
|
|
171603
|
+
{
|
|
171604
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
171605
|
+
"type": "object",
|
|
171606
|
+
"properties": {
|
|
171607
|
+
"text": {
|
|
171608
|
+
"type": "string",
|
|
171609
|
+
"minLength": 1,
|
|
171610
|
+
"maxLength": 8192
|
|
171611
|
+
}
|
|
171612
|
+
},
|
|
171613
|
+
"required": [
|
|
171614
|
+
"text"
|
|
171615
|
+
],
|
|
171616
|
+
"additionalProperties": false
|
|
171617
|
+
}
|
|
171618
|
+
```
|
|
171619
|
+
### <a name="suggest-function-post-example"></a> Example
|
|
171620
|
+
|
|
171621
|
+
```json
|
|
171622
|
+
{
|
|
171623
|
+
"text": "A function that sorts an array of objects by the name property from z to a"
|
|
171624
|
+
}
|
|
171625
|
+
```
|
|
171626
|
+
|
|
171627
|
+
<br/>
|
|
171628
|
+
|
|
171629
|
+
## Suggest Function Respone
|
|
171630
|
+
|
|
171631
|
+
Schema for the response to a suggest function request
|
|
171632
|
+
|
|
171633
|
+
### <a name="suggest-function-respone-schema"></a> Schema
|
|
171634
|
+
|
|
171635
|
+
```json
|
|
171636
|
+
{
|
|
171637
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
171638
|
+
"type": "object",
|
|
171639
|
+
"properties": {
|
|
171640
|
+
"text": {
|
|
171641
|
+
"type": "string",
|
|
171642
|
+
"maxLength": 32767,
|
|
171643
|
+
"minLength": 1
|
|
171644
|
+
},
|
|
171645
|
+
"responseId": {
|
|
171646
|
+
"type": "string",
|
|
171647
|
+
"minLength": 1,
|
|
171648
|
+
"maxLength": 1024
|
|
171649
|
+
},
|
|
171650
|
+
"finishReason": {
|
|
171651
|
+
"type": "string",
|
|
171652
|
+
"enum": [
|
|
171653
|
+
"FINISH_REASON_UNSPECIFIED",
|
|
171654
|
+
"STOP",
|
|
171655
|
+
"MAX_TOKENS",
|
|
171656
|
+
"SAFETY",
|
|
171657
|
+
"RECITATION",
|
|
171658
|
+
"OTHER",
|
|
171659
|
+
"BLOCKLIST",
|
|
171660
|
+
"PROHIBITED_CONTENT",
|
|
171661
|
+
"SPII",
|
|
171662
|
+
"MALFORMED_FUNCTION_CALL"
|
|
171663
|
+
]
|
|
171664
|
+
}
|
|
171665
|
+
},
|
|
171666
|
+
"required": [
|
|
171667
|
+
"text",
|
|
171668
|
+
"responseId",
|
|
171669
|
+
"finishReason"
|
|
171670
|
+
],
|
|
171671
|
+
"additionalProperties": false
|
|
171672
|
+
}
|
|
171673
|
+
```
|
|
171674
|
+
### <a name="suggest-function-respone-example"></a> Example
|
|
171675
|
+
|
|
171676
|
+
```json
|
|
171677
|
+
{
|
|
171678
|
+
"text": "```javascript\n/**\n * A function to sort an array of objects, by their 'name' property,\n * from the nethermost 'Z' to the foremost 'A'.\n *\n * @param {Array<Object>} arr - The array of objects to be sorted,\n * each object possessing a 'name' property.\n * @returns {Array<Object>} - The sorted array of objects.\n */\nfunction sortObjectsByNameReverse(arr) {\n // Hark! A comparison function, to bend the wills of objects!\n // We shall compare the names, and judge which doth precede the other.\n return arr.sort((a, b) => {\n // Let 'nameA' be the name of the first object, brought low for scrutiny.\n const nameA = a.name.toUpperCase(); // Cast aloft to uppercase, lest lower case betray us!\n // And 'nameB', the name of the second, likewise brought before us.\n const nameB = b.name.toUpperCase(); // Uppercase again, that all be judged as equals!\n\n // Now, to the comparing! A most subtle dance of precedence!\n if (nameA < nameB) {\n // If 'nameA' be found wanting, and falls behind 'nameB'...\n return 1; // ...then 'nameB' shall take precedence, and rise above!\n }\n if (nameA > nameB) {\n // But if 'nameA' doth surpass 'nameB', and standeth taller...\n return -1; // ...then 'nameA' shall hold its place, and 'nameB' shall yield.\n }\n\n // Should they be equal, twins in name and form...\n return 0; // ...then let them remain as they were, neither before nor behind.\n });\n}\n\n// Example Usage: A scene of players, sorted by their given names!\nconst players = [\n { name: \"Hamlet\" },\n { name: \"Ophelia\" },\n { name: \"Lear\" },\n { name: \"Macbeth\" },\n { name: \"Juliet\" },\n];\n\nconst sortedPlayers = sortObjectsByNameReverse(players);\nconsole.log(sortedPlayers); // Behold! A tragedy, properly ordered!\n\n```\n\n**Explanation of the Shakespearean Comments:**\n\n* **Hark!**: An attention-grabbing start, like a herald announcing something important.\n* **Bend the wills of objects!**: A dramatic way of saying \"compare the objects.\"\n* **Brought low for scrutiny**: Figurative language for accessing the `name` property.\n* **Cast aloft to uppercase, lest lower case betray us!**: Converting to uppercase to ensure case-insensitive sorting (avoids confusion with lowercase vs. uppercase letters). The \"betray us\" adds a dramatic flair.\n* **A most subtle dance of precedence!**: Describing the comparison process in a poetic way.\n* **Found wanting, and falls behind**: Describing the comparison result in a theatrical manner.\n* **Take precedence, and rise above!**: Emphasizing the meaning of the return value `1`.\n* **Doth surpass... shall hold its place, and yield**: The inverse of the previous comment, for the `-1` return value.\n* **Twins in name and form**: Describes when the names are equal.\n* **Then let them remain as they were**: meaning return 0, and the original order remains intact.\n* **Behold! A tragedy, properly ordered!**: A dramatic conclusion to the example, linking the sorted array back to the Shakespearean theme.\n\nThe comments attempt to use language that is both descriptive of the code and stylistically reminiscent of Shakespeare's plays, adding a layer of humor and theatricality to the code explanation.\n",
|
|
171679
|
+
"responseId": "YCwSaIeyOfComecPutWYyAg",
|
|
171680
|
+
"finishReason": "STOP"
|
|
171681
|
+
}
|
|
171682
|
+
```
|
|
171683
|
+
|
|
171684
|
+
<br/>
|
|
171685
|
+
|
|
170058
171686
|
## Tag Keys Response
|
|
170059
171687
|
|
|
170060
171688
|
Schema for a list of tag keys
|
|
@@ -172744,6 +174372,8 @@ Schema for the body of a User authentication request
|
|
|
172744
174372
|
"deviceRecipe.*",
|
|
172745
174373
|
"deviceRecipes.*",
|
|
172746
174374
|
"devices.*",
|
|
174375
|
+
"deviceAttribute.*",
|
|
174376
|
+
"deviceAttributes.*",
|
|
172747
174377
|
"edgeDeployment.*",
|
|
172748
174378
|
"edgeDeployments.*",
|
|
172749
174379
|
"embeddedDeployment.*",
|
|
@@ -172890,6 +174520,11 @@ Schema for the body of a User authentication request
|
|
|
172890
174520
|
"devices.sendCommand",
|
|
172891
174521
|
"devices.tagKeys",
|
|
172892
174522
|
"devices.tagValues",
|
|
174523
|
+
"deviceAttribute.get",
|
|
174524
|
+
"deviceAttribute.patch",
|
|
174525
|
+
"deviceAttribute.delete",
|
|
174526
|
+
"deviceAttributes.get",
|
|
174527
|
+
"deviceAttributes.post",
|
|
172893
174528
|
"edgeDeployment.get",
|
|
172894
174529
|
"edgeDeployments.get",
|
|
172895
174530
|
"edgeDeployments.release",
|
|
@@ -172975,6 +174610,7 @@ Schema for the body of a User authentication request
|
|
|
172975
174610
|
"flow.setStorageEntry",
|
|
172976
174611
|
"flow.getStorageEntriesMetadata",
|
|
172977
174612
|
"flow.stats",
|
|
174613
|
+
"flow.suggestFunction",
|
|
172978
174614
|
"flows.get",
|
|
172979
174615
|
"flows.getByVersion",
|
|
172980
174616
|
"flows.import",
|
|
@@ -173343,6 +174979,8 @@ Schema for the body of a User creation request
|
|
|
173343
174979
|
"deviceRecipe.*",
|
|
173344
174980
|
"deviceRecipes.*",
|
|
173345
174981
|
"devices.*",
|
|
174982
|
+
"deviceAttribute.*",
|
|
174983
|
+
"deviceAttributes.*",
|
|
173346
174984
|
"edgeDeployment.*",
|
|
173347
174985
|
"edgeDeployments.*",
|
|
173348
174986
|
"embeddedDeployment.*",
|
|
@@ -173489,6 +175127,11 @@ Schema for the body of a User creation request
|
|
|
173489
175127
|
"devices.sendCommand",
|
|
173490
175128
|
"devices.tagKeys",
|
|
173491
175129
|
"devices.tagValues",
|
|
175130
|
+
"deviceAttribute.get",
|
|
175131
|
+
"deviceAttribute.patch",
|
|
175132
|
+
"deviceAttribute.delete",
|
|
175133
|
+
"deviceAttributes.get",
|
|
175134
|
+
"deviceAttributes.post",
|
|
173492
175135
|
"edgeDeployment.get",
|
|
173493
175136
|
"edgeDeployments.get",
|
|
173494
175137
|
"edgeDeployments.release",
|
|
@@ -173574,6 +175217,7 @@ Schema for the body of a User creation request
|
|
|
173574
175217
|
"flow.setStorageEntry",
|
|
173575
175218
|
"flow.getStorageEntriesMetadata",
|
|
173576
175219
|
"flow.stats",
|
|
175220
|
+
"flow.suggestFunction",
|
|
173577
175221
|
"flows.get",
|
|
173578
175222
|
"flows.getByVersion",
|
|
173579
175223
|
"flows.import",
|