losant_rest 1.8.6 → 1.8.7
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 +2143 -330
- data/docs/applicationCertificate.md +133 -0
- data/docs/applicationCertificateAuthorities.md +93 -0
- data/docs/applicationCertificateAuthority.md +133 -0
- data/docs/applicationCertificates.md +93 -0
- data/docs/auth.md +1 -1
- data/docs/dataTableRows.md +2 -0
- data/docs/events.md +1 -1
- data/docs/experienceUsers.md +2 -1
- data/lib/losant_rest.rb +4 -0
- data/lib/losant_rest/application_certificate.rb +174 -0
- data/lib/losant_rest/application_certificate_authorities.rb +136 -0
- data/lib/losant_rest/application_certificate_authority.rb +174 -0
- data/lib/losant_rest/application_certificates.rb +136 -0
- data/lib/losant_rest/auth.rb +1 -1
- data/lib/losant_rest/client.rb +18 -2
- data/lib/losant_rest/data_table_rows.rb +4 -0
- data/lib/losant_rest/events.rb +1 -1
- data/lib/losant_rest/experience_users.rb +3 -1
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/applicationApiTokenPost.json +14 -0
- data/schemas/applicationCertificate.json +67 -0
- data/schemas/applicationCertificateAuthorities.json +93 -0
- data/schemas/applicationCertificateAuthority.json +51 -0
- data/schemas/applicationCertificateAuthorityPatch.json +26 -0
- data/schemas/applicationCertificateAuthorityPost.json +30 -0
- data/schemas/applicationCertificatePatch.json +21 -0
- data/schemas/applicationCertificatePost.json +51 -0
- data/schemas/applicationCertificates.json +109 -0
- data/schemas/dashboard.json +274 -72
- data/schemas/dashboardPatch.json +274 -72
- data/schemas/dashboardPost.json +274 -72
- data/schemas/dashboards.json +274 -72
- data/schemas/dataTableQuery.json +12 -0
- data/schemas/dataTableRowsExport.json +12 -0
- data/schemas/deviceCredentials.json +1 -3
- data/schemas/event.json +15 -0
- data/schemas/eventPatch.json +12 -1
- data/schemas/eventPost.json +16 -1
- data/schemas/events.json +15 -0
- data/schemas/experienceDomain.json +2 -6
- data/schemas/experienceDomainPatch.json +2 -6
- data/schemas/experienceDomainPost.json +2 -6
- data/schemas/experienceDomains.json +2 -6
- data/schemas/experienceGroup.json +38 -0
- data/schemas/experienceGroupPatch.json +38 -0
- data/schemas/experienceGroupPost.json +38 -0
- data/schemas/experienceGroups.json +38 -0
- data/schemas/flow.json +1 -0
- data/schemas/flowPatch.json +3 -2
- data/schemas/flowPost.json +1 -0
- data/schemas/flowVersion.json +2 -0
- data/schemas/flowVersionPost.json +1 -0
- data/schemas/flowVersions.json +2 -0
- data/schemas/flows.json +1 -0
- data/schemas/flowsImportPost.json +4 -2
- data/schemas/flowsImportResult.json +3 -0
- data/schemas/githubLogin.json +14 -0
- data/schemas/userCredentials.json +14 -0
- data/schemas/userPost.json +14 -0
- metadata +18 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '082ff15301dafcf4486966d2b668bb19d88fadd5ac11a67706863a6668bba209'
|
4
|
+
data.tar.gz: 3a9e214397a6922302ecfde8b480ac2606e496c184d4830c330722cd6062fd2f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d66a07edbf0ea607218b65f8b4d240063ee08e265a4b4cad961148ddc21d11b0d5ac4635c7096e50e9db43593b708081bd916a00c2639145e2795e501ab3f99c
|
7
|
+
data.tar.gz: 3e9a2b4671695ce7eb12fcbb93a065704f27395fccff01e94ffe3bbb09c5d89d629c716b4bba4c6aaefa8b15d2c74dab5a53cb0c1f51771c9b13dbba3c082e34
|
data/docs/_schemas.md
CHANGED
@@ -5,6 +5,14 @@
|
|
5
5
|
* [API Tokens](#api-tokens)
|
6
6
|
* [Application](#application)
|
7
7
|
* [Application API Token Post](#application-api-token-post)
|
8
|
+
* [Application Certificate](#application-certificate)
|
9
|
+
* [Application Certificate Authorities](#application-certificate-authorities)
|
10
|
+
* [Application Certificate Authority](#application-certificate-authority)
|
11
|
+
* [Application Certificate Authority Patch](#application-certificate-authority-patch)
|
12
|
+
* [Application Certificate Authority Post](#application-certificate-authority-post)
|
13
|
+
* [Application Certificate Patch](#application-certificate-patch)
|
14
|
+
* [Application Certificate Post](#application-certificate-post)
|
15
|
+
* [Application Certificates](#application-certificates)
|
8
16
|
* [Application Key](#application-key)
|
9
17
|
* [Application Key Patch](#application-key-patch)
|
10
18
|
* [Application Key Post](#application-key-post)
|
@@ -879,6 +887,10 @@ Schema for the body of an Application API Token creation request
|
|
879
887
|
"application.*",
|
880
888
|
"applicationApiToken.*",
|
881
889
|
"applicationApiTokens.*",
|
890
|
+
"applicationCertificate.*",
|
891
|
+
"applicationCertificates.*",
|
892
|
+
"applicationCertificateAuthority.*",
|
893
|
+
"applicationCertificateAuthorities.*",
|
882
894
|
"applicationKey.*",
|
883
895
|
"applicationKeys.*",
|
884
896
|
"data.*",
|
@@ -935,6 +947,16 @@ Schema for the body of an Application API Token creation request
|
|
935
947
|
"applicationApiToken.patch",
|
936
948
|
"applicationApiTokens.get",
|
937
949
|
"applicationApiTokens.post",
|
950
|
+
"applicationCertificate.delete",
|
951
|
+
"applicationCertificate.get",
|
952
|
+
"applicationCertificate.patch",
|
953
|
+
"applicationCertificates.get",
|
954
|
+
"applicationCertificates.post",
|
955
|
+
"applicationCertificateAuthority.delete",
|
956
|
+
"applicationCertificateAuthority.get",
|
957
|
+
"applicationCertificateAuthority.patch",
|
958
|
+
"applicationCertificateAuthorities.get",
|
959
|
+
"applicationCertificateAuthorities.post",
|
938
960
|
"applicationKey.delete",
|
939
961
|
"applicationKey.get",
|
940
962
|
"applicationKey.patch",
|
@@ -1115,6 +1137,689 @@ Schema for the body of an Application API Token creation request
|
|
1115
1137
|
|
1116
1138
|
<br/>
|
1117
1139
|
|
1140
|
+
## Application Certificate
|
1141
|
+
|
1142
|
+
Schema for a single Application Certificate
|
1143
|
+
|
1144
|
+
### <a name="application-certificate-schema"></a> Schema
|
1145
|
+
|
1146
|
+
```json
|
1147
|
+
{
|
1148
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1149
|
+
"type": "object",
|
1150
|
+
"properties": {
|
1151
|
+
"id": {
|
1152
|
+
"type": "string",
|
1153
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1154
|
+
},
|
1155
|
+
"applicationCertificateId": {
|
1156
|
+
"type": "string",
|
1157
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1158
|
+
},
|
1159
|
+
"applicationId": {
|
1160
|
+
"type": "string",
|
1161
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1162
|
+
},
|
1163
|
+
"creationDate": {
|
1164
|
+
"type": "string",
|
1165
|
+
"format": "date-time"
|
1166
|
+
},
|
1167
|
+
"lastUpdated": {
|
1168
|
+
"type": "string",
|
1169
|
+
"format": "date-time"
|
1170
|
+
},
|
1171
|
+
"status": {
|
1172
|
+
"type": "string",
|
1173
|
+
"enum": [
|
1174
|
+
"active",
|
1175
|
+
"inactive"
|
1176
|
+
]
|
1177
|
+
},
|
1178
|
+
"description": {
|
1179
|
+
"type": "string",
|
1180
|
+
"maxLength": 32767
|
1181
|
+
},
|
1182
|
+
"deviceIds": {
|
1183
|
+
"type": "array",
|
1184
|
+
"items": {
|
1185
|
+
"type": "string",
|
1186
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1187
|
+
},
|
1188
|
+
"maxItems": 1000
|
1189
|
+
},
|
1190
|
+
"deviceTags": {
|
1191
|
+
"type": "array",
|
1192
|
+
"items": {
|
1193
|
+
"type": "object",
|
1194
|
+
"properties": {
|
1195
|
+
"key": {
|
1196
|
+
"type": "string",
|
1197
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
1198
|
+
},
|
1199
|
+
"value": {
|
1200
|
+
"type": "string",
|
1201
|
+
"minLength": 1,
|
1202
|
+
"maxLength": 255
|
1203
|
+
}
|
1204
|
+
},
|
1205
|
+
"additionalProperties": false
|
1206
|
+
},
|
1207
|
+
"maxItems": 100
|
1208
|
+
},
|
1209
|
+
"certificateInfo": {
|
1210
|
+
"$ref": "#/definitions/certificateInfo"
|
1211
|
+
}
|
1212
|
+
}
|
1213
|
+
}
|
1214
|
+
```
|
1215
|
+
### <a name="application-certificate-example"></a> Example
|
1216
|
+
|
1217
|
+
```json
|
1218
|
+
{
|
1219
|
+
"id": "5cd02a50df66feb0994c7196",
|
1220
|
+
"applicationCertificateId": "5cd02a50df66feb0994c7196",
|
1221
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
1222
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
1223
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
1224
|
+
"status": "active",
|
1225
|
+
"description": "An example certificate description",
|
1226
|
+
"certificateInfo": {
|
1227
|
+
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
1228
|
+
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
1229
|
+
"commonName": "myDomain.com",
|
1230
|
+
"issuerName": "Network Solutions OV Server CA 2",
|
1231
|
+
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
1232
|
+
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
1233
|
+
}
|
1234
|
+
}
|
1235
|
+
```
|
1236
|
+
|
1237
|
+
<br/>
|
1238
|
+
|
1239
|
+
## Application Certificate Authorities
|
1240
|
+
|
1241
|
+
Schema for a collection of Application Certificate Authorities
|
1242
|
+
|
1243
|
+
### <a name="application-certificate-authorities-schema"></a> Schema
|
1244
|
+
|
1245
|
+
```json
|
1246
|
+
{
|
1247
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1248
|
+
"type": "object",
|
1249
|
+
"properties": {
|
1250
|
+
"items": {
|
1251
|
+
"type": "array",
|
1252
|
+
"items": {
|
1253
|
+
"title": "Application Certificate Authority",
|
1254
|
+
"description": "Schema for a single Application Certificate Authority",
|
1255
|
+
"type": "object",
|
1256
|
+
"properties": {
|
1257
|
+
"id": {
|
1258
|
+
"type": "string",
|
1259
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1260
|
+
},
|
1261
|
+
"applicationCertificateAuthorityId": {
|
1262
|
+
"type": "string",
|
1263
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1264
|
+
},
|
1265
|
+
"applicationId": {
|
1266
|
+
"type": "string",
|
1267
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1268
|
+
},
|
1269
|
+
"creationDate": {
|
1270
|
+
"type": "string",
|
1271
|
+
"format": "date-time"
|
1272
|
+
},
|
1273
|
+
"lastUpdated": {
|
1274
|
+
"type": "string",
|
1275
|
+
"format": "date-time"
|
1276
|
+
},
|
1277
|
+
"status": {
|
1278
|
+
"type": "string",
|
1279
|
+
"enum": [
|
1280
|
+
"active",
|
1281
|
+
"inactive"
|
1282
|
+
]
|
1283
|
+
},
|
1284
|
+
"name": {
|
1285
|
+
"type": "string",
|
1286
|
+
"minLength": 1,
|
1287
|
+
"maxLength": 255
|
1288
|
+
},
|
1289
|
+
"description": {
|
1290
|
+
"type": "string",
|
1291
|
+
"maxLength": 32767
|
1292
|
+
},
|
1293
|
+
"caBundle": {
|
1294
|
+
"$ref": "#/definitions/common/certificateString"
|
1295
|
+
},
|
1296
|
+
"caInfo": {
|
1297
|
+
"type": "array",
|
1298
|
+
"items": {
|
1299
|
+
"$ref": "#/definitions/certificateInfo"
|
1300
|
+
}
|
1301
|
+
}
|
1302
|
+
}
|
1303
|
+
}
|
1304
|
+
},
|
1305
|
+
"count": {
|
1306
|
+
"type": "integer"
|
1307
|
+
},
|
1308
|
+
"totalCount": {
|
1309
|
+
"type": "integer"
|
1310
|
+
},
|
1311
|
+
"perPage": {
|
1312
|
+
"type": "integer"
|
1313
|
+
},
|
1314
|
+
"page": {
|
1315
|
+
"type": "integer"
|
1316
|
+
},
|
1317
|
+
"filter": {
|
1318
|
+
"type": "string"
|
1319
|
+
},
|
1320
|
+
"filterField": {
|
1321
|
+
"type": "string"
|
1322
|
+
},
|
1323
|
+
"sortField": {
|
1324
|
+
"type": "string"
|
1325
|
+
},
|
1326
|
+
"sortDirection": {
|
1327
|
+
"type": "string",
|
1328
|
+
"enum": [
|
1329
|
+
"asc",
|
1330
|
+
"desc"
|
1331
|
+
]
|
1332
|
+
},
|
1333
|
+
"applicationId": {
|
1334
|
+
"type": "string",
|
1335
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1336
|
+
}
|
1337
|
+
}
|
1338
|
+
}
|
1339
|
+
```
|
1340
|
+
### <a name="application-certificate-authorities-example"></a> Example
|
1341
|
+
|
1342
|
+
```json
|
1343
|
+
{
|
1344
|
+
"items": [
|
1345
|
+
{
|
1346
|
+
"id": "5cd02a7bdf66feb0994c7197",
|
1347
|
+
"applicationCertificateAuthorityId": "5cd02a7bdf66feb0994c7197",
|
1348
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
1349
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
1350
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
1351
|
+
"status": "active",
|
1352
|
+
"name": "my certificate authority",
|
1353
|
+
"description": "An example certificate authority description",
|
1354
|
+
"caBundle": "MY_SSL_CERTIFICATE",
|
1355
|
+
"caInfo": [
|
1356
|
+
{
|
1357
|
+
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
1358
|
+
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
1359
|
+
"commonName": "myDomain.com",
|
1360
|
+
"issuerName": "Network Solutions OV Server CA 2",
|
1361
|
+
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
1362
|
+
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
1363
|
+
}
|
1364
|
+
]
|
1365
|
+
}
|
1366
|
+
],
|
1367
|
+
"count": 1,
|
1368
|
+
"totalCount": 4,
|
1369
|
+
"perPage": 1,
|
1370
|
+
"page": 0,
|
1371
|
+
"sortField": "key",
|
1372
|
+
"sortDirection": "asc",
|
1373
|
+
"applicationId": "575ec8687ae143cd83dc4a97"
|
1374
|
+
}
|
1375
|
+
```
|
1376
|
+
|
1377
|
+
<br/>
|
1378
|
+
|
1379
|
+
## Application Certificate Authority
|
1380
|
+
|
1381
|
+
Schema for a single Application Certificate Authority
|
1382
|
+
|
1383
|
+
### <a name="application-certificate-authority-schema"></a> Schema
|
1384
|
+
|
1385
|
+
```json
|
1386
|
+
{
|
1387
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1388
|
+
"type": "object",
|
1389
|
+
"properties": {
|
1390
|
+
"id": {
|
1391
|
+
"type": "string",
|
1392
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1393
|
+
},
|
1394
|
+
"applicationCertificateAuthorityId": {
|
1395
|
+
"type": "string",
|
1396
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1397
|
+
},
|
1398
|
+
"applicationId": {
|
1399
|
+
"type": "string",
|
1400
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1401
|
+
},
|
1402
|
+
"creationDate": {
|
1403
|
+
"type": "string",
|
1404
|
+
"format": "date-time"
|
1405
|
+
},
|
1406
|
+
"lastUpdated": {
|
1407
|
+
"type": "string",
|
1408
|
+
"format": "date-time"
|
1409
|
+
},
|
1410
|
+
"status": {
|
1411
|
+
"type": "string",
|
1412
|
+
"enum": [
|
1413
|
+
"active",
|
1414
|
+
"inactive"
|
1415
|
+
]
|
1416
|
+
},
|
1417
|
+
"name": {
|
1418
|
+
"type": "string",
|
1419
|
+
"minLength": 1,
|
1420
|
+
"maxLength": 255
|
1421
|
+
},
|
1422
|
+
"description": {
|
1423
|
+
"type": "string",
|
1424
|
+
"maxLength": 32767
|
1425
|
+
},
|
1426
|
+
"caBundle": {
|
1427
|
+
"$ref": "#/definitions/common/certificateString"
|
1428
|
+
},
|
1429
|
+
"caInfo": {
|
1430
|
+
"type": "array",
|
1431
|
+
"items": {
|
1432
|
+
"$ref": "#/definitions/certificateInfo"
|
1433
|
+
}
|
1434
|
+
}
|
1435
|
+
}
|
1436
|
+
}
|
1437
|
+
```
|
1438
|
+
### <a name="application-certificate-authority-example"></a> Example
|
1439
|
+
|
1440
|
+
```json
|
1441
|
+
{
|
1442
|
+
"id": "5cd02a7bdf66feb0994c7197",
|
1443
|
+
"applicationCertificateAuthorityId": "5cd02a7bdf66feb0994c7197",
|
1444
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
1445
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
1446
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
1447
|
+
"status": "active",
|
1448
|
+
"name": "my certificate authority",
|
1449
|
+
"description": "An example certificate authority description",
|
1450
|
+
"caBundle": "MY_SSL_CERTIFICATE",
|
1451
|
+
"caInfo": [
|
1452
|
+
{
|
1453
|
+
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
1454
|
+
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
1455
|
+
"commonName": "myDomain.com",
|
1456
|
+
"issuerName": "Network Solutions OV Server CA 2",
|
1457
|
+
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
1458
|
+
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
1459
|
+
}
|
1460
|
+
]
|
1461
|
+
}
|
1462
|
+
```
|
1463
|
+
|
1464
|
+
<br/>
|
1465
|
+
|
1466
|
+
## Application Certificate Authority Patch
|
1467
|
+
|
1468
|
+
Schema for the body of an Application Certificate Authority modification request
|
1469
|
+
|
1470
|
+
### <a name="application-certificate-authority-patch-schema"></a> Schema
|
1471
|
+
|
1472
|
+
```json
|
1473
|
+
{
|
1474
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1475
|
+
"type": "object",
|
1476
|
+
"properties": {
|
1477
|
+
"name": {
|
1478
|
+
"type": "string",
|
1479
|
+
"minLength": 1,
|
1480
|
+
"maxLength": 255
|
1481
|
+
},
|
1482
|
+
"status": {
|
1483
|
+
"type": "string",
|
1484
|
+
"enum": [
|
1485
|
+
"active",
|
1486
|
+
"inactive"
|
1487
|
+
]
|
1488
|
+
},
|
1489
|
+
"description": {
|
1490
|
+
"type": "string",
|
1491
|
+
"maxLength": 32767
|
1492
|
+
},
|
1493
|
+
"caBundle": {
|
1494
|
+
"$ref": "#/definitions/common/certificateString"
|
1495
|
+
}
|
1496
|
+
},
|
1497
|
+
"additionalProperties": false
|
1498
|
+
}
|
1499
|
+
```
|
1500
|
+
### <a name="application-certificate-authority-patch-example"></a> Example
|
1501
|
+
|
1502
|
+
```json
|
1503
|
+
{
|
1504
|
+
"status": "active",
|
1505
|
+
"description": "An example updated authority description"
|
1506
|
+
}
|
1507
|
+
```
|
1508
|
+
|
1509
|
+
<br/>
|
1510
|
+
|
1511
|
+
## Application Certificate Authority Post
|
1512
|
+
|
1513
|
+
Schema for the body of an Application Certificate Authority creation request
|
1514
|
+
|
1515
|
+
### <a name="application-certificate-authority-post-schema"></a> Schema
|
1516
|
+
|
1517
|
+
```json
|
1518
|
+
{
|
1519
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1520
|
+
"type": "object",
|
1521
|
+
"properties": {
|
1522
|
+
"name": {
|
1523
|
+
"type": "string",
|
1524
|
+
"minLength": 1,
|
1525
|
+
"maxLength": 255
|
1526
|
+
},
|
1527
|
+
"status": {
|
1528
|
+
"type": "string",
|
1529
|
+
"enum": [
|
1530
|
+
"active",
|
1531
|
+
"inactive"
|
1532
|
+
]
|
1533
|
+
},
|
1534
|
+
"description": {
|
1535
|
+
"type": "string",
|
1536
|
+
"maxLength": 32767
|
1537
|
+
},
|
1538
|
+
"caBundle": {
|
1539
|
+
"$ref": "#/definitions/common/certificateString"
|
1540
|
+
}
|
1541
|
+
},
|
1542
|
+
"required": [
|
1543
|
+
"name",
|
1544
|
+
"caBundle"
|
1545
|
+
],
|
1546
|
+
"additionalProperties": false
|
1547
|
+
}
|
1548
|
+
```
|
1549
|
+
### <a name="application-certificate-authority-post-example"></a> Example
|
1550
|
+
|
1551
|
+
```json
|
1552
|
+
{
|
1553
|
+
"name": "my certificate authority",
|
1554
|
+
"description": "An example new authority description",
|
1555
|
+
"caBundle": "MY_SSL_CERTIFICATE"
|
1556
|
+
}
|
1557
|
+
```
|
1558
|
+
|
1559
|
+
<br/>
|
1560
|
+
|
1561
|
+
## Application Certificate Patch
|
1562
|
+
|
1563
|
+
Schema for the body of an Application Certificate modification request
|
1564
|
+
|
1565
|
+
### <a name="application-certificate-patch-schema"></a> Schema
|
1566
|
+
|
1567
|
+
```json
|
1568
|
+
{
|
1569
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1570
|
+
"type": "object",
|
1571
|
+
"properties": {
|
1572
|
+
"status": {
|
1573
|
+
"type": "string",
|
1574
|
+
"enum": [
|
1575
|
+
"active",
|
1576
|
+
"inactive"
|
1577
|
+
]
|
1578
|
+
},
|
1579
|
+
"description": {
|
1580
|
+
"type": "string",
|
1581
|
+
"maxLength": 32767
|
1582
|
+
},
|
1583
|
+
"certificate": {
|
1584
|
+
"$ref": "#/definitions/common/certificateString"
|
1585
|
+
}
|
1586
|
+
},
|
1587
|
+
"additionalProperties": false
|
1588
|
+
}
|
1589
|
+
```
|
1590
|
+
### <a name="application-certificate-patch-example"></a> Example
|
1591
|
+
|
1592
|
+
```json
|
1593
|
+
{
|
1594
|
+
"status": "active",
|
1595
|
+
"description": "An example updated certificate description"
|
1596
|
+
}
|
1597
|
+
```
|
1598
|
+
|
1599
|
+
<br/>
|
1600
|
+
|
1601
|
+
## Application Certificate Post
|
1602
|
+
|
1603
|
+
Schema for the body of an Application Certificate creation request
|
1604
|
+
|
1605
|
+
### <a name="application-certificate-post-schema"></a> Schema
|
1606
|
+
|
1607
|
+
```json
|
1608
|
+
{
|
1609
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1610
|
+
"type": "object",
|
1611
|
+
"properties": {
|
1612
|
+
"status": {
|
1613
|
+
"type": "string",
|
1614
|
+
"enum": [
|
1615
|
+
"active",
|
1616
|
+
"inactive"
|
1617
|
+
]
|
1618
|
+
},
|
1619
|
+
"description": {
|
1620
|
+
"type": "string",
|
1621
|
+
"maxLength": 32767
|
1622
|
+
},
|
1623
|
+
"deviceIds": {
|
1624
|
+
"type": "array",
|
1625
|
+
"items": {
|
1626
|
+
"type": "string",
|
1627
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1628
|
+
},
|
1629
|
+
"maxItems": 1000
|
1630
|
+
},
|
1631
|
+
"deviceTags": {
|
1632
|
+
"type": "array",
|
1633
|
+
"items": {
|
1634
|
+
"type": "object",
|
1635
|
+
"properties": {
|
1636
|
+
"key": {
|
1637
|
+
"type": "string",
|
1638
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
1639
|
+
},
|
1640
|
+
"value": {
|
1641
|
+
"type": "string",
|
1642
|
+
"minLength": 1,
|
1643
|
+
"maxLength": 255
|
1644
|
+
}
|
1645
|
+
},
|
1646
|
+
"additionalProperties": false
|
1647
|
+
},
|
1648
|
+
"maxItems": 100
|
1649
|
+
},
|
1650
|
+
"certificate": {
|
1651
|
+
"$ref": "#/definitions/common/certificateString"
|
1652
|
+
}
|
1653
|
+
},
|
1654
|
+
"required": [
|
1655
|
+
"certificate"
|
1656
|
+
],
|
1657
|
+
"additionalProperties": false
|
1658
|
+
}
|
1659
|
+
```
|
1660
|
+
### <a name="application-certificate-post-example"></a> Example
|
1661
|
+
|
1662
|
+
```json
|
1663
|
+
{
|
1664
|
+
"description": "An example new certificate description",
|
1665
|
+
"certificate": "MY_SSL_CERTIFICATE"
|
1666
|
+
}
|
1667
|
+
```
|
1668
|
+
|
1669
|
+
<br/>
|
1670
|
+
|
1671
|
+
## Application Certificates
|
1672
|
+
|
1673
|
+
Schema for a collection of Application Certificates
|
1674
|
+
|
1675
|
+
### <a name="application-certificates-schema"></a> Schema
|
1676
|
+
|
1677
|
+
```json
|
1678
|
+
{
|
1679
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
1680
|
+
"type": "object",
|
1681
|
+
"properties": {
|
1682
|
+
"items": {
|
1683
|
+
"type": "array",
|
1684
|
+
"items": {
|
1685
|
+
"title": "Application Certificate",
|
1686
|
+
"description": "Schema for a single Application Certificate",
|
1687
|
+
"type": "object",
|
1688
|
+
"properties": {
|
1689
|
+
"id": {
|
1690
|
+
"type": "string",
|
1691
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1692
|
+
},
|
1693
|
+
"applicationCertificateId": {
|
1694
|
+
"type": "string",
|
1695
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1696
|
+
},
|
1697
|
+
"applicationId": {
|
1698
|
+
"type": "string",
|
1699
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1700
|
+
},
|
1701
|
+
"creationDate": {
|
1702
|
+
"type": "string",
|
1703
|
+
"format": "date-time"
|
1704
|
+
},
|
1705
|
+
"lastUpdated": {
|
1706
|
+
"type": "string",
|
1707
|
+
"format": "date-time"
|
1708
|
+
},
|
1709
|
+
"status": {
|
1710
|
+
"type": "string",
|
1711
|
+
"enum": [
|
1712
|
+
"active",
|
1713
|
+
"inactive"
|
1714
|
+
]
|
1715
|
+
},
|
1716
|
+
"description": {
|
1717
|
+
"type": "string",
|
1718
|
+
"maxLength": 32767
|
1719
|
+
},
|
1720
|
+
"deviceIds": {
|
1721
|
+
"type": "array",
|
1722
|
+
"items": {
|
1723
|
+
"type": "string",
|
1724
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1725
|
+
},
|
1726
|
+
"maxItems": 1000
|
1727
|
+
},
|
1728
|
+
"deviceTags": {
|
1729
|
+
"type": "array",
|
1730
|
+
"items": {
|
1731
|
+
"type": "object",
|
1732
|
+
"properties": {
|
1733
|
+
"key": {
|
1734
|
+
"type": "string",
|
1735
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
1736
|
+
},
|
1737
|
+
"value": {
|
1738
|
+
"type": "string",
|
1739
|
+
"minLength": 1,
|
1740
|
+
"maxLength": 255
|
1741
|
+
}
|
1742
|
+
},
|
1743
|
+
"additionalProperties": false
|
1744
|
+
},
|
1745
|
+
"maxItems": 100
|
1746
|
+
},
|
1747
|
+
"certificateInfo": {
|
1748
|
+
"$ref": "#/definitions/certificateInfo"
|
1749
|
+
}
|
1750
|
+
}
|
1751
|
+
}
|
1752
|
+
},
|
1753
|
+
"count": {
|
1754
|
+
"type": "integer"
|
1755
|
+
},
|
1756
|
+
"totalCount": {
|
1757
|
+
"type": "integer"
|
1758
|
+
},
|
1759
|
+
"perPage": {
|
1760
|
+
"type": "integer"
|
1761
|
+
},
|
1762
|
+
"page": {
|
1763
|
+
"type": "integer"
|
1764
|
+
},
|
1765
|
+
"filter": {
|
1766
|
+
"type": "string"
|
1767
|
+
},
|
1768
|
+
"filterField": {
|
1769
|
+
"type": "string"
|
1770
|
+
},
|
1771
|
+
"sortField": {
|
1772
|
+
"type": "string"
|
1773
|
+
},
|
1774
|
+
"sortDirection": {
|
1775
|
+
"type": "string",
|
1776
|
+
"enum": [
|
1777
|
+
"asc",
|
1778
|
+
"desc"
|
1779
|
+
]
|
1780
|
+
},
|
1781
|
+
"applicationId": {
|
1782
|
+
"type": "string",
|
1783
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
1784
|
+
}
|
1785
|
+
}
|
1786
|
+
}
|
1787
|
+
```
|
1788
|
+
### <a name="application-certificates-example"></a> Example
|
1789
|
+
|
1790
|
+
```json
|
1791
|
+
{
|
1792
|
+
"items": [
|
1793
|
+
{
|
1794
|
+
"id": "5cd02a50df66feb0994c7196",
|
1795
|
+
"applicationCertificateId": "5cd02a50df66feb0994c7196",
|
1796
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
1797
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
1798
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
1799
|
+
"status": "active",
|
1800
|
+
"description": "An example certificate description",
|
1801
|
+
"certificateInfo": {
|
1802
|
+
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
1803
|
+
"fingerprint": "FF:4A:88:5D:93:E7:FF:61:E4:72:94:EE:82:4B:56:B2:AB:71:38:06",
|
1804
|
+
"commonName": "myDomain.com",
|
1805
|
+
"issuerName": "Network Solutions OV Server CA 2",
|
1806
|
+
"notValidBefore": "2019-04-10T00:00:00.000Z",
|
1807
|
+
"notValidAfter": "2020-04-10T00:00:00.000Z"
|
1808
|
+
}
|
1809
|
+
}
|
1810
|
+
],
|
1811
|
+
"count": 1,
|
1812
|
+
"totalCount": 4,
|
1813
|
+
"perPage": 1,
|
1814
|
+
"page": 0,
|
1815
|
+
"sortField": "key",
|
1816
|
+
"sortDirection": "asc",
|
1817
|
+
"applicationId": "575ec8687ae143cd83dc4a97"
|
1818
|
+
}
|
1819
|
+
```
|
1820
|
+
|
1821
|
+
<br/>
|
1822
|
+
|
1118
1823
|
## Application Key
|
1119
1824
|
|
1120
1825
|
Schema for a single Application Key
|
@@ -3351,36 +4056,137 @@ Schema for a single Dashboard
|
|
3351
4056
|
"contextConfiguration": {
|
3352
4057
|
"type": "array",
|
3353
4058
|
"items": {
|
3354
|
-
"
|
3355
|
-
|
3356
|
-
|
3357
|
-
"
|
3358
|
-
|
4059
|
+
"oneOf": [
|
4060
|
+
{
|
4061
|
+
"type": "object",
|
4062
|
+
"properties": {
|
4063
|
+
"name": {
|
4064
|
+
"type": "string",
|
4065
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4066
|
+
},
|
4067
|
+
"type": {
|
4068
|
+
"type": "string",
|
4069
|
+
"enum": [
|
4070
|
+
"deviceAttribute"
|
4071
|
+
]
|
4072
|
+
},
|
4073
|
+
"applicationId": {
|
4074
|
+
"type": "string",
|
4075
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4076
|
+
},
|
4077
|
+
"defaultValue": {
|
4078
|
+
"type": "string",
|
4079
|
+
"maxLength": 32767
|
4080
|
+
},
|
4081
|
+
"validationEnabled": {
|
4082
|
+
"type": "boolean"
|
4083
|
+
},
|
4084
|
+
"validationConfig": {
|
4085
|
+
"type": "object",
|
4086
|
+
"properties": {
|
4087
|
+
"attributes": {
|
4088
|
+
"type": "array",
|
4089
|
+
"items": {
|
4090
|
+
"type": "string",
|
4091
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4092
|
+
},
|
4093
|
+
"maxItems": 100
|
4094
|
+
}
|
4095
|
+
},
|
4096
|
+
"additionalProperties": false
|
4097
|
+
}
|
4098
|
+
},
|
4099
|
+
"required": [
|
4100
|
+
"name",
|
4101
|
+
"type",
|
4102
|
+
"defaultValue"
|
4103
|
+
]
|
3359
4104
|
},
|
3360
|
-
|
3361
|
-
"type": "
|
3362
|
-
"
|
3363
|
-
"
|
3364
|
-
|
3365
|
-
|
3366
|
-
|
3367
|
-
"
|
4105
|
+
{
|
4106
|
+
"type": "object",
|
4107
|
+
"properties": {
|
4108
|
+
"name": {
|
4109
|
+
"type": "string",
|
4110
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4111
|
+
},
|
4112
|
+
"type": {
|
4113
|
+
"type": "string",
|
4114
|
+
"enum": [
|
4115
|
+
"deviceId"
|
4116
|
+
]
|
4117
|
+
},
|
4118
|
+
"applicationId": {
|
4119
|
+
"type": "string",
|
4120
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4121
|
+
},
|
4122
|
+
"defaultValue": {
|
4123
|
+
"type": "string",
|
4124
|
+
"maxLength": 32767
|
4125
|
+
},
|
4126
|
+
"validationEnabled": {
|
4127
|
+
"type": "boolean"
|
4128
|
+
},
|
4129
|
+
"validationConfig": {
|
4130
|
+
"type": "object",
|
4131
|
+
"properties": {
|
4132
|
+
"deviceIds": {
|
4133
|
+
"type": "array",
|
4134
|
+
"items": {
|
4135
|
+
"type": "string",
|
4136
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4137
|
+
},
|
4138
|
+
"maxItems": 1000
|
4139
|
+
},
|
4140
|
+
"deviceTags": {
|
4141
|
+
"type": "array",
|
4142
|
+
"items": {
|
4143
|
+
"type": "object",
|
4144
|
+
"properties": {
|
4145
|
+
"key": {
|
4146
|
+
"type": "string",
|
4147
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4148
|
+
},
|
4149
|
+
"value": {
|
4150
|
+
"type": "string",
|
4151
|
+
"minLength": 1,
|
4152
|
+
"maxLength": 255
|
4153
|
+
}
|
4154
|
+
},
|
4155
|
+
"additionalProperties": false
|
4156
|
+
},
|
4157
|
+
"maxItems": 100
|
4158
|
+
},
|
4159
|
+
"includeFullDevice": {
|
4160
|
+
"type": "boolean"
|
4161
|
+
}
|
4162
|
+
},
|
4163
|
+
"additionalProperties": false
|
4164
|
+
}
|
4165
|
+
},
|
4166
|
+
"required": [
|
4167
|
+
"name",
|
4168
|
+
"type",
|
4169
|
+
"defaultValue"
|
3368
4170
|
]
|
3369
4171
|
},
|
3370
|
-
|
3371
|
-
"type": "
|
3372
|
-
"
|
3373
|
-
|
3374
|
-
"defaultValue": {
|
3375
|
-
"oneOf": [
|
3376
|
-
{
|
4172
|
+
{
|
4173
|
+
"type": "object",
|
4174
|
+
"properties": {
|
4175
|
+
"name": {
|
3377
4176
|
"type": "string",
|
3378
|
-
"
|
4177
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3379
4178
|
},
|
3380
|
-
{
|
3381
|
-
"type": "
|
4179
|
+
"type": {
|
4180
|
+
"type": "string",
|
4181
|
+
"enum": [
|
4182
|
+
"deviceTag"
|
4183
|
+
]
|
3382
4184
|
},
|
3383
|
-
{
|
4185
|
+
"applicationId": {
|
4186
|
+
"type": "string",
|
4187
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4188
|
+
},
|
4189
|
+
"defaultValue": {
|
3384
4190
|
"type": "object",
|
3385
4191
|
"properties": {
|
3386
4192
|
"key": {
|
@@ -3394,73 +4200,174 @@ Schema for a single Dashboard
|
|
3394
4200
|
}
|
3395
4201
|
},
|
3396
4202
|
"additionalProperties": false
|
4203
|
+
},
|
4204
|
+
"validationEnabled": {
|
4205
|
+
"type": "boolean"
|
4206
|
+
},
|
4207
|
+
"validationConfig": {
|
4208
|
+
"type": "object",
|
4209
|
+
"properties": {
|
4210
|
+
"deviceTags": {
|
4211
|
+
"type": "array",
|
4212
|
+
"items": {
|
4213
|
+
"type": "object",
|
4214
|
+
"properties": {
|
4215
|
+
"key": {
|
4216
|
+
"type": "string",
|
4217
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4218
|
+
},
|
4219
|
+
"value": {
|
4220
|
+
"type": "string",
|
4221
|
+
"minLength": 1,
|
4222
|
+
"maxLength": 255
|
4223
|
+
}
|
4224
|
+
},
|
4225
|
+
"additionalProperties": false
|
4226
|
+
},
|
4227
|
+
"maxItems": 100
|
4228
|
+
}
|
4229
|
+
},
|
4230
|
+
"additionalProperties": false
|
3397
4231
|
}
|
4232
|
+
},
|
4233
|
+
"required": [
|
4234
|
+
"name",
|
4235
|
+
"type",
|
4236
|
+
"defaultValue"
|
3398
4237
|
]
|
3399
4238
|
},
|
3400
|
-
|
3401
|
-
"type": "boolean"
|
3402
|
-
},
|
3403
|
-
"validationConfig": {
|
4239
|
+
{
|
3404
4240
|
"type": "object",
|
3405
4241
|
"properties": {
|
3406
|
-
"
|
3407
|
-
"type": "
|
4242
|
+
"name": {
|
4243
|
+
"type": "string",
|
4244
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3408
4245
|
},
|
3409
|
-
"
|
3410
|
-
"type": "
|
4246
|
+
"type": {
|
4247
|
+
"type": "string",
|
4248
|
+
"enum": [
|
4249
|
+
"number"
|
4250
|
+
]
|
3411
4251
|
},
|
3412
|
-
"
|
4252
|
+
"applicationId": {
|
3413
4253
|
"type": "string",
|
3414
|
-
"
|
4254
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
3415
4255
|
},
|
3416
|
-
"
|
3417
|
-
"type":
|
3418
|
-
|
3419
|
-
"
|
3420
|
-
|
4256
|
+
"defaultValue": {
|
4257
|
+
"type": [
|
4258
|
+
"number",
|
4259
|
+
"string"
|
4260
|
+
]
|
4261
|
+
},
|
4262
|
+
"validationEnabled": {
|
4263
|
+
"type": "boolean"
|
4264
|
+
},
|
4265
|
+
"validationConfig": {
|
4266
|
+
"type": "object",
|
4267
|
+
"properties": {
|
4268
|
+
"min": {
|
4269
|
+
"type": "number"
|
4270
|
+
},
|
4271
|
+
"max": {
|
4272
|
+
"type": "number"
|
4273
|
+
}
|
3421
4274
|
},
|
3422
|
-
"
|
4275
|
+
"additionalProperties": false
|
4276
|
+
}
|
4277
|
+
},
|
4278
|
+
"required": [
|
4279
|
+
"name",
|
4280
|
+
"type",
|
4281
|
+
"defaultValue"
|
4282
|
+
]
|
4283
|
+
},
|
4284
|
+
{
|
4285
|
+
"type": "object",
|
4286
|
+
"properties": {
|
4287
|
+
"name": {
|
4288
|
+
"type": "string",
|
4289
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3423
4290
|
},
|
3424
|
-
"
|
3425
|
-
"type": "
|
3426
|
-
"
|
3427
|
-
"
|
3428
|
-
|
4291
|
+
"type": {
|
4292
|
+
"type": "string",
|
4293
|
+
"enum": [
|
4294
|
+
"string"
|
4295
|
+
]
|
4296
|
+
},
|
4297
|
+
"applicationId": {
|
4298
|
+
"type": "string",
|
4299
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4300
|
+
},
|
4301
|
+
"defaultValue": {
|
4302
|
+
"type": "string",
|
4303
|
+
"maxLength": 32767
|
4304
|
+
},
|
4305
|
+
"validationEnabled": {
|
4306
|
+
"type": "boolean"
|
4307
|
+
},
|
4308
|
+
"validationConfig": {
|
4309
|
+
"type": "object",
|
4310
|
+
"properties": {
|
4311
|
+
"regExp": {
|
4312
|
+
"type": "string",
|
4313
|
+
"maxLength": 1024
|
4314
|
+
}
|
3429
4315
|
},
|
3430
|
-
"
|
4316
|
+
"additionalProperties": false
|
4317
|
+
}
|
4318
|
+
},
|
4319
|
+
"required": [
|
4320
|
+
"name",
|
4321
|
+
"type",
|
4322
|
+
"defaultValue"
|
4323
|
+
]
|
4324
|
+
},
|
4325
|
+
{
|
4326
|
+
"type": "object",
|
4327
|
+
"properties": {
|
4328
|
+
"name": {
|
4329
|
+
"type": "string",
|
4330
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3431
4331
|
},
|
3432
|
-
"
|
3433
|
-
"type": "
|
3434
|
-
"
|
3435
|
-
"
|
3436
|
-
|
3437
|
-
|
4332
|
+
"type": {
|
4333
|
+
"type": "string",
|
4334
|
+
"enum": [
|
4335
|
+
"experienceUser"
|
4336
|
+
]
|
4337
|
+
},
|
4338
|
+
"applicationId": {
|
4339
|
+
"type": "string",
|
4340
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4341
|
+
},
|
4342
|
+
"defaultValue": {
|
4343
|
+
"type": "string",
|
4344
|
+
"maxLength": 32767
|
4345
|
+
},
|
4346
|
+
"validationEnabled": {
|
4347
|
+
"type": "boolean"
|
4348
|
+
},
|
4349
|
+
"validationConfig": {
|
4350
|
+
"type": "object",
|
4351
|
+
"properties": {
|
4352
|
+
"experienceGroupIds": {
|
4353
|
+
"type": "array",
|
4354
|
+
"items": {
|
3438
4355
|
"type": "string",
|
3439
|
-
"pattern": "^[
|
4356
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
3440
4357
|
},
|
3441
|
-
"
|
3442
|
-
|
3443
|
-
"minLength": 1,
|
3444
|
-
"maxLength": 255
|
3445
|
-
}
|
3446
|
-
},
|
3447
|
-
"additionalProperties": false
|
4358
|
+
"maxItems": 1000
|
4359
|
+
}
|
3448
4360
|
},
|
3449
|
-
"
|
3450
|
-
},
|
3451
|
-
"includeFullDevice": {
|
3452
|
-
"type": "boolean"
|
4361
|
+
"additionalProperties": false
|
3453
4362
|
}
|
3454
4363
|
},
|
3455
|
-
"
|
4364
|
+
"required": [
|
4365
|
+
"name",
|
4366
|
+
"type",
|
4367
|
+
"defaultValue"
|
4368
|
+
]
|
3456
4369
|
}
|
3457
|
-
|
3458
|
-
"required": [
|
3459
|
-
"name",
|
3460
|
-
"type",
|
3461
|
-
"defaultValue"
|
3462
|
-
],
|
3463
|
-
"additionalProperties": false
|
4370
|
+
]
|
3464
4371
|
},
|
3465
4372
|
"maxItems": 100
|
3466
4373
|
}
|
@@ -3805,36 +4712,137 @@ Schema for the body of a Dashboard modification request
|
|
3805
4712
|
"contextConfiguration": {
|
3806
4713
|
"type": "array",
|
3807
4714
|
"items": {
|
3808
|
-
"
|
3809
|
-
|
3810
|
-
|
3811
|
-
"
|
3812
|
-
|
4715
|
+
"oneOf": [
|
4716
|
+
{
|
4717
|
+
"type": "object",
|
4718
|
+
"properties": {
|
4719
|
+
"name": {
|
4720
|
+
"type": "string",
|
4721
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4722
|
+
},
|
4723
|
+
"type": {
|
4724
|
+
"type": "string",
|
4725
|
+
"enum": [
|
4726
|
+
"deviceAttribute"
|
4727
|
+
]
|
4728
|
+
},
|
4729
|
+
"applicationId": {
|
4730
|
+
"type": "string",
|
4731
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4732
|
+
},
|
4733
|
+
"defaultValue": {
|
4734
|
+
"type": "string",
|
4735
|
+
"maxLength": 32767
|
4736
|
+
},
|
4737
|
+
"validationEnabled": {
|
4738
|
+
"type": "boolean"
|
4739
|
+
},
|
4740
|
+
"validationConfig": {
|
4741
|
+
"type": "object",
|
4742
|
+
"properties": {
|
4743
|
+
"attributes": {
|
4744
|
+
"type": "array",
|
4745
|
+
"items": {
|
4746
|
+
"type": "string",
|
4747
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4748
|
+
},
|
4749
|
+
"maxItems": 100
|
4750
|
+
}
|
4751
|
+
},
|
4752
|
+
"additionalProperties": false
|
4753
|
+
}
|
4754
|
+
},
|
4755
|
+
"required": [
|
4756
|
+
"name",
|
4757
|
+
"type",
|
4758
|
+
"defaultValue"
|
4759
|
+
]
|
3813
4760
|
},
|
3814
|
-
|
3815
|
-
"type": "
|
3816
|
-
"
|
3817
|
-
"
|
3818
|
-
|
3819
|
-
|
3820
|
-
|
3821
|
-
"
|
4761
|
+
{
|
4762
|
+
"type": "object",
|
4763
|
+
"properties": {
|
4764
|
+
"name": {
|
4765
|
+
"type": "string",
|
4766
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4767
|
+
},
|
4768
|
+
"type": {
|
4769
|
+
"type": "string",
|
4770
|
+
"enum": [
|
4771
|
+
"deviceId"
|
4772
|
+
]
|
4773
|
+
},
|
4774
|
+
"applicationId": {
|
4775
|
+
"type": "string",
|
4776
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4777
|
+
},
|
4778
|
+
"defaultValue": {
|
4779
|
+
"type": "string",
|
4780
|
+
"maxLength": 32767
|
4781
|
+
},
|
4782
|
+
"validationEnabled": {
|
4783
|
+
"type": "boolean"
|
4784
|
+
},
|
4785
|
+
"validationConfig": {
|
4786
|
+
"type": "object",
|
4787
|
+
"properties": {
|
4788
|
+
"deviceIds": {
|
4789
|
+
"type": "array",
|
4790
|
+
"items": {
|
4791
|
+
"type": "string",
|
4792
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4793
|
+
},
|
4794
|
+
"maxItems": 1000
|
4795
|
+
},
|
4796
|
+
"deviceTags": {
|
4797
|
+
"type": "array",
|
4798
|
+
"items": {
|
4799
|
+
"type": "object",
|
4800
|
+
"properties": {
|
4801
|
+
"key": {
|
4802
|
+
"type": "string",
|
4803
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4804
|
+
},
|
4805
|
+
"value": {
|
4806
|
+
"type": "string",
|
4807
|
+
"minLength": 1,
|
4808
|
+
"maxLength": 255
|
4809
|
+
}
|
4810
|
+
},
|
4811
|
+
"additionalProperties": false
|
4812
|
+
},
|
4813
|
+
"maxItems": 100
|
4814
|
+
},
|
4815
|
+
"includeFullDevice": {
|
4816
|
+
"type": "boolean"
|
4817
|
+
}
|
4818
|
+
},
|
4819
|
+
"additionalProperties": false
|
4820
|
+
}
|
4821
|
+
},
|
4822
|
+
"required": [
|
4823
|
+
"name",
|
4824
|
+
"type",
|
4825
|
+
"defaultValue"
|
3822
4826
|
]
|
3823
4827
|
},
|
3824
|
-
|
3825
|
-
"type": "
|
3826
|
-
"
|
3827
|
-
|
3828
|
-
"defaultValue": {
|
3829
|
-
"oneOf": [
|
3830
|
-
{
|
4828
|
+
{
|
4829
|
+
"type": "object",
|
4830
|
+
"properties": {
|
4831
|
+
"name": {
|
3831
4832
|
"type": "string",
|
3832
|
-
"
|
4833
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3833
4834
|
},
|
3834
|
-
{
|
3835
|
-
"type": "
|
4835
|
+
"type": {
|
4836
|
+
"type": "string",
|
4837
|
+
"enum": [
|
4838
|
+
"deviceTag"
|
4839
|
+
]
|
3836
4840
|
},
|
3837
|
-
{
|
4841
|
+
"applicationId": {
|
4842
|
+
"type": "string",
|
4843
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4844
|
+
},
|
4845
|
+
"defaultValue": {
|
3838
4846
|
"type": "object",
|
3839
4847
|
"properties": {
|
3840
4848
|
"key": {
|
@@ -3848,73 +4856,174 @@ Schema for the body of a Dashboard modification request
|
|
3848
4856
|
}
|
3849
4857
|
},
|
3850
4858
|
"additionalProperties": false
|
4859
|
+
},
|
4860
|
+
"validationEnabled": {
|
4861
|
+
"type": "boolean"
|
4862
|
+
},
|
4863
|
+
"validationConfig": {
|
4864
|
+
"type": "object",
|
4865
|
+
"properties": {
|
4866
|
+
"deviceTags": {
|
4867
|
+
"type": "array",
|
4868
|
+
"items": {
|
4869
|
+
"type": "object",
|
4870
|
+
"properties": {
|
4871
|
+
"key": {
|
4872
|
+
"type": "string",
|
4873
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4874
|
+
},
|
4875
|
+
"value": {
|
4876
|
+
"type": "string",
|
4877
|
+
"minLength": 1,
|
4878
|
+
"maxLength": 255
|
4879
|
+
}
|
4880
|
+
},
|
4881
|
+
"additionalProperties": false
|
4882
|
+
},
|
4883
|
+
"maxItems": 100
|
4884
|
+
}
|
4885
|
+
},
|
4886
|
+
"additionalProperties": false
|
3851
4887
|
}
|
4888
|
+
},
|
4889
|
+
"required": [
|
4890
|
+
"name",
|
4891
|
+
"type",
|
4892
|
+
"defaultValue"
|
3852
4893
|
]
|
3853
4894
|
},
|
3854
|
-
|
3855
|
-
"type": "boolean"
|
3856
|
-
},
|
3857
|
-
"validationConfig": {
|
4895
|
+
{
|
3858
4896
|
"type": "object",
|
3859
4897
|
"properties": {
|
3860
|
-
"
|
3861
|
-
"type": "
|
4898
|
+
"name": {
|
4899
|
+
"type": "string",
|
4900
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3862
4901
|
},
|
3863
|
-
"
|
3864
|
-
"type": "
|
4902
|
+
"type": {
|
4903
|
+
"type": "string",
|
4904
|
+
"enum": [
|
4905
|
+
"number"
|
4906
|
+
]
|
3865
4907
|
},
|
3866
|
-
"
|
4908
|
+
"applicationId": {
|
3867
4909
|
"type": "string",
|
3868
|
-
"
|
4910
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
3869
4911
|
},
|
3870
|
-
"
|
3871
|
-
"type":
|
3872
|
-
|
3873
|
-
"
|
3874
|
-
|
4912
|
+
"defaultValue": {
|
4913
|
+
"type": [
|
4914
|
+
"number",
|
4915
|
+
"string"
|
4916
|
+
]
|
4917
|
+
},
|
4918
|
+
"validationEnabled": {
|
4919
|
+
"type": "boolean"
|
4920
|
+
},
|
4921
|
+
"validationConfig": {
|
4922
|
+
"type": "object",
|
4923
|
+
"properties": {
|
4924
|
+
"min": {
|
4925
|
+
"type": "number"
|
4926
|
+
},
|
4927
|
+
"max": {
|
4928
|
+
"type": "number"
|
4929
|
+
}
|
3875
4930
|
},
|
3876
|
-
"
|
4931
|
+
"additionalProperties": false
|
4932
|
+
}
|
4933
|
+
},
|
4934
|
+
"required": [
|
4935
|
+
"name",
|
4936
|
+
"type",
|
4937
|
+
"defaultValue"
|
4938
|
+
]
|
4939
|
+
},
|
4940
|
+
{
|
4941
|
+
"type": "object",
|
4942
|
+
"properties": {
|
4943
|
+
"name": {
|
4944
|
+
"type": "string",
|
4945
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3877
4946
|
},
|
3878
|
-
"
|
3879
|
-
"type": "
|
3880
|
-
"
|
3881
|
-
"
|
3882
|
-
|
4947
|
+
"type": {
|
4948
|
+
"type": "string",
|
4949
|
+
"enum": [
|
4950
|
+
"string"
|
4951
|
+
]
|
4952
|
+
},
|
4953
|
+
"applicationId": {
|
4954
|
+
"type": "string",
|
4955
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4956
|
+
},
|
4957
|
+
"defaultValue": {
|
4958
|
+
"type": "string",
|
4959
|
+
"maxLength": 32767
|
4960
|
+
},
|
4961
|
+
"validationEnabled": {
|
4962
|
+
"type": "boolean"
|
4963
|
+
},
|
4964
|
+
"validationConfig": {
|
4965
|
+
"type": "object",
|
4966
|
+
"properties": {
|
4967
|
+
"regExp": {
|
4968
|
+
"type": "string",
|
4969
|
+
"maxLength": 1024
|
4970
|
+
}
|
3883
4971
|
},
|
3884
|
-
"
|
4972
|
+
"additionalProperties": false
|
4973
|
+
}
|
4974
|
+
},
|
4975
|
+
"required": [
|
4976
|
+
"name",
|
4977
|
+
"type",
|
4978
|
+
"defaultValue"
|
4979
|
+
]
|
4980
|
+
},
|
4981
|
+
{
|
4982
|
+
"type": "object",
|
4983
|
+
"properties": {
|
4984
|
+
"name": {
|
4985
|
+
"type": "string",
|
4986
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
3885
4987
|
},
|
3886
|
-
"
|
3887
|
-
"type": "
|
3888
|
-
"
|
3889
|
-
"
|
3890
|
-
|
3891
|
-
|
4988
|
+
"type": {
|
4989
|
+
"type": "string",
|
4990
|
+
"enum": [
|
4991
|
+
"experienceUser"
|
4992
|
+
]
|
4993
|
+
},
|
4994
|
+
"applicationId": {
|
4995
|
+
"type": "string",
|
4996
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4997
|
+
},
|
4998
|
+
"defaultValue": {
|
4999
|
+
"type": "string",
|
5000
|
+
"maxLength": 32767
|
5001
|
+
},
|
5002
|
+
"validationEnabled": {
|
5003
|
+
"type": "boolean"
|
5004
|
+
},
|
5005
|
+
"validationConfig": {
|
5006
|
+
"type": "object",
|
5007
|
+
"properties": {
|
5008
|
+
"experienceGroupIds": {
|
5009
|
+
"type": "array",
|
5010
|
+
"items": {
|
3892
5011
|
"type": "string",
|
3893
|
-
"pattern": "^[
|
5012
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
3894
5013
|
},
|
3895
|
-
"
|
3896
|
-
|
3897
|
-
"minLength": 1,
|
3898
|
-
"maxLength": 255
|
3899
|
-
}
|
3900
|
-
},
|
3901
|
-
"additionalProperties": false
|
5014
|
+
"maxItems": 1000
|
5015
|
+
}
|
3902
5016
|
},
|
3903
|
-
"
|
3904
|
-
},
|
3905
|
-
"includeFullDevice": {
|
3906
|
-
"type": "boolean"
|
5017
|
+
"additionalProperties": false
|
3907
5018
|
}
|
3908
5019
|
},
|
3909
|
-
"
|
5020
|
+
"required": [
|
5021
|
+
"name",
|
5022
|
+
"type",
|
5023
|
+
"defaultValue"
|
5024
|
+
]
|
3910
5025
|
}
|
3911
|
-
|
3912
|
-
"required": [
|
3913
|
-
"name",
|
3914
|
-
"type",
|
3915
|
-
"defaultValue"
|
3916
|
-
],
|
3917
|
-
"additionalProperties": false
|
5026
|
+
]
|
3918
5027
|
},
|
3919
5028
|
"maxItems": 100
|
3920
5029
|
}
|
@@ -4112,36 +5221,137 @@ Schema for the body of a Dashboard creation request
|
|
4112
5221
|
"contextConfiguration": {
|
4113
5222
|
"type": "array",
|
4114
5223
|
"items": {
|
4115
|
-
"
|
4116
|
-
|
4117
|
-
|
4118
|
-
"
|
4119
|
-
|
4120
|
-
|
4121
|
-
|
4122
|
-
|
4123
|
-
|
4124
|
-
|
4125
|
-
|
4126
|
-
|
4127
|
-
|
4128
|
-
|
5224
|
+
"oneOf": [
|
5225
|
+
{
|
5226
|
+
"type": "object",
|
5227
|
+
"properties": {
|
5228
|
+
"name": {
|
5229
|
+
"type": "string",
|
5230
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5231
|
+
},
|
5232
|
+
"type": {
|
5233
|
+
"type": "string",
|
5234
|
+
"enum": [
|
5235
|
+
"deviceAttribute"
|
5236
|
+
]
|
5237
|
+
},
|
5238
|
+
"applicationId": {
|
5239
|
+
"type": "string",
|
5240
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5241
|
+
},
|
5242
|
+
"defaultValue": {
|
5243
|
+
"type": "string",
|
5244
|
+
"maxLength": 32767
|
5245
|
+
},
|
5246
|
+
"validationEnabled": {
|
5247
|
+
"type": "boolean"
|
5248
|
+
},
|
5249
|
+
"validationConfig": {
|
5250
|
+
"type": "object",
|
5251
|
+
"properties": {
|
5252
|
+
"attributes": {
|
5253
|
+
"type": "array",
|
5254
|
+
"items": {
|
5255
|
+
"type": "string",
|
5256
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5257
|
+
},
|
5258
|
+
"maxItems": 100
|
5259
|
+
}
|
5260
|
+
},
|
5261
|
+
"additionalProperties": false
|
5262
|
+
}
|
5263
|
+
},
|
5264
|
+
"required": [
|
5265
|
+
"name",
|
5266
|
+
"type",
|
5267
|
+
"defaultValue"
|
4129
5268
|
]
|
4130
5269
|
},
|
4131
|
-
|
4132
|
-
"type": "
|
4133
|
-
"
|
4134
|
-
|
4135
|
-
|
4136
|
-
|
4137
|
-
|
5270
|
+
{
|
5271
|
+
"type": "object",
|
5272
|
+
"properties": {
|
5273
|
+
"name": {
|
5274
|
+
"type": "string",
|
5275
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5276
|
+
},
|
5277
|
+
"type": {
|
5278
|
+
"type": "string",
|
5279
|
+
"enum": [
|
5280
|
+
"deviceId"
|
5281
|
+
]
|
5282
|
+
},
|
5283
|
+
"applicationId": {
|
5284
|
+
"type": "string",
|
5285
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5286
|
+
},
|
5287
|
+
"defaultValue": {
|
4138
5288
|
"type": "string",
|
4139
5289
|
"maxLength": 32767
|
4140
5290
|
},
|
4141
|
-
{
|
4142
|
-
"type": "
|
5291
|
+
"validationEnabled": {
|
5292
|
+
"type": "boolean"
|
4143
5293
|
},
|
4144
|
-
{
|
5294
|
+
"validationConfig": {
|
5295
|
+
"type": "object",
|
5296
|
+
"properties": {
|
5297
|
+
"deviceIds": {
|
5298
|
+
"type": "array",
|
5299
|
+
"items": {
|
5300
|
+
"type": "string",
|
5301
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5302
|
+
},
|
5303
|
+
"maxItems": 1000
|
5304
|
+
},
|
5305
|
+
"deviceTags": {
|
5306
|
+
"type": "array",
|
5307
|
+
"items": {
|
5308
|
+
"type": "object",
|
5309
|
+
"properties": {
|
5310
|
+
"key": {
|
5311
|
+
"type": "string",
|
5312
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5313
|
+
},
|
5314
|
+
"value": {
|
5315
|
+
"type": "string",
|
5316
|
+
"minLength": 1,
|
5317
|
+
"maxLength": 255
|
5318
|
+
}
|
5319
|
+
},
|
5320
|
+
"additionalProperties": false
|
5321
|
+
},
|
5322
|
+
"maxItems": 100
|
5323
|
+
},
|
5324
|
+
"includeFullDevice": {
|
5325
|
+
"type": "boolean"
|
5326
|
+
}
|
5327
|
+
},
|
5328
|
+
"additionalProperties": false
|
5329
|
+
}
|
5330
|
+
},
|
5331
|
+
"required": [
|
5332
|
+
"name",
|
5333
|
+
"type",
|
5334
|
+
"defaultValue"
|
5335
|
+
]
|
5336
|
+
},
|
5337
|
+
{
|
5338
|
+
"type": "object",
|
5339
|
+
"properties": {
|
5340
|
+
"name": {
|
5341
|
+
"type": "string",
|
5342
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5343
|
+
},
|
5344
|
+
"type": {
|
5345
|
+
"type": "string",
|
5346
|
+
"enum": [
|
5347
|
+
"deviceTag"
|
5348
|
+
]
|
5349
|
+
},
|
5350
|
+
"applicationId": {
|
5351
|
+
"type": "string",
|
5352
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5353
|
+
},
|
5354
|
+
"defaultValue": {
|
4145
5355
|
"type": "object",
|
4146
5356
|
"properties": {
|
4147
5357
|
"key": {
|
@@ -4155,73 +5365,174 @@ Schema for the body of a Dashboard creation request
|
|
4155
5365
|
}
|
4156
5366
|
},
|
4157
5367
|
"additionalProperties": false
|
5368
|
+
},
|
5369
|
+
"validationEnabled": {
|
5370
|
+
"type": "boolean"
|
5371
|
+
},
|
5372
|
+
"validationConfig": {
|
5373
|
+
"type": "object",
|
5374
|
+
"properties": {
|
5375
|
+
"deviceTags": {
|
5376
|
+
"type": "array",
|
5377
|
+
"items": {
|
5378
|
+
"type": "object",
|
5379
|
+
"properties": {
|
5380
|
+
"key": {
|
5381
|
+
"type": "string",
|
5382
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5383
|
+
},
|
5384
|
+
"value": {
|
5385
|
+
"type": "string",
|
5386
|
+
"minLength": 1,
|
5387
|
+
"maxLength": 255
|
5388
|
+
}
|
5389
|
+
},
|
5390
|
+
"additionalProperties": false
|
5391
|
+
},
|
5392
|
+
"maxItems": 100
|
5393
|
+
}
|
5394
|
+
},
|
5395
|
+
"additionalProperties": false
|
4158
5396
|
}
|
5397
|
+
},
|
5398
|
+
"required": [
|
5399
|
+
"name",
|
5400
|
+
"type",
|
5401
|
+
"defaultValue"
|
4159
5402
|
]
|
4160
5403
|
},
|
4161
|
-
|
4162
|
-
"type": "boolean"
|
4163
|
-
},
|
4164
|
-
"validationConfig": {
|
5404
|
+
{
|
4165
5405
|
"type": "object",
|
4166
5406
|
"properties": {
|
4167
|
-
"
|
4168
|
-
"type": "
|
5407
|
+
"name": {
|
5408
|
+
"type": "string",
|
5409
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4169
5410
|
},
|
4170
|
-
"
|
4171
|
-
"type": "
|
5411
|
+
"type": {
|
5412
|
+
"type": "string",
|
5413
|
+
"enum": [
|
5414
|
+
"number"
|
5415
|
+
]
|
4172
5416
|
},
|
4173
|
-
"
|
5417
|
+
"applicationId": {
|
4174
5418
|
"type": "string",
|
4175
|
-
"
|
5419
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4176
5420
|
},
|
4177
|
-
"
|
4178
|
-
"type":
|
4179
|
-
|
4180
|
-
"
|
4181
|
-
|
5421
|
+
"defaultValue": {
|
5422
|
+
"type": [
|
5423
|
+
"number",
|
5424
|
+
"string"
|
5425
|
+
]
|
5426
|
+
},
|
5427
|
+
"validationEnabled": {
|
5428
|
+
"type": "boolean"
|
5429
|
+
},
|
5430
|
+
"validationConfig": {
|
5431
|
+
"type": "object",
|
5432
|
+
"properties": {
|
5433
|
+
"min": {
|
5434
|
+
"type": "number"
|
5435
|
+
},
|
5436
|
+
"max": {
|
5437
|
+
"type": "number"
|
5438
|
+
}
|
4182
5439
|
},
|
4183
|
-
"
|
5440
|
+
"additionalProperties": false
|
5441
|
+
}
|
5442
|
+
},
|
5443
|
+
"required": [
|
5444
|
+
"name",
|
5445
|
+
"type",
|
5446
|
+
"defaultValue"
|
5447
|
+
]
|
5448
|
+
},
|
5449
|
+
{
|
5450
|
+
"type": "object",
|
5451
|
+
"properties": {
|
5452
|
+
"name": {
|
5453
|
+
"type": "string",
|
5454
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4184
5455
|
},
|
4185
|
-
"
|
4186
|
-
"type": "
|
4187
|
-
"
|
4188
|
-
"
|
4189
|
-
|
5456
|
+
"type": {
|
5457
|
+
"type": "string",
|
5458
|
+
"enum": [
|
5459
|
+
"string"
|
5460
|
+
]
|
5461
|
+
},
|
5462
|
+
"applicationId": {
|
5463
|
+
"type": "string",
|
5464
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5465
|
+
},
|
5466
|
+
"defaultValue": {
|
5467
|
+
"type": "string",
|
5468
|
+
"maxLength": 32767
|
5469
|
+
},
|
5470
|
+
"validationEnabled": {
|
5471
|
+
"type": "boolean"
|
5472
|
+
},
|
5473
|
+
"validationConfig": {
|
5474
|
+
"type": "object",
|
5475
|
+
"properties": {
|
5476
|
+
"regExp": {
|
5477
|
+
"type": "string",
|
5478
|
+
"maxLength": 1024
|
5479
|
+
}
|
4190
5480
|
},
|
4191
|
-
"
|
5481
|
+
"additionalProperties": false
|
5482
|
+
}
|
5483
|
+
},
|
5484
|
+
"required": [
|
5485
|
+
"name",
|
5486
|
+
"type",
|
5487
|
+
"defaultValue"
|
5488
|
+
]
|
5489
|
+
},
|
5490
|
+
{
|
5491
|
+
"type": "object",
|
5492
|
+
"properties": {
|
5493
|
+
"name": {
|
5494
|
+
"type": "string",
|
5495
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4192
5496
|
},
|
4193
|
-
"
|
4194
|
-
"type": "
|
4195
|
-
"
|
4196
|
-
"
|
4197
|
-
|
4198
|
-
|
5497
|
+
"type": {
|
5498
|
+
"type": "string",
|
5499
|
+
"enum": [
|
5500
|
+
"experienceUser"
|
5501
|
+
]
|
5502
|
+
},
|
5503
|
+
"applicationId": {
|
5504
|
+
"type": "string",
|
5505
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5506
|
+
},
|
5507
|
+
"defaultValue": {
|
5508
|
+
"type": "string",
|
5509
|
+
"maxLength": 32767
|
5510
|
+
},
|
5511
|
+
"validationEnabled": {
|
5512
|
+
"type": "boolean"
|
5513
|
+
},
|
5514
|
+
"validationConfig": {
|
5515
|
+
"type": "object",
|
5516
|
+
"properties": {
|
5517
|
+
"experienceGroupIds": {
|
5518
|
+
"type": "array",
|
5519
|
+
"items": {
|
4199
5520
|
"type": "string",
|
4200
|
-
"pattern": "^[
|
5521
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4201
5522
|
},
|
4202
|
-
"
|
4203
|
-
|
4204
|
-
"minLength": 1,
|
4205
|
-
"maxLength": 255
|
4206
|
-
}
|
4207
|
-
},
|
4208
|
-
"additionalProperties": false
|
5523
|
+
"maxItems": 1000
|
5524
|
+
}
|
4209
5525
|
},
|
4210
|
-
"
|
4211
|
-
},
|
4212
|
-
"includeFullDevice": {
|
4213
|
-
"type": "boolean"
|
5526
|
+
"additionalProperties": false
|
4214
5527
|
}
|
4215
5528
|
},
|
4216
|
-
"
|
5529
|
+
"required": [
|
5530
|
+
"name",
|
5531
|
+
"type",
|
5532
|
+
"defaultValue"
|
5533
|
+
]
|
4217
5534
|
}
|
4218
|
-
|
4219
|
-
"required": [
|
4220
|
-
"name",
|
4221
|
-
"type",
|
4222
|
-
"defaultValue"
|
4223
|
-
],
|
4224
|
-
"additionalProperties": false
|
5535
|
+
]
|
4225
5536
|
},
|
4226
5537
|
"maxItems": 100
|
4227
5538
|
}
|
@@ -4517,41 +5828,142 @@ Schema for a collection of Dashboards
|
|
4517
5828
|
"height"
|
4518
5829
|
],
|
4519
5830
|
"additionalProperties": false
|
4520
|
-
}
|
4521
|
-
},
|
4522
|
-
"contextConfiguration": {
|
4523
|
-
"type": "array",
|
4524
|
-
"items": {
|
4525
|
-
"
|
4526
|
-
|
4527
|
-
|
4528
|
-
"
|
4529
|
-
|
4530
|
-
|
4531
|
-
|
4532
|
-
|
4533
|
-
|
4534
|
-
|
4535
|
-
|
4536
|
-
|
4537
|
-
|
4538
|
-
|
5831
|
+
}
|
5832
|
+
},
|
5833
|
+
"contextConfiguration": {
|
5834
|
+
"type": "array",
|
5835
|
+
"items": {
|
5836
|
+
"oneOf": [
|
5837
|
+
{
|
5838
|
+
"type": "object",
|
5839
|
+
"properties": {
|
5840
|
+
"name": {
|
5841
|
+
"type": "string",
|
5842
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5843
|
+
},
|
5844
|
+
"type": {
|
5845
|
+
"type": "string",
|
5846
|
+
"enum": [
|
5847
|
+
"deviceAttribute"
|
5848
|
+
]
|
5849
|
+
},
|
5850
|
+
"applicationId": {
|
5851
|
+
"type": "string",
|
5852
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5853
|
+
},
|
5854
|
+
"defaultValue": {
|
5855
|
+
"type": "string",
|
5856
|
+
"maxLength": 32767
|
5857
|
+
},
|
5858
|
+
"validationEnabled": {
|
5859
|
+
"type": "boolean"
|
5860
|
+
},
|
5861
|
+
"validationConfig": {
|
5862
|
+
"type": "object",
|
5863
|
+
"properties": {
|
5864
|
+
"attributes": {
|
5865
|
+
"type": "array",
|
5866
|
+
"items": {
|
5867
|
+
"type": "string",
|
5868
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5869
|
+
},
|
5870
|
+
"maxItems": 100
|
5871
|
+
}
|
5872
|
+
},
|
5873
|
+
"additionalProperties": false
|
5874
|
+
}
|
5875
|
+
},
|
5876
|
+
"required": [
|
5877
|
+
"name",
|
5878
|
+
"type",
|
5879
|
+
"defaultValue"
|
4539
5880
|
]
|
4540
5881
|
},
|
4541
|
-
|
4542
|
-
"type": "
|
4543
|
-
"
|
4544
|
-
|
4545
|
-
|
4546
|
-
|
4547
|
-
|
5882
|
+
{
|
5883
|
+
"type": "object",
|
5884
|
+
"properties": {
|
5885
|
+
"name": {
|
5886
|
+
"type": "string",
|
5887
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5888
|
+
},
|
5889
|
+
"type": {
|
5890
|
+
"type": "string",
|
5891
|
+
"enum": [
|
5892
|
+
"deviceId"
|
5893
|
+
]
|
5894
|
+
},
|
5895
|
+
"applicationId": {
|
5896
|
+
"type": "string",
|
5897
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5898
|
+
},
|
5899
|
+
"defaultValue": {
|
4548
5900
|
"type": "string",
|
4549
5901
|
"maxLength": 32767
|
4550
5902
|
},
|
4551
|
-
{
|
4552
|
-
"type": "
|
5903
|
+
"validationEnabled": {
|
5904
|
+
"type": "boolean"
|
4553
5905
|
},
|
4554
|
-
{
|
5906
|
+
"validationConfig": {
|
5907
|
+
"type": "object",
|
5908
|
+
"properties": {
|
5909
|
+
"deviceIds": {
|
5910
|
+
"type": "array",
|
5911
|
+
"items": {
|
5912
|
+
"type": "string",
|
5913
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5914
|
+
},
|
5915
|
+
"maxItems": 1000
|
5916
|
+
},
|
5917
|
+
"deviceTags": {
|
5918
|
+
"type": "array",
|
5919
|
+
"items": {
|
5920
|
+
"type": "object",
|
5921
|
+
"properties": {
|
5922
|
+
"key": {
|
5923
|
+
"type": "string",
|
5924
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5925
|
+
},
|
5926
|
+
"value": {
|
5927
|
+
"type": "string",
|
5928
|
+
"minLength": 1,
|
5929
|
+
"maxLength": 255
|
5930
|
+
}
|
5931
|
+
},
|
5932
|
+
"additionalProperties": false
|
5933
|
+
},
|
5934
|
+
"maxItems": 100
|
5935
|
+
},
|
5936
|
+
"includeFullDevice": {
|
5937
|
+
"type": "boolean"
|
5938
|
+
}
|
5939
|
+
},
|
5940
|
+
"additionalProperties": false
|
5941
|
+
}
|
5942
|
+
},
|
5943
|
+
"required": [
|
5944
|
+
"name",
|
5945
|
+
"type",
|
5946
|
+
"defaultValue"
|
5947
|
+
]
|
5948
|
+
},
|
5949
|
+
{
|
5950
|
+
"type": "object",
|
5951
|
+
"properties": {
|
5952
|
+
"name": {
|
5953
|
+
"type": "string",
|
5954
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5955
|
+
},
|
5956
|
+
"type": {
|
5957
|
+
"type": "string",
|
5958
|
+
"enum": [
|
5959
|
+
"deviceTag"
|
5960
|
+
]
|
5961
|
+
},
|
5962
|
+
"applicationId": {
|
5963
|
+
"type": "string",
|
5964
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
5965
|
+
},
|
5966
|
+
"defaultValue": {
|
4555
5967
|
"type": "object",
|
4556
5968
|
"properties": {
|
4557
5969
|
"key": {
|
@@ -4565,73 +5977,174 @@ Schema for a collection of Dashboards
|
|
4565
5977
|
}
|
4566
5978
|
},
|
4567
5979
|
"additionalProperties": false
|
5980
|
+
},
|
5981
|
+
"validationEnabled": {
|
5982
|
+
"type": "boolean"
|
5983
|
+
},
|
5984
|
+
"validationConfig": {
|
5985
|
+
"type": "object",
|
5986
|
+
"properties": {
|
5987
|
+
"deviceTags": {
|
5988
|
+
"type": "array",
|
5989
|
+
"items": {
|
5990
|
+
"type": "object",
|
5991
|
+
"properties": {
|
5992
|
+
"key": {
|
5993
|
+
"type": "string",
|
5994
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
5995
|
+
},
|
5996
|
+
"value": {
|
5997
|
+
"type": "string",
|
5998
|
+
"minLength": 1,
|
5999
|
+
"maxLength": 255
|
6000
|
+
}
|
6001
|
+
},
|
6002
|
+
"additionalProperties": false
|
6003
|
+
},
|
6004
|
+
"maxItems": 100
|
6005
|
+
}
|
6006
|
+
},
|
6007
|
+
"additionalProperties": false
|
4568
6008
|
}
|
6009
|
+
},
|
6010
|
+
"required": [
|
6011
|
+
"name",
|
6012
|
+
"type",
|
6013
|
+
"defaultValue"
|
4569
6014
|
]
|
4570
6015
|
},
|
4571
|
-
|
4572
|
-
"type": "boolean"
|
4573
|
-
},
|
4574
|
-
"validationConfig": {
|
6016
|
+
{
|
4575
6017
|
"type": "object",
|
4576
6018
|
"properties": {
|
4577
|
-
"
|
4578
|
-
"type": "
|
6019
|
+
"name": {
|
6020
|
+
"type": "string",
|
6021
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4579
6022
|
},
|
4580
|
-
"
|
4581
|
-
"type": "
|
6023
|
+
"type": {
|
6024
|
+
"type": "string",
|
6025
|
+
"enum": [
|
6026
|
+
"number"
|
6027
|
+
]
|
4582
6028
|
},
|
4583
|
-
"
|
6029
|
+
"applicationId": {
|
4584
6030
|
"type": "string",
|
4585
|
-
"
|
6031
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4586
6032
|
},
|
4587
|
-
"
|
4588
|
-
"type":
|
4589
|
-
|
4590
|
-
"
|
4591
|
-
|
6033
|
+
"defaultValue": {
|
6034
|
+
"type": [
|
6035
|
+
"number",
|
6036
|
+
"string"
|
6037
|
+
]
|
6038
|
+
},
|
6039
|
+
"validationEnabled": {
|
6040
|
+
"type": "boolean"
|
6041
|
+
},
|
6042
|
+
"validationConfig": {
|
6043
|
+
"type": "object",
|
6044
|
+
"properties": {
|
6045
|
+
"min": {
|
6046
|
+
"type": "number"
|
6047
|
+
},
|
6048
|
+
"max": {
|
6049
|
+
"type": "number"
|
6050
|
+
}
|
4592
6051
|
},
|
4593
|
-
"
|
6052
|
+
"additionalProperties": false
|
6053
|
+
}
|
6054
|
+
},
|
6055
|
+
"required": [
|
6056
|
+
"name",
|
6057
|
+
"type",
|
6058
|
+
"defaultValue"
|
6059
|
+
]
|
6060
|
+
},
|
6061
|
+
{
|
6062
|
+
"type": "object",
|
6063
|
+
"properties": {
|
6064
|
+
"name": {
|
6065
|
+
"type": "string",
|
6066
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4594
6067
|
},
|
4595
|
-
"
|
4596
|
-
"type": "
|
4597
|
-
"
|
4598
|
-
"
|
4599
|
-
|
6068
|
+
"type": {
|
6069
|
+
"type": "string",
|
6070
|
+
"enum": [
|
6071
|
+
"string"
|
6072
|
+
]
|
6073
|
+
},
|
6074
|
+
"applicationId": {
|
6075
|
+
"type": "string",
|
6076
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6077
|
+
},
|
6078
|
+
"defaultValue": {
|
6079
|
+
"type": "string",
|
6080
|
+
"maxLength": 32767
|
6081
|
+
},
|
6082
|
+
"validationEnabled": {
|
6083
|
+
"type": "boolean"
|
6084
|
+
},
|
6085
|
+
"validationConfig": {
|
6086
|
+
"type": "object",
|
6087
|
+
"properties": {
|
6088
|
+
"regExp": {
|
6089
|
+
"type": "string",
|
6090
|
+
"maxLength": 1024
|
6091
|
+
}
|
4600
6092
|
},
|
4601
|
-
"
|
6093
|
+
"additionalProperties": false
|
6094
|
+
}
|
6095
|
+
},
|
6096
|
+
"required": [
|
6097
|
+
"name",
|
6098
|
+
"type",
|
6099
|
+
"defaultValue"
|
6100
|
+
]
|
6101
|
+
},
|
6102
|
+
{
|
6103
|
+
"type": "object",
|
6104
|
+
"properties": {
|
6105
|
+
"name": {
|
6106
|
+
"type": "string",
|
6107
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
4602
6108
|
},
|
4603
|
-
"
|
4604
|
-
"type": "
|
4605
|
-
"
|
4606
|
-
"
|
4607
|
-
|
4608
|
-
|
6109
|
+
"type": {
|
6110
|
+
"type": "string",
|
6111
|
+
"enum": [
|
6112
|
+
"experienceUser"
|
6113
|
+
]
|
6114
|
+
},
|
6115
|
+
"applicationId": {
|
6116
|
+
"type": "string",
|
6117
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
6118
|
+
},
|
6119
|
+
"defaultValue": {
|
6120
|
+
"type": "string",
|
6121
|
+
"maxLength": 32767
|
6122
|
+
},
|
6123
|
+
"validationEnabled": {
|
6124
|
+
"type": "boolean"
|
6125
|
+
},
|
6126
|
+
"validationConfig": {
|
6127
|
+
"type": "object",
|
6128
|
+
"properties": {
|
6129
|
+
"experienceGroupIds": {
|
6130
|
+
"type": "array",
|
6131
|
+
"items": {
|
4609
6132
|
"type": "string",
|
4610
|
-
"pattern": "^[
|
6133
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
4611
6134
|
},
|
4612
|
-
"
|
4613
|
-
|
4614
|
-
"minLength": 1,
|
4615
|
-
"maxLength": 255
|
4616
|
-
}
|
4617
|
-
},
|
4618
|
-
"additionalProperties": false
|
6135
|
+
"maxItems": 1000
|
6136
|
+
}
|
4619
6137
|
},
|
4620
|
-
"
|
4621
|
-
},
|
4622
|
-
"includeFullDevice": {
|
4623
|
-
"type": "boolean"
|
6138
|
+
"additionalProperties": false
|
4624
6139
|
}
|
4625
6140
|
},
|
4626
|
-
"
|
6141
|
+
"required": [
|
6142
|
+
"name",
|
6143
|
+
"type",
|
6144
|
+
"defaultValue"
|
6145
|
+
]
|
4627
6146
|
}
|
4628
|
-
|
4629
|
-
"required": [
|
4630
|
-
"name",
|
4631
|
-
"type",
|
4632
|
-
"defaultValue"
|
4633
|
-
],
|
4634
|
-
"additionalProperties": false
|
6147
|
+
]
|
4635
6148
|
},
|
4636
6149
|
"maxItems": 100
|
4637
6150
|
}
|
@@ -5285,6 +6798,18 @@ Schema for a data table query
|
|
5285
6798
|
"boolean",
|
5286
6799
|
"null"
|
5287
6800
|
]
|
6801
|
+
},
|
6802
|
+
"$startsWith": {
|
6803
|
+
"type": "string",
|
6804
|
+
"minLength": 1
|
6805
|
+
},
|
6806
|
+
"$endsWith": {
|
6807
|
+
"type": "string",
|
6808
|
+
"minLength": 1
|
6809
|
+
},
|
6810
|
+
"$contains": {
|
6811
|
+
"type": "string",
|
6812
|
+
"minLength": 1
|
5288
6813
|
}
|
5289
6814
|
}
|
5290
6815
|
}
|
@@ -5799,6 +7324,18 @@ Schema for the body of a data table export
|
|
5799
7324
|
"boolean",
|
5800
7325
|
"null"
|
5801
7326
|
]
|
7327
|
+
},
|
7328
|
+
"$startsWith": {
|
7329
|
+
"type": "string",
|
7330
|
+
"minLength": 1
|
7331
|
+
},
|
7332
|
+
"$endsWith": {
|
7333
|
+
"type": "string",
|
7334
|
+
"minLength": 1
|
7335
|
+
},
|
7336
|
+
"$contains": {
|
7337
|
+
"type": "string",
|
7338
|
+
"minLength": 1
|
5802
7339
|
}
|
5803
7340
|
}
|
5804
7341
|
}
|
@@ -6469,7 +8006,7 @@ Schema for the body of a request to set a device's connection status
|
|
6469
8006
|
|
6470
8007
|
## Device Credentials
|
6471
8008
|
|
6472
|
-
Schema for the body of a
|
8009
|
+
Schema for the body of a device authentication request
|
6473
8010
|
|
6474
8011
|
### <a name="device-credentials-schema"></a> Schema
|
6475
8012
|
|
@@ -6521,9 +8058,7 @@ Schema for the body of a Device authentication request
|
|
6521
8058
|
}
|
6522
8059
|
},
|
6523
8060
|
"required": [
|
6524
|
-
"deviceId"
|
6525
|
-
"key",
|
6526
|
-
"secret"
|
8061
|
+
"deviceId"
|
6527
8062
|
],
|
6528
8063
|
"additionalProperties": false
|
6529
8064
|
}
|
@@ -8869,6 +10404,21 @@ Schema for a single Event
|
|
8869
10404
|
"maxLength": 32767
|
8870
10405
|
},
|
8871
10406
|
"data": {},
|
10407
|
+
"deviceId": {
|
10408
|
+
"type": "string",
|
10409
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
10410
|
+
},
|
10411
|
+
"eventTags": {
|
10412
|
+
"type": "object",
|
10413
|
+
"patternProperties": {
|
10414
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
10415
|
+
"type": "string",
|
10416
|
+
"minLength": 1,
|
10417
|
+
"maxLength": 255
|
10418
|
+
}
|
10419
|
+
},
|
10420
|
+
"additionalProperties": false
|
10421
|
+
},
|
8872
10422
|
"updates": {
|
8873
10423
|
"type": "array",
|
8874
10424
|
"items": {
|
@@ -8939,7 +10489,12 @@ Schema for a single Event
|
|
8939
10489
|
"state": "new",
|
8940
10490
|
"subject": "Power levels critical",
|
8941
10491
|
"message": "Power levels on device 432 have surpassed critical thresholds",
|
8942
|
-
"updates": []
|
10492
|
+
"updates": [],
|
10493
|
+
"deviceId": "575ecf887ae143cd83dc4aa2",
|
10494
|
+
"eventTags": {
|
10495
|
+
"key": "myKey",
|
10496
|
+
"value": "foo"
|
10497
|
+
}
|
8943
10498
|
}
|
8944
10499
|
```
|
8945
10500
|
|
@@ -8968,7 +10523,18 @@ Schema for the body of an Event modification request
|
|
8968
10523
|
"type": "string",
|
8969
10524
|
"maxLength": 32767
|
8970
10525
|
},
|
8971
|
-
"data": {}
|
10526
|
+
"data": {},
|
10527
|
+
"eventTags": {
|
10528
|
+
"type": "object",
|
10529
|
+
"patternProperties": {
|
10530
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
10531
|
+
"type": "string",
|
10532
|
+
"minLength": 1,
|
10533
|
+
"maxLength": 255
|
10534
|
+
}
|
10535
|
+
},
|
10536
|
+
"additionalProperties": false
|
10537
|
+
}
|
8972
10538
|
},
|
8973
10539
|
"additionalProperties": false
|
8974
10540
|
}
|
@@ -9021,7 +10587,22 @@ Schema for the body of an Event creation request
|
|
9021
10587
|
"type": "string",
|
9022
10588
|
"maxLength": 32767
|
9023
10589
|
},
|
9024
|
-
"data": {}
|
10590
|
+
"data": {},
|
10591
|
+
"deviceId": {
|
10592
|
+
"type": "string",
|
10593
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
10594
|
+
},
|
10595
|
+
"eventTags": {
|
10596
|
+
"type": "object",
|
10597
|
+
"patternProperties": {
|
10598
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
10599
|
+
"type": "string",
|
10600
|
+
"minLength": 1,
|
10601
|
+
"maxLength": 255
|
10602
|
+
}
|
10603
|
+
},
|
10604
|
+
"additionalProperties": false
|
10605
|
+
}
|
9025
10606
|
},
|
9026
10607
|
"required": [
|
9027
10608
|
"level",
|
@@ -9123,6 +10704,21 @@ Schema for a collection of Events
|
|
9123
10704
|
"maxLength": 32767
|
9124
10705
|
},
|
9125
10706
|
"data": {},
|
10707
|
+
"deviceId": {
|
10708
|
+
"type": "string",
|
10709
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
10710
|
+
},
|
10711
|
+
"eventTags": {
|
10712
|
+
"type": "object",
|
10713
|
+
"patternProperties": {
|
10714
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
10715
|
+
"type": "string",
|
10716
|
+
"minLength": 1,
|
10717
|
+
"maxLength": 255
|
10718
|
+
}
|
10719
|
+
},
|
10720
|
+
"additionalProperties": false
|
10721
|
+
},
|
9126
10722
|
"updates": {
|
9127
10723
|
"type": "array",
|
9128
10724
|
"items": {
|
@@ -9238,7 +10834,12 @@ Schema for a collection of Events
|
|
9238
10834
|
"state": "new",
|
9239
10835
|
"subject": "Power levels critical",
|
9240
10836
|
"message": "Power levels on device 432 have surpassed critical thresholds",
|
9241
|
-
"updates": []
|
10837
|
+
"updates": [],
|
10838
|
+
"deviceId": "575ecf887ae143cd83dc4aa2",
|
10839
|
+
"eventTags": {
|
10840
|
+
"key": "myKey",
|
10841
|
+
"value": "foo"
|
10842
|
+
}
|
9242
10843
|
}
|
9243
10844
|
],
|
9244
10845
|
"count": 1,
|
@@ -9365,14 +10966,10 @@ Schema for a single Experience Domain
|
|
9365
10966
|
"format": "date-time"
|
9366
10967
|
},
|
9367
10968
|
"sslCert": {
|
9368
|
-
"
|
9369
|
-
"maxLength": 32767,
|
9370
|
-
"minLength": 50
|
10969
|
+
"$ref": "#/definitions/common/certificateString"
|
9371
10970
|
},
|
9372
10971
|
"sslBundle": {
|
9373
|
-
"
|
9374
|
-
"maxLength": 32767,
|
9375
|
-
"minLength": 50
|
10972
|
+
"$ref": "#/definitions/common/certificateString"
|
9376
10973
|
},
|
9377
10974
|
"domainName": {
|
9378
10975
|
"type": "string",
|
@@ -9429,9 +11026,7 @@ Schema for the body of an Experience Domain modification request
|
|
9429
11026
|
"sslCert": {
|
9430
11027
|
"$oneOf": [
|
9431
11028
|
{
|
9432
|
-
"
|
9433
|
-
"maxLength": 32767,
|
9434
|
-
"minLength": 50
|
11029
|
+
"$ref": "#/definitions/common/certificateString"
|
9435
11030
|
},
|
9436
11031
|
{
|
9437
11032
|
"type": null
|
@@ -9441,9 +11036,7 @@ Schema for the body of an Experience Domain modification request
|
|
9441
11036
|
"sslBundle": {
|
9442
11037
|
"$oneOf": [
|
9443
11038
|
{
|
9444
|
-
"
|
9445
|
-
"maxLength": 32767,
|
9446
|
-
"minLength": 50
|
11039
|
+
"$ref": "#/definitions/common/certificateString"
|
9447
11040
|
},
|
9448
11041
|
{
|
9449
11042
|
"type": null
|
@@ -9501,14 +11094,10 @@ Schema for the body of an Experience Domain creation request
|
|
9501
11094
|
"minLength": 50
|
9502
11095
|
},
|
9503
11096
|
"sslCert": {
|
9504
|
-
"
|
9505
|
-
"maxLength": 32767,
|
9506
|
-
"minLength": 50
|
11097
|
+
"$ref": "#/definitions/common/certificateString"
|
9507
11098
|
},
|
9508
11099
|
"sslBundle": {
|
9509
|
-
"
|
9510
|
-
"maxLength": 32767,
|
9511
|
-
"minLength": 50
|
11100
|
+
"$ref": "#/definitions/common/certificateString"
|
9512
11101
|
},
|
9513
11102
|
"domainName": {
|
9514
11103
|
"type": "string",
|
@@ -9586,14 +11175,10 @@ Schema for a collection of Experience Domains
|
|
9586
11175
|
"format": "date-time"
|
9587
11176
|
},
|
9588
11177
|
"sslCert": {
|
9589
|
-
"
|
9590
|
-
"maxLength": 32767,
|
9591
|
-
"minLength": 50
|
11178
|
+
"$ref": "#/definitions/common/certificateString"
|
9592
11179
|
},
|
9593
11180
|
"sslBundle": {
|
9594
|
-
"
|
9595
|
-
"maxLength": 32767,
|
9596
|
-
"minLength": 50
|
11181
|
+
"$ref": "#/definitions/common/certificateString"
|
9597
11182
|
},
|
9598
11183
|
"domainName": {
|
9599
11184
|
"type": "string",
|
@@ -10527,6 +12112,44 @@ Schema for a single Experience Group
|
|
10527
12112
|
}
|
10528
12113
|
},
|
10529
12114
|
"additionalProperties": false
|
12115
|
+
},
|
12116
|
+
"deviceIds": {
|
12117
|
+
"type": "array",
|
12118
|
+
"items": {
|
12119
|
+
"type": "string",
|
12120
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12121
|
+
},
|
12122
|
+
"maxItems": 1000
|
12123
|
+
},
|
12124
|
+
"deviceTags": {
|
12125
|
+
"type": "array",
|
12126
|
+
"items": {
|
12127
|
+
"type": "object",
|
12128
|
+
"properties": {
|
12129
|
+
"key": {
|
12130
|
+
"type": "string",
|
12131
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
12132
|
+
},
|
12133
|
+
"value": {
|
12134
|
+
"type": "string",
|
12135
|
+
"minLength": 1,
|
12136
|
+
"maxLength": 255
|
12137
|
+
}
|
12138
|
+
},
|
12139
|
+
"additionalProperties": false
|
12140
|
+
},
|
12141
|
+
"maxItems": 100
|
12142
|
+
},
|
12143
|
+
"parentId": {
|
12144
|
+
"$oneOf": [
|
12145
|
+
{
|
12146
|
+
"type": "string",
|
12147
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12148
|
+
},
|
12149
|
+
{
|
12150
|
+
"type": null
|
12151
|
+
}
|
12152
|
+
]
|
10530
12153
|
}
|
10531
12154
|
}
|
10532
12155
|
}
|
@@ -10600,6 +12223,44 @@ Schema for the body of an Experience Group modification request
|
|
10600
12223
|
}
|
10601
12224
|
},
|
10602
12225
|
"additionalProperties": false
|
12226
|
+
},
|
12227
|
+
"deviceIds": {
|
12228
|
+
"type": "array",
|
12229
|
+
"items": {
|
12230
|
+
"type": "string",
|
12231
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12232
|
+
},
|
12233
|
+
"maxItems": 1000
|
12234
|
+
},
|
12235
|
+
"deviceTags": {
|
12236
|
+
"type": "array",
|
12237
|
+
"items": {
|
12238
|
+
"type": "object",
|
12239
|
+
"properties": {
|
12240
|
+
"key": {
|
12241
|
+
"type": "string",
|
12242
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
12243
|
+
},
|
12244
|
+
"value": {
|
12245
|
+
"type": "string",
|
12246
|
+
"minLength": 1,
|
12247
|
+
"maxLength": 255
|
12248
|
+
}
|
12249
|
+
},
|
12250
|
+
"additionalProperties": false
|
12251
|
+
},
|
12252
|
+
"maxItems": 100
|
12253
|
+
},
|
12254
|
+
"parentId": {
|
12255
|
+
"$oneOf": [
|
12256
|
+
{
|
12257
|
+
"type": "string",
|
12258
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12259
|
+
},
|
12260
|
+
{
|
12261
|
+
"type": null
|
12262
|
+
}
|
12263
|
+
]
|
10603
12264
|
}
|
10604
12265
|
},
|
10605
12266
|
"additionalProperties": false
|
@@ -10617,6 +12278,16 @@ Schema for the body of an Experience Group modification request
|
|
10617
12278
|
"experienceEndpointIds": [
|
10618
12279
|
"58b9d743cbfafe1be675744b",
|
10619
12280
|
"58b9d743cbfafe1be675744c"
|
12281
|
+
],
|
12282
|
+
"parentId": "775ed70c7ae143cd83dc4aa9",
|
12283
|
+
"deviceIds": [
|
12284
|
+
"58b9d743cbfafe1be675744d"
|
12285
|
+
],
|
12286
|
+
"deviceTags": [
|
12287
|
+
{
|
12288
|
+
"key": "myKey",
|
12289
|
+
"value": "foo"
|
12290
|
+
}
|
10620
12291
|
]
|
10621
12292
|
}
|
10622
12293
|
```
|
@@ -10669,6 +12340,44 @@ Schema for the body of an Experience Group creation request
|
|
10669
12340
|
}
|
10670
12341
|
},
|
10671
12342
|
"additionalProperties": false
|
12343
|
+
},
|
12344
|
+
"deviceIds": {
|
12345
|
+
"type": "array",
|
12346
|
+
"items": {
|
12347
|
+
"type": "string",
|
12348
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12349
|
+
},
|
12350
|
+
"maxItems": 1000
|
12351
|
+
},
|
12352
|
+
"deviceTags": {
|
12353
|
+
"type": "array",
|
12354
|
+
"items": {
|
12355
|
+
"type": "object",
|
12356
|
+
"properties": {
|
12357
|
+
"key": {
|
12358
|
+
"type": "string",
|
12359
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
12360
|
+
},
|
12361
|
+
"value": {
|
12362
|
+
"type": "string",
|
12363
|
+
"minLength": 1,
|
12364
|
+
"maxLength": 255
|
12365
|
+
}
|
12366
|
+
},
|
12367
|
+
"additionalProperties": false
|
12368
|
+
},
|
12369
|
+
"maxItems": 100
|
12370
|
+
},
|
12371
|
+
"parentId": {
|
12372
|
+
"$oneOf": [
|
12373
|
+
{
|
12374
|
+
"type": "string",
|
12375
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12376
|
+
},
|
12377
|
+
{
|
12378
|
+
"type": null
|
12379
|
+
}
|
12380
|
+
]
|
10672
12381
|
}
|
10673
12382
|
},
|
10674
12383
|
"additionalProperties": false,
|
@@ -10689,7 +12398,17 @@ Schema for the body of an Experience Group creation request
|
|
10689
12398
|
"experienceEndpointIds": [
|
10690
12399
|
"58b9d743cbfafe1be675744b",
|
10691
12400
|
"58b9d743cbfafe1be675744c"
|
10692
|
-
]
|
12401
|
+
],
|
12402
|
+
"deviceIds": [
|
12403
|
+
"58b9d743cbfafe1be675744d"
|
12404
|
+
],
|
12405
|
+
"deviceTags": [
|
12406
|
+
{
|
12407
|
+
"key": "floor",
|
12408
|
+
"value": 8
|
12409
|
+
}
|
12410
|
+
],
|
12411
|
+
"parentId": "58b9d743cbfafe1be675744e"
|
10693
12412
|
}
|
10694
12413
|
```
|
10695
12414
|
|
@@ -10768,6 +12487,44 @@ Schema for a collection of Experience Groups
|
|
10768
12487
|
}
|
10769
12488
|
},
|
10770
12489
|
"additionalProperties": false
|
12490
|
+
},
|
12491
|
+
"deviceIds": {
|
12492
|
+
"type": "array",
|
12493
|
+
"items": {
|
12494
|
+
"type": "string",
|
12495
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12496
|
+
},
|
12497
|
+
"maxItems": 1000
|
12498
|
+
},
|
12499
|
+
"deviceTags": {
|
12500
|
+
"type": "array",
|
12501
|
+
"items": {
|
12502
|
+
"type": "object",
|
12503
|
+
"properties": {
|
12504
|
+
"key": {
|
12505
|
+
"type": "string",
|
12506
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
12507
|
+
},
|
12508
|
+
"value": {
|
12509
|
+
"type": "string",
|
12510
|
+
"minLength": 1,
|
12511
|
+
"maxLength": 255
|
12512
|
+
}
|
12513
|
+
},
|
12514
|
+
"additionalProperties": false
|
12515
|
+
},
|
12516
|
+
"maxItems": 100
|
12517
|
+
},
|
12518
|
+
"parentId": {
|
12519
|
+
"$oneOf": [
|
12520
|
+
{
|
12521
|
+
"type": "string",
|
12522
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
12523
|
+
},
|
12524
|
+
{
|
12525
|
+
"type": null
|
12526
|
+
}
|
12527
|
+
]
|
10771
12528
|
}
|
10772
12529
|
}
|
10773
12530
|
}
|
@@ -12956,6 +14713,7 @@ Schema for a single Workflow
|
|
12956
14713
|
"integration",
|
12957
14714
|
"mqttTopic",
|
12958
14715
|
"notebook",
|
14716
|
+
"opcua",
|
12959
14717
|
"redis",
|
12960
14718
|
"request",
|
12961
14719
|
"serial",
|
@@ -13538,13 +15296,13 @@ Schema for the body of a Workflow modification request
|
|
13538
15296
|
"type": "boolean"
|
13539
15297
|
},
|
13540
15298
|
"defaultVersionId": {
|
13541
|
-
"oneOf": [
|
15299
|
+
"$oneOf": [
|
13542
15300
|
{
|
13543
15301
|
"type": "string",
|
13544
15302
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
13545
15303
|
},
|
13546
15304
|
{
|
13547
|
-
"type":
|
15305
|
+
"type": null
|
13548
15306
|
}
|
13549
15307
|
]
|
13550
15308
|
},
|
@@ -13577,6 +15335,7 @@ Schema for the body of a Workflow modification request
|
|
13577
15335
|
"integration",
|
13578
15336
|
"mqttTopic",
|
13579
15337
|
"notebook",
|
15338
|
+
"opcua",
|
13580
15339
|
"redis",
|
13581
15340
|
"request",
|
13582
15341
|
"serial",
|
@@ -14071,6 +15830,7 @@ Schema for the body of a Workflow creation request
|
|
14071
15830
|
"integration",
|
14072
15831
|
"mqttTopic",
|
14073
15832
|
"notebook",
|
15833
|
+
"opcua",
|
14074
15834
|
"redis",
|
14075
15835
|
"request",
|
14076
15836
|
"serial",
|
@@ -14705,6 +16465,7 @@ Schema for a single Workflow Version
|
|
14705
16465
|
"integration",
|
14706
16466
|
"mqttTopic",
|
14707
16467
|
"notebook",
|
16468
|
+
"opcua",
|
14708
16469
|
"redis",
|
14709
16470
|
"request",
|
14710
16471
|
"serial",
|
@@ -15236,6 +16997,7 @@ Schema for a single Workflow Version
|
|
15236
16997
|
"integration",
|
15237
16998
|
"mqttTopic",
|
15238
16999
|
"notebook",
|
17000
|
+
"opcua",
|
15239
17001
|
"redis",
|
15240
17002
|
"request",
|
15241
17003
|
"serial",
|
@@ -15470,6 +17232,7 @@ Schema for the body of a Workflow Version creation request
|
|
15470
17232
|
"integration",
|
15471
17233
|
"mqttTopic",
|
15472
17234
|
"notebook",
|
17235
|
+
"opcua",
|
15473
17236
|
"redis",
|
15474
17237
|
"request",
|
15475
17238
|
"serial",
|
@@ -15989,6 +17752,7 @@ Schema for a collection of Workflow Versions
|
|
15989
17752
|
"integration",
|
15990
17753
|
"mqttTopic",
|
15991
17754
|
"notebook",
|
17755
|
+
"opcua",
|
15992
17756
|
"redis",
|
15993
17757
|
"request",
|
15994
17758
|
"serial",
|
@@ -16520,6 +18284,7 @@ Schema for a collection of Workflow Versions
|
|
16520
18284
|
"integration",
|
16521
18285
|
"mqttTopic",
|
16522
18286
|
"notebook",
|
18287
|
+
"opcua",
|
16523
18288
|
"redis",
|
16524
18289
|
"request",
|
16525
18290
|
"serial",
|
@@ -16821,6 +18586,7 @@ Schema for a collection of Workflows
|
|
16821
18586
|
"integration",
|
16822
18587
|
"mqttTopic",
|
16823
18588
|
"notebook",
|
18589
|
+
"opcua",
|
16824
18590
|
"redis",
|
16825
18591
|
"request",
|
16826
18592
|
"serial",
|
@@ -17426,6 +19192,7 @@ Schema for the body of a workflow import request
|
|
17426
19192
|
"integration",
|
17427
19193
|
"mqttTopic",
|
17428
19194
|
"notebook",
|
19195
|
+
"opcua",
|
17429
19196
|
"redis",
|
17430
19197
|
"request",
|
17431
19198
|
"serial",
|
@@ -17532,13 +19299,13 @@ Schema for the body of a workflow import request
|
|
17532
19299
|
]
|
17533
19300
|
},
|
17534
19301
|
"defaultVersionId": {
|
17535
|
-
"oneOf": [
|
19302
|
+
"$oneOf": [
|
17536
19303
|
{
|
17537
19304
|
"type": "string",
|
17538
19305
|
"pattern": "^[A-Fa-f\\d]{24}$"
|
17539
19306
|
},
|
17540
19307
|
{
|
17541
|
-
"type":
|
19308
|
+
"type": null
|
17542
19309
|
}
|
17543
19310
|
]
|
17544
19311
|
},
|
@@ -17938,6 +19705,7 @@ Schema for the body of a workflow import request
|
|
17938
19705
|
"integration",
|
17939
19706
|
"mqttTopic",
|
17940
19707
|
"notebook",
|
19708
|
+
"opcua",
|
17941
19709
|
"redis",
|
17942
19710
|
"request",
|
17943
19711
|
"serial",
|
@@ -18497,6 +20265,7 @@ Schema for the result of a workflow import request
|
|
18497
20265
|
"integration",
|
18498
20266
|
"mqttTopic",
|
18499
20267
|
"notebook",
|
20268
|
+
"opcua",
|
18500
20269
|
"redis",
|
18501
20270
|
"request",
|
18502
20271
|
"serial",
|
@@ -19028,6 +20797,7 @@ Schema for the result of a workflow import request
|
|
19028
20797
|
"integration",
|
19029
20798
|
"mqttTopic",
|
19030
20799
|
"notebook",
|
20800
|
+
"opcua",
|
19031
20801
|
"redis",
|
19032
20802
|
"request",
|
19033
20803
|
"serial",
|
@@ -19559,6 +21329,7 @@ Schema for the result of a workflow import request
|
|
19559
21329
|
"integration",
|
19560
21330
|
"mqttTopic",
|
19561
21331
|
"notebook",
|
21332
|
+
"opcua",
|
19562
21333
|
"redis",
|
19563
21334
|
"request",
|
19564
21335
|
"serial",
|
@@ -19773,6 +21544,10 @@ Schema for the body of a Github login request
|
|
19773
21544
|
"application.*",
|
19774
21545
|
"applicationApiToken.*",
|
19775
21546
|
"applicationApiTokens.*",
|
21547
|
+
"applicationCertificate.*",
|
21548
|
+
"applicationCertificates.*",
|
21549
|
+
"applicationCertificateAuthority.*",
|
21550
|
+
"applicationCertificateAuthorities.*",
|
19776
21551
|
"applicationKey.*",
|
19777
21552
|
"applicationKeys.*",
|
19778
21553
|
"data.*",
|
@@ -19829,6 +21604,16 @@ Schema for the body of a Github login request
|
|
19829
21604
|
"applicationApiToken.patch",
|
19830
21605
|
"applicationApiTokens.get",
|
19831
21606
|
"applicationApiTokens.post",
|
21607
|
+
"applicationCertificate.delete",
|
21608
|
+
"applicationCertificate.get",
|
21609
|
+
"applicationCertificate.patch",
|
21610
|
+
"applicationCertificates.get",
|
21611
|
+
"applicationCertificates.post",
|
21612
|
+
"applicationCertificateAuthority.delete",
|
21613
|
+
"applicationCertificateAuthority.get",
|
21614
|
+
"applicationCertificateAuthority.patch",
|
21615
|
+
"applicationCertificateAuthorities.get",
|
21616
|
+
"applicationCertificateAuthorities.post",
|
19832
21617
|
"applicationKey.delete",
|
19833
21618
|
"applicationKey.get",
|
19834
21619
|
"applicationKey.patch",
|
@@ -27248,6 +29033,10 @@ Schema for the body of a User authentication request
|
|
27248
29033
|
"application.*",
|
27249
29034
|
"applicationApiToken.*",
|
27250
29035
|
"applicationApiTokens.*",
|
29036
|
+
"applicationCertificate.*",
|
29037
|
+
"applicationCertificates.*",
|
29038
|
+
"applicationCertificateAuthority.*",
|
29039
|
+
"applicationCertificateAuthorities.*",
|
27251
29040
|
"applicationKey.*",
|
27252
29041
|
"applicationKeys.*",
|
27253
29042
|
"data.*",
|
@@ -27304,6 +29093,16 @@ Schema for the body of a User authentication request
|
|
27304
29093
|
"applicationApiToken.patch",
|
27305
29094
|
"applicationApiTokens.get",
|
27306
29095
|
"applicationApiTokens.post",
|
29096
|
+
"applicationCertificate.delete",
|
29097
|
+
"applicationCertificate.get",
|
29098
|
+
"applicationCertificate.patch",
|
29099
|
+
"applicationCertificates.get",
|
29100
|
+
"applicationCertificates.post",
|
29101
|
+
"applicationCertificateAuthority.delete",
|
29102
|
+
"applicationCertificateAuthority.get",
|
29103
|
+
"applicationCertificateAuthority.patch",
|
29104
|
+
"applicationCertificateAuthorities.get",
|
29105
|
+
"applicationCertificateAuthorities.post",
|
27307
29106
|
"applicationKey.delete",
|
27308
29107
|
"applicationKey.get",
|
27309
29108
|
"applicationKey.patch",
|
@@ -27655,6 +29454,10 @@ Schema for the body of a User creation request
|
|
27655
29454
|
"application.*",
|
27656
29455
|
"applicationApiToken.*",
|
27657
29456
|
"applicationApiTokens.*",
|
29457
|
+
"applicationCertificate.*",
|
29458
|
+
"applicationCertificates.*",
|
29459
|
+
"applicationCertificateAuthority.*",
|
29460
|
+
"applicationCertificateAuthorities.*",
|
27658
29461
|
"applicationKey.*",
|
27659
29462
|
"applicationKeys.*",
|
27660
29463
|
"data.*",
|
@@ -27711,6 +29514,16 @@ Schema for the body of a User creation request
|
|
27711
29514
|
"applicationApiToken.patch",
|
27712
29515
|
"applicationApiTokens.get",
|
27713
29516
|
"applicationApiTokens.post",
|
29517
|
+
"applicationCertificate.delete",
|
29518
|
+
"applicationCertificate.get",
|
29519
|
+
"applicationCertificate.patch",
|
29520
|
+
"applicationCertificates.get",
|
29521
|
+
"applicationCertificates.post",
|
29522
|
+
"applicationCertificateAuthority.delete",
|
29523
|
+
"applicationCertificateAuthority.get",
|
29524
|
+
"applicationCertificateAuthority.patch",
|
29525
|
+
"applicationCertificateAuthorities.get",
|
29526
|
+
"applicationCertificateAuthorities.post",
|
27714
29527
|
"applicationKey.delete",
|
27715
29528
|
"applicationKey.get",
|
27716
29529
|
"applicationKey.patch",
|