losant_rest 1.13.1 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +2919 -507
- data/docs/application.md +1 -1
- data/docs/device.md +43 -0
- data/docs/devices.md +39 -0
- data/docs/edgeDeployment.md +49 -0
- data/docs/flow.md +1 -1
- data/docs/instanceOrg.md +2 -0
- data/docs/instanceOrgInvite.md +139 -0
- data/docs/instanceOrgInvites.md +96 -0
- data/docs/instanceOrgMembers.md +2 -2
- data/docs/instanceOrgs.md +1 -1
- data/docs/me.md +1 -1
- data/docs/org.md +1 -1
- data/lib/losant_rest.rb +3 -0
- data/lib/losant_rest/client.rb +14 -2
- data/lib/losant_rest/device.rb +50 -0
- data/lib/losant_rest/devices.rb +46 -0
- data/lib/losant_rest/edge_deployment.rb +81 -0
- data/lib/losant_rest/flow.rb +1 -1
- data/lib/losant_rest/instance_org.rb +4 -0
- data/lib/losant_rest/instance_org_invite.rb +182 -0
- data/lib/losant_rest/instance_org_invites.rb +138 -0
- data/lib/losant_rest/instance_org_members.rb +2 -2
- data/lib/losant_rest/instance_orgs.rb +2 -2
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/apiTokenPost.json +11 -0
- data/schemas/devicePayloadCounts.json +24 -0
- data/schemas/devicesExportPayloadCountPost.json +1350 -0
- data/schemas/edgeDeployment.json +16 -0
- data/schemas/edgeDeployments.json +16 -0
- data/schemas/experienceLinkedResources.json +45 -0
- data/schemas/flow.json +15 -0
- data/schemas/flowPatch.json +15 -0
- data/schemas/flowPost.json +15 -0
- data/schemas/flowVersion.json +30 -0
- data/schemas/flowVersionPost.json +15 -0
- data/schemas/flowVersions.json +30 -0
- data/schemas/flows.json +15 -0
- data/schemas/flowsImportPost.json +30 -0
- data/schemas/flowsImportResult.json +45 -0
- data/schemas/githubLogin.json +11 -0
- data/schemas/historicalSummary.json +60 -28
- data/schemas/instanceMember.json +4 -0
- data/schemas/instanceMemberPost.json +18 -3
- data/schemas/instanceMembers.json +8 -0
- data/schemas/instanceOrgMember.json +8 -0
- data/schemas/instanceOrgMembers.json +8 -0
- data/schemas/instanceOrgs.json +4 -0
- data/schemas/me.json +30 -14
- data/schemas/notebook.json +30 -0
- data/schemas/notebookPatch.json +30 -0
- data/schemas/notebookPost.json +30 -0
- data/schemas/notebooks.json +30 -0
- data/schemas/org.json +30 -14
- data/schemas/orgInvite.json +90 -0
- data/schemas/orgInviteCollection.json +130 -0
- data/schemas/orgInvites.json +82 -77
- data/schemas/orgRoleInfo.json +69 -0
- data/schemas/orgs.json +30 -14
- data/schemas/payloadStats.json +28 -12
- data/schemas/userCredentials.json +11 -0
- data/schemas/userPost.json +11 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +13 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6701ee4eb911ee9efd7fc3e9737f3ca339a8b969dfa6014363b05dda31c93ea1
|
4
|
+
data.tar.gz: 6160f6193122d8b0ec6b526907652046209514d1ea20aac52be1c367453dd20c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 97a44fed4fd435e7557881d430f18a1e47152b63b70d1f4a7d0a14b1d7ba07a8956b3c6920db027f4257d26f5347a6a3f32c0eef75ce2e2b2cbd729e710b47a4
|
7
|
+
data.tar.gz: daf15f6cb4506faa304a23a7037790875db6eb31a334610d4fd2851cc6e847d573a91ee860e128be6c5023b3146598eb5cc00a4ee00b873302a17bb7cb5cbb4b
|
data/docs/_schemas.md
CHANGED
@@ -82,6 +82,7 @@
|
|
82
82
|
* [Device Credentials](#device-credentials)
|
83
83
|
* [Device Log](#device-log)
|
84
84
|
* [Device Patch](#device-patch)
|
85
|
+
* [Device Payload Counts](#device-payload-counts)
|
85
86
|
* [Device Post](#device-post)
|
86
87
|
* [Device Recipe](#device-recipe)
|
87
88
|
* [Device Recipe Bulk Create](#device-recipe-bulk-create)
|
@@ -97,6 +98,7 @@
|
|
97
98
|
* [Devices](#devices)
|
98
99
|
* [Devices Data Removed](#devices-data-removed)
|
99
100
|
* [Devices Delete Post](#devices-delete-post)
|
101
|
+
* [Devices Payload Count Export Post](#devices-payload-count-export-post)
|
100
102
|
* [Devices Metadata Export Post](#devices-metadata-export-post)
|
101
103
|
* [Devices Patch](#devices-patch)
|
102
104
|
* [Devices Remove Data Post](#devices-remove-data-post)
|
@@ -210,7 +212,9 @@
|
|
210
212
|
* [Notebook Post](#notebook-post)
|
211
213
|
* [Notebooks](#notebooks)
|
212
214
|
* [Organization](#organization)
|
215
|
+
* [Organization Invitation](#organization-invitation)
|
213
216
|
* [Organization Invitation Action](#organization-invitation-action)
|
217
|
+
* [Instance Organization Invitations](#instance-organization-invitations)
|
214
218
|
* [Organization Invitation Information](#organization-invitation-information)
|
215
219
|
* [Organization Invitation Post](#organization-invitation-post)
|
216
220
|
* [Organization Invitation Result](#organization-invitation-result)
|
@@ -218,11 +222,12 @@
|
|
218
222
|
* [Organization Member Patch](#organization-member-patch)
|
219
223
|
* [Organization Patch](#organization-patch)
|
220
224
|
* [Organization Post](#organization-post)
|
225
|
+
* [Organization Role Info](#organization-role-info)
|
221
226
|
* [Organizations](#organizations)
|
222
227
|
* [Password Reset Finish](#password-reset-finish)
|
223
228
|
* [Password Reset Input](#password-reset-input)
|
224
229
|
* [Password Reset Response](#password-reset-response)
|
225
|
-
* [Payload
|
230
|
+
* [Payload Stats](#payload-stats)
|
226
231
|
* [Recent Item](#recent-item)
|
227
232
|
* [Recent Item List](#recent-item-list)
|
228
233
|
* [Resource Transfer](#resource-transfer)
|
@@ -6834,6 +6839,7 @@ Schema for the body of an API Token creation request
|
|
6834
6839
|
"deviceRecipe.*",
|
6835
6840
|
"deviceRecipes.*",
|
6836
6841
|
"devices.*",
|
6842
|
+
"edgeDeployment.*",
|
6837
6843
|
"edgeDeployments.*",
|
6838
6844
|
"event.*",
|
6839
6845
|
"events.*",
|
@@ -6934,6 +6940,7 @@ Schema for the body of an API Token creation request
|
|
6934
6940
|
"device.getLogEntries",
|
6935
6941
|
"device.getState",
|
6936
6942
|
"device.patch",
|
6943
|
+
"device.payloadCounts",
|
6937
6944
|
"device.removeData",
|
6938
6945
|
"device.sendCommand",
|
6939
6946
|
"device.sendState",
|
@@ -6952,10 +6959,12 @@ Schema for the body of an API Token creation request
|
|
6952
6959
|
"devices.detailedSummary",
|
6953
6960
|
"devices.export",
|
6954
6961
|
"devices.get",
|
6962
|
+
"devices.payloadCounts",
|
6955
6963
|
"devices.post",
|
6956
6964
|
"devices.sendCommand",
|
6957
6965
|
"devices.tagKeys",
|
6958
6966
|
"devices.tagValues",
|
6967
|
+
"edgeDeployment.get",
|
6959
6968
|
"edgeDeployments.get",
|
6960
6969
|
"edgeDeployments.release",
|
6961
6970
|
"edgeDeployments.remove",
|
@@ -7137,6 +7146,13 @@ Schema for the body of an API Token creation request
|
|
7137
7146
|
"instanceOrgMembers.*",
|
7138
7147
|
"instanceOrgMembers.get",
|
7139
7148
|
"instanceOrgMembers.post",
|
7149
|
+
"instanceOrgInvite.*",
|
7150
|
+
"instanceOrgInvite.get",
|
7151
|
+
"instanceOrgInvite.delete",
|
7152
|
+
"instanceOrgInvite.resendInvite",
|
7153
|
+
"instanceOrgInvites.*",
|
7154
|
+
"instanceOrgInvites.get",
|
7155
|
+
"instanceOrgInvites.post",
|
7140
7156
|
"instanceApiTokens.*",
|
7141
7157
|
"instanceApiTokens.get",
|
7142
7158
|
"instanceApiTokens.post",
|
@@ -7830,7 +7846,7 @@ Schema for the body of an application template import request
|
|
7830
7846
|
```json
|
7831
7847
|
{
|
7832
7848
|
"templateId": "575ec8687ae143cd83dc4a97",
|
7833
|
-
"email": "email
|
7849
|
+
"email": "email@example.com"
|
7834
7850
|
}
|
7835
7851
|
```
|
7836
7852
|
|
@@ -7987,8 +8003,8 @@ Schema for a single Application Certificate
|
|
7987
8003
|
"certificateInfo": {
|
7988
8004
|
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
7989
8005
|
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
7990
|
-
"commonName": "
|
7991
|
-
"issuerName": "
|
8006
|
+
"commonName": "example.com",
|
8007
|
+
"issuerName": "Example Issuer",
|
7992
8008
|
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
7993
8009
|
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
7994
8010
|
},
|
@@ -8153,8 +8169,8 @@ Schema for a collection of Application Certificate Authorities
|
|
8153
8169
|
{
|
8154
8170
|
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
8155
8171
|
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
8156
|
-
"commonName": "
|
8157
|
-
"issuerName": "
|
8172
|
+
"commonName": "example.com",
|
8173
|
+
"issuerName": "Example Issuer",
|
8158
8174
|
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
8159
8175
|
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
8160
8176
|
}
|
@@ -8279,8 +8295,8 @@ Schema for a single Application Certificate Authority
|
|
8279
8295
|
{
|
8280
8296
|
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
8281
8297
|
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
8282
|
-
"commonName": "
|
8283
|
-
"issuerName": "
|
8298
|
+
"commonName": "example.com",
|
8299
|
+
"issuerName": "Example Issuer",
|
8284
8300
|
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
8285
8301
|
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
8286
8302
|
}
|
@@ -8772,8 +8788,8 @@ Schema for a collection of Application Certificates
|
|
8772
8788
|
"certificateInfo": {
|
8773
8789
|
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
8774
8790
|
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
8775
|
-
"commonName": "
|
8776
|
-
"issuerName": "
|
8791
|
+
"commonName": "example.com",
|
8792
|
+
"issuerName": "Example Issuer",
|
8777
8793
|
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
8778
8794
|
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
8779
8795
|
},
|
@@ -15082,7 +15098,7 @@ Schema for the body of an application export request
|
|
15082
15098
|
{
|
15083
15099
|
"includeFiles": true,
|
15084
15100
|
"includeDevices": true,
|
15085
|
-
"email": "test@
|
15101
|
+
"email": "test@example.com"
|
15086
15102
|
}
|
15087
15103
|
```
|
15088
15104
|
|
@@ -15110,7 +15126,7 @@ Schema for an application export result
|
|
15110
15126
|
|
15111
15127
|
```json
|
15112
15128
|
{
|
15113
|
-
"url": "https://
|
15129
|
+
"url": "https://example.com/applicationExport.zip"
|
15114
15130
|
}
|
15115
15131
|
```
|
15116
15132
|
|
@@ -16605,9 +16621,9 @@ Schema for a single Application Template
|
|
16605
16621
|
"name": "smart environment",
|
16606
16622
|
"description": "a smart env set up",
|
16607
16623
|
"public": true,
|
16608
|
-
"authorName": "
|
16609
|
-
"authorUrl": "https://
|
16610
|
-
"templateUrl": "https://
|
16624
|
+
"authorName": "Example Author",
|
16625
|
+
"authorUrl": "https://example.com/theAuther",
|
16626
|
+
"templateUrl": "https://example.com/theTemplate",
|
16611
16627
|
"summary": {
|
16612
16628
|
"applicationCertificateAuthorityCount": 0,
|
16613
16629
|
"dashboardCount": 0,
|
@@ -16941,9 +16957,9 @@ Schema for a collection of Application Templates
|
|
16941
16957
|
"name": "smart environment",
|
16942
16958
|
"description": "a smart env set up",
|
16943
16959
|
"public": true,
|
16944
|
-
"authorName": "
|
16945
|
-
"authorUrl": "https://
|
16946
|
-
"templateUrl": "https://
|
16960
|
+
"authorName": "Example Author",
|
16961
|
+
"authorUrl": "https://example.com/theAuther",
|
16962
|
+
"templateUrl": "https://example.com/theTemplate",
|
16947
16963
|
"summary": {
|
16948
16964
|
"applicationCertificateAuthorityCount": 0,
|
16949
16965
|
"dashboardCount": 0,
|
@@ -17601,7 +17617,7 @@ Schema for a single Audit Log entry
|
|
17601
17617
|
"primaryTargetName": "My Application",
|
17602
17618
|
"actorId": "575ed70c7ae143cd83dc4aa9",
|
17603
17619
|
"actorType": "User",
|
17604
|
-
"actorName": "example
|
17620
|
+
"actorName": "actor@example.com",
|
17605
17621
|
"requestResource": "application",
|
17606
17622
|
"requestAction": "delete",
|
17607
17623
|
"requestQueryParams": {},
|
@@ -17954,7 +17970,7 @@ Schema for a collection of Audit Logs
|
|
17954
17970
|
"primaryTargetName": "My Application",
|
17955
17971
|
"actorId": "575ed70c7ae143cd83dc4aa9",
|
17956
17972
|
"actorType": "User",
|
17957
|
-
"actorName": "example
|
17973
|
+
"actorName": "actor@example.com",
|
17958
17974
|
"requestResource": "application",
|
17959
17975
|
"requestAction": "delete",
|
17960
17976
|
"requestQueryParams": {},
|
@@ -24015,7 +24031,7 @@ Schema for a single Dashboard
|
|
24015
24031
|
"dashboardId": "575ece2b7ae143cd83dc4a9b",
|
24016
24032
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
24017
24033
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
24018
|
-
"organizationName": "
|
24034
|
+
"organizationName": "Example Org",
|
24019
24035
|
"organizationIconColor": "#284fff",
|
24020
24036
|
"ownerType": "organization",
|
24021
24037
|
"ownerId": "58238ff2fe7b4b01009a0554",
|
@@ -24030,7 +24046,7 @@ Schema for a single Dashboard
|
|
24030
24046
|
"reportConfigs": [
|
24031
24047
|
{
|
24032
24048
|
"toEmail": [
|
24033
|
-
"
|
24049
|
+
"email@example.com"
|
24034
24050
|
],
|
24035
24051
|
"cron": "0 0 12 * * TUE-THU",
|
24036
24052
|
"theme": "dark",
|
@@ -35654,7 +35670,7 @@ Schema for the body of a Dashboard report request
|
|
35654
35670
|
```json
|
35655
35671
|
{
|
35656
35672
|
"toEmail": [
|
35657
|
-
"
|
35673
|
+
"email@example.com"
|
35658
35674
|
],
|
35659
35675
|
"subject": "Dashboard Report",
|
35660
35676
|
"message": "Lookit",
|
@@ -41529,7 +41545,7 @@ Schema for a collection of Dashboards
|
|
41529
41545
|
"dashboardId": "575ece2b7ae143cd83dc4a9b",
|
41530
41546
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
41531
41547
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
41532
|
-
"organizationName": "
|
41548
|
+
"organizationName": "Example Org",
|
41533
41549
|
"organizationIconColor": "#284fff",
|
41534
41550
|
"ownerType": "organization",
|
41535
41551
|
"ownerId": "58238ff2fe7b4b01009a0554",
|
@@ -41544,7 +41560,7 @@ Schema for a collection of Dashboards
|
|
41544
41560
|
"reportConfigs": [
|
41545
41561
|
{
|
41546
41562
|
"toEmail": [
|
41547
|
-
"
|
41563
|
+
"email@example.com"
|
41548
41564
|
],
|
41549
41565
|
"cron": "0 0 12 * * TUE-THU",
|
41550
41566
|
"theme": "dark",
|
@@ -41865,7 +41881,7 @@ Schema for exporting data devices query
|
|
41865
41881
|
|
41866
41882
|
```json
|
41867
41883
|
{
|
41868
|
-
"email": "example
|
41884
|
+
"email": "export@example.com",
|
41869
41885
|
"deviceIds": [
|
41870
41886
|
"575ecf887ae143cd83dc4aa2",
|
41871
41887
|
"575ef5c97ae143cd83dc4aac"
|
@@ -43993,292 +44009,337 @@ Schema for the body of a Device modification request
|
|
43993
44009
|
|
43994
44010
|
<br/>
|
43995
44011
|
|
43996
|
-
## Device
|
44012
|
+
## Device Payload Counts
|
43997
44013
|
|
43998
|
-
Schema for the
|
44014
|
+
Schema for the result of a device payload count request
|
43999
44015
|
|
44000
|
-
### <a name="device-
|
44016
|
+
### <a name="device-payload-counts-schema"></a> Schema
|
44001
44017
|
|
44002
44018
|
```json
|
44003
44019
|
{
|
44004
44020
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
44005
44021
|
"type": "object",
|
44006
44022
|
"properties": {
|
44007
|
-
"
|
44008
|
-
"type": "
|
44009
|
-
"minLength": 1,
|
44010
|
-
"maxLength": 255
|
44011
|
-
},
|
44012
|
-
"description": {
|
44013
|
-
"type": "string",
|
44014
|
-
"maxLength": 32767
|
44015
|
-
},
|
44016
|
-
"tags": {
|
44017
|
-
"type": "array",
|
44018
|
-
"items": {
|
44019
|
-
"type": "object",
|
44020
|
-
"properties": {
|
44021
|
-
"key": {
|
44022
|
-
"type": "string",
|
44023
|
-
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44024
|
-
},
|
44025
|
-
"value": {
|
44026
|
-
"type": "string",
|
44027
|
-
"minLength": 1,
|
44028
|
-
"maxLength": 255
|
44029
|
-
}
|
44030
|
-
},
|
44031
|
-
"required": [
|
44032
|
-
"key",
|
44033
|
-
"value"
|
44034
|
-
],
|
44035
|
-
"additionalProperties": false
|
44036
|
-
},
|
44037
|
-
"maxItems": 100
|
44038
|
-
},
|
44039
|
-
"attributes": {
|
44040
|
-
"type": "array",
|
44041
|
-
"items": {
|
44042
|
-
"type": "object",
|
44043
|
-
"properties": {
|
44044
|
-
"name": {
|
44045
|
-
"type": "string",
|
44046
|
-
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44047
|
-
},
|
44048
|
-
"dataType": {
|
44049
|
-
"type": "string",
|
44050
|
-
"enum": [
|
44051
|
-
"string",
|
44052
|
-
"number",
|
44053
|
-
"gps",
|
44054
|
-
"boolean",
|
44055
|
-
"blob"
|
44056
|
-
]
|
44057
|
-
},
|
44058
|
-
"contentType": {
|
44059
|
-
"type": "string",
|
44060
|
-
"maxLength": 64
|
44061
|
-
},
|
44062
|
-
"description": {
|
44063
|
-
"type": "string",
|
44064
|
-
"maxLength": 32767
|
44065
|
-
},
|
44066
|
-
"attributeTags": {
|
44067
|
-
"type": "object",
|
44068
|
-
"patternProperties": {
|
44069
|
-
"^[0-9a-zA-Z_-]{1,255}$": {
|
44070
|
-
"type": "string",
|
44071
|
-
"minLength": 1,
|
44072
|
-
"maxLength": 255
|
44073
|
-
}
|
44074
|
-
},
|
44075
|
-
"additionalProperties": false
|
44076
|
-
},
|
44077
|
-
"system": {
|
44078
|
-
"type": "object",
|
44079
|
-
"properties": {
|
44080
|
-
"aggregation": {
|
44081
|
-
"type": "string",
|
44082
|
-
"enum": [
|
44083
|
-
"FIRST",
|
44084
|
-
"LAST",
|
44085
|
-
"COUNT",
|
44086
|
-
"MAX",
|
44087
|
-
"MIN",
|
44088
|
-
"MEDIAN",
|
44089
|
-
"MEAN",
|
44090
|
-
"SUM",
|
44091
|
-
"STD_DEV"
|
44092
|
-
]
|
44093
|
-
},
|
44094
|
-
"aggregationOptions": {
|
44095
|
-
"type": "array",
|
44096
|
-
"items": {
|
44097
|
-
"type": "object",
|
44098
|
-
"additionalProperties": false
|
44099
|
-
},
|
44100
|
-
"additionalProperties": false,
|
44101
|
-
"maxItems": 0
|
44102
|
-
},
|
44103
|
-
"childAttributes": {
|
44104
|
-
"type": "array",
|
44105
|
-
"items": {
|
44106
|
-
"type": "object",
|
44107
|
-
"properties": {
|
44108
|
-
"name": {
|
44109
|
-
"type": "string",
|
44110
|
-
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44111
|
-
},
|
44112
|
-
"mode": {
|
44113
|
-
"type": "string",
|
44114
|
-
"enum": [
|
44115
|
-
"all",
|
44116
|
-
"whitelist",
|
44117
|
-
"blacklist"
|
44118
|
-
]
|
44119
|
-
},
|
44120
|
-
"deviceIds": {
|
44121
|
-
"type": "array",
|
44122
|
-
"items": {
|
44123
|
-
"type": "string",
|
44124
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
44125
|
-
},
|
44126
|
-
"maxItems": 1000
|
44127
|
-
},
|
44128
|
-
"deviceTags": {
|
44129
|
-
"type": "array",
|
44130
|
-
"items": {
|
44131
|
-
"type": "object",
|
44132
|
-
"properties": {
|
44133
|
-
"key": {
|
44134
|
-
"type": "string",
|
44135
|
-
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44136
|
-
},
|
44137
|
-
"value": {
|
44138
|
-
"type": "string",
|
44139
|
-
"minLength": 1,
|
44140
|
-
"maxLength": 255
|
44141
|
-
}
|
44142
|
-
},
|
44143
|
-
"additionalProperties": false
|
44144
|
-
},
|
44145
|
-
"maxItems": 100
|
44146
|
-
}
|
44147
|
-
},
|
44148
|
-
"required": [
|
44149
|
-
"name",
|
44150
|
-
"mode"
|
44151
|
-
],
|
44152
|
-
"additionalProperties": false
|
44153
|
-
},
|
44154
|
-
"maxItems": 256
|
44155
|
-
}
|
44156
|
-
},
|
44157
|
-
"additionalProperties": false
|
44158
|
-
}
|
44159
|
-
},
|
44160
|
-
"required": [
|
44161
|
-
"name",
|
44162
|
-
"dataType"
|
44163
|
-
],
|
44164
|
-
"additionalProperties": false
|
44165
|
-
},
|
44166
|
-
"maxItems": 256
|
44023
|
+
"deviceCommand": {
|
44024
|
+
"type": "number"
|
44167
44025
|
},
|
44168
|
-
"
|
44169
|
-
"type": "
|
44170
|
-
"enum": [
|
44171
|
-
"standalone",
|
44172
|
-
"gateway",
|
44173
|
-
"peripheral",
|
44174
|
-
"floating",
|
44175
|
-
"edgeCompute",
|
44176
|
-
"system"
|
44177
|
-
]
|
44026
|
+
"deviceConnect": {
|
44027
|
+
"type": "number"
|
44178
44028
|
},
|
44179
|
-
"
|
44180
|
-
"type": "
|
44181
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
44029
|
+
"deviceDisconnect": {
|
44030
|
+
"type": "number"
|
44182
44031
|
},
|
44183
|
-
"
|
44184
|
-
"
|
44185
|
-
{
|
44186
|
-
"type": "string",
|
44187
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
44188
|
-
},
|
44189
|
-
{
|
44190
|
-
"type": "null"
|
44191
|
-
}
|
44192
|
-
]
|
44032
|
+
"deviceState": {
|
44033
|
+
"type": "number"
|
44193
44034
|
},
|
44194
|
-
"
|
44195
|
-
"type": "
|
44196
|
-
"minimum": 5,
|
44197
|
-
"maximum": 3600
|
44035
|
+
"mqttIn": {
|
44036
|
+
"type": "number"
|
44198
44037
|
},
|
44199
|
-
"
|
44200
|
-
"type": "
|
44038
|
+
"mqttOut": {
|
44039
|
+
"type": "number"
|
44201
44040
|
}
|
44202
|
-
}
|
44203
|
-
"additionalProperties": false,
|
44204
|
-
"required": [
|
44205
|
-
"name"
|
44206
|
-
]
|
44041
|
+
}
|
44207
44042
|
}
|
44208
44043
|
```
|
44209
|
-
### <a name="device-
|
44044
|
+
### <a name="device-payload-counts-example"></a> Example
|
44210
44045
|
|
44211
44046
|
```json
|
44212
44047
|
{
|
44213
|
-
"
|
44214
|
-
"
|
44215
|
-
"
|
44216
|
-
|
44217
|
-
"key": "TagKey",
|
44218
|
-
"value": "TagValue"
|
44219
|
-
}
|
44220
|
-
],
|
44221
|
-
"attributes": [
|
44222
|
-
{
|
44223
|
-
"name": "voltage",
|
44224
|
-
"dataType": "number"
|
44225
|
-
}
|
44226
|
-
],
|
44227
|
-
"deviceClass": "standalone"
|
44048
|
+
"deviceState": 1244049,
|
44049
|
+
"mqttOut": 12,
|
44050
|
+
"deviceConnect": 1016,
|
44051
|
+
"deviceDisconnect": 1016
|
44228
44052
|
}
|
44229
44053
|
```
|
44230
44054
|
|
44231
44055
|
<br/>
|
44232
44056
|
|
44233
|
-
## Device
|
44057
|
+
## Device Post
|
44234
44058
|
|
44235
|
-
Schema for a
|
44059
|
+
Schema for the body of a Device creation request
|
44236
44060
|
|
44237
|
-
### <a name="device-
|
44061
|
+
### <a name="device-post-schema"></a> Schema
|
44238
44062
|
|
44239
44063
|
```json
|
44240
44064
|
{
|
44241
44065
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
44242
44066
|
"type": "object",
|
44243
44067
|
"properties": {
|
44244
|
-
"id": {
|
44245
|
-
"type": "string",
|
44246
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
44247
|
-
},
|
44248
|
-
"deviceRecipeId": {
|
44249
|
-
"type": "string",
|
44250
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
44251
|
-
},
|
44252
|
-
"applicationId": {
|
44253
|
-
"type": "string",
|
44254
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
44255
|
-
},
|
44256
|
-
"creationDate": {
|
44257
|
-
"type": "string",
|
44258
|
-
"format": "date-time"
|
44259
|
-
},
|
44260
|
-
"lastUpdated": {
|
44261
|
-
"type": "string",
|
44262
|
-
"format": "date-time"
|
44263
|
-
},
|
44264
44068
|
"name": {
|
44265
44069
|
"type": "string",
|
44266
44070
|
"minLength": 1,
|
44267
44071
|
"maxLength": 255
|
44268
44072
|
},
|
44269
|
-
"deviceName": {
|
44270
|
-
"type": "string",
|
44271
|
-
"minLength": 1,
|
44272
|
-
"maxLength": 255
|
44273
|
-
},
|
44274
44073
|
"description": {
|
44275
44074
|
"type": "string",
|
44276
44075
|
"maxLength": 32767
|
44277
44076
|
},
|
44278
|
-
"
|
44279
|
-
"type": "
|
44280
|
-
"
|
44281
|
-
|
44077
|
+
"tags": {
|
44078
|
+
"type": "array",
|
44079
|
+
"items": {
|
44080
|
+
"type": "object",
|
44081
|
+
"properties": {
|
44082
|
+
"key": {
|
44083
|
+
"type": "string",
|
44084
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44085
|
+
},
|
44086
|
+
"value": {
|
44087
|
+
"type": "string",
|
44088
|
+
"minLength": 1,
|
44089
|
+
"maxLength": 255
|
44090
|
+
}
|
44091
|
+
},
|
44092
|
+
"required": [
|
44093
|
+
"key",
|
44094
|
+
"value"
|
44095
|
+
],
|
44096
|
+
"additionalProperties": false
|
44097
|
+
},
|
44098
|
+
"maxItems": 100
|
44099
|
+
},
|
44100
|
+
"attributes": {
|
44101
|
+
"type": "array",
|
44102
|
+
"items": {
|
44103
|
+
"type": "object",
|
44104
|
+
"properties": {
|
44105
|
+
"name": {
|
44106
|
+
"type": "string",
|
44107
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44108
|
+
},
|
44109
|
+
"dataType": {
|
44110
|
+
"type": "string",
|
44111
|
+
"enum": [
|
44112
|
+
"string",
|
44113
|
+
"number",
|
44114
|
+
"gps",
|
44115
|
+
"boolean",
|
44116
|
+
"blob"
|
44117
|
+
]
|
44118
|
+
},
|
44119
|
+
"contentType": {
|
44120
|
+
"type": "string",
|
44121
|
+
"maxLength": 64
|
44122
|
+
},
|
44123
|
+
"description": {
|
44124
|
+
"type": "string",
|
44125
|
+
"maxLength": 32767
|
44126
|
+
},
|
44127
|
+
"attributeTags": {
|
44128
|
+
"type": "object",
|
44129
|
+
"patternProperties": {
|
44130
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
44131
|
+
"type": "string",
|
44132
|
+
"minLength": 1,
|
44133
|
+
"maxLength": 255
|
44134
|
+
}
|
44135
|
+
},
|
44136
|
+
"additionalProperties": false
|
44137
|
+
},
|
44138
|
+
"system": {
|
44139
|
+
"type": "object",
|
44140
|
+
"properties": {
|
44141
|
+
"aggregation": {
|
44142
|
+
"type": "string",
|
44143
|
+
"enum": [
|
44144
|
+
"FIRST",
|
44145
|
+
"LAST",
|
44146
|
+
"COUNT",
|
44147
|
+
"MAX",
|
44148
|
+
"MIN",
|
44149
|
+
"MEDIAN",
|
44150
|
+
"MEAN",
|
44151
|
+
"SUM",
|
44152
|
+
"STD_DEV"
|
44153
|
+
]
|
44154
|
+
},
|
44155
|
+
"aggregationOptions": {
|
44156
|
+
"type": "array",
|
44157
|
+
"items": {
|
44158
|
+
"type": "object",
|
44159
|
+
"additionalProperties": false
|
44160
|
+
},
|
44161
|
+
"additionalProperties": false,
|
44162
|
+
"maxItems": 0
|
44163
|
+
},
|
44164
|
+
"childAttributes": {
|
44165
|
+
"type": "array",
|
44166
|
+
"items": {
|
44167
|
+
"type": "object",
|
44168
|
+
"properties": {
|
44169
|
+
"name": {
|
44170
|
+
"type": "string",
|
44171
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44172
|
+
},
|
44173
|
+
"mode": {
|
44174
|
+
"type": "string",
|
44175
|
+
"enum": [
|
44176
|
+
"all",
|
44177
|
+
"whitelist",
|
44178
|
+
"blacklist"
|
44179
|
+
]
|
44180
|
+
},
|
44181
|
+
"deviceIds": {
|
44182
|
+
"type": "array",
|
44183
|
+
"items": {
|
44184
|
+
"type": "string",
|
44185
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
44186
|
+
},
|
44187
|
+
"maxItems": 1000
|
44188
|
+
},
|
44189
|
+
"deviceTags": {
|
44190
|
+
"type": "array",
|
44191
|
+
"items": {
|
44192
|
+
"type": "object",
|
44193
|
+
"properties": {
|
44194
|
+
"key": {
|
44195
|
+
"type": "string",
|
44196
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
44197
|
+
},
|
44198
|
+
"value": {
|
44199
|
+
"type": "string",
|
44200
|
+
"minLength": 1,
|
44201
|
+
"maxLength": 255
|
44202
|
+
}
|
44203
|
+
},
|
44204
|
+
"additionalProperties": false
|
44205
|
+
},
|
44206
|
+
"maxItems": 100
|
44207
|
+
}
|
44208
|
+
},
|
44209
|
+
"required": [
|
44210
|
+
"name",
|
44211
|
+
"mode"
|
44212
|
+
],
|
44213
|
+
"additionalProperties": false
|
44214
|
+
},
|
44215
|
+
"maxItems": 256
|
44216
|
+
}
|
44217
|
+
},
|
44218
|
+
"additionalProperties": false
|
44219
|
+
}
|
44220
|
+
},
|
44221
|
+
"required": [
|
44222
|
+
"name",
|
44223
|
+
"dataType"
|
44224
|
+
],
|
44225
|
+
"additionalProperties": false
|
44226
|
+
},
|
44227
|
+
"maxItems": 256
|
44228
|
+
},
|
44229
|
+
"deviceClass": {
|
44230
|
+
"type": "string",
|
44231
|
+
"enum": [
|
44232
|
+
"standalone",
|
44233
|
+
"gateway",
|
44234
|
+
"peripheral",
|
44235
|
+
"floating",
|
44236
|
+
"edgeCompute",
|
44237
|
+
"system"
|
44238
|
+
]
|
44239
|
+
},
|
44240
|
+
"gatewayId": {
|
44241
|
+
"type": "string",
|
44242
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
44243
|
+
},
|
44244
|
+
"parentId": {
|
44245
|
+
"oneOf": [
|
44246
|
+
{
|
44247
|
+
"type": "string",
|
44248
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
44249
|
+
},
|
44250
|
+
{
|
44251
|
+
"type": "null"
|
44252
|
+
}
|
44253
|
+
]
|
44254
|
+
},
|
44255
|
+
"systemInterval": {
|
44256
|
+
"type": "integer",
|
44257
|
+
"minimum": 5,
|
44258
|
+
"maximum": 3600
|
44259
|
+
},
|
44260
|
+
"keepDuplicates": {
|
44261
|
+
"type": "boolean"
|
44262
|
+
}
|
44263
|
+
},
|
44264
|
+
"additionalProperties": false,
|
44265
|
+
"required": [
|
44266
|
+
"name"
|
44267
|
+
]
|
44268
|
+
}
|
44269
|
+
```
|
44270
|
+
### <a name="device-post-example"></a> Example
|
44271
|
+
|
44272
|
+
```json
|
44273
|
+
{
|
44274
|
+
"name": "My New Device",
|
44275
|
+
"description": "Description of my new device",
|
44276
|
+
"tags": [
|
44277
|
+
{
|
44278
|
+
"key": "TagKey",
|
44279
|
+
"value": "TagValue"
|
44280
|
+
}
|
44281
|
+
],
|
44282
|
+
"attributes": [
|
44283
|
+
{
|
44284
|
+
"name": "voltage",
|
44285
|
+
"dataType": "number"
|
44286
|
+
}
|
44287
|
+
],
|
44288
|
+
"deviceClass": "standalone"
|
44289
|
+
}
|
44290
|
+
```
|
44291
|
+
|
44292
|
+
<br/>
|
44293
|
+
|
44294
|
+
## Device Recipe
|
44295
|
+
|
44296
|
+
Schema for a single Device Recipe
|
44297
|
+
|
44298
|
+
### <a name="device-recipe-schema"></a> Schema
|
44299
|
+
|
44300
|
+
```json
|
44301
|
+
{
|
44302
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
44303
|
+
"type": "object",
|
44304
|
+
"properties": {
|
44305
|
+
"id": {
|
44306
|
+
"type": "string",
|
44307
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
44308
|
+
},
|
44309
|
+
"deviceRecipeId": {
|
44310
|
+
"type": "string",
|
44311
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
44312
|
+
},
|
44313
|
+
"applicationId": {
|
44314
|
+
"type": "string",
|
44315
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
44316
|
+
},
|
44317
|
+
"creationDate": {
|
44318
|
+
"type": "string",
|
44319
|
+
"format": "date-time"
|
44320
|
+
},
|
44321
|
+
"lastUpdated": {
|
44322
|
+
"type": "string",
|
44323
|
+
"format": "date-time"
|
44324
|
+
},
|
44325
|
+
"name": {
|
44326
|
+
"type": "string",
|
44327
|
+
"minLength": 1,
|
44328
|
+
"maxLength": 255
|
44329
|
+
},
|
44330
|
+
"deviceName": {
|
44331
|
+
"type": "string",
|
44332
|
+
"minLength": 1,
|
44333
|
+
"maxLength": 255
|
44334
|
+
},
|
44335
|
+
"description": {
|
44336
|
+
"type": "string",
|
44337
|
+
"maxLength": 32767
|
44338
|
+
},
|
44339
|
+
"deviceDescription": {
|
44340
|
+
"type": "string",
|
44341
|
+
"maxLength": 32767
|
44342
|
+
},
|
44282
44343
|
"tags": {
|
44283
44344
|
"type": "array",
|
44284
44345
|
"items": {
|
@@ -47548,6 +47609,1379 @@ Schema for the body of a bulk device delete request
|
|
47548
47609
|
|
47549
47610
|
<br/>
|
47550
47611
|
|
47612
|
+
## Devices Payload Count Export Post
|
47613
|
+
|
47614
|
+
Schema for the body of a device payload count export request
|
47615
|
+
|
47616
|
+
### <a name="devices-payload-count-export-post-schema"></a> Schema
|
47617
|
+
|
47618
|
+
```json
|
47619
|
+
{
|
47620
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
47621
|
+
"type": "object",
|
47622
|
+
"properties": {
|
47623
|
+
"email": {
|
47624
|
+
"type": "string",
|
47625
|
+
"format": "email",
|
47626
|
+
"maxLength": 1024
|
47627
|
+
},
|
47628
|
+
"callbackUrl": {
|
47629
|
+
"type": "string",
|
47630
|
+
"maxLength": 1024
|
47631
|
+
},
|
47632
|
+
"query": {
|
47633
|
+
"title": "Advanced Device Query",
|
47634
|
+
"description": "Schema for advanced device queries",
|
47635
|
+
"type": "object",
|
47636
|
+
"properties": {
|
47637
|
+
"$and": {
|
47638
|
+
"type": "array",
|
47639
|
+
"items": {
|
47640
|
+
"$ref": "#/definitions/advancedDeviceQuery"
|
47641
|
+
},
|
47642
|
+
"maxItems": 100
|
47643
|
+
},
|
47644
|
+
"$or": {
|
47645
|
+
"type": "array",
|
47646
|
+
"items": {
|
47647
|
+
"$ref": "#/definitions/advancedDeviceQuery"
|
47648
|
+
},
|
47649
|
+
"maxItems": 100
|
47650
|
+
},
|
47651
|
+
"$nor": {
|
47652
|
+
"type": "array",
|
47653
|
+
"items": {
|
47654
|
+
"$ref": "#/definitions/advancedDeviceQuery"
|
47655
|
+
},
|
47656
|
+
"maxItems": 100
|
47657
|
+
},
|
47658
|
+
"id": {
|
47659
|
+
"oneOf": [
|
47660
|
+
{
|
47661
|
+
"oneOf": [
|
47662
|
+
{
|
47663
|
+
"type": "string",
|
47664
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
47665
|
+
},
|
47666
|
+
{
|
47667
|
+
"type": "null"
|
47668
|
+
}
|
47669
|
+
]
|
47670
|
+
},
|
47671
|
+
{
|
47672
|
+
"type": "object",
|
47673
|
+
"properties": {
|
47674
|
+
"$eq": {
|
47675
|
+
"oneOf": [
|
47676
|
+
{
|
47677
|
+
"type": "string",
|
47678
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
47679
|
+
},
|
47680
|
+
{
|
47681
|
+
"type": "null"
|
47682
|
+
}
|
47683
|
+
]
|
47684
|
+
},
|
47685
|
+
"$ne": {
|
47686
|
+
"oneOf": [
|
47687
|
+
{
|
47688
|
+
"type": "string",
|
47689
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
47690
|
+
},
|
47691
|
+
{
|
47692
|
+
"type": "null"
|
47693
|
+
}
|
47694
|
+
]
|
47695
|
+
},
|
47696
|
+
"$in": {
|
47697
|
+
"type": "array",
|
47698
|
+
"maxItems": 100,
|
47699
|
+
"items": {
|
47700
|
+
"type": "string",
|
47701
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
47702
|
+
}
|
47703
|
+
},
|
47704
|
+
"$nin": {
|
47705
|
+
"type": "array",
|
47706
|
+
"maxItems": 100,
|
47707
|
+
"items": {
|
47708
|
+
"type": "string",
|
47709
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
47710
|
+
}
|
47711
|
+
}
|
47712
|
+
},
|
47713
|
+
"additionalProperties": false,
|
47714
|
+
"minProperties": 1,
|
47715
|
+
"maxProperties": 1
|
47716
|
+
}
|
47717
|
+
]
|
47718
|
+
},
|
47719
|
+
"creationDate": {
|
47720
|
+
"oneOf": [
|
47721
|
+
{
|
47722
|
+
"type": [
|
47723
|
+
"string",
|
47724
|
+
"number",
|
47725
|
+
"boolean",
|
47726
|
+
"null"
|
47727
|
+
]
|
47728
|
+
},
|
47729
|
+
{
|
47730
|
+
"type": "object",
|
47731
|
+
"properties": {
|
47732
|
+
"$eq": {
|
47733
|
+
"type": [
|
47734
|
+
"string",
|
47735
|
+
"number",
|
47736
|
+
"boolean",
|
47737
|
+
"null"
|
47738
|
+
]
|
47739
|
+
},
|
47740
|
+
"$ne": {
|
47741
|
+
"type": [
|
47742
|
+
"string",
|
47743
|
+
"number",
|
47744
|
+
"boolean",
|
47745
|
+
"null"
|
47746
|
+
]
|
47747
|
+
},
|
47748
|
+
"$gt": {
|
47749
|
+
"type": [
|
47750
|
+
"string",
|
47751
|
+
"number",
|
47752
|
+
"boolean",
|
47753
|
+
"null"
|
47754
|
+
]
|
47755
|
+
},
|
47756
|
+
"$lt": {
|
47757
|
+
"type": [
|
47758
|
+
"string",
|
47759
|
+
"number",
|
47760
|
+
"boolean",
|
47761
|
+
"null"
|
47762
|
+
]
|
47763
|
+
},
|
47764
|
+
"$gte": {
|
47765
|
+
"type": [
|
47766
|
+
"string",
|
47767
|
+
"number",
|
47768
|
+
"boolean",
|
47769
|
+
"null"
|
47770
|
+
]
|
47771
|
+
},
|
47772
|
+
"$lte": {
|
47773
|
+
"type": [
|
47774
|
+
"string",
|
47775
|
+
"number",
|
47776
|
+
"boolean",
|
47777
|
+
"null"
|
47778
|
+
]
|
47779
|
+
},
|
47780
|
+
"$startsWith": {
|
47781
|
+
"type": "string",
|
47782
|
+
"minLength": 1
|
47783
|
+
},
|
47784
|
+
"$endsWith": {
|
47785
|
+
"type": "string",
|
47786
|
+
"minLength": 1
|
47787
|
+
},
|
47788
|
+
"$contains": {
|
47789
|
+
"type": "string",
|
47790
|
+
"minLength": 1
|
47791
|
+
},
|
47792
|
+
"$ci": {
|
47793
|
+
"type": "boolean"
|
47794
|
+
},
|
47795
|
+
"$in": {
|
47796
|
+
"type": "array",
|
47797
|
+
"maxItems": 100,
|
47798
|
+
"items": {
|
47799
|
+
"type": [
|
47800
|
+
"string",
|
47801
|
+
"number",
|
47802
|
+
"boolean"
|
47803
|
+
]
|
47804
|
+
}
|
47805
|
+
},
|
47806
|
+
"$nin": {
|
47807
|
+
"type": "array",
|
47808
|
+
"maxItems": 100,
|
47809
|
+
"items": {
|
47810
|
+
"type": [
|
47811
|
+
"string",
|
47812
|
+
"number",
|
47813
|
+
"boolean"
|
47814
|
+
]
|
47815
|
+
}
|
47816
|
+
}
|
47817
|
+
},
|
47818
|
+
"additionalProperties": false
|
47819
|
+
}
|
47820
|
+
]
|
47821
|
+
},
|
47822
|
+
"lastUpdated": {
|
47823
|
+
"oneOf": [
|
47824
|
+
{
|
47825
|
+
"type": [
|
47826
|
+
"string",
|
47827
|
+
"number",
|
47828
|
+
"boolean",
|
47829
|
+
"null"
|
47830
|
+
]
|
47831
|
+
},
|
47832
|
+
{
|
47833
|
+
"type": "object",
|
47834
|
+
"properties": {
|
47835
|
+
"$eq": {
|
47836
|
+
"type": [
|
47837
|
+
"string",
|
47838
|
+
"number",
|
47839
|
+
"boolean",
|
47840
|
+
"null"
|
47841
|
+
]
|
47842
|
+
},
|
47843
|
+
"$ne": {
|
47844
|
+
"type": [
|
47845
|
+
"string",
|
47846
|
+
"number",
|
47847
|
+
"boolean",
|
47848
|
+
"null"
|
47849
|
+
]
|
47850
|
+
},
|
47851
|
+
"$gt": {
|
47852
|
+
"type": [
|
47853
|
+
"string",
|
47854
|
+
"number",
|
47855
|
+
"boolean",
|
47856
|
+
"null"
|
47857
|
+
]
|
47858
|
+
},
|
47859
|
+
"$lt": {
|
47860
|
+
"type": [
|
47861
|
+
"string",
|
47862
|
+
"number",
|
47863
|
+
"boolean",
|
47864
|
+
"null"
|
47865
|
+
]
|
47866
|
+
},
|
47867
|
+
"$gte": {
|
47868
|
+
"type": [
|
47869
|
+
"string",
|
47870
|
+
"number",
|
47871
|
+
"boolean",
|
47872
|
+
"null"
|
47873
|
+
]
|
47874
|
+
},
|
47875
|
+
"$lte": {
|
47876
|
+
"type": [
|
47877
|
+
"string",
|
47878
|
+
"number",
|
47879
|
+
"boolean",
|
47880
|
+
"null"
|
47881
|
+
]
|
47882
|
+
},
|
47883
|
+
"$startsWith": {
|
47884
|
+
"type": "string",
|
47885
|
+
"minLength": 1
|
47886
|
+
},
|
47887
|
+
"$endsWith": {
|
47888
|
+
"type": "string",
|
47889
|
+
"minLength": 1
|
47890
|
+
},
|
47891
|
+
"$contains": {
|
47892
|
+
"type": "string",
|
47893
|
+
"minLength": 1
|
47894
|
+
},
|
47895
|
+
"$ci": {
|
47896
|
+
"type": "boolean"
|
47897
|
+
},
|
47898
|
+
"$in": {
|
47899
|
+
"type": "array",
|
47900
|
+
"maxItems": 100,
|
47901
|
+
"items": {
|
47902
|
+
"type": [
|
47903
|
+
"string",
|
47904
|
+
"number",
|
47905
|
+
"boolean"
|
47906
|
+
]
|
47907
|
+
}
|
47908
|
+
},
|
47909
|
+
"$nin": {
|
47910
|
+
"type": "array",
|
47911
|
+
"maxItems": 100,
|
47912
|
+
"items": {
|
47913
|
+
"type": [
|
47914
|
+
"string",
|
47915
|
+
"number",
|
47916
|
+
"boolean"
|
47917
|
+
]
|
47918
|
+
}
|
47919
|
+
}
|
47920
|
+
},
|
47921
|
+
"additionalProperties": false
|
47922
|
+
}
|
47923
|
+
]
|
47924
|
+
},
|
47925
|
+
"name": {
|
47926
|
+
"oneOf": [
|
47927
|
+
{
|
47928
|
+
"type": [
|
47929
|
+
"string",
|
47930
|
+
"number",
|
47931
|
+
"boolean",
|
47932
|
+
"null"
|
47933
|
+
]
|
47934
|
+
},
|
47935
|
+
{
|
47936
|
+
"type": "object",
|
47937
|
+
"properties": {
|
47938
|
+
"$eq": {
|
47939
|
+
"type": [
|
47940
|
+
"string",
|
47941
|
+
"number",
|
47942
|
+
"boolean",
|
47943
|
+
"null"
|
47944
|
+
]
|
47945
|
+
},
|
47946
|
+
"$ne": {
|
47947
|
+
"type": [
|
47948
|
+
"string",
|
47949
|
+
"number",
|
47950
|
+
"boolean",
|
47951
|
+
"null"
|
47952
|
+
]
|
47953
|
+
},
|
47954
|
+
"$gt": {
|
47955
|
+
"type": [
|
47956
|
+
"string",
|
47957
|
+
"number",
|
47958
|
+
"boolean",
|
47959
|
+
"null"
|
47960
|
+
]
|
47961
|
+
},
|
47962
|
+
"$lt": {
|
47963
|
+
"type": [
|
47964
|
+
"string",
|
47965
|
+
"number",
|
47966
|
+
"boolean",
|
47967
|
+
"null"
|
47968
|
+
]
|
47969
|
+
},
|
47970
|
+
"$gte": {
|
47971
|
+
"type": [
|
47972
|
+
"string",
|
47973
|
+
"number",
|
47974
|
+
"boolean",
|
47975
|
+
"null"
|
47976
|
+
]
|
47977
|
+
},
|
47978
|
+
"$lte": {
|
47979
|
+
"type": [
|
47980
|
+
"string",
|
47981
|
+
"number",
|
47982
|
+
"boolean",
|
47983
|
+
"null"
|
47984
|
+
]
|
47985
|
+
},
|
47986
|
+
"$startsWith": {
|
47987
|
+
"type": "string",
|
47988
|
+
"minLength": 1
|
47989
|
+
},
|
47990
|
+
"$endsWith": {
|
47991
|
+
"type": "string",
|
47992
|
+
"minLength": 1
|
47993
|
+
},
|
47994
|
+
"$contains": {
|
47995
|
+
"type": "string",
|
47996
|
+
"minLength": 1
|
47997
|
+
},
|
47998
|
+
"$ci": {
|
47999
|
+
"type": "boolean"
|
48000
|
+
},
|
48001
|
+
"$in": {
|
48002
|
+
"type": "array",
|
48003
|
+
"maxItems": 100,
|
48004
|
+
"items": {
|
48005
|
+
"type": [
|
48006
|
+
"string",
|
48007
|
+
"number",
|
48008
|
+
"boolean"
|
48009
|
+
]
|
48010
|
+
}
|
48011
|
+
},
|
48012
|
+
"$nin": {
|
48013
|
+
"type": "array",
|
48014
|
+
"maxItems": 100,
|
48015
|
+
"items": {
|
48016
|
+
"type": [
|
48017
|
+
"string",
|
48018
|
+
"number",
|
48019
|
+
"boolean"
|
48020
|
+
]
|
48021
|
+
}
|
48022
|
+
}
|
48023
|
+
},
|
48024
|
+
"additionalProperties": false
|
48025
|
+
}
|
48026
|
+
]
|
48027
|
+
},
|
48028
|
+
"deviceClass": {
|
48029
|
+
"oneOf": [
|
48030
|
+
{
|
48031
|
+
"type": [
|
48032
|
+
"string",
|
48033
|
+
"number",
|
48034
|
+
"boolean",
|
48035
|
+
"null"
|
48036
|
+
]
|
48037
|
+
},
|
48038
|
+
{
|
48039
|
+
"type": "object",
|
48040
|
+
"properties": {
|
48041
|
+
"$eq": {
|
48042
|
+
"type": [
|
48043
|
+
"string",
|
48044
|
+
"number",
|
48045
|
+
"boolean",
|
48046
|
+
"null"
|
48047
|
+
]
|
48048
|
+
},
|
48049
|
+
"$ne": {
|
48050
|
+
"type": [
|
48051
|
+
"string",
|
48052
|
+
"number",
|
48053
|
+
"boolean",
|
48054
|
+
"null"
|
48055
|
+
]
|
48056
|
+
},
|
48057
|
+
"$gt": {
|
48058
|
+
"type": [
|
48059
|
+
"string",
|
48060
|
+
"number",
|
48061
|
+
"boolean",
|
48062
|
+
"null"
|
48063
|
+
]
|
48064
|
+
},
|
48065
|
+
"$lt": {
|
48066
|
+
"type": [
|
48067
|
+
"string",
|
48068
|
+
"number",
|
48069
|
+
"boolean",
|
48070
|
+
"null"
|
48071
|
+
]
|
48072
|
+
},
|
48073
|
+
"$gte": {
|
48074
|
+
"type": [
|
48075
|
+
"string",
|
48076
|
+
"number",
|
48077
|
+
"boolean",
|
48078
|
+
"null"
|
48079
|
+
]
|
48080
|
+
},
|
48081
|
+
"$lte": {
|
48082
|
+
"type": [
|
48083
|
+
"string",
|
48084
|
+
"number",
|
48085
|
+
"boolean",
|
48086
|
+
"null"
|
48087
|
+
]
|
48088
|
+
},
|
48089
|
+
"$startsWith": {
|
48090
|
+
"type": "string",
|
48091
|
+
"minLength": 1
|
48092
|
+
},
|
48093
|
+
"$endsWith": {
|
48094
|
+
"type": "string",
|
48095
|
+
"minLength": 1
|
48096
|
+
},
|
48097
|
+
"$contains": {
|
48098
|
+
"type": "string",
|
48099
|
+
"minLength": 1
|
48100
|
+
},
|
48101
|
+
"$ci": {
|
48102
|
+
"type": "boolean"
|
48103
|
+
},
|
48104
|
+
"$in": {
|
48105
|
+
"type": "array",
|
48106
|
+
"maxItems": 100,
|
48107
|
+
"items": {
|
48108
|
+
"type": [
|
48109
|
+
"string",
|
48110
|
+
"number",
|
48111
|
+
"boolean"
|
48112
|
+
]
|
48113
|
+
}
|
48114
|
+
},
|
48115
|
+
"$nin": {
|
48116
|
+
"type": "array",
|
48117
|
+
"maxItems": 100,
|
48118
|
+
"items": {
|
48119
|
+
"type": [
|
48120
|
+
"string",
|
48121
|
+
"number",
|
48122
|
+
"boolean"
|
48123
|
+
]
|
48124
|
+
}
|
48125
|
+
}
|
48126
|
+
},
|
48127
|
+
"additionalProperties": false
|
48128
|
+
}
|
48129
|
+
]
|
48130
|
+
},
|
48131
|
+
"gatewayId": {
|
48132
|
+
"oneOf": [
|
48133
|
+
{
|
48134
|
+
"oneOf": [
|
48135
|
+
{
|
48136
|
+
"type": "string",
|
48137
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48138
|
+
},
|
48139
|
+
{
|
48140
|
+
"type": "null"
|
48141
|
+
}
|
48142
|
+
]
|
48143
|
+
},
|
48144
|
+
{
|
48145
|
+
"type": "object",
|
48146
|
+
"properties": {
|
48147
|
+
"$eq": {
|
48148
|
+
"oneOf": [
|
48149
|
+
{
|
48150
|
+
"type": "string",
|
48151
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48152
|
+
},
|
48153
|
+
{
|
48154
|
+
"type": "null"
|
48155
|
+
}
|
48156
|
+
]
|
48157
|
+
},
|
48158
|
+
"$ne": {
|
48159
|
+
"oneOf": [
|
48160
|
+
{
|
48161
|
+
"type": "string",
|
48162
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48163
|
+
},
|
48164
|
+
{
|
48165
|
+
"type": "null"
|
48166
|
+
}
|
48167
|
+
]
|
48168
|
+
},
|
48169
|
+
"$in": {
|
48170
|
+
"type": "array",
|
48171
|
+
"maxItems": 100,
|
48172
|
+
"items": {
|
48173
|
+
"type": "string",
|
48174
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48175
|
+
}
|
48176
|
+
},
|
48177
|
+
"$nin": {
|
48178
|
+
"type": "array",
|
48179
|
+
"maxItems": 100,
|
48180
|
+
"items": {
|
48181
|
+
"type": "string",
|
48182
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48183
|
+
}
|
48184
|
+
}
|
48185
|
+
},
|
48186
|
+
"additionalProperties": false,
|
48187
|
+
"minProperties": 1,
|
48188
|
+
"maxProperties": 1
|
48189
|
+
}
|
48190
|
+
]
|
48191
|
+
},
|
48192
|
+
"parentId": {
|
48193
|
+
"oneOf": [
|
48194
|
+
{
|
48195
|
+
"oneOf": [
|
48196
|
+
{
|
48197
|
+
"type": "string",
|
48198
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48199
|
+
},
|
48200
|
+
{
|
48201
|
+
"type": "null"
|
48202
|
+
}
|
48203
|
+
]
|
48204
|
+
},
|
48205
|
+
{
|
48206
|
+
"type": "object",
|
48207
|
+
"properties": {
|
48208
|
+
"$eq": {
|
48209
|
+
"oneOf": [
|
48210
|
+
{
|
48211
|
+
"type": "string",
|
48212
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48213
|
+
},
|
48214
|
+
{
|
48215
|
+
"type": "null"
|
48216
|
+
}
|
48217
|
+
]
|
48218
|
+
},
|
48219
|
+
"$ne": {
|
48220
|
+
"oneOf": [
|
48221
|
+
{
|
48222
|
+
"type": "string",
|
48223
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48224
|
+
},
|
48225
|
+
{
|
48226
|
+
"type": "null"
|
48227
|
+
}
|
48228
|
+
]
|
48229
|
+
},
|
48230
|
+
"$in": {
|
48231
|
+
"type": "array",
|
48232
|
+
"maxItems": 100,
|
48233
|
+
"items": {
|
48234
|
+
"type": "string",
|
48235
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48236
|
+
}
|
48237
|
+
},
|
48238
|
+
"$nin": {
|
48239
|
+
"type": "array",
|
48240
|
+
"maxItems": 100,
|
48241
|
+
"items": {
|
48242
|
+
"type": "string",
|
48243
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48244
|
+
}
|
48245
|
+
}
|
48246
|
+
},
|
48247
|
+
"additionalProperties": false,
|
48248
|
+
"minProperties": 1,
|
48249
|
+
"maxProperties": 1
|
48250
|
+
}
|
48251
|
+
]
|
48252
|
+
},
|
48253
|
+
"ancestorId": {
|
48254
|
+
"oneOf": [
|
48255
|
+
{
|
48256
|
+
"oneOf": [
|
48257
|
+
{
|
48258
|
+
"type": "string",
|
48259
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48260
|
+
},
|
48261
|
+
{
|
48262
|
+
"type": "null"
|
48263
|
+
}
|
48264
|
+
]
|
48265
|
+
},
|
48266
|
+
{
|
48267
|
+
"type": "object",
|
48268
|
+
"properties": {
|
48269
|
+
"$eq": {
|
48270
|
+
"oneOf": [
|
48271
|
+
{
|
48272
|
+
"type": "string",
|
48273
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48274
|
+
},
|
48275
|
+
{
|
48276
|
+
"type": "null"
|
48277
|
+
}
|
48278
|
+
]
|
48279
|
+
},
|
48280
|
+
"$ne": {
|
48281
|
+
"oneOf": [
|
48282
|
+
{
|
48283
|
+
"type": "string",
|
48284
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48285
|
+
},
|
48286
|
+
{
|
48287
|
+
"type": "null"
|
48288
|
+
}
|
48289
|
+
]
|
48290
|
+
},
|
48291
|
+
"$in": {
|
48292
|
+
"type": "array",
|
48293
|
+
"maxItems": 100,
|
48294
|
+
"items": {
|
48295
|
+
"type": "string",
|
48296
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48297
|
+
}
|
48298
|
+
},
|
48299
|
+
"$nin": {
|
48300
|
+
"type": "array",
|
48301
|
+
"maxItems": 100,
|
48302
|
+
"items": {
|
48303
|
+
"type": "string",
|
48304
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48305
|
+
}
|
48306
|
+
}
|
48307
|
+
},
|
48308
|
+
"additionalProperties": false,
|
48309
|
+
"minProperties": 1,
|
48310
|
+
"maxProperties": 1
|
48311
|
+
}
|
48312
|
+
]
|
48313
|
+
},
|
48314
|
+
"attributeName": {
|
48315
|
+
"oneOf": [
|
48316
|
+
{
|
48317
|
+
"type": [
|
48318
|
+
"string",
|
48319
|
+
"number",
|
48320
|
+
"boolean",
|
48321
|
+
"null"
|
48322
|
+
]
|
48323
|
+
},
|
48324
|
+
{
|
48325
|
+
"type": "object",
|
48326
|
+
"properties": {
|
48327
|
+
"$eq": {
|
48328
|
+
"type": [
|
48329
|
+
"string",
|
48330
|
+
"number",
|
48331
|
+
"boolean",
|
48332
|
+
"null"
|
48333
|
+
]
|
48334
|
+
},
|
48335
|
+
"$ne": {
|
48336
|
+
"type": [
|
48337
|
+
"string",
|
48338
|
+
"number",
|
48339
|
+
"boolean",
|
48340
|
+
"null"
|
48341
|
+
]
|
48342
|
+
},
|
48343
|
+
"$gt": {
|
48344
|
+
"type": [
|
48345
|
+
"string",
|
48346
|
+
"number",
|
48347
|
+
"boolean",
|
48348
|
+
"null"
|
48349
|
+
]
|
48350
|
+
},
|
48351
|
+
"$lt": {
|
48352
|
+
"type": [
|
48353
|
+
"string",
|
48354
|
+
"number",
|
48355
|
+
"boolean",
|
48356
|
+
"null"
|
48357
|
+
]
|
48358
|
+
},
|
48359
|
+
"$gte": {
|
48360
|
+
"type": [
|
48361
|
+
"string",
|
48362
|
+
"number",
|
48363
|
+
"boolean",
|
48364
|
+
"null"
|
48365
|
+
]
|
48366
|
+
},
|
48367
|
+
"$lte": {
|
48368
|
+
"type": [
|
48369
|
+
"string",
|
48370
|
+
"number",
|
48371
|
+
"boolean",
|
48372
|
+
"null"
|
48373
|
+
]
|
48374
|
+
},
|
48375
|
+
"$startsWith": {
|
48376
|
+
"type": "string",
|
48377
|
+
"minLength": 1
|
48378
|
+
},
|
48379
|
+
"$endsWith": {
|
48380
|
+
"type": "string",
|
48381
|
+
"minLength": 1
|
48382
|
+
},
|
48383
|
+
"$contains": {
|
48384
|
+
"type": "string",
|
48385
|
+
"minLength": 1
|
48386
|
+
},
|
48387
|
+
"$ci": {
|
48388
|
+
"type": "boolean"
|
48389
|
+
},
|
48390
|
+
"$in": {
|
48391
|
+
"type": "array",
|
48392
|
+
"maxItems": 100,
|
48393
|
+
"items": {
|
48394
|
+
"type": [
|
48395
|
+
"string",
|
48396
|
+
"number",
|
48397
|
+
"boolean"
|
48398
|
+
]
|
48399
|
+
}
|
48400
|
+
},
|
48401
|
+
"$nin": {
|
48402
|
+
"type": "array",
|
48403
|
+
"maxItems": 100,
|
48404
|
+
"items": {
|
48405
|
+
"type": [
|
48406
|
+
"string",
|
48407
|
+
"number",
|
48408
|
+
"boolean"
|
48409
|
+
]
|
48410
|
+
}
|
48411
|
+
}
|
48412
|
+
},
|
48413
|
+
"additionalProperties": false
|
48414
|
+
}
|
48415
|
+
]
|
48416
|
+
},
|
48417
|
+
"experienceUserId": {
|
48418
|
+
"oneOf": [
|
48419
|
+
{
|
48420
|
+
"oneOf": [
|
48421
|
+
{
|
48422
|
+
"type": "string",
|
48423
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48424
|
+
},
|
48425
|
+
{
|
48426
|
+
"type": "null"
|
48427
|
+
}
|
48428
|
+
]
|
48429
|
+
},
|
48430
|
+
{
|
48431
|
+
"type": "object",
|
48432
|
+
"properties": {
|
48433
|
+
"$eq": {
|
48434
|
+
"oneOf": [
|
48435
|
+
{
|
48436
|
+
"type": "string",
|
48437
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48438
|
+
},
|
48439
|
+
{
|
48440
|
+
"type": "null"
|
48441
|
+
}
|
48442
|
+
]
|
48443
|
+
},
|
48444
|
+
"$ne": {
|
48445
|
+
"oneOf": [
|
48446
|
+
{
|
48447
|
+
"type": "string",
|
48448
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48449
|
+
},
|
48450
|
+
{
|
48451
|
+
"type": "null"
|
48452
|
+
}
|
48453
|
+
]
|
48454
|
+
},
|
48455
|
+
"$in": {
|
48456
|
+
"type": "array",
|
48457
|
+
"maxItems": 100,
|
48458
|
+
"items": {
|
48459
|
+
"type": "string",
|
48460
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48461
|
+
}
|
48462
|
+
},
|
48463
|
+
"$nin": {
|
48464
|
+
"type": "array",
|
48465
|
+
"maxItems": 100,
|
48466
|
+
"items": {
|
48467
|
+
"type": "string",
|
48468
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48469
|
+
}
|
48470
|
+
}
|
48471
|
+
},
|
48472
|
+
"additionalProperties": false,
|
48473
|
+
"minProperties": 1,
|
48474
|
+
"maxProperties": 1
|
48475
|
+
}
|
48476
|
+
]
|
48477
|
+
},
|
48478
|
+
"experienceGroupId": {
|
48479
|
+
"oneOf": [
|
48480
|
+
{
|
48481
|
+
"oneOf": [
|
48482
|
+
{
|
48483
|
+
"type": "string",
|
48484
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48485
|
+
},
|
48486
|
+
{
|
48487
|
+
"type": "null"
|
48488
|
+
}
|
48489
|
+
]
|
48490
|
+
},
|
48491
|
+
{
|
48492
|
+
"type": "object",
|
48493
|
+
"properties": {
|
48494
|
+
"$eq": {
|
48495
|
+
"oneOf": [
|
48496
|
+
{
|
48497
|
+
"type": "string",
|
48498
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48499
|
+
},
|
48500
|
+
{
|
48501
|
+
"type": "null"
|
48502
|
+
}
|
48503
|
+
]
|
48504
|
+
},
|
48505
|
+
"$ne": {
|
48506
|
+
"oneOf": [
|
48507
|
+
{
|
48508
|
+
"type": "string",
|
48509
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48510
|
+
},
|
48511
|
+
{
|
48512
|
+
"type": "null"
|
48513
|
+
}
|
48514
|
+
]
|
48515
|
+
},
|
48516
|
+
"$in": {
|
48517
|
+
"type": "array",
|
48518
|
+
"maxItems": 100,
|
48519
|
+
"items": {
|
48520
|
+
"type": "string",
|
48521
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48522
|
+
}
|
48523
|
+
},
|
48524
|
+
"$nin": {
|
48525
|
+
"type": "array",
|
48526
|
+
"maxItems": 100,
|
48527
|
+
"items": {
|
48528
|
+
"type": "string",
|
48529
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
48530
|
+
}
|
48531
|
+
}
|
48532
|
+
},
|
48533
|
+
"additionalProperties": false,
|
48534
|
+
"minProperties": 1,
|
48535
|
+
"maxProperties": 1
|
48536
|
+
}
|
48537
|
+
]
|
48538
|
+
},
|
48539
|
+
"tags": {
|
48540
|
+
"oneOf": [
|
48541
|
+
{
|
48542
|
+
"oneOf": [
|
48543
|
+
{
|
48544
|
+
"type": "object",
|
48545
|
+
"properties": {
|
48546
|
+
"$tagKey": {
|
48547
|
+
"type": "string",
|
48548
|
+
"maxLength": 255
|
48549
|
+
},
|
48550
|
+
"$tagValue": {
|
48551
|
+
"type": "string",
|
48552
|
+
"maxLength": 255
|
48553
|
+
}
|
48554
|
+
},
|
48555
|
+
"additionalProperties": false,
|
48556
|
+
"minProperties": 1
|
48557
|
+
},
|
48558
|
+
{
|
48559
|
+
"type": "object",
|
48560
|
+
"patternProperties": {
|
48561
|
+
"^[0-9a-zA-Z_-]{1,255}": {
|
48562
|
+
"type": "string",
|
48563
|
+
"maxLength": 255
|
48564
|
+
}
|
48565
|
+
},
|
48566
|
+
"additionalProperties": false
|
48567
|
+
}
|
48568
|
+
]
|
48569
|
+
},
|
48570
|
+
{
|
48571
|
+
"type": "object",
|
48572
|
+
"properties": {
|
48573
|
+
"$eq": {
|
48574
|
+
"oneOf": [
|
48575
|
+
{
|
48576
|
+
"type": "object",
|
48577
|
+
"properties": {
|
48578
|
+
"$tagKey": {
|
48579
|
+
"type": "string",
|
48580
|
+
"maxLength": 255
|
48581
|
+
},
|
48582
|
+
"$tagValue": {
|
48583
|
+
"type": "string",
|
48584
|
+
"maxLength": 255
|
48585
|
+
}
|
48586
|
+
},
|
48587
|
+
"additionalProperties": false,
|
48588
|
+
"minProperties": 1
|
48589
|
+
},
|
48590
|
+
{
|
48591
|
+
"type": "object",
|
48592
|
+
"patternProperties": {
|
48593
|
+
"^[0-9a-zA-Z_-]{1,255}": {
|
48594
|
+
"type": "string",
|
48595
|
+
"maxLength": 255
|
48596
|
+
}
|
48597
|
+
},
|
48598
|
+
"additionalProperties": false
|
48599
|
+
}
|
48600
|
+
]
|
48601
|
+
}
|
48602
|
+
},
|
48603
|
+
"required": [
|
48604
|
+
"$eq"
|
48605
|
+
],
|
48606
|
+
"additionalProperties": false
|
48607
|
+
},
|
48608
|
+
{
|
48609
|
+
"type": "object",
|
48610
|
+
"properties": {
|
48611
|
+
"$ne": {
|
48612
|
+
"oneOf": [
|
48613
|
+
{
|
48614
|
+
"type": "object",
|
48615
|
+
"properties": {
|
48616
|
+
"$tagKey": {
|
48617
|
+
"type": "string",
|
48618
|
+
"maxLength": 255
|
48619
|
+
},
|
48620
|
+
"$tagValue": {
|
48621
|
+
"type": "string",
|
48622
|
+
"maxLength": 255
|
48623
|
+
}
|
48624
|
+
},
|
48625
|
+
"additionalProperties": false,
|
48626
|
+
"minProperties": 1
|
48627
|
+
},
|
48628
|
+
{
|
48629
|
+
"type": "object",
|
48630
|
+
"patternProperties": {
|
48631
|
+
"^[0-9a-zA-Z_-]{1,255}": {
|
48632
|
+
"type": "string",
|
48633
|
+
"maxLength": 255
|
48634
|
+
}
|
48635
|
+
},
|
48636
|
+
"additionalProperties": false
|
48637
|
+
}
|
48638
|
+
]
|
48639
|
+
}
|
48640
|
+
},
|
48641
|
+
"required": [
|
48642
|
+
"$ne"
|
48643
|
+
],
|
48644
|
+
"additionalProperties": false
|
48645
|
+
}
|
48646
|
+
]
|
48647
|
+
},
|
48648
|
+
"disconnectedAt": {
|
48649
|
+
"oneOf": [
|
48650
|
+
{
|
48651
|
+
"type": [
|
48652
|
+
"string",
|
48653
|
+
"number",
|
48654
|
+
"boolean",
|
48655
|
+
"null"
|
48656
|
+
]
|
48657
|
+
},
|
48658
|
+
{
|
48659
|
+
"type": "object",
|
48660
|
+
"properties": {
|
48661
|
+
"$eq": {
|
48662
|
+
"type": [
|
48663
|
+
"string",
|
48664
|
+
"number",
|
48665
|
+
"boolean",
|
48666
|
+
"null"
|
48667
|
+
]
|
48668
|
+
},
|
48669
|
+
"$ne": {
|
48670
|
+
"type": [
|
48671
|
+
"string",
|
48672
|
+
"number",
|
48673
|
+
"boolean",
|
48674
|
+
"null"
|
48675
|
+
]
|
48676
|
+
},
|
48677
|
+
"$gt": {
|
48678
|
+
"type": [
|
48679
|
+
"string",
|
48680
|
+
"number",
|
48681
|
+
"boolean",
|
48682
|
+
"null"
|
48683
|
+
]
|
48684
|
+
},
|
48685
|
+
"$lt": {
|
48686
|
+
"type": [
|
48687
|
+
"string",
|
48688
|
+
"number",
|
48689
|
+
"boolean",
|
48690
|
+
"null"
|
48691
|
+
]
|
48692
|
+
},
|
48693
|
+
"$gte": {
|
48694
|
+
"type": [
|
48695
|
+
"string",
|
48696
|
+
"number",
|
48697
|
+
"boolean",
|
48698
|
+
"null"
|
48699
|
+
]
|
48700
|
+
},
|
48701
|
+
"$lte": {
|
48702
|
+
"type": [
|
48703
|
+
"string",
|
48704
|
+
"number",
|
48705
|
+
"boolean",
|
48706
|
+
"null"
|
48707
|
+
]
|
48708
|
+
},
|
48709
|
+
"$startsWith": {
|
48710
|
+
"type": "string",
|
48711
|
+
"minLength": 1
|
48712
|
+
},
|
48713
|
+
"$endsWith": {
|
48714
|
+
"type": "string",
|
48715
|
+
"minLength": 1
|
48716
|
+
},
|
48717
|
+
"$contains": {
|
48718
|
+
"type": "string",
|
48719
|
+
"minLength": 1
|
48720
|
+
},
|
48721
|
+
"$ci": {
|
48722
|
+
"type": "boolean"
|
48723
|
+
},
|
48724
|
+
"$in": {
|
48725
|
+
"type": "array",
|
48726
|
+
"maxItems": 100,
|
48727
|
+
"items": {
|
48728
|
+
"type": [
|
48729
|
+
"string",
|
48730
|
+
"number",
|
48731
|
+
"boolean"
|
48732
|
+
]
|
48733
|
+
}
|
48734
|
+
},
|
48735
|
+
"$nin": {
|
48736
|
+
"type": "array",
|
48737
|
+
"maxItems": 100,
|
48738
|
+
"items": {
|
48739
|
+
"type": [
|
48740
|
+
"string",
|
48741
|
+
"number",
|
48742
|
+
"boolean"
|
48743
|
+
]
|
48744
|
+
}
|
48745
|
+
}
|
48746
|
+
},
|
48747
|
+
"additionalProperties": false
|
48748
|
+
}
|
48749
|
+
]
|
48750
|
+
},
|
48751
|
+
"connectedAt": {
|
48752
|
+
"oneOf": [
|
48753
|
+
{
|
48754
|
+
"type": [
|
48755
|
+
"string",
|
48756
|
+
"number",
|
48757
|
+
"boolean",
|
48758
|
+
"null"
|
48759
|
+
]
|
48760
|
+
},
|
48761
|
+
{
|
48762
|
+
"type": "object",
|
48763
|
+
"properties": {
|
48764
|
+
"$eq": {
|
48765
|
+
"type": [
|
48766
|
+
"string",
|
48767
|
+
"number",
|
48768
|
+
"boolean",
|
48769
|
+
"null"
|
48770
|
+
]
|
48771
|
+
},
|
48772
|
+
"$ne": {
|
48773
|
+
"type": [
|
48774
|
+
"string",
|
48775
|
+
"number",
|
48776
|
+
"boolean",
|
48777
|
+
"null"
|
48778
|
+
]
|
48779
|
+
},
|
48780
|
+
"$gt": {
|
48781
|
+
"type": [
|
48782
|
+
"string",
|
48783
|
+
"number",
|
48784
|
+
"boolean",
|
48785
|
+
"null"
|
48786
|
+
]
|
48787
|
+
},
|
48788
|
+
"$lt": {
|
48789
|
+
"type": [
|
48790
|
+
"string",
|
48791
|
+
"number",
|
48792
|
+
"boolean",
|
48793
|
+
"null"
|
48794
|
+
]
|
48795
|
+
},
|
48796
|
+
"$gte": {
|
48797
|
+
"type": [
|
48798
|
+
"string",
|
48799
|
+
"number",
|
48800
|
+
"boolean",
|
48801
|
+
"null"
|
48802
|
+
]
|
48803
|
+
},
|
48804
|
+
"$lte": {
|
48805
|
+
"type": [
|
48806
|
+
"string",
|
48807
|
+
"number",
|
48808
|
+
"boolean",
|
48809
|
+
"null"
|
48810
|
+
]
|
48811
|
+
},
|
48812
|
+
"$startsWith": {
|
48813
|
+
"type": "string",
|
48814
|
+
"minLength": 1
|
48815
|
+
},
|
48816
|
+
"$endsWith": {
|
48817
|
+
"type": "string",
|
48818
|
+
"minLength": 1
|
48819
|
+
},
|
48820
|
+
"$contains": {
|
48821
|
+
"type": "string",
|
48822
|
+
"minLength": 1
|
48823
|
+
},
|
48824
|
+
"$ci": {
|
48825
|
+
"type": "boolean"
|
48826
|
+
},
|
48827
|
+
"$in": {
|
48828
|
+
"type": "array",
|
48829
|
+
"maxItems": 100,
|
48830
|
+
"items": {
|
48831
|
+
"type": [
|
48832
|
+
"string",
|
48833
|
+
"number",
|
48834
|
+
"boolean"
|
48835
|
+
]
|
48836
|
+
}
|
48837
|
+
},
|
48838
|
+
"$nin": {
|
48839
|
+
"type": "array",
|
48840
|
+
"maxItems": 100,
|
48841
|
+
"items": {
|
48842
|
+
"type": [
|
48843
|
+
"string",
|
48844
|
+
"number",
|
48845
|
+
"boolean"
|
48846
|
+
]
|
48847
|
+
}
|
48848
|
+
}
|
48849
|
+
},
|
48850
|
+
"additionalProperties": false
|
48851
|
+
}
|
48852
|
+
]
|
48853
|
+
},
|
48854
|
+
"connectionStatus": {
|
48855
|
+
"oneOf": [
|
48856
|
+
{
|
48857
|
+
"type": [
|
48858
|
+
"string",
|
48859
|
+
"number",
|
48860
|
+
"boolean",
|
48861
|
+
"null"
|
48862
|
+
]
|
48863
|
+
},
|
48864
|
+
{
|
48865
|
+
"type": "object",
|
48866
|
+
"properties": {
|
48867
|
+
"$eq": {
|
48868
|
+
"type": [
|
48869
|
+
"string",
|
48870
|
+
"number",
|
48871
|
+
"boolean",
|
48872
|
+
"null"
|
48873
|
+
]
|
48874
|
+
},
|
48875
|
+
"$ne": {
|
48876
|
+
"type": [
|
48877
|
+
"string",
|
48878
|
+
"number",
|
48879
|
+
"boolean",
|
48880
|
+
"null"
|
48881
|
+
]
|
48882
|
+
},
|
48883
|
+
"$gt": {
|
48884
|
+
"type": [
|
48885
|
+
"string",
|
48886
|
+
"number",
|
48887
|
+
"boolean",
|
48888
|
+
"null"
|
48889
|
+
]
|
48890
|
+
},
|
48891
|
+
"$lt": {
|
48892
|
+
"type": [
|
48893
|
+
"string",
|
48894
|
+
"number",
|
48895
|
+
"boolean",
|
48896
|
+
"null"
|
48897
|
+
]
|
48898
|
+
},
|
48899
|
+
"$gte": {
|
48900
|
+
"type": [
|
48901
|
+
"string",
|
48902
|
+
"number",
|
48903
|
+
"boolean",
|
48904
|
+
"null"
|
48905
|
+
]
|
48906
|
+
},
|
48907
|
+
"$lte": {
|
48908
|
+
"type": [
|
48909
|
+
"string",
|
48910
|
+
"number",
|
48911
|
+
"boolean",
|
48912
|
+
"null"
|
48913
|
+
]
|
48914
|
+
},
|
48915
|
+
"$startsWith": {
|
48916
|
+
"type": "string",
|
48917
|
+
"minLength": 1
|
48918
|
+
},
|
48919
|
+
"$endsWith": {
|
48920
|
+
"type": "string",
|
48921
|
+
"minLength": 1
|
48922
|
+
},
|
48923
|
+
"$contains": {
|
48924
|
+
"type": "string",
|
48925
|
+
"minLength": 1
|
48926
|
+
},
|
48927
|
+
"$ci": {
|
48928
|
+
"type": "boolean"
|
48929
|
+
},
|
48930
|
+
"$in": {
|
48931
|
+
"type": "array",
|
48932
|
+
"maxItems": 100,
|
48933
|
+
"items": {
|
48934
|
+
"type": [
|
48935
|
+
"string",
|
48936
|
+
"number",
|
48937
|
+
"boolean"
|
48938
|
+
]
|
48939
|
+
}
|
48940
|
+
},
|
48941
|
+
"$nin": {
|
48942
|
+
"type": "array",
|
48943
|
+
"maxItems": 100,
|
48944
|
+
"items": {
|
48945
|
+
"type": [
|
48946
|
+
"string",
|
48947
|
+
"number",
|
48948
|
+
"boolean"
|
48949
|
+
]
|
48950
|
+
}
|
48951
|
+
}
|
48952
|
+
},
|
48953
|
+
"additionalProperties": false
|
48954
|
+
}
|
48955
|
+
]
|
48956
|
+
}
|
48957
|
+
},
|
48958
|
+
"additionalProperties": false
|
48959
|
+
},
|
48960
|
+
"start": {
|
48961
|
+
"type": "number"
|
48962
|
+
},
|
48963
|
+
"end": {
|
48964
|
+
"type": "number"
|
48965
|
+
}
|
48966
|
+
},
|
48967
|
+
"additionalProperties": false
|
48968
|
+
}
|
48969
|
+
```
|
48970
|
+
### <a name="devices-payload-count-export-post-example"></a> Example
|
48971
|
+
|
48972
|
+
```json
|
48973
|
+
{
|
48974
|
+
"query": {
|
48975
|
+
"name": {
|
48976
|
+
"$ne": "My Device"
|
48977
|
+
}
|
48978
|
+
},
|
48979
|
+
"email": "email@example.com"
|
48980
|
+
}
|
48981
|
+
```
|
48982
|
+
|
48983
|
+
<br/>
|
48984
|
+
|
47551
48985
|
## Devices Metadata Export Post
|
47552
48986
|
|
47553
48987
|
Schema for the body of a device metadata export request
|
@@ -52664,7 +54098,7 @@ Schema for response of devices updated if under 100 devices queried
|
|
52664
54098
|
"updated": 3,
|
52665
54099
|
"failed": 0,
|
52666
54100
|
"skipped": 2,
|
52667
|
-
"logLink": "https://
|
54101
|
+
"logLink": "https://example.com/log-link"
|
52668
54102
|
}
|
52669
54103
|
```
|
52670
54104
|
|
@@ -52741,6 +54175,22 @@ Schema for a single deployment of an edge workflow to an edge device
|
|
52741
54175
|
"minLength": 1,
|
52742
54176
|
"maxLength": 255
|
52743
54177
|
},
|
54178
|
+
"deviceConnectionInfo": {
|
54179
|
+
"type": "object",
|
54180
|
+
"properties": {
|
54181
|
+
"time": {
|
54182
|
+
"type": "string",
|
54183
|
+
"format": "date-time"
|
54184
|
+
},
|
54185
|
+
"connected": {
|
54186
|
+
"enum": [
|
54187
|
+
1,
|
54188
|
+
0,
|
54189
|
+
null
|
54190
|
+
]
|
54191
|
+
}
|
54192
|
+
}
|
54193
|
+
},
|
52744
54194
|
"flowId": {
|
52745
54195
|
"type": "string",
|
52746
54196
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
@@ -53069,6 +54519,22 @@ Schema for a collection of Edge Deployments
|
|
53069
54519
|
"minLength": 1,
|
53070
54520
|
"maxLength": 255
|
53071
54521
|
},
|
54522
|
+
"deviceConnectionInfo": {
|
54523
|
+
"type": "object",
|
54524
|
+
"properties": {
|
54525
|
+
"time": {
|
54526
|
+
"type": "string",
|
54527
|
+
"format": "date-time"
|
54528
|
+
},
|
54529
|
+
"connected": {
|
54530
|
+
"enum": [
|
54531
|
+
1,
|
54532
|
+
0,
|
54533
|
+
null
|
54534
|
+
]
|
54535
|
+
}
|
54536
|
+
}
|
54537
|
+
},
|
53072
54538
|
"flowId": {
|
53073
54539
|
"type": "string",
|
53074
54540
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
@@ -53262,7 +54728,7 @@ Schema for the body of a request verifying an email
|
|
53262
54728
|
|
53263
54729
|
```json
|
53264
54730
|
{
|
53265
|
-
"email": "example
|
54731
|
+
"email": "email@example.com",
|
53266
54732
|
"token": "the email verification token"
|
53267
54733
|
}
|
53268
54734
|
```
|
@@ -55380,7 +56846,7 @@ Schema for a single Experience Domain
|
|
55380
56846
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
55381
56847
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
55382
56848
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
55383
|
-
"domainName": "my.example.
|
56849
|
+
"domainName": "my.domain.example.com",
|
55384
56850
|
"version": "develop"
|
55385
56851
|
}
|
55386
56852
|
```
|
@@ -55459,7 +56925,7 @@ Schema for the body of an Experience Domain modification request
|
|
55459
56925
|
|
55460
56926
|
```json
|
55461
56927
|
{
|
55462
|
-
"domainName": "my.example.
|
56928
|
+
"domainName": "my.domain.example.com",
|
55463
56929
|
"sslCert": "MY_SSL_CERTIFICATE",
|
55464
56930
|
"sslKey": "MY_SSL_KEY",
|
55465
56931
|
"version": "develop"
|
@@ -55522,7 +56988,7 @@ Schema for the body of an Experience Domain creation request
|
|
55522
56988
|
|
55523
56989
|
```json
|
55524
56990
|
{
|
55525
|
-
"domainName": "my.example.
|
56991
|
+
"domainName": "my.domain.example.com",
|
55526
56992
|
"sslCert": "MY_SSL_CERTIFICATE",
|
55527
56993
|
"sslKey": "MY_SSL_KEY",
|
55528
56994
|
"version": "develop"
|
@@ -55616,7 +57082,7 @@ Schema for a collection of Experience Domains
|
|
55616
57082
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
55617
57083
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
55618
57084
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
55619
|
-
"domainName": "my.example.
|
57085
|
+
"domainName": "my.domain.example.com",
|
55620
57086
|
"version": "develop"
|
55621
57087
|
}
|
55622
57088
|
],
|
@@ -57756,6 +59222,21 @@ The body of an experience linked resources response
|
|
57756
59222
|
},
|
57757
59223
|
"maxAge": {
|
57758
59224
|
"type": "number"
|
59225
|
+
},
|
59226
|
+
"triggerOn": {
|
59227
|
+
"type": "string",
|
59228
|
+
"enum": [
|
59229
|
+
"batch",
|
59230
|
+
"individual",
|
59231
|
+
"both"
|
59232
|
+
]
|
59233
|
+
},
|
59234
|
+
"batchBehavior": {
|
59235
|
+
"type": "string",
|
59236
|
+
"enum": [
|
59237
|
+
"once",
|
59238
|
+
"each"
|
59239
|
+
]
|
57759
59240
|
}
|
57760
59241
|
},
|
57761
59242
|
"additionalProperties": false
|
@@ -60004,6 +61485,21 @@ The body of an experience linked resources response
|
|
60004
61485
|
},
|
60005
61486
|
"maxAge": {
|
60006
61487
|
"type": "number"
|
61488
|
+
},
|
61489
|
+
"triggerOn": {
|
61490
|
+
"type": "string",
|
61491
|
+
"enum": [
|
61492
|
+
"batch",
|
61493
|
+
"individual",
|
61494
|
+
"both"
|
61495
|
+
]
|
61496
|
+
},
|
61497
|
+
"batchBehavior": {
|
61498
|
+
"type": "string",
|
61499
|
+
"enum": [
|
61500
|
+
"once",
|
61501
|
+
"each"
|
61502
|
+
]
|
60007
61503
|
}
|
60008
61504
|
},
|
60009
61505
|
"additionalProperties": false
|
@@ -62202,6 +63698,21 @@ The body of an experience linked resources response
|
|
62202
63698
|
},
|
62203
63699
|
"maxAge": {
|
62204
63700
|
"type": "number"
|
63701
|
+
},
|
63702
|
+
"triggerOn": {
|
63703
|
+
"type": "string",
|
63704
|
+
"enum": [
|
63705
|
+
"batch",
|
63706
|
+
"individual",
|
63707
|
+
"both"
|
63708
|
+
]
|
63709
|
+
},
|
63710
|
+
"batchBehavior": {
|
63711
|
+
"type": "string",
|
63712
|
+
"enum": [
|
63713
|
+
"once",
|
63714
|
+
"each"
|
63715
|
+
]
|
62205
63716
|
}
|
62206
63717
|
},
|
62207
63718
|
"additionalProperties": false
|
@@ -64264,7 +65775,7 @@ Schema for a single Experience User
|
|
64264
65775
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
64265
65776
|
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
|
64266
65777
|
"lastLogin": "2016-06-13T04:00:00.000Z",
|
64267
|
-
"email": "example
|
65778
|
+
"email": "experienceuser@example.com",
|
64268
65779
|
"firstName": "Example",
|
64269
65780
|
"lastName": "Name",
|
64270
65781
|
"avatarUrl": "https://example.avatar.url/is_here.png",
|
@@ -64409,7 +65920,7 @@ Schema for the body of an Experience User creation request
|
|
64409
65920
|
|
64410
65921
|
```json
|
64411
65922
|
{
|
64412
|
-
"email": "example
|
65923
|
+
"email": "experienceuser@example.com",
|
64413
65924
|
"firstName": "Example",
|
64414
65925
|
"lastName": "Name",
|
64415
65926
|
"password": "aUserPassword",
|
@@ -64574,7 +66085,7 @@ Schema for a collection of Experience Users
|
|
64574
66085
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
64575
66086
|
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
|
64576
66087
|
"lastLogin": "2016-06-13T04:00:00.000Z",
|
64577
|
-
"email": "example
|
66088
|
+
"email": "experienceuser@example.com",
|
64578
66089
|
"firstName": "Example",
|
64579
66090
|
"lastName": "Name",
|
64580
66091
|
"avatarUrl": "https://example.avatar.url/is_here.png",
|
@@ -64708,7 +66219,7 @@ Schema for a single Experience Version
|
|
64708
66219
|
"attachedDomains": [
|
64709
66220
|
{
|
64710
66221
|
"id": "58c1de6c8f812590d8e82980",
|
64711
|
-
"domainName": "my.example.
|
66222
|
+
"domainName": "my.domain.example.com"
|
64712
66223
|
}
|
64713
66224
|
],
|
64714
66225
|
"attachedSlugs": [
|
@@ -64963,7 +66474,7 @@ Schema for a collection of Experience Versions
|
|
64963
66474
|
"attachedDomains": [
|
64964
66475
|
{
|
64965
66476
|
"id": "58c1de6c8f812590d8e82980",
|
64966
|
-
"domainName": "my.example.
|
66477
|
+
"domainName": "my.domain.example.com"
|
64967
66478
|
}
|
64968
66479
|
],
|
64969
66480
|
"attachedSlugs": [
|
@@ -65791,10 +67302,10 @@ Schema to upload the file to s3
|
|
65791
67302
|
"fileSize": 500,
|
65792
67303
|
"contentType": "text/csv",
|
65793
67304
|
"upload": {
|
65794
|
-
"url": "https://
|
67305
|
+
"url": "https://example.com/the-bucket-name",
|
65795
67306
|
"fields": {
|
65796
67307
|
"key": "5630dcbe1035c9d0011/file.js",
|
65797
|
-
"bucket": "
|
67308
|
+
"bucket": "the-bucket-name",
|
65798
67309
|
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
|
65799
67310
|
"X-Amz-Credential": "AKIAJPGQGBQX4PYM6FXA/20180416/us-west-1/s3/aws4_request",
|
65800
67311
|
"X-Amz-Date": "20180416T142402Z",
|
@@ -66318,6 +67829,21 @@ Schema for a single Workflow
|
|
66318
67829
|
},
|
66319
67830
|
"maxAge": {
|
66320
67831
|
"type": "number"
|
67832
|
+
},
|
67833
|
+
"triggerOn": {
|
67834
|
+
"type": "string",
|
67835
|
+
"enum": [
|
67836
|
+
"batch",
|
67837
|
+
"individual",
|
67838
|
+
"both"
|
67839
|
+
]
|
67840
|
+
},
|
67841
|
+
"batchBehavior": {
|
67842
|
+
"type": "string",
|
67843
|
+
"enum": [
|
67844
|
+
"once",
|
67845
|
+
"each"
|
67846
|
+
]
|
66321
67847
|
}
|
66322
67848
|
},
|
66323
67849
|
"additionalProperties": false
|
@@ -68724,6 +70250,21 @@ Schema for the body of a Workflow modification request
|
|
68724
70250
|
},
|
68725
70251
|
"maxAge": {
|
68726
70252
|
"type": "number"
|
70253
|
+
},
|
70254
|
+
"triggerOn": {
|
70255
|
+
"type": "string",
|
70256
|
+
"enum": [
|
70257
|
+
"batch",
|
70258
|
+
"individual",
|
70259
|
+
"both"
|
70260
|
+
]
|
70261
|
+
},
|
70262
|
+
"batchBehavior": {
|
70263
|
+
"type": "string",
|
70264
|
+
"enum": [
|
70265
|
+
"once",
|
70266
|
+
"each"
|
70267
|
+
]
|
68727
70268
|
}
|
68728
70269
|
},
|
68729
70270
|
"additionalProperties": false
|
@@ -70885,6 +72426,21 @@ Schema for the body of a Workflow creation request
|
|
70885
72426
|
},
|
70886
72427
|
"maxAge": {
|
70887
72428
|
"type": "number"
|
72429
|
+
},
|
72430
|
+
"triggerOn": {
|
72431
|
+
"type": "string",
|
72432
|
+
"enum": [
|
72433
|
+
"batch",
|
72434
|
+
"individual",
|
72435
|
+
"both"
|
72436
|
+
]
|
72437
|
+
},
|
72438
|
+
"batchBehavior": {
|
72439
|
+
"type": "string",
|
72440
|
+
"enum": [
|
72441
|
+
"once",
|
72442
|
+
"each"
|
72443
|
+
]
|
70888
72444
|
}
|
70889
72445
|
},
|
70890
72446
|
"additionalProperties": false
|
@@ -73301,6 +74857,21 @@ Schema for a single Workflow Version
|
|
73301
74857
|
},
|
73302
74858
|
"maxAge": {
|
73303
74859
|
"type": "number"
|
74860
|
+
},
|
74861
|
+
"triggerOn": {
|
74862
|
+
"type": "string",
|
74863
|
+
"enum": [
|
74864
|
+
"batch",
|
74865
|
+
"individual",
|
74866
|
+
"both"
|
74867
|
+
]
|
74868
|
+
},
|
74869
|
+
"batchBehavior": {
|
74870
|
+
"type": "string",
|
74871
|
+
"enum": [
|
74872
|
+
"once",
|
74873
|
+
"each"
|
74874
|
+
]
|
73304
74875
|
}
|
73305
74876
|
},
|
73306
74877
|
"additionalProperties": false
|
@@ -75499,6 +77070,21 @@ Schema for a single Workflow Version
|
|
75499
77070
|
},
|
75500
77071
|
"maxAge": {
|
75501
77072
|
"type": "number"
|
77073
|
+
},
|
77074
|
+
"triggerOn": {
|
77075
|
+
"type": "string",
|
77076
|
+
"enum": [
|
77077
|
+
"batch",
|
77078
|
+
"individual",
|
77079
|
+
"both"
|
77080
|
+
]
|
77081
|
+
},
|
77082
|
+
"batchBehavior": {
|
77083
|
+
"type": "string",
|
77084
|
+
"enum": [
|
77085
|
+
"once",
|
77086
|
+
"each"
|
77087
|
+
]
|
75502
77088
|
}
|
75503
77089
|
},
|
75504
77090
|
"additionalProperties": false
|
@@ -77400,6 +78986,21 @@ Schema for the body of a Workflow Version creation request
|
|
77400
78986
|
},
|
77401
78987
|
"maxAge": {
|
77402
78988
|
"type": "number"
|
78989
|
+
},
|
78990
|
+
"triggerOn": {
|
78991
|
+
"type": "string",
|
78992
|
+
"enum": [
|
78993
|
+
"batch",
|
78994
|
+
"individual",
|
78995
|
+
"both"
|
78996
|
+
]
|
78997
|
+
},
|
78998
|
+
"batchBehavior": {
|
78999
|
+
"type": "string",
|
79000
|
+
"enum": [
|
79001
|
+
"once",
|
79002
|
+
"each"
|
79003
|
+
]
|
77403
79004
|
}
|
77404
79005
|
},
|
77405
79006
|
"additionalProperties": false
|
@@ -79586,6 +81187,21 @@ Schema for a collection of Workflow Versions
|
|
79586
81187
|
},
|
79587
81188
|
"maxAge": {
|
79588
81189
|
"type": "number"
|
81190
|
+
},
|
81191
|
+
"triggerOn": {
|
81192
|
+
"type": "string",
|
81193
|
+
"enum": [
|
81194
|
+
"batch",
|
81195
|
+
"individual",
|
81196
|
+
"both"
|
81197
|
+
]
|
81198
|
+
},
|
81199
|
+
"batchBehavior": {
|
81200
|
+
"type": "string",
|
81201
|
+
"enum": [
|
81202
|
+
"once",
|
81203
|
+
"each"
|
81204
|
+
]
|
79589
81205
|
}
|
79590
81206
|
},
|
79591
81207
|
"additionalProperties": false
|
@@ -81784,6 +83400,21 @@ Schema for a collection of Workflow Versions
|
|
81784
83400
|
},
|
81785
83401
|
"maxAge": {
|
81786
83402
|
"type": "number"
|
83403
|
+
},
|
83404
|
+
"triggerOn": {
|
83405
|
+
"type": "string",
|
83406
|
+
"enum": [
|
83407
|
+
"batch",
|
83408
|
+
"individual",
|
83409
|
+
"both"
|
83410
|
+
]
|
83411
|
+
},
|
83412
|
+
"batchBehavior": {
|
83413
|
+
"type": "string",
|
83414
|
+
"enum": [
|
83415
|
+
"once",
|
83416
|
+
"each"
|
83417
|
+
]
|
81787
83418
|
}
|
81788
83419
|
},
|
81789
83420
|
"additionalProperties": false
|
@@ -84719,6 +86350,21 @@ Schema for a collection of Workflows
|
|
84719
86350
|
},
|
84720
86351
|
"maxAge": {
|
84721
86352
|
"type": "number"
|
86353
|
+
},
|
86354
|
+
"triggerOn": {
|
86355
|
+
"type": "string",
|
86356
|
+
"enum": [
|
86357
|
+
"batch",
|
86358
|
+
"individual",
|
86359
|
+
"both"
|
86360
|
+
]
|
86361
|
+
},
|
86362
|
+
"batchBehavior": {
|
86363
|
+
"type": "string",
|
86364
|
+
"enum": [
|
86365
|
+
"once",
|
86366
|
+
"each"
|
86367
|
+
]
|
84722
86368
|
}
|
84723
86369
|
},
|
84724
86370
|
"additionalProperties": false
|
@@ -86994,6 +88640,21 @@ Schema for the body of a workflow import request
|
|
86994
88640
|
},
|
86995
88641
|
"maxAge": {
|
86996
88642
|
"type": "number"
|
88643
|
+
},
|
88644
|
+
"triggerOn": {
|
88645
|
+
"type": "string",
|
88646
|
+
"enum": [
|
88647
|
+
"batch",
|
88648
|
+
"individual",
|
88649
|
+
"both"
|
88650
|
+
]
|
88651
|
+
},
|
88652
|
+
"batchBehavior": {
|
88653
|
+
"type": "string",
|
88654
|
+
"enum": [
|
88655
|
+
"once",
|
88656
|
+
"each"
|
88657
|
+
]
|
86997
88658
|
}
|
86998
88659
|
},
|
86999
88660
|
"additionalProperties": false
|
@@ -89173,6 +90834,21 @@ Schema for the body of a workflow import request
|
|
89173
90834
|
},
|
89174
90835
|
"maxAge": {
|
89175
90836
|
"type": "number"
|
90837
|
+
},
|
90838
|
+
"triggerOn": {
|
90839
|
+
"type": "string",
|
90840
|
+
"enum": [
|
90841
|
+
"batch",
|
90842
|
+
"individual",
|
90843
|
+
"both"
|
90844
|
+
]
|
90845
|
+
},
|
90846
|
+
"batchBehavior": {
|
90847
|
+
"type": "string",
|
90848
|
+
"enum": [
|
90849
|
+
"once",
|
90850
|
+
"each"
|
90851
|
+
]
|
89176
90852
|
}
|
89177
90853
|
},
|
89178
90854
|
"additionalProperties": false
|
@@ -91399,6 +93075,21 @@ Schema for the result of a workflow import request
|
|
91399
93075
|
},
|
91400
93076
|
"maxAge": {
|
91401
93077
|
"type": "number"
|
93078
|
+
},
|
93079
|
+
"triggerOn": {
|
93080
|
+
"type": "string",
|
93081
|
+
"enum": [
|
93082
|
+
"batch",
|
93083
|
+
"individual",
|
93084
|
+
"both"
|
93085
|
+
]
|
93086
|
+
},
|
93087
|
+
"batchBehavior": {
|
93088
|
+
"type": "string",
|
93089
|
+
"enum": [
|
93090
|
+
"once",
|
93091
|
+
"each"
|
93092
|
+
]
|
91402
93093
|
}
|
91403
93094
|
},
|
91404
93095
|
"additionalProperties": false
|
@@ -93597,6 +95288,21 @@ Schema for the result of a workflow import request
|
|
93597
95288
|
},
|
93598
95289
|
"maxAge": {
|
93599
95290
|
"type": "number"
|
95291
|
+
},
|
95292
|
+
"triggerOn": {
|
95293
|
+
"type": "string",
|
95294
|
+
"enum": [
|
95295
|
+
"batch",
|
95296
|
+
"individual",
|
95297
|
+
"both"
|
95298
|
+
]
|
95299
|
+
},
|
95300
|
+
"batchBehavior": {
|
95301
|
+
"type": "string",
|
95302
|
+
"enum": [
|
95303
|
+
"once",
|
95304
|
+
"each"
|
95305
|
+
]
|
93600
95306
|
}
|
93601
95307
|
},
|
93602
95308
|
"additionalProperties": false
|
@@ -95795,6 +97501,21 @@ Schema for the result of a workflow import request
|
|
95795
97501
|
},
|
95796
97502
|
"maxAge": {
|
95797
97503
|
"type": "number"
|
97504
|
+
},
|
97505
|
+
"triggerOn": {
|
97506
|
+
"type": "string",
|
97507
|
+
"enum": [
|
97508
|
+
"batch",
|
97509
|
+
"individual",
|
97510
|
+
"both"
|
97511
|
+
]
|
97512
|
+
},
|
97513
|
+
"batchBehavior": {
|
97514
|
+
"type": "string",
|
97515
|
+
"enum": [
|
97516
|
+
"once",
|
97517
|
+
"each"
|
97518
|
+
]
|
95798
97519
|
}
|
95799
97520
|
},
|
95800
97521
|
"additionalProperties": false
|
@@ -97459,6 +99180,7 @@ Schema for the body of a Github login request
|
|
97459
99180
|
"deviceRecipe.*",
|
97460
99181
|
"deviceRecipes.*",
|
97461
99182
|
"devices.*",
|
99183
|
+
"edgeDeployment.*",
|
97462
99184
|
"edgeDeployments.*",
|
97463
99185
|
"event.*",
|
97464
99186
|
"events.*",
|
@@ -97559,6 +99281,7 @@ Schema for the body of a Github login request
|
|
97559
99281
|
"device.getLogEntries",
|
97560
99282
|
"device.getState",
|
97561
99283
|
"device.patch",
|
99284
|
+
"device.payloadCounts",
|
97562
99285
|
"device.removeData",
|
97563
99286
|
"device.sendCommand",
|
97564
99287
|
"device.sendState",
|
@@ -97577,10 +99300,12 @@ Schema for the body of a Github login request
|
|
97577
99300
|
"devices.detailedSummary",
|
97578
99301
|
"devices.export",
|
97579
99302
|
"devices.get",
|
99303
|
+
"devices.payloadCounts",
|
97580
99304
|
"devices.post",
|
97581
99305
|
"devices.sendCommand",
|
97582
99306
|
"devices.tagKeys",
|
97583
99307
|
"devices.tagValues",
|
99308
|
+
"edgeDeployment.get",
|
97584
99309
|
"edgeDeployments.get",
|
97585
99310
|
"edgeDeployments.release",
|
97586
99311
|
"edgeDeployments.remove",
|
@@ -97762,6 +99487,13 @@ Schema for the body of a Github login request
|
|
97762
99487
|
"instanceOrgMembers.*",
|
97763
99488
|
"instanceOrgMembers.get",
|
97764
99489
|
"instanceOrgMembers.post",
|
99490
|
+
"instanceOrgInvite.*",
|
99491
|
+
"instanceOrgInvite.get",
|
99492
|
+
"instanceOrgInvite.delete",
|
99493
|
+
"instanceOrgInvite.resendInvite",
|
99494
|
+
"instanceOrgInvites.*",
|
99495
|
+
"instanceOrgInvites.get",
|
99496
|
+
"instanceOrgInvites.post",
|
97765
99497
|
"instanceApiTokens.*",
|
97766
99498
|
"instanceApiTokens.get",
|
97767
99499
|
"instanceApiTokens.post",
|
@@ -98202,11 +99934,11 @@ Schema for a historical summary report
|
|
98202
99934
|
"type": "number"
|
98203
99935
|
},
|
98204
99936
|
"payloadCountDetails": {
|
98205
|
-
"title": "Payload
|
98206
|
-
"description": "Schema for the result of a payload
|
99937
|
+
"title": "Payload Stats",
|
99938
|
+
"description": "Schema for the result of a payload stats request",
|
98207
99939
|
"type": "object",
|
98208
99940
|
"properties": {
|
98209
|
-
"
|
99941
|
+
"dataTable": {
|
98210
99942
|
"type": "object",
|
98211
99943
|
"patternProperties": {
|
98212
99944
|
".*": {
|
@@ -98214,7 +99946,7 @@ Schema for a historical summary report
|
|
98214
99946
|
}
|
98215
99947
|
}
|
98216
99948
|
},
|
98217
|
-
"
|
99949
|
+
"deviceCommand": {
|
98218
99950
|
"type": "object",
|
98219
99951
|
"patternProperties": {
|
98220
99952
|
".*": {
|
@@ -98222,7 +99954,15 @@ Schema for a historical summary report
|
|
98222
99954
|
}
|
98223
99955
|
}
|
98224
99956
|
},
|
98225
|
-
"
|
99957
|
+
"deviceConnect": {
|
99958
|
+
"type": "object",
|
99959
|
+
"patternProperties": {
|
99960
|
+
".*": {
|
99961
|
+
"type": "number"
|
99962
|
+
}
|
99963
|
+
}
|
99964
|
+
},
|
99965
|
+
"deviceDisconnect": {
|
98226
99966
|
"type": "object",
|
98227
99967
|
"patternProperties": {
|
98228
99968
|
".*": {
|
@@ -98238,7 +99978,7 @@ Schema for a historical summary report
|
|
98238
99978
|
}
|
98239
99979
|
}
|
98240
99980
|
},
|
98241
|
-
"
|
99981
|
+
"endpoint": {
|
98242
99982
|
"type": "object",
|
98243
99983
|
"patternProperties": {
|
98244
99984
|
".*": {
|
@@ -98246,7 +99986,7 @@ Schema for a historical summary report
|
|
98246
99986
|
}
|
98247
99987
|
}
|
98248
99988
|
},
|
98249
|
-
"
|
99989
|
+
"event": {
|
98250
99990
|
"type": "object",
|
98251
99991
|
"patternProperties": {
|
98252
99992
|
".*": {
|
@@ -98254,7 +99994,7 @@ Schema for a historical summary report
|
|
98254
99994
|
}
|
98255
99995
|
}
|
98256
99996
|
},
|
98257
|
-
"
|
99997
|
+
"flowError": {
|
98258
99998
|
"type": "object",
|
98259
99999
|
"patternProperties": {
|
98260
100000
|
".*": {
|
@@ -98262,7 +100002,39 @@ Schema for a historical summary report
|
|
98262
100002
|
}
|
98263
100003
|
}
|
98264
100004
|
},
|
98265
|
-
"
|
100005
|
+
"integration": {
|
100006
|
+
"type": "object",
|
100007
|
+
"patternProperties": {
|
100008
|
+
".*": {
|
100009
|
+
"type": "number"
|
100010
|
+
}
|
100011
|
+
}
|
100012
|
+
},
|
100013
|
+
"mqttIn": {
|
100014
|
+
"type": "object",
|
100015
|
+
"patternProperties": {
|
100016
|
+
".*": {
|
100017
|
+
"type": "number"
|
100018
|
+
}
|
100019
|
+
}
|
100020
|
+
},
|
100021
|
+
"mqttOut": {
|
100022
|
+
"type": "object",
|
100023
|
+
"patternProperties": {
|
100024
|
+
".*": {
|
100025
|
+
"type": "number"
|
100026
|
+
}
|
100027
|
+
}
|
100028
|
+
},
|
100029
|
+
"notebook": {
|
100030
|
+
"type": "object",
|
100031
|
+
"patternProperties": {
|
100032
|
+
".*": {
|
100033
|
+
"type": "number"
|
100034
|
+
}
|
100035
|
+
}
|
100036
|
+
},
|
100037
|
+
"timer": {
|
98266
100038
|
"type": "object",
|
98267
100039
|
"patternProperties": {
|
98268
100040
|
".*": {
|
@@ -98278,6 +100050,37 @@ Schema for a historical summary report
|
|
98278
100050
|
}
|
98279
100051
|
}
|
98280
100052
|
},
|
100053
|
+
"webhook": {
|
100054
|
+
"type": "object",
|
100055
|
+
"patternProperties": {
|
100056
|
+
".*": {
|
100057
|
+
"type": "number"
|
100058
|
+
}
|
100059
|
+
}
|
100060
|
+
}
|
100061
|
+
}
|
100062
|
+
},
|
100063
|
+
"payloadSizeDetails": {
|
100064
|
+
"title": "Payload Stats",
|
100065
|
+
"description": "Schema for the result of a payload stats request",
|
100066
|
+
"type": "object",
|
100067
|
+
"properties": {
|
100068
|
+
"dataTable": {
|
100069
|
+
"type": "object",
|
100070
|
+
"patternProperties": {
|
100071
|
+
".*": {
|
100072
|
+
"type": "number"
|
100073
|
+
}
|
100074
|
+
}
|
100075
|
+
},
|
100076
|
+
"deviceCommand": {
|
100077
|
+
"type": "object",
|
100078
|
+
"patternProperties": {
|
100079
|
+
".*": {
|
100080
|
+
"type": "number"
|
100081
|
+
}
|
100082
|
+
}
|
100083
|
+
},
|
98281
100084
|
"deviceConnect": {
|
98282
100085
|
"type": "object",
|
98283
100086
|
"patternProperties": {
|
@@ -98294,7 +100097,7 @@ Schema for a historical summary report
|
|
98294
100097
|
}
|
98295
100098
|
}
|
98296
100099
|
},
|
98297
|
-
"
|
100100
|
+
"deviceState": {
|
98298
100101
|
"type": "object",
|
98299
100102
|
"patternProperties": {
|
98300
100103
|
".*": {
|
@@ -98302,22 +100105,7 @@ Schema for a historical summary report
|
|
98302
100105
|
}
|
98303
100106
|
}
|
98304
100107
|
},
|
98305
|
-
"
|
98306
|
-
"type": "object",
|
98307
|
-
"patternProperties": {
|
98308
|
-
".*": {
|
98309
|
-
"type": "number"
|
98310
|
-
}
|
98311
|
-
}
|
98312
|
-
}
|
98313
|
-
}
|
98314
|
-
},
|
98315
|
-
"payloadSizeDetails": {
|
98316
|
-
"title": "Payload Counts",
|
98317
|
-
"description": "Schema for the result of a payload count request",
|
98318
|
-
"type": "object",
|
98319
|
-
"properties": {
|
98320
|
-
"mqttOut": {
|
100108
|
+
"endpoint": {
|
98321
100109
|
"type": "object",
|
98322
100110
|
"patternProperties": {
|
98323
100111
|
".*": {
|
@@ -98325,7 +100113,7 @@ Schema for a historical summary report
|
|
98325
100113
|
}
|
98326
100114
|
}
|
98327
100115
|
},
|
98328
|
-
"
|
100116
|
+
"event": {
|
98329
100117
|
"type": "object",
|
98330
100118
|
"patternProperties": {
|
98331
100119
|
".*": {
|
@@ -98333,7 +100121,7 @@ Schema for a historical summary report
|
|
98333
100121
|
}
|
98334
100122
|
}
|
98335
100123
|
},
|
98336
|
-
"
|
100124
|
+
"flowError": {
|
98337
100125
|
"type": "object",
|
98338
100126
|
"patternProperties": {
|
98339
100127
|
".*": {
|
@@ -98341,7 +100129,7 @@ Schema for a historical summary report
|
|
98341
100129
|
}
|
98342
100130
|
}
|
98343
100131
|
},
|
98344
|
-
"
|
100132
|
+
"integration": {
|
98345
100133
|
"type": "object",
|
98346
100134
|
"patternProperties": {
|
98347
100135
|
".*": {
|
@@ -98349,7 +100137,7 @@ Schema for a historical summary report
|
|
98349
100137
|
}
|
98350
100138
|
}
|
98351
100139
|
},
|
98352
|
-
"
|
100140
|
+
"mqttIn": {
|
98353
100141
|
"type": "object",
|
98354
100142
|
"patternProperties": {
|
98355
100143
|
".*": {
|
@@ -98357,7 +100145,7 @@ Schema for a historical summary report
|
|
98357
100145
|
}
|
98358
100146
|
}
|
98359
100147
|
},
|
98360
|
-
"
|
100148
|
+
"mqttOut": {
|
98361
100149
|
"type": "object",
|
98362
100150
|
"patternProperties": {
|
98363
100151
|
".*": {
|
@@ -98365,7 +100153,7 @@ Schema for a historical summary report
|
|
98365
100153
|
}
|
98366
100154
|
}
|
98367
100155
|
},
|
98368
|
-
"
|
100156
|
+
"notebook": {
|
98369
100157
|
"type": "object",
|
98370
100158
|
"patternProperties": {
|
98371
100159
|
".*": {
|
@@ -98373,7 +100161,7 @@ Schema for a historical summary report
|
|
98373
100161
|
}
|
98374
100162
|
}
|
98375
100163
|
},
|
98376
|
-
"
|
100164
|
+
"timer": {
|
98377
100165
|
"type": "object",
|
98378
100166
|
"patternProperties": {
|
98379
100167
|
".*": {
|
@@ -98389,31 +100177,7 @@ Schema for a historical summary report
|
|
98389
100177
|
}
|
98390
100178
|
}
|
98391
100179
|
},
|
98392
|
-
"
|
98393
|
-
"type": "object",
|
98394
|
-
"patternProperties": {
|
98395
|
-
".*": {
|
98396
|
-
"type": "number"
|
98397
|
-
}
|
98398
|
-
}
|
98399
|
-
},
|
98400
|
-
"deviceDisconnect": {
|
98401
|
-
"type": "object",
|
98402
|
-
"patternProperties": {
|
98403
|
-
".*": {
|
98404
|
-
"type": "number"
|
98405
|
-
}
|
98406
|
-
}
|
98407
|
-
},
|
98408
|
-
"endpoint": {
|
98409
|
-
"type": "object",
|
98410
|
-
"patternProperties": {
|
98411
|
-
".*": {
|
98412
|
-
"type": "number"
|
98413
|
-
}
|
98414
|
-
}
|
98415
|
-
},
|
98416
|
-
"integration": {
|
100180
|
+
"webhook": {
|
98417
100181
|
"type": "object",
|
98418
100182
|
"patternProperties": {
|
98419
100183
|
".*": {
|
@@ -98764,6 +100528,10 @@ Schema for an Instance member
|
|
98764
100528
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
98765
100529
|
"type": "object",
|
98766
100530
|
"properties": {
|
100531
|
+
"instanceId": {
|
100532
|
+
"type": "string",
|
100533
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
100534
|
+
},
|
98767
100535
|
"userId": {
|
98768
100536
|
"type": "string",
|
98769
100537
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
@@ -98859,6 +100627,11 @@ Schema for an Instance member creation request
|
|
98859
100627
|
"type": "string",
|
98860
100628
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
98861
100629
|
},
|
100630
|
+
"email": {
|
100631
|
+
"type": "string",
|
100632
|
+
"format": "email",
|
100633
|
+
"maxLength": 1024
|
100634
|
+
},
|
98862
100635
|
"role": {
|
98863
100636
|
"type": "string",
|
98864
100637
|
"enum": [
|
@@ -98868,9 +100641,19 @@ Schema for an Instance member creation request
|
|
98868
100641
|
}
|
98869
100642
|
},
|
98870
100643
|
"additionalProperties": false,
|
98871
|
-
"
|
98872
|
-
|
98873
|
-
|
100644
|
+
"anyOf": [
|
100645
|
+
{
|
100646
|
+
"required": [
|
100647
|
+
"email",
|
100648
|
+
"role"
|
100649
|
+
]
|
100650
|
+
},
|
100651
|
+
{
|
100652
|
+
"required": [
|
100653
|
+
"userId",
|
100654
|
+
"role"
|
100655
|
+
]
|
100656
|
+
}
|
98874
100657
|
]
|
98875
100658
|
}
|
98876
100659
|
```
|
@@ -98903,6 +100686,10 @@ Schema for a collection of Instance members
|
|
98903
100686
|
"description": "Schema for an Instance member",
|
98904
100687
|
"type": "object",
|
98905
100688
|
"properties": {
|
100689
|
+
"instanceId": {
|
100690
|
+
"type": "string",
|
100691
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
100692
|
+
},
|
98906
100693
|
"userId": {
|
98907
100694
|
"type": "string",
|
98908
100695
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
@@ -98937,6 +100724,10 @@ Schema for a collection of Instance members
|
|
98937
100724
|
"additionalProperties": false
|
98938
100725
|
}
|
98939
100726
|
},
|
100727
|
+
"instanceId": {
|
100728
|
+
"type": "string",
|
100729
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
100730
|
+
},
|
98940
100731
|
"count": {
|
98941
100732
|
"type": "integer"
|
98942
100733
|
},
|
@@ -99148,6 +100939,14 @@ Schema for an Instance Organization member
|
|
99148
100939
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
99149
100940
|
"type": "object",
|
99150
100941
|
"properties": {
|
100942
|
+
"instanceId": {
|
100943
|
+
"type": "string",
|
100944
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
100945
|
+
},
|
100946
|
+
"orgId": {
|
100947
|
+
"type": "string",
|
100948
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
100949
|
+
},
|
99151
100950
|
"userId": {
|
99152
100951
|
"type": "string",
|
99153
100952
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
@@ -99490,6 +101289,14 @@ Schema for a collection of Organization members within an instance
|
|
99490
101289
|
"$ref": "#/definitions/instanceOrgMembers"
|
99491
101290
|
}
|
99492
101291
|
},
|
101292
|
+
"instanceId": {
|
101293
|
+
"type": "string",
|
101294
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
101295
|
+
},
|
101296
|
+
"orgId": {
|
101297
|
+
"type": "string",
|
101298
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
101299
|
+
},
|
99493
101300
|
"count": {
|
99494
101301
|
"type": "integer"
|
99495
101302
|
},
|
@@ -100145,6 +101952,10 @@ Schema for a collection of Organizations within an instance
|
|
100145
101952
|
]
|
100146
101953
|
}
|
100147
101954
|
},
|
101955
|
+
"instanceId": {
|
101956
|
+
"type": "string",
|
101957
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
101958
|
+
},
|
100148
101959
|
"count": {
|
100149
101960
|
"type": "integer"
|
100150
101961
|
},
|
@@ -100289,7 +102100,7 @@ Schema for instance patch request
|
|
100289
102100
|
"email": [
|
100290
102101
|
"email@example.com"
|
100291
102102
|
],
|
100292
|
-
"callbackUrl": "https://
|
102103
|
+
"callbackUrl": "https://example.com/callback",
|
100293
102104
|
"resourceGroupBy": "organization",
|
100294
102105
|
"dateGroupBy": "month",
|
100295
102106
|
"includeSandbox": false,
|
@@ -100364,7 +102175,7 @@ Schema for the body of a instance report request
|
|
100364
102175
|
```json
|
100365
102176
|
{
|
100366
102177
|
"email": "email@example.com",
|
100367
|
-
"callbackUrl": "https://
|
102178
|
+
"callbackUrl": "https://example.com/callback",
|
100368
102179
|
"resourceGroupBy": "organization",
|
100369
102180
|
"dateGroupBy": "month",
|
100370
102181
|
"includeSandbox": false,
|
@@ -101985,11 +103796,11 @@ Schema for information about the currently authenticated user
|
|
101985
103796
|
"type": "number"
|
101986
103797
|
},
|
101987
103798
|
"payloadCount": {
|
101988
|
-
"title": "Payload
|
101989
|
-
"description": "Schema for the result of a payload
|
103799
|
+
"title": "Payload Stats",
|
103800
|
+
"description": "Schema for the result of a payload stats request",
|
101990
103801
|
"type": "object",
|
101991
103802
|
"properties": {
|
101992
|
-
"
|
103803
|
+
"dataTable": {
|
101993
103804
|
"type": "object",
|
101994
103805
|
"patternProperties": {
|
101995
103806
|
".*": {
|
@@ -101997,7 +103808,7 @@ Schema for information about the currently authenticated user
|
|
101997
103808
|
}
|
101998
103809
|
}
|
101999
103810
|
},
|
102000
|
-
"
|
103811
|
+
"deviceCommand": {
|
102001
103812
|
"type": "object",
|
102002
103813
|
"patternProperties": {
|
102003
103814
|
".*": {
|
@@ -102005,7 +103816,15 @@ Schema for information about the currently authenticated user
|
|
102005
103816
|
}
|
102006
103817
|
}
|
102007
103818
|
},
|
102008
|
-
"
|
103819
|
+
"deviceConnect": {
|
103820
|
+
"type": "object",
|
103821
|
+
"patternProperties": {
|
103822
|
+
".*": {
|
103823
|
+
"type": "number"
|
103824
|
+
}
|
103825
|
+
}
|
103826
|
+
},
|
103827
|
+
"deviceDisconnect": {
|
102009
103828
|
"type": "object",
|
102010
103829
|
"patternProperties": {
|
102011
103830
|
".*": {
|
@@ -102021,7 +103840,7 @@ Schema for information about the currently authenticated user
|
|
102021
103840
|
}
|
102022
103841
|
}
|
102023
103842
|
},
|
102024
|
-
"
|
103843
|
+
"endpoint": {
|
102025
103844
|
"type": "object",
|
102026
103845
|
"patternProperties": {
|
102027
103846
|
".*": {
|
@@ -102029,7 +103848,7 @@ Schema for information about the currently authenticated user
|
|
102029
103848
|
}
|
102030
103849
|
}
|
102031
103850
|
},
|
102032
|
-
"
|
103851
|
+
"event": {
|
102033
103852
|
"type": "object",
|
102034
103853
|
"patternProperties": {
|
102035
103854
|
".*": {
|
@@ -102037,7 +103856,7 @@ Schema for information about the currently authenticated user
|
|
102037
103856
|
}
|
102038
103857
|
}
|
102039
103858
|
},
|
102040
|
-
"
|
103859
|
+
"flowError": {
|
102041
103860
|
"type": "object",
|
102042
103861
|
"patternProperties": {
|
102043
103862
|
".*": {
|
@@ -102045,7 +103864,7 @@ Schema for information about the currently authenticated user
|
|
102045
103864
|
}
|
102046
103865
|
}
|
102047
103866
|
},
|
102048
|
-
"
|
103867
|
+
"integration": {
|
102049
103868
|
"type": "object",
|
102050
103869
|
"patternProperties": {
|
102051
103870
|
".*": {
|
@@ -102053,7 +103872,7 @@ Schema for information about the currently authenticated user
|
|
102053
103872
|
}
|
102054
103873
|
}
|
102055
103874
|
},
|
102056
|
-
"
|
103875
|
+
"mqttIn": {
|
102057
103876
|
"type": "object",
|
102058
103877
|
"patternProperties": {
|
102059
103878
|
".*": {
|
@@ -102061,7 +103880,7 @@ Schema for information about the currently authenticated user
|
|
102061
103880
|
}
|
102062
103881
|
}
|
102063
103882
|
},
|
102064
|
-
"
|
103883
|
+
"mqttOut": {
|
102065
103884
|
"type": "object",
|
102066
103885
|
"patternProperties": {
|
102067
103886
|
".*": {
|
@@ -102069,7 +103888,7 @@ Schema for information about the currently authenticated user
|
|
102069
103888
|
}
|
102070
103889
|
}
|
102071
103890
|
},
|
102072
|
-
"
|
103891
|
+
"notebook": {
|
102073
103892
|
"type": "object",
|
102074
103893
|
"patternProperties": {
|
102075
103894
|
".*": {
|
@@ -102077,7 +103896,7 @@ Schema for information about the currently authenticated user
|
|
102077
103896
|
}
|
102078
103897
|
}
|
102079
103898
|
},
|
102080
|
-
"
|
103899
|
+
"timer": {
|
102081
103900
|
"type": "object",
|
102082
103901
|
"patternProperties": {
|
102083
103902
|
".*": {
|
@@ -102085,7 +103904,15 @@ Schema for information about the currently authenticated user
|
|
102085
103904
|
}
|
102086
103905
|
}
|
102087
103906
|
},
|
102088
|
-
"
|
103907
|
+
"virtualButton": {
|
103908
|
+
"type": "object",
|
103909
|
+
"patternProperties": {
|
103910
|
+
".*": {
|
103911
|
+
"type": "number"
|
103912
|
+
}
|
103913
|
+
}
|
103914
|
+
},
|
103915
|
+
"webhook": {
|
102089
103916
|
"type": "object",
|
102090
103917
|
"patternProperties": {
|
102091
103918
|
".*": {
|
@@ -102134,11 +103961,11 @@ Schema for information about the currently authenticated user
|
|
102134
103961
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
102135
103962
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
102136
103963
|
"passwordLastUpdated": "2016-06-13T04:00:00.000Z",
|
102137
|
-
"email": "example
|
103964
|
+
"email": "email@example.com",
|
102138
103965
|
"firstName": "Example",
|
102139
103966
|
"lastName": "Name",
|
102140
|
-
"companyName": "
|
102141
|
-
"url": "https://
|
103967
|
+
"companyName": "Example, Inc.",
|
103968
|
+
"url": "https://example.com",
|
102142
103969
|
"emailVerified": true,
|
102143
103970
|
"needsToVerifyEmail": false,
|
102144
103971
|
"twoFactorAuthEnabled": false,
|
@@ -102223,11 +104050,11 @@ Schema for the body of request to modify the current user
|
|
102223
104050
|
|
102224
104051
|
```json
|
102225
104052
|
{
|
102226
|
-
"email": "example
|
104053
|
+
"email": "email@example.com",
|
102227
104054
|
"firstName": "Example",
|
102228
104055
|
"lastName": "Name",
|
102229
|
-
"companyName": "
|
102230
|
-
"url": "https://
|
104056
|
+
"companyName": "Example, Inc.",
|
104057
|
+
"url": "https://example.com",
|
102231
104058
|
"password": "my new password"
|
102232
104059
|
}
|
102233
104060
|
```
|
@@ -104315,6 +106142,36 @@ Schema for a single Notebook
|
|
104315
106142
|
"outputType"
|
104316
106143
|
],
|
104317
106144
|
"additionalProperties": false
|
106145
|
+
},
|
106146
|
+
{
|
106147
|
+
"type": "object",
|
106148
|
+
"properties": {
|
106149
|
+
"outputType": {
|
106150
|
+
"type": "string",
|
106151
|
+
"enum": [
|
106152
|
+
"temporaryUrl"
|
106153
|
+
]
|
106154
|
+
},
|
106155
|
+
"fileName": {
|
106156
|
+
"oneOf": [
|
106157
|
+
{
|
106158
|
+
"type": "string",
|
106159
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
106160
|
+
},
|
106161
|
+
{
|
106162
|
+
"type": "string",
|
106163
|
+
"minLength": 4,
|
106164
|
+
"maxLength": 255,
|
106165
|
+
"pattern": ".*{{.+}}.*"
|
106166
|
+
}
|
106167
|
+
]
|
106168
|
+
}
|
106169
|
+
},
|
106170
|
+
"required": [
|
106171
|
+
"fileName",
|
106172
|
+
"outputType"
|
106173
|
+
],
|
106174
|
+
"additionalProperties": false
|
104318
106175
|
}
|
104319
106176
|
]
|
104320
106177
|
}
|
@@ -104348,7 +106205,7 @@ Schema for a single Notebook
|
|
104348
106205
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
104349
106206
|
"name": "Example Notebook",
|
104350
106207
|
"jupyterFileName": "myNotebook.ipynb",
|
104351
|
-
"jupyterFileUrl": "https
|
106208
|
+
"jupyterFileUrl": "https:/storage.example.com/myNotebook.ipynb",
|
104352
106209
|
"inputs": [
|
104353
106210
|
{
|
104354
106211
|
"fileName": "deviceDataWithAttributes",
|
@@ -104398,7 +106255,7 @@ Schema for a single Notebook
|
|
104398
106255
|
{
|
104399
106256
|
"fileName": "anExternalUrl",
|
104400
106257
|
"inputType": "externalUrl",
|
104401
|
-
"sourceUrl": "https://
|
106258
|
+
"sourceUrl": "https://example.com/external"
|
104402
106259
|
}
|
104403
106260
|
],
|
104404
106261
|
"outputs": [
|
@@ -105325,6 +107182,36 @@ Schema for the body of a Notebook modification request
|
|
105325
107182
|
"outputType"
|
105326
107183
|
],
|
105327
107184
|
"additionalProperties": false
|
107185
|
+
},
|
107186
|
+
{
|
107187
|
+
"type": "object",
|
107188
|
+
"properties": {
|
107189
|
+
"outputType": {
|
107190
|
+
"type": "string",
|
107191
|
+
"enum": [
|
107192
|
+
"temporaryUrl"
|
107193
|
+
]
|
107194
|
+
},
|
107195
|
+
"fileName": {
|
107196
|
+
"oneOf": [
|
107197
|
+
{
|
107198
|
+
"type": "string",
|
107199
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
107200
|
+
},
|
107201
|
+
{
|
107202
|
+
"type": "string",
|
107203
|
+
"minLength": 4,
|
107204
|
+
"maxLength": 255,
|
107205
|
+
"pattern": ".*{{.+}}.*"
|
107206
|
+
}
|
107207
|
+
]
|
107208
|
+
}
|
107209
|
+
},
|
107210
|
+
"required": [
|
107211
|
+
"fileName",
|
107212
|
+
"outputType"
|
107213
|
+
],
|
107214
|
+
"additionalProperties": false
|
105328
107215
|
}
|
105329
107216
|
]
|
105330
107217
|
}
|
@@ -105939,6 +107826,36 @@ Schema for the body of an Notebook creation request
|
|
105939
107826
|
"outputType"
|
105940
107827
|
],
|
105941
107828
|
"additionalProperties": false
|
107829
|
+
},
|
107830
|
+
{
|
107831
|
+
"type": "object",
|
107832
|
+
"properties": {
|
107833
|
+
"outputType": {
|
107834
|
+
"type": "string",
|
107835
|
+
"enum": [
|
107836
|
+
"temporaryUrl"
|
107837
|
+
]
|
107838
|
+
},
|
107839
|
+
"fileName": {
|
107840
|
+
"oneOf": [
|
107841
|
+
{
|
107842
|
+
"type": "string",
|
107843
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
107844
|
+
},
|
107845
|
+
{
|
107846
|
+
"type": "string",
|
107847
|
+
"minLength": 4,
|
107848
|
+
"maxLength": 255,
|
107849
|
+
"pattern": ".*{{.+}}.*"
|
107850
|
+
}
|
107851
|
+
]
|
107852
|
+
}
|
107853
|
+
},
|
107854
|
+
"required": [
|
107855
|
+
"fileName",
|
107856
|
+
"outputType"
|
107857
|
+
],
|
107858
|
+
"additionalProperties": false
|
105942
107859
|
}
|
105943
107860
|
]
|
105944
107861
|
}
|
@@ -106584,6 +108501,36 @@ Schema for a collection of Notebooks
|
|
106584
108501
|
"outputType"
|
106585
108502
|
],
|
106586
108503
|
"additionalProperties": false
|
108504
|
+
},
|
108505
|
+
{
|
108506
|
+
"type": "object",
|
108507
|
+
"properties": {
|
108508
|
+
"outputType": {
|
108509
|
+
"type": "string",
|
108510
|
+
"enum": [
|
108511
|
+
"temporaryUrl"
|
108512
|
+
]
|
108513
|
+
},
|
108514
|
+
"fileName": {
|
108515
|
+
"oneOf": [
|
108516
|
+
{
|
108517
|
+
"type": "string",
|
108518
|
+
"pattern": "^(?!\\.{1,2}$)[0-9a-zA-Z_.-]{1,255}$"
|
108519
|
+
},
|
108520
|
+
{
|
108521
|
+
"type": "string",
|
108522
|
+
"minLength": 4,
|
108523
|
+
"maxLength": 255,
|
108524
|
+
"pattern": ".*{{.+}}.*"
|
108525
|
+
}
|
108526
|
+
]
|
108527
|
+
}
|
108528
|
+
},
|
108529
|
+
"required": [
|
108530
|
+
"fileName",
|
108531
|
+
"outputType"
|
108532
|
+
],
|
108533
|
+
"additionalProperties": false
|
106587
108534
|
}
|
106588
108535
|
]
|
106589
108536
|
}
|
@@ -106657,7 +108604,7 @@ Schema for a collection of Notebooks
|
|
106657
108604
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
106658
108605
|
"name": "Example Notebook",
|
106659
108606
|
"jupyterFileName": "myNotebook.ipynb",
|
106660
|
-
"jupyterFileUrl": "https
|
108607
|
+
"jupyterFileUrl": "https:/storage.example.com/myNotebook.ipynb",
|
106661
108608
|
"inputs": [
|
106662
108609
|
{
|
106663
108610
|
"fileName": "deviceDataWithAttributes",
|
@@ -106707,7 +108654,7 @@ Schema for a collection of Notebooks
|
|
106707
108654
|
{
|
106708
108655
|
"fileName": "anExternalUrl",
|
106709
108656
|
"inputType": "externalUrl",
|
106710
|
-
"sourceUrl": "https://
|
108657
|
+
"sourceUrl": "https://example.com/external"
|
106711
108658
|
}
|
106712
108659
|
],
|
106713
108660
|
"outputs": [
|
@@ -107050,11 +108997,11 @@ Schema for a single Organization
|
|
107050
108997
|
"type": "number"
|
107051
108998
|
},
|
107052
108999
|
"payloadCount": {
|
107053
|
-
"title": "Payload
|
107054
|
-
"description": "Schema for the result of a payload
|
109000
|
+
"title": "Payload Stats",
|
109001
|
+
"description": "Schema for the result of a payload stats request",
|
107055
109002
|
"type": "object",
|
107056
109003
|
"properties": {
|
107057
|
-
"
|
109004
|
+
"dataTable": {
|
107058
109005
|
"type": "object",
|
107059
109006
|
"patternProperties": {
|
107060
109007
|
".*": {
|
@@ -107062,7 +109009,7 @@ Schema for a single Organization
|
|
107062
109009
|
}
|
107063
109010
|
}
|
107064
109011
|
},
|
107065
|
-
"
|
109012
|
+
"deviceCommand": {
|
107066
109013
|
"type": "object",
|
107067
109014
|
"patternProperties": {
|
107068
109015
|
".*": {
|
@@ -107070,7 +109017,15 @@ Schema for a single Organization
|
|
107070
109017
|
}
|
107071
109018
|
}
|
107072
109019
|
},
|
107073
|
-
"
|
109020
|
+
"deviceConnect": {
|
109021
|
+
"type": "object",
|
109022
|
+
"patternProperties": {
|
109023
|
+
".*": {
|
109024
|
+
"type": "number"
|
109025
|
+
}
|
109026
|
+
}
|
109027
|
+
},
|
109028
|
+
"deviceDisconnect": {
|
107074
109029
|
"type": "object",
|
107075
109030
|
"patternProperties": {
|
107076
109031
|
".*": {
|
@@ -107086,7 +109041,7 @@ Schema for a single Organization
|
|
107086
109041
|
}
|
107087
109042
|
}
|
107088
109043
|
},
|
107089
|
-
"
|
109044
|
+
"endpoint": {
|
107090
109045
|
"type": "object",
|
107091
109046
|
"patternProperties": {
|
107092
109047
|
".*": {
|
@@ -107094,7 +109049,7 @@ Schema for a single Organization
|
|
107094
109049
|
}
|
107095
109050
|
}
|
107096
109051
|
},
|
107097
|
-
"
|
109052
|
+
"event": {
|
107098
109053
|
"type": "object",
|
107099
109054
|
"patternProperties": {
|
107100
109055
|
".*": {
|
@@ -107102,7 +109057,7 @@ Schema for a single Organization
|
|
107102
109057
|
}
|
107103
109058
|
}
|
107104
109059
|
},
|
107105
|
-
"
|
109060
|
+
"flowError": {
|
107106
109061
|
"type": "object",
|
107107
109062
|
"patternProperties": {
|
107108
109063
|
".*": {
|
@@ -107110,7 +109065,7 @@ Schema for a single Organization
|
|
107110
109065
|
}
|
107111
109066
|
}
|
107112
109067
|
},
|
107113
|
-
"
|
109068
|
+
"integration": {
|
107114
109069
|
"type": "object",
|
107115
109070
|
"patternProperties": {
|
107116
109071
|
".*": {
|
@@ -107118,7 +109073,7 @@ Schema for a single Organization
|
|
107118
109073
|
}
|
107119
109074
|
}
|
107120
109075
|
},
|
107121
|
-
"
|
109076
|
+
"mqttIn": {
|
107122
109077
|
"type": "object",
|
107123
109078
|
"patternProperties": {
|
107124
109079
|
".*": {
|
@@ -107126,7 +109081,7 @@ Schema for a single Organization
|
|
107126
109081
|
}
|
107127
109082
|
}
|
107128
109083
|
},
|
107129
|
-
"
|
109084
|
+
"mqttOut": {
|
107130
109085
|
"type": "object",
|
107131
109086
|
"patternProperties": {
|
107132
109087
|
".*": {
|
@@ -107134,7 +109089,7 @@ Schema for a single Organization
|
|
107134
109089
|
}
|
107135
109090
|
}
|
107136
109091
|
},
|
107137
|
-
"
|
109092
|
+
"notebook": {
|
107138
109093
|
"type": "object",
|
107139
109094
|
"patternProperties": {
|
107140
109095
|
".*": {
|
@@ -107142,7 +109097,7 @@ Schema for a single Organization
|
|
107142
109097
|
}
|
107143
109098
|
}
|
107144
109099
|
},
|
107145
|
-
"
|
109100
|
+
"timer": {
|
107146
109101
|
"type": "object",
|
107147
109102
|
"patternProperties": {
|
107148
109103
|
".*": {
|
@@ -107150,7 +109105,15 @@ Schema for a single Organization
|
|
107150
109105
|
}
|
107151
109106
|
}
|
107152
109107
|
},
|
107153
|
-
"
|
109108
|
+
"virtualButton": {
|
109109
|
+
"type": "object",
|
109110
|
+
"patternProperties": {
|
109111
|
+
".*": {
|
109112
|
+
"type": "number"
|
109113
|
+
}
|
109114
|
+
}
|
109115
|
+
},
|
109116
|
+
"webhook": {
|
107154
109117
|
"type": "object",
|
107155
109118
|
"patternProperties": {
|
107156
109119
|
".*": {
|
@@ -107239,14 +109202,14 @@ Schema for a single Organization
|
|
107239
109202
|
"userId": "575ed70c7ae143cd83dc4aa9",
|
107240
109203
|
"firstName": "Example",
|
107241
109204
|
"lastName": "Name",
|
107242
|
-
"email": "example
|
109205
|
+
"email": "email@example.com",
|
107243
109206
|
"role": "admin"
|
107244
109207
|
},
|
107245
109208
|
{
|
107246
109209
|
"userId": "575ef90f7ae143cd83dc4aad",
|
107247
109210
|
"firstName": "Other View",
|
107248
109211
|
"lastName": "Only User",
|
107249
|
-
"email": "viewer@
|
109212
|
+
"email": "viewer@example.com",
|
107250
109213
|
"role": "view"
|
107251
109214
|
}
|
107252
109215
|
],
|
@@ -107264,6 +109227,132 @@ Schema for a single Organization
|
|
107264
109227
|
|
107265
109228
|
<br/>
|
107266
109229
|
|
109230
|
+
## Organization Invitation
|
109231
|
+
|
109232
|
+
Schema for a pending invitation to an Organization
|
109233
|
+
|
109234
|
+
### <a name="organization-invitation-schema"></a> Schema
|
109235
|
+
|
109236
|
+
```json
|
109237
|
+
{
|
109238
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
109239
|
+
"type": "object",
|
109240
|
+
"properties": {
|
109241
|
+
"id": {
|
109242
|
+
"type": "string",
|
109243
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109244
|
+
},
|
109245
|
+
"email": {
|
109246
|
+
"type": "string",
|
109247
|
+
"format": "email",
|
109248
|
+
"maxLength": 1024
|
109249
|
+
},
|
109250
|
+
"role": {
|
109251
|
+
"type": "string",
|
109252
|
+
"enum": [
|
109253
|
+
"admin",
|
109254
|
+
"edit",
|
109255
|
+
"collaborate",
|
109256
|
+
"view",
|
109257
|
+
"none"
|
109258
|
+
]
|
109259
|
+
},
|
109260
|
+
"applicationRoles": {
|
109261
|
+
"type": "array",
|
109262
|
+
"items": {
|
109263
|
+
"type": "object",
|
109264
|
+
"properties": {
|
109265
|
+
"resourceId": {
|
109266
|
+
"type": "string",
|
109267
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109268
|
+
},
|
109269
|
+
"role": {
|
109270
|
+
"type": "string",
|
109271
|
+
"enum": [
|
109272
|
+
"collaborate",
|
109273
|
+
"view",
|
109274
|
+
"none"
|
109275
|
+
]
|
109276
|
+
}
|
109277
|
+
},
|
109278
|
+
"required": [
|
109279
|
+
"resourceId",
|
109280
|
+
"role"
|
109281
|
+
],
|
109282
|
+
"additionalProperties": false
|
109283
|
+
},
|
109284
|
+
"maxItems": 1000
|
109285
|
+
},
|
109286
|
+
"dashboardRoles": {
|
109287
|
+
"type": "array",
|
109288
|
+
"items": {
|
109289
|
+
"type": "object",
|
109290
|
+
"properties": {
|
109291
|
+
"resourceId": {
|
109292
|
+
"type": "string",
|
109293
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109294
|
+
},
|
109295
|
+
"role": {
|
109296
|
+
"type": "string",
|
109297
|
+
"enum": [
|
109298
|
+
"collaborate",
|
109299
|
+
"view",
|
109300
|
+
"none"
|
109301
|
+
]
|
109302
|
+
}
|
109303
|
+
},
|
109304
|
+
"required": [
|
109305
|
+
"resourceId",
|
109306
|
+
"role"
|
109307
|
+
],
|
109308
|
+
"additionalProperties": false
|
109309
|
+
},
|
109310
|
+
"maxItems": 1000
|
109311
|
+
},
|
109312
|
+
"inviteDate": {
|
109313
|
+
"type": "string",
|
109314
|
+
"format": "date-time"
|
109315
|
+
},
|
109316
|
+
"ttl": {
|
109317
|
+
"type": "number"
|
109318
|
+
},
|
109319
|
+
"hasExpired": {
|
109320
|
+
"type": "boolean"
|
109321
|
+
},
|
109322
|
+
"disallowTransfer": {
|
109323
|
+
"type": "boolean"
|
109324
|
+
}
|
109325
|
+
}
|
109326
|
+
}
|
109327
|
+
```
|
109328
|
+
### <a name="organization-invitation-example"></a> Example
|
109329
|
+
|
109330
|
+
```json
|
109331
|
+
{
|
109332
|
+
"id": "575ed71e7ae143cd83dc4aaa",
|
109333
|
+
"email": "invitedUser@example.com",
|
109334
|
+
"role": "edit",
|
109335
|
+
"applicationRoles": [
|
109336
|
+
{
|
109337
|
+
"resourceId": "575ec8687ae143cd83dc4a97",
|
109338
|
+
"role": "view"
|
109339
|
+
}
|
109340
|
+
],
|
109341
|
+
"dashboardRoles": [
|
109342
|
+
{
|
109343
|
+
"resourceId": "575ece2b7ae143cd83dc4a9b",
|
109344
|
+
"role": "none"
|
109345
|
+
}
|
109346
|
+
],
|
109347
|
+
"inviteDate": "2016-05-13T04:00:00.000Z",
|
109348
|
+
"ttl": 4233600000,
|
109349
|
+
"hasExpired": true,
|
109350
|
+
"disallowTransfer": false
|
109351
|
+
}
|
109352
|
+
```
|
109353
|
+
|
109354
|
+
<br/>
|
109355
|
+
|
107267
109356
|
## Organization Invitation Action
|
107268
109357
|
|
107269
109358
|
Schema for the body of a request to accept or reject an invitation
|
@@ -107300,7 +109389,7 @@ Schema for the body of a request to accept or reject an invitation
|
|
107300
109389
|
|
107301
109390
|
```json
|
107302
109391
|
{
|
107303
|
-
"email": "invitedUser@
|
109392
|
+
"email": "invitedUser@example.com",
|
107304
109393
|
"token": "the_invitation_token",
|
107305
109394
|
"accept": true
|
107306
109395
|
}
|
@@ -107308,6 +109397,179 @@ Schema for the body of a request to accept or reject an invitation
|
|
107308
109397
|
|
107309
109398
|
<br/>
|
107310
109399
|
|
109400
|
+
## Instance Organization Invitations
|
109401
|
+
|
109402
|
+
Schema for an collection of pending invitations to an Instance Organization
|
109403
|
+
|
109404
|
+
### <a name="instance-organization-invitations-schema"></a> Schema
|
109405
|
+
|
109406
|
+
```json
|
109407
|
+
{
|
109408
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
109409
|
+
"type": "object",
|
109410
|
+
"properties": {
|
109411
|
+
"items": {
|
109412
|
+
"type": "array",
|
109413
|
+
"items": {
|
109414
|
+
"title": "Organization Invitation",
|
109415
|
+
"description": "Schema for a pending invitation to an Organization",
|
109416
|
+
"type": "object",
|
109417
|
+
"properties": {
|
109418
|
+
"id": {
|
109419
|
+
"type": "string",
|
109420
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109421
|
+
},
|
109422
|
+
"email": {
|
109423
|
+
"type": "string",
|
109424
|
+
"format": "email",
|
109425
|
+
"maxLength": 1024
|
109426
|
+
},
|
109427
|
+
"role": {
|
109428
|
+
"type": "string",
|
109429
|
+
"enum": [
|
109430
|
+
"admin",
|
109431
|
+
"edit",
|
109432
|
+
"collaborate",
|
109433
|
+
"view",
|
109434
|
+
"none"
|
109435
|
+
]
|
109436
|
+
},
|
109437
|
+
"applicationRoles": {
|
109438
|
+
"type": "array",
|
109439
|
+
"items": {
|
109440
|
+
"type": "object",
|
109441
|
+
"properties": {
|
109442
|
+
"resourceId": {
|
109443
|
+
"type": "string",
|
109444
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109445
|
+
},
|
109446
|
+
"role": {
|
109447
|
+
"type": "string",
|
109448
|
+
"enum": [
|
109449
|
+
"collaborate",
|
109450
|
+
"view",
|
109451
|
+
"none"
|
109452
|
+
]
|
109453
|
+
}
|
109454
|
+
},
|
109455
|
+
"required": [
|
109456
|
+
"resourceId",
|
109457
|
+
"role"
|
109458
|
+
],
|
109459
|
+
"additionalProperties": false
|
109460
|
+
},
|
109461
|
+
"maxItems": 1000
|
109462
|
+
},
|
109463
|
+
"dashboardRoles": {
|
109464
|
+
"type": "array",
|
109465
|
+
"items": {
|
109466
|
+
"type": "object",
|
109467
|
+
"properties": {
|
109468
|
+
"resourceId": {
|
109469
|
+
"type": "string",
|
109470
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109471
|
+
},
|
109472
|
+
"role": {
|
109473
|
+
"type": "string",
|
109474
|
+
"enum": [
|
109475
|
+
"collaborate",
|
109476
|
+
"view",
|
109477
|
+
"none"
|
109478
|
+
]
|
109479
|
+
}
|
109480
|
+
},
|
109481
|
+
"required": [
|
109482
|
+
"resourceId",
|
109483
|
+
"role"
|
109484
|
+
],
|
109485
|
+
"additionalProperties": false
|
109486
|
+
},
|
109487
|
+
"maxItems": 1000
|
109488
|
+
},
|
109489
|
+
"inviteDate": {
|
109490
|
+
"type": "string",
|
109491
|
+
"format": "date-time"
|
109492
|
+
},
|
109493
|
+
"ttl": {
|
109494
|
+
"type": "number"
|
109495
|
+
},
|
109496
|
+
"hasExpired": {
|
109497
|
+
"type": "boolean"
|
109498
|
+
},
|
109499
|
+
"disallowTransfer": {
|
109500
|
+
"type": "boolean"
|
109501
|
+
}
|
109502
|
+
}
|
109503
|
+
}
|
109504
|
+
},
|
109505
|
+
"instanceId": {
|
109506
|
+
"type": "string",
|
109507
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109508
|
+
},
|
109509
|
+
"orgId": {
|
109510
|
+
"type": "string",
|
109511
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109512
|
+
},
|
109513
|
+
"count": {
|
109514
|
+
"type": "integer"
|
109515
|
+
},
|
109516
|
+
"filter": {
|
109517
|
+
"type": "string"
|
109518
|
+
},
|
109519
|
+
"filterField": {
|
109520
|
+
"type": "string"
|
109521
|
+
},
|
109522
|
+
"sortField": {
|
109523
|
+
"type": "string"
|
109524
|
+
},
|
109525
|
+
"sortDirection": {
|
109526
|
+
"type": "string",
|
109527
|
+
"enum": [
|
109528
|
+
"asc",
|
109529
|
+
"desc",
|
109530
|
+
"ASC",
|
109531
|
+
"DESC",
|
109532
|
+
""
|
109533
|
+
]
|
109534
|
+
}
|
109535
|
+
}
|
109536
|
+
}
|
109537
|
+
```
|
109538
|
+
### <a name="instance-organization-invitations-example"></a> Example
|
109539
|
+
|
109540
|
+
```json
|
109541
|
+
{
|
109542
|
+
"items": [
|
109543
|
+
{
|
109544
|
+
"id": "575ed71e7ae143cd83dc4aaa",
|
109545
|
+
"email": "invitedUser@example.com",
|
109546
|
+
"role": "edit",
|
109547
|
+
"applicationRoles": [
|
109548
|
+
{
|
109549
|
+
"resourceId": "575ec8687ae143cd83dc4a97",
|
109550
|
+
"role": "view"
|
109551
|
+
}
|
109552
|
+
],
|
109553
|
+
"dashboardRoles": [
|
109554
|
+
{
|
109555
|
+
"resourceId": "575ece2b7ae143cd83dc4a9b",
|
109556
|
+
"role": "none"
|
109557
|
+
}
|
109558
|
+
],
|
109559
|
+
"inviteDate": "2016-05-13T04:00:00.000Z",
|
109560
|
+
"ttl": 4233600000,
|
109561
|
+
"hasExpired": true,
|
109562
|
+
"disallowTransfer": false
|
109563
|
+
}
|
109564
|
+
],
|
109565
|
+
"count": 8,
|
109566
|
+
"sortField": "role",
|
109567
|
+
"sortDirection": "asc"
|
109568
|
+
}
|
109569
|
+
```
|
109570
|
+
|
109571
|
+
<br/>
|
109572
|
+
|
107311
109573
|
## Organization Invitation Information
|
107312
109574
|
|
107313
109575
|
Schema for information about an invitation
|
@@ -107357,7 +109619,7 @@ Schema for information about an invitation
|
|
107357
109619
|
```json
|
107358
109620
|
{
|
107359
109621
|
"orgName": "My Organization",
|
107360
|
-
"email": "invitedUser@
|
109622
|
+
"email": "invitedUser@example.com",
|
107361
109623
|
"role": "edit",
|
107362
109624
|
"inviteDate": "2016-05-13T04:00:00.000Z",
|
107363
109625
|
"ttl": 4233600000,
|
@@ -107460,7 +109722,7 @@ Schema for the body of a request to send an invitation
|
|
107460
109722
|
|
107461
109723
|
```json
|
107462
109724
|
{
|
107463
|
-
"email": "invitedUser@
|
109725
|
+
"email": "invitedUser@example.com",
|
107464
109726
|
"role": "edit"
|
107465
109727
|
}
|
107466
109728
|
```
|
@@ -107512,89 +109774,94 @@ Schema for an array of pending invitations to an Organization
|
|
107512
109774
|
"items": {
|
107513
109775
|
"type": "object",
|
107514
109776
|
"properties": {
|
107515
|
-
"
|
107516
|
-
|
107517
|
-
|
107518
|
-
|
107519
|
-
|
107520
|
-
|
107521
|
-
|
107522
|
-
|
107523
|
-
|
107524
|
-
|
107525
|
-
|
107526
|
-
|
107527
|
-
|
107528
|
-
|
107529
|
-
"
|
107530
|
-
"
|
107531
|
-
|
107532
|
-
|
107533
|
-
|
107534
|
-
|
107535
|
-
|
107536
|
-
|
107537
|
-
|
107538
|
-
|
107539
|
-
|
107540
|
-
|
107541
|
-
|
109777
|
+
"title": "Organization Invitation",
|
109778
|
+
"description": "Schema for a pending invitation to an Organization",
|
109779
|
+
"type": "object",
|
109780
|
+
"properties": {
|
109781
|
+
"id": {
|
109782
|
+
"type": "string",
|
109783
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109784
|
+
},
|
109785
|
+
"email": {
|
109786
|
+
"type": "string",
|
109787
|
+
"format": "email",
|
109788
|
+
"maxLength": 1024
|
109789
|
+
},
|
109790
|
+
"role": {
|
109791
|
+
"type": "string",
|
109792
|
+
"enum": [
|
109793
|
+
"admin",
|
109794
|
+
"edit",
|
109795
|
+
"collaborate",
|
109796
|
+
"view",
|
109797
|
+
"none"
|
109798
|
+
]
|
109799
|
+
},
|
109800
|
+
"applicationRoles": {
|
109801
|
+
"type": "array",
|
109802
|
+
"items": {
|
109803
|
+
"type": "object",
|
109804
|
+
"properties": {
|
109805
|
+
"resourceId": {
|
109806
|
+
"type": "string",
|
109807
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109808
|
+
},
|
109809
|
+
"role": {
|
109810
|
+
"type": "string",
|
109811
|
+
"enum": [
|
109812
|
+
"collaborate",
|
109813
|
+
"view",
|
109814
|
+
"none"
|
109815
|
+
]
|
109816
|
+
}
|
107542
109817
|
},
|
107543
|
-
"
|
107544
|
-
"
|
107545
|
-
"
|
107546
|
-
|
107547
|
-
|
107548
|
-
"none"
|
107549
|
-
]
|
107550
|
-
}
|
109818
|
+
"required": [
|
109819
|
+
"resourceId",
|
109820
|
+
"role"
|
109821
|
+
],
|
109822
|
+
"additionalProperties": false
|
107551
109823
|
},
|
107552
|
-
"
|
107553
|
-
"resourceId",
|
107554
|
-
"role"
|
107555
|
-
],
|
107556
|
-
"additionalProperties": false
|
109824
|
+
"maxItems": 1000
|
107557
109825
|
},
|
107558
|
-
"
|
107559
|
-
|
107560
|
-
|
107561
|
-
|
107562
|
-
|
107563
|
-
|
107564
|
-
|
107565
|
-
|
107566
|
-
|
107567
|
-
"
|
109826
|
+
"dashboardRoles": {
|
109827
|
+
"type": "array",
|
109828
|
+
"items": {
|
109829
|
+
"type": "object",
|
109830
|
+
"properties": {
|
109831
|
+
"resourceId": {
|
109832
|
+
"type": "string",
|
109833
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
109834
|
+
},
|
109835
|
+
"role": {
|
109836
|
+
"type": "string",
|
109837
|
+
"enum": [
|
109838
|
+
"collaborate",
|
109839
|
+
"view",
|
109840
|
+
"none"
|
109841
|
+
]
|
109842
|
+
}
|
107568
109843
|
},
|
107569
|
-
"
|
107570
|
-
"
|
107571
|
-
"
|
107572
|
-
|
107573
|
-
|
107574
|
-
"none"
|
107575
|
-
]
|
107576
|
-
}
|
109844
|
+
"required": [
|
109845
|
+
"resourceId",
|
109846
|
+
"role"
|
109847
|
+
],
|
109848
|
+
"additionalProperties": false
|
107577
109849
|
},
|
107578
|
-
"
|
107579
|
-
"resourceId",
|
107580
|
-
"role"
|
107581
|
-
],
|
107582
|
-
"additionalProperties": false
|
109850
|
+
"maxItems": 1000
|
107583
109851
|
},
|
107584
|
-
"
|
107585
|
-
|
107586
|
-
|
107587
|
-
|
107588
|
-
"
|
107589
|
-
|
107590
|
-
|
107591
|
-
"
|
107592
|
-
|
107593
|
-
|
107594
|
-
"
|
107595
|
-
|
107596
|
-
|
107597
|
-
"type": "boolean"
|
109852
|
+
"inviteDate": {
|
109853
|
+
"type": "string",
|
109854
|
+
"format": "date-time"
|
109855
|
+
},
|
109856
|
+
"ttl": {
|
109857
|
+
"type": "number"
|
109858
|
+
},
|
109859
|
+
"hasExpired": {
|
109860
|
+
"type": "boolean"
|
109861
|
+
},
|
109862
|
+
"disallowTransfer": {
|
109863
|
+
"type": "boolean"
|
109864
|
+
}
|
107598
109865
|
}
|
107599
109866
|
}
|
107600
109867
|
}
|
@@ -107606,7 +109873,7 @@ Schema for an array of pending invitations to an Organization
|
|
107606
109873
|
[
|
107607
109874
|
{
|
107608
109875
|
"id": "575ed71e7ae143cd83dc4aaa",
|
107609
|
-
"email": "invitedUser@
|
109876
|
+
"email": "invitedUser@example.com",
|
107610
109877
|
"role": "edit",
|
107611
109878
|
"applicationRoles": [
|
107612
109879
|
{
|
@@ -107832,6 +110099,93 @@ Schema for the body of an Organization creation request
|
|
107832
110099
|
|
107833
110100
|
<br/>
|
107834
110101
|
|
110102
|
+
## Organization Role Info
|
110103
|
+
|
110104
|
+
Schema for an Organization member's role info
|
110105
|
+
|
110106
|
+
### <a name="organization-role-info-schema"></a> Schema
|
110107
|
+
|
110108
|
+
```json
|
110109
|
+
{
|
110110
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
110111
|
+
"type": "object",
|
110112
|
+
"properties": {
|
110113
|
+
"role": {
|
110114
|
+
"type": "string",
|
110115
|
+
"enum": [
|
110116
|
+
"admin",
|
110117
|
+
"edit",
|
110118
|
+
"collaborate",
|
110119
|
+
"view",
|
110120
|
+
"none"
|
110121
|
+
]
|
110122
|
+
},
|
110123
|
+
"applicationRoles": {
|
110124
|
+
"type": "array",
|
110125
|
+
"items": {
|
110126
|
+
"type": "object",
|
110127
|
+
"properties": {
|
110128
|
+
"resourceId": {
|
110129
|
+
"type": "string",
|
110130
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
110131
|
+
},
|
110132
|
+
"role": {
|
110133
|
+
"type": "string",
|
110134
|
+
"enum": [
|
110135
|
+
"collaborate",
|
110136
|
+
"view",
|
110137
|
+
"none"
|
110138
|
+
]
|
110139
|
+
}
|
110140
|
+
},
|
110141
|
+
"required": [
|
110142
|
+
"resourceId",
|
110143
|
+
"role"
|
110144
|
+
],
|
110145
|
+
"additionalProperties": false
|
110146
|
+
},
|
110147
|
+
"maxItems": 1000
|
110148
|
+
},
|
110149
|
+
"dashboardRoles": {
|
110150
|
+
"type": "array",
|
110151
|
+
"items": {
|
110152
|
+
"type": "object",
|
110153
|
+
"properties": {
|
110154
|
+
"resourceId": {
|
110155
|
+
"type": "string",
|
110156
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
110157
|
+
},
|
110158
|
+
"role": {
|
110159
|
+
"type": "string",
|
110160
|
+
"enum": [
|
110161
|
+
"collaborate",
|
110162
|
+
"view",
|
110163
|
+
"none"
|
110164
|
+
]
|
110165
|
+
}
|
110166
|
+
},
|
110167
|
+
"required": [
|
110168
|
+
"resourceId",
|
110169
|
+
"role"
|
110170
|
+
],
|
110171
|
+
"additionalProperties": false
|
110172
|
+
},
|
110173
|
+
"maxItems": 1000
|
110174
|
+
}
|
110175
|
+
},
|
110176
|
+
"additionalProperties": false
|
110177
|
+
}
|
110178
|
+
```
|
110179
|
+
### <a name="organization-role-info-example"></a> Example
|
110180
|
+
|
110181
|
+
```json
|
110182
|
+
{
|
110183
|
+
"role": "view"
|
110184
|
+
}
|
110185
|
+
```
|
110186
|
+
|
110187
|
+
<br/>
|
110188
|
+
|
107835
110189
|
## Organizations
|
107836
110190
|
|
107837
110191
|
Schema for a collection of Organizations
|
@@ -108103,11 +110457,11 @@ Schema for a collection of Organizations
|
|
108103
110457
|
"type": "number"
|
108104
110458
|
},
|
108105
110459
|
"payloadCount": {
|
108106
|
-
"title": "Payload
|
108107
|
-
"description": "Schema for the result of a payload
|
110460
|
+
"title": "Payload Stats",
|
110461
|
+
"description": "Schema for the result of a payload stats request",
|
108108
110462
|
"type": "object",
|
108109
110463
|
"properties": {
|
108110
|
-
"
|
110464
|
+
"dataTable": {
|
108111
110465
|
"type": "object",
|
108112
110466
|
"patternProperties": {
|
108113
110467
|
".*": {
|
@@ -108115,7 +110469,7 @@ Schema for a collection of Organizations
|
|
108115
110469
|
}
|
108116
110470
|
}
|
108117
110471
|
},
|
108118
|
-
"
|
110472
|
+
"deviceCommand": {
|
108119
110473
|
"type": "object",
|
108120
110474
|
"patternProperties": {
|
108121
110475
|
".*": {
|
@@ -108123,7 +110477,15 @@ Schema for a collection of Organizations
|
|
108123
110477
|
}
|
108124
110478
|
}
|
108125
110479
|
},
|
108126
|
-
"
|
110480
|
+
"deviceConnect": {
|
110481
|
+
"type": "object",
|
110482
|
+
"patternProperties": {
|
110483
|
+
".*": {
|
110484
|
+
"type": "number"
|
110485
|
+
}
|
110486
|
+
}
|
110487
|
+
},
|
110488
|
+
"deviceDisconnect": {
|
108127
110489
|
"type": "object",
|
108128
110490
|
"patternProperties": {
|
108129
110491
|
".*": {
|
@@ -108139,7 +110501,7 @@ Schema for a collection of Organizations
|
|
108139
110501
|
}
|
108140
110502
|
}
|
108141
110503
|
},
|
108142
|
-
"
|
110504
|
+
"endpoint": {
|
108143
110505
|
"type": "object",
|
108144
110506
|
"patternProperties": {
|
108145
110507
|
".*": {
|
@@ -108147,7 +110509,7 @@ Schema for a collection of Organizations
|
|
108147
110509
|
}
|
108148
110510
|
}
|
108149
110511
|
},
|
108150
|
-
"
|
110512
|
+
"event": {
|
108151
110513
|
"type": "object",
|
108152
110514
|
"patternProperties": {
|
108153
110515
|
".*": {
|
@@ -108155,7 +110517,7 @@ Schema for a collection of Organizations
|
|
108155
110517
|
}
|
108156
110518
|
}
|
108157
110519
|
},
|
108158
|
-
"
|
110520
|
+
"flowError": {
|
108159
110521
|
"type": "object",
|
108160
110522
|
"patternProperties": {
|
108161
110523
|
".*": {
|
@@ -108163,7 +110525,7 @@ Schema for a collection of Organizations
|
|
108163
110525
|
}
|
108164
110526
|
}
|
108165
110527
|
},
|
108166
|
-
"
|
110528
|
+
"integration": {
|
108167
110529
|
"type": "object",
|
108168
110530
|
"patternProperties": {
|
108169
110531
|
".*": {
|
@@ -108171,7 +110533,7 @@ Schema for a collection of Organizations
|
|
108171
110533
|
}
|
108172
110534
|
}
|
108173
110535
|
},
|
108174
|
-
"
|
110536
|
+
"mqttIn": {
|
108175
110537
|
"type": "object",
|
108176
110538
|
"patternProperties": {
|
108177
110539
|
".*": {
|
@@ -108179,7 +110541,7 @@ Schema for a collection of Organizations
|
|
108179
110541
|
}
|
108180
110542
|
}
|
108181
110543
|
},
|
108182
|
-
"
|
110544
|
+
"mqttOut": {
|
108183
110545
|
"type": "object",
|
108184
110546
|
"patternProperties": {
|
108185
110547
|
".*": {
|
@@ -108187,7 +110549,7 @@ Schema for a collection of Organizations
|
|
108187
110549
|
}
|
108188
110550
|
}
|
108189
110551
|
},
|
108190
|
-
"
|
110552
|
+
"notebook": {
|
108191
110553
|
"type": "object",
|
108192
110554
|
"patternProperties": {
|
108193
110555
|
".*": {
|
@@ -108195,7 +110557,7 @@ Schema for a collection of Organizations
|
|
108195
110557
|
}
|
108196
110558
|
}
|
108197
110559
|
},
|
108198
|
-
"
|
110560
|
+
"timer": {
|
108199
110561
|
"type": "object",
|
108200
110562
|
"patternProperties": {
|
108201
110563
|
".*": {
|
@@ -108203,7 +110565,15 @@ Schema for a collection of Organizations
|
|
108203
110565
|
}
|
108204
110566
|
}
|
108205
110567
|
},
|
108206
|
-
"
|
110568
|
+
"virtualButton": {
|
110569
|
+
"type": "object",
|
110570
|
+
"patternProperties": {
|
110571
|
+
".*": {
|
110572
|
+
"type": "number"
|
110573
|
+
}
|
110574
|
+
}
|
110575
|
+
},
|
110576
|
+
"webhook": {
|
108207
110577
|
"type": "object",
|
108208
110578
|
"patternProperties": {
|
108209
110579
|
".*": {
|
@@ -108328,14 +110698,14 @@ Schema for a collection of Organizations
|
|
108328
110698
|
"userId": "575ed70c7ae143cd83dc4aa9",
|
108329
110699
|
"firstName": "Example",
|
108330
110700
|
"lastName": "Name",
|
108331
|
-
"email": "example
|
110701
|
+
"email": "email@example.com",
|
108332
110702
|
"role": "admin"
|
108333
110703
|
},
|
108334
110704
|
{
|
108335
110705
|
"userId": "575ef90f7ae143cd83dc4aad",
|
108336
110706
|
"firstName": "Other View",
|
108337
110707
|
"lastName": "Only User",
|
108338
|
-
"email": "viewer@
|
110708
|
+
"email": "viewer@example.com",
|
108339
110709
|
"role": "view"
|
108340
110710
|
}
|
108341
110711
|
],
|
@@ -108401,7 +110771,7 @@ Schema for the body of a request to complete the reset password flow
|
|
108401
110771
|
```json
|
108402
110772
|
{
|
108403
110773
|
"token": "the_password_reset_token",
|
108404
|
-
"email": "example
|
110774
|
+
"email": "email@example.com",
|
108405
110775
|
"password": "the new password"
|
108406
110776
|
}
|
108407
110777
|
```
|
@@ -108435,7 +110805,7 @@ Schema for the body of a request to start the reset password flow
|
|
108435
110805
|
|
108436
110806
|
```json
|
108437
110807
|
{
|
108438
|
-
"email": "example
|
110808
|
+
"email": "email@example.com"
|
108439
110809
|
}
|
108440
110810
|
```
|
108441
110811
|
|
@@ -108479,18 +110849,18 @@ Schema for result of a successful password reset
|
|
108479
110849
|
|
108480
110850
|
<br/>
|
108481
110851
|
|
108482
|
-
## Payload
|
110852
|
+
## Payload Stats
|
108483
110853
|
|
108484
|
-
Schema for the result of a payload
|
110854
|
+
Schema for the result of a payload stats request
|
108485
110855
|
|
108486
|
-
### <a name="payload-
|
110856
|
+
### <a name="payload-stats-schema"></a> Schema
|
108487
110857
|
|
108488
110858
|
```json
|
108489
110859
|
{
|
108490
110860
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
108491
110861
|
"type": "object",
|
108492
110862
|
"properties": {
|
108493
|
-
"
|
110863
|
+
"dataTable": {
|
108494
110864
|
"type": "object",
|
108495
110865
|
"patternProperties": {
|
108496
110866
|
".*": {
|
@@ -108498,7 +110868,7 @@ Schema for the result of a payload count request
|
|
108498
110868
|
}
|
108499
110869
|
}
|
108500
110870
|
},
|
108501
|
-
"
|
110871
|
+
"deviceCommand": {
|
108502
110872
|
"type": "object",
|
108503
110873
|
"patternProperties": {
|
108504
110874
|
".*": {
|
@@ -108506,7 +110876,15 @@ Schema for the result of a payload count request
|
|
108506
110876
|
}
|
108507
110877
|
}
|
108508
110878
|
},
|
108509
|
-
"
|
110879
|
+
"deviceConnect": {
|
110880
|
+
"type": "object",
|
110881
|
+
"patternProperties": {
|
110882
|
+
".*": {
|
110883
|
+
"type": "number"
|
110884
|
+
}
|
110885
|
+
}
|
110886
|
+
},
|
110887
|
+
"deviceDisconnect": {
|
108510
110888
|
"type": "object",
|
108511
110889
|
"patternProperties": {
|
108512
110890
|
".*": {
|
@@ -108522,7 +110900,7 @@ Schema for the result of a payload count request
|
|
108522
110900
|
}
|
108523
110901
|
}
|
108524
110902
|
},
|
108525
|
-
"
|
110903
|
+
"endpoint": {
|
108526
110904
|
"type": "object",
|
108527
110905
|
"patternProperties": {
|
108528
110906
|
".*": {
|
@@ -108530,7 +110908,7 @@ Schema for the result of a payload count request
|
|
108530
110908
|
}
|
108531
110909
|
}
|
108532
110910
|
},
|
108533
|
-
"
|
110911
|
+
"event": {
|
108534
110912
|
"type": "object",
|
108535
110913
|
"patternProperties": {
|
108536
110914
|
".*": {
|
@@ -108538,7 +110916,7 @@ Schema for the result of a payload count request
|
|
108538
110916
|
}
|
108539
110917
|
}
|
108540
110918
|
},
|
108541
|
-
"
|
110919
|
+
"flowError": {
|
108542
110920
|
"type": "object",
|
108543
110921
|
"patternProperties": {
|
108544
110922
|
".*": {
|
@@ -108546,7 +110924,7 @@ Schema for the result of a payload count request
|
|
108546
110924
|
}
|
108547
110925
|
}
|
108548
110926
|
},
|
108549
|
-
"
|
110927
|
+
"integration": {
|
108550
110928
|
"type": "object",
|
108551
110929
|
"patternProperties": {
|
108552
110930
|
".*": {
|
@@ -108554,7 +110932,7 @@ Schema for the result of a payload count request
|
|
108554
110932
|
}
|
108555
110933
|
}
|
108556
110934
|
},
|
108557
|
-
"
|
110935
|
+
"mqttIn": {
|
108558
110936
|
"type": "object",
|
108559
110937
|
"patternProperties": {
|
108560
110938
|
".*": {
|
@@ -108562,7 +110940,7 @@ Schema for the result of a payload count request
|
|
108562
110940
|
}
|
108563
110941
|
}
|
108564
110942
|
},
|
108565
|
-
"
|
110943
|
+
"mqttOut": {
|
108566
110944
|
"type": "object",
|
108567
110945
|
"patternProperties": {
|
108568
110946
|
".*": {
|
@@ -108570,7 +110948,7 @@ Schema for the result of a payload count request
|
|
108570
110948
|
}
|
108571
110949
|
}
|
108572
110950
|
},
|
108573
|
-
"
|
110951
|
+
"notebook": {
|
108574
110952
|
"type": "object",
|
108575
110953
|
"patternProperties": {
|
108576
110954
|
".*": {
|
@@ -108578,7 +110956,7 @@ Schema for the result of a payload count request
|
|
108578
110956
|
}
|
108579
110957
|
}
|
108580
110958
|
},
|
108581
|
-
"
|
110959
|
+
"timer": {
|
108582
110960
|
"type": "object",
|
108583
110961
|
"patternProperties": {
|
108584
110962
|
".*": {
|
@@ -108586,7 +110964,15 @@ Schema for the result of a payload count request
|
|
108586
110964
|
}
|
108587
110965
|
}
|
108588
110966
|
},
|
108589
|
-
"
|
110967
|
+
"virtualButton": {
|
110968
|
+
"type": "object",
|
110969
|
+
"patternProperties": {
|
110970
|
+
".*": {
|
110971
|
+
"type": "number"
|
110972
|
+
}
|
110973
|
+
}
|
110974
|
+
},
|
110975
|
+
"webhook": {
|
108590
110976
|
"type": "object",
|
108591
110977
|
"patternProperties": {
|
108592
110978
|
".*": {
|
@@ -108597,7 +110983,7 @@ Schema for the result of a payload count request
|
|
108597
110983
|
}
|
108598
110984
|
}
|
108599
110985
|
```
|
108600
|
-
### <a name="payload-
|
110986
|
+
### <a name="payload-stats-example"></a> Example
|
108601
110987
|
|
108602
110988
|
```json
|
108603
110989
|
{
|
@@ -108835,7 +111221,7 @@ SAML Response body for login
|
|
108835
111221
|
```json
|
108836
111222
|
{
|
108837
111223
|
"SAMLResponse": "PHNhbWxwOlJlc3BvbnNlIHhtbG5zOnNhbWxwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoy...",
|
108838
|
-
"SAMLDomain": "
|
111224
|
+
"SAMLDomain": "example.com"
|
108839
111225
|
}
|
108840
111226
|
```
|
108841
111227
|
|
@@ -109518,6 +111904,7 @@ Schema for the body of a User authentication request
|
|
109518
111904
|
"deviceRecipe.*",
|
109519
111905
|
"deviceRecipes.*",
|
109520
111906
|
"devices.*",
|
111907
|
+
"edgeDeployment.*",
|
109521
111908
|
"edgeDeployments.*",
|
109522
111909
|
"event.*",
|
109523
111910
|
"events.*",
|
@@ -109618,6 +112005,7 @@ Schema for the body of a User authentication request
|
|
109618
112005
|
"device.getLogEntries",
|
109619
112006
|
"device.getState",
|
109620
112007
|
"device.patch",
|
112008
|
+
"device.payloadCounts",
|
109621
112009
|
"device.removeData",
|
109622
112010
|
"device.sendCommand",
|
109623
112011
|
"device.sendState",
|
@@ -109636,10 +112024,12 @@ Schema for the body of a User authentication request
|
|
109636
112024
|
"devices.detailedSummary",
|
109637
112025
|
"devices.export",
|
109638
112026
|
"devices.get",
|
112027
|
+
"devices.payloadCounts",
|
109639
112028
|
"devices.post",
|
109640
112029
|
"devices.sendCommand",
|
109641
112030
|
"devices.tagKeys",
|
109642
112031
|
"devices.tagValues",
|
112032
|
+
"edgeDeployment.get",
|
109643
112033
|
"edgeDeployments.get",
|
109644
112034
|
"edgeDeployments.release",
|
109645
112035
|
"edgeDeployments.remove",
|
@@ -109821,6 +112211,13 @@ Schema for the body of a User authentication request
|
|
109821
112211
|
"instanceOrgMembers.*",
|
109822
112212
|
"instanceOrgMembers.get",
|
109823
112213
|
"instanceOrgMembers.post",
|
112214
|
+
"instanceOrgInvite.*",
|
112215
|
+
"instanceOrgInvite.get",
|
112216
|
+
"instanceOrgInvite.delete",
|
112217
|
+
"instanceOrgInvite.resendInvite",
|
112218
|
+
"instanceOrgInvites.*",
|
112219
|
+
"instanceOrgInvites.get",
|
112220
|
+
"instanceOrgInvites.post",
|
109824
112221
|
"instanceApiTokens.*",
|
109825
112222
|
"instanceApiTokens.get",
|
109826
112223
|
"instanceApiTokens.post",
|
@@ -109889,7 +112286,7 @@ Schema for the body of a User authentication request
|
|
109889
112286
|
|
109890
112287
|
```json
|
109891
112288
|
{
|
109892
|
-
"email": "example
|
112289
|
+
"email": "email@example.com",
|
109893
112290
|
"password": "this is the password"
|
109894
112291
|
}
|
109895
112292
|
```
|
@@ -110015,6 +112412,7 @@ Schema for the body of a User creation request
|
|
110015
112412
|
"deviceRecipe.*",
|
110016
112413
|
"deviceRecipes.*",
|
110017
112414
|
"devices.*",
|
112415
|
+
"edgeDeployment.*",
|
110018
112416
|
"edgeDeployments.*",
|
110019
112417
|
"event.*",
|
110020
112418
|
"events.*",
|
@@ -110115,6 +112513,7 @@ Schema for the body of a User creation request
|
|
110115
112513
|
"device.getLogEntries",
|
110116
112514
|
"device.getState",
|
110117
112515
|
"device.patch",
|
112516
|
+
"device.payloadCounts",
|
110118
112517
|
"device.removeData",
|
110119
112518
|
"device.sendCommand",
|
110120
112519
|
"device.sendState",
|
@@ -110133,10 +112532,12 @@ Schema for the body of a User creation request
|
|
110133
112532
|
"devices.detailedSummary",
|
110134
112533
|
"devices.export",
|
110135
112534
|
"devices.get",
|
112535
|
+
"devices.payloadCounts",
|
110136
112536
|
"devices.post",
|
110137
112537
|
"devices.sendCommand",
|
110138
112538
|
"devices.tagKeys",
|
110139
112539
|
"devices.tagValues",
|
112540
|
+
"edgeDeployment.get",
|
110140
112541
|
"edgeDeployments.get",
|
110141
112542
|
"edgeDeployments.release",
|
110142
112543
|
"edgeDeployments.remove",
|
@@ -110318,6 +112719,13 @@ Schema for the body of a User creation request
|
|
110318
112719
|
"instanceOrgMembers.*",
|
110319
112720
|
"instanceOrgMembers.get",
|
110320
112721
|
"instanceOrgMembers.post",
|
112722
|
+
"instanceOrgInvite.*",
|
112723
|
+
"instanceOrgInvite.get",
|
112724
|
+
"instanceOrgInvite.delete",
|
112725
|
+
"instanceOrgInvite.resendInvite",
|
112726
|
+
"instanceOrgInvites.*",
|
112727
|
+
"instanceOrgInvites.get",
|
112728
|
+
"instanceOrgInvites.post",
|
110321
112729
|
"instanceApiTokens.*",
|
110322
112730
|
"instanceApiTokens.get",
|
110323
112731
|
"instanceApiTokens.post",
|
@@ -110401,11 +112809,11 @@ Schema for the body of a User creation request
|
|
110401
112809
|
|
110402
112810
|
```json
|
110403
112811
|
{
|
110404
|
-
"email": "example
|
112812
|
+
"email": "email@example.com",
|
110405
112813
|
"firstName": "Example",
|
110406
112814
|
"lastName": "Name",
|
110407
|
-
"companyName": "
|
110408
|
-
"url": "https://
|
112815
|
+
"companyName": "Example, Inc.",
|
112816
|
+
"url": "https://example.com",
|
110409
112817
|
"password": "the new password",
|
110410
112818
|
"acceptTerms": "on"
|
110411
112819
|
}
|
@@ -110843,6 +113251,10 @@ Schema for the body of a request to press a Workflow virtual button
|
|
110843
113251
|
"deviceId": {
|
110844
113252
|
"type": "string",
|
110845
113253
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
113254
|
+
},
|
113255
|
+
"deploymentId": {
|
113256
|
+
"type": "string",
|
113257
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
110846
113258
|
}
|
110847
113259
|
},
|
110848
113260
|
"required": [
|