losant_rest 1.16.0 → 1.16.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +1618 -706
  3. data/docs/applicationDashboard.md +43 -0
  4. data/lib/losant_rest/application_dashboard.rb +49 -0
  5. data/lib/losant_rest/client.rb +2 -2
  6. data/lib/losant_rest/version.rb +1 -1
  7. data/schemas/apiTokenPost.json +1 -0
  8. data/schemas/application.json +1 -1
  9. data/schemas/applicationApplyTemplatePatch.json +5 -0
  10. data/schemas/applicationClonePost.json +5 -0
  11. data/schemas/applicationCreationByTemplateResult.json +1 -1
  12. data/schemas/applicationDashboardPost.json +162 -3
  13. data/schemas/applicationExportPost.json +4 -0
  14. data/schemas/applicationImportOptions.json +33 -1
  15. data/schemas/applicationPatch.json +1 -1
  16. data/schemas/applicationPost.json +1 -1
  17. data/schemas/applications.json +1 -1
  18. data/schemas/dashboard.json +162 -3
  19. data/schemas/dashboardPatch.json +162 -3
  20. data/schemas/dashboardPost.json +162 -3
  21. data/schemas/dashboardSendReport.json +20 -3
  22. data/schemas/dashboards.json +162 -3
  23. data/schemas/experienceBootstrapOptions.json +1 -1
  24. data/schemas/experienceSlug.json +1 -1
  25. data/schemas/experienceSlugPatch.json +1 -1
  26. data/schemas/experienceSlugPost.json +1 -1
  27. data/schemas/experienceSlugs.json +1 -1
  28. data/schemas/experienceUser.json +2 -1
  29. data/schemas/experienceUsers.json +2 -1
  30. data/schemas/githubLogin.json +1 -0
  31. data/schemas/instanceCustomNode.json +9 -0
  32. data/schemas/instanceCustomNodes.json +9 -0
  33. data/schemas/instanceMember.json +2 -1
  34. data/schemas/instanceMembers.json +2 -1
  35. data/schemas/instanceOrg.json +8 -0
  36. data/schemas/instanceOrgMember.json +2 -1
  37. data/schemas/instanceOrgs.json +8 -0
  38. data/schemas/integration.json +2 -1
  39. data/schemas/integrationPatch.json +2 -1
  40. data/schemas/integrationPost.json +2 -1
  41. data/schemas/integrations.json +2 -1
  42. data/schemas/me.json +2 -1
  43. data/schemas/org.json +2 -1
  44. data/schemas/orgs.json +2 -1
  45. data/schemas/userCredentials.json +1 -0
  46. data/schemas/userPost.json +1 -0
  47. metadata +2 -2
data/docs/_schemas.md CHANGED
@@ -6918,6 +6918,7 @@ Schema for the body of an API Token creation request
6918
6918
  "applicationCertificateAuthorities.post",
6919
6919
  "applicationDashboard.get",
6920
6920
  "applicationDashboard.patch",
6921
+ "applicationDashboard.sendReport",
6921
6922
  "applicationDashboard.delete",
6922
6923
  "applicationDashboards.get",
6923
6924
  "applicationDashboards.post",
@@ -7509,7 +7510,7 @@ Schema for a single Application
7509
7510
  },
7510
7511
  "endpointSlug": {
7511
7512
  "type": "string",
7512
- "minLength": 4,
7513
+ "minLength": 3,
7513
7514
  "maxLength": 63,
7514
7515
  "pattern": "^[0-9a-z-]*$"
7515
7516
  },
@@ -7865,6 +7866,11 @@ Schema for the body of an application template import request
7865
7866
  "type": "string",
7866
7867
  "format": "email",
7867
7868
  "maxLength": 1024
7869
+ },
7870
+ "callbackUrl": {
7871
+ "type": "string",
7872
+ "format": "uri",
7873
+ "maxLength": 1024
7868
7874
  }
7869
7875
  },
7870
7876
  "required": [
@@ -8925,6 +8931,11 @@ Schema for the body of an application clone request
8925
8931
  "type": "string",
8926
8932
  "format": "email",
8927
8933
  "maxLength": 1024
8934
+ },
8935
+ "callbackUrl": {
8936
+ "type": "string",
8937
+ "format": "uri",
8938
+ "maxLength": 1024
8928
8939
  }
8929
8940
  },
8930
8941
  "additionalProperties": false
@@ -9016,7 +9027,7 @@ Schema for creating an application by template result
9016
9027
  },
9017
9028
  "endpointSlug": {
9018
9029
  "type": "string",
9019
- "minLength": 4,
9030
+ "minLength": 3,
9020
9031
  "maxLength": 63,
9021
9032
  "pattern": "^[0-9a-z-]*$"
9022
9033
  },
@@ -10395,228 +10406,369 @@ Schema for the body of an Application scoped Dashboard creation request
10395
10406
  "blockType": {
10396
10407
  "type": "string",
10397
10408
  "enum": [
10398
- "device-list"
10409
+ "device-count"
10399
10410
  ]
10400
10411
  },
10401
10412
  "config": {
10402
10413
  "type": "object",
10403
10414
  "properties": {
10404
- "additionalAttributes": {
10405
- "oneOf": [
10406
- {
10407
- "type": "null"
10408
- },
10409
- {
10410
- "type": "array",
10411
- "maxItems": 100,
10412
- "items": {
10415
+ "segments": {
10416
+ "type": "array",
10417
+ "minItems": 1,
10418
+ "maxItems": 100,
10419
+ "items": {
10420
+ "type": "object",
10421
+ "properties": {
10422
+ "id": {
10413
10423
  "type": "string",
10414
- "maxLength": 255
10424
+ "maxLength": 48
10425
+ },
10426
+ "query": {
10427
+ "type": "string",
10428
+ "maxLength": 32767
10415
10429
  }
10416
- }
10417
- ]
10418
- },
10419
- "excludeConnectionInfo": {
10420
- "type": "boolean"
10421
- },
10422
- "deviceLinkNewWindow": {
10423
- "type": "boolean"
10424
- },
10425
- "deviceLinkType": {
10426
- "type": "string",
10427
- "enum": [
10428
- "custom",
10429
- "default"
10430
- ]
10431
- },
10432
- "deviceLinkUrl": {
10433
- "type": "string",
10434
- "maxLength": 2048
10435
- },
10436
- "match": {
10437
- "type": "string",
10438
- "enum": [
10439
- "unfiltered",
10440
- "all",
10441
- "any"
10442
- ]
10443
- },
10444
- "showPublicFilter": {
10445
- "type": "boolean"
10446
- },
10447
- "sortField": {
10448
- "type": "string",
10449
- "enum": [
10450
- "id",
10451
- "creationDate",
10452
- "lastUpdated",
10453
- "name"
10454
- ]
10455
- },
10456
- "sortDirection": {
10457
- "type": "string",
10458
- "enum": [
10459
- "asc",
10460
- "desc",
10461
- "ASC",
10462
- "DESC",
10463
- ""
10464
- ]
10465
- },
10466
- "filter": {
10467
- "oneOf": [
10468
- {
10469
- "type": "string",
10470
- "maxLength": 255
10471
10430
  },
10472
- {
10473
- "type": "object",
10474
- "properties": {
10475
- "ids": {
10476
- "type": "array",
10477
- "maxItems": 100,
10478
- "items": {
10479
- "type": "string",
10480
- "maxLength": 255
10481
- }
10482
- },
10483
- "tags": {
10484
- "type": "array",
10485
- "maxItems": 100,
10486
- "items": {
10487
- "type": "object",
10488
- "properties": {
10489
- "key": {
10490
- "type": "string",
10491
- "maxLength": 255
10492
- },
10493
- "value": {
10494
- "type": "string",
10495
- "maxLength": 255
10496
- },
10497
- "fromCtx": {
10498
- "type": "string",
10499
- "maxLength": 255
10500
- }
10501
- },
10502
- "additionalProperties": false
10503
- }
10504
- },
10505
- "searchParam": {
10506
- "type": "string",
10507
- "maxLength": 255
10508
- }
10509
- },
10510
- "additionalProperties": false
10511
- }
10512
- ]
10513
- },
10514
- "query": {
10515
- "type": "string",
10516
- "maxLength": 32767
10431
+ "required": [
10432
+ "id",
10433
+ "query"
10434
+ ],
10435
+ "additionalProperties": false
10436
+ }
10517
10437
  },
10518
- "columns": {
10438
+ "conditions": {
10519
10439
  "type": "array",
10520
10440
  "maxItems": 100,
10521
10441
  "items": {
10522
10442
  "type": "object",
10523
10443
  "properties": {
10444
+ "color": {
10445
+ "type": "string",
10446
+ "maxLength": 64
10447
+ },
10524
10448
  "id": {
10525
10449
  "type": "string",
10526
10450
  "maxLength": 48
10527
10451
  },
10528
- "type": {
10452
+ "label": {
10529
10453
  "type": "string",
10530
- "enum": [
10531
- "id",
10532
- "connectionStatus",
10533
- "attribute",
10534
- "tag",
10535
- "name",
10536
- "custom",
10537
- "created",
10538
- "updated"
10539
- ]
10454
+ "maxLength": 32767
10540
10455
  },
10541
- "source": {
10456
+ "condition": {
10542
10457
  "type": "string",
10543
- "maxLength": 255
10458
+ "maxLength": 2048
10544
10459
  },
10545
- "headerTemplate": {
10460
+ "imageUrl": {
10546
10461
  "type": "string",
10547
- "maxLength": 1024
10462
+ "maxLength": 32767
10548
10463
  },
10549
- "rowTemplate": {
10464
+ "shape": {
10550
10465
  "type": "string",
10551
- "maxLength": 32767
10466
+ "enum": [
10467
+ "circle",
10468
+ "square",
10469
+ "triangle-down",
10470
+ "triangle-up",
10471
+ "octagon"
10472
+ ]
10552
10473
  }
10553
10474
  },
10554
10475
  "additionalProperties": false
10555
10476
  }
10556
- }
10557
- },
10558
- "additionalProperties": false
10559
- }
10560
- },
10561
- "required": [
10562
- "blockType",
10563
- "startX",
10564
- "startY",
10565
- "width",
10566
- "height"
10567
- ],
10568
- "additionalProperties": false
10569
- },
10570
- {
10571
- "type": "object",
10572
- "properties": {
10573
- "id": {
10574
- "type": "string",
10575
- "maxLength": 48
10576
- },
10577
- "title": {
10578
- "type": "string",
10579
- "maxLength": 255
10580
- },
10581
- "description": {
10582
- "type": "string",
10583
- "maxLength": 32767
10584
- },
10585
- "applicationId": {
10586
- "type": "string",
10587
- "pattern": "^[A-Fa-f\\d]{24}$"
10588
- },
10589
- "startX": {
10590
- "type": "number"
10591
- },
10592
- "startY": {
10593
- "type": "number"
10594
- },
10595
- "width": {
10596
- "type": "number"
10597
- },
10598
- "height": {
10599
- "type": "number"
10600
- },
10601
- "blockType": {
10602
- "type": "string",
10603
- "enum": [
10604
- "device-log"
10605
- ]
10606
- },
10607
- "config": {
10608
- "type": "object",
10609
- "properties": {
10610
- "deviceIds": {
10611
- "type": "array",
10612
- "maxItems": 100,
10613
- "items": {
10614
- "type": "string",
10615
- "maxLength": 255
10616
- }
10617
10477
  },
10618
- "includeDeviceInfo": {
10619
- "type": "boolean"
10478
+ "defaultCondition": {
10479
+ "type": "object",
10480
+ "properties": {
10481
+ "color": {
10482
+ "type": "string",
10483
+ "maxLength": 64
10484
+ },
10485
+ "label": {
10486
+ "type": "string",
10487
+ "maxLength": 32767
10488
+ },
10489
+ "value": {
10490
+ "type": "string",
10491
+ "maxLength": 32767
10492
+ }
10493
+ },
10494
+ "required": [
10495
+ "color"
10496
+ ],
10497
+ "additionalProperties": false
10498
+ }
10499
+ },
10500
+ "required": [
10501
+ "segments",
10502
+ "defaultCondition"
10503
+ ],
10504
+ "additionalProperties": false
10505
+ }
10506
+ },
10507
+ "required": [
10508
+ "blockType",
10509
+ "startX",
10510
+ "startY",
10511
+ "width",
10512
+ "height"
10513
+ ],
10514
+ "additionalProperties": false
10515
+ },
10516
+ {
10517
+ "type": "object",
10518
+ "properties": {
10519
+ "id": {
10520
+ "type": "string",
10521
+ "maxLength": 48
10522
+ },
10523
+ "title": {
10524
+ "type": "string",
10525
+ "maxLength": 255
10526
+ },
10527
+ "description": {
10528
+ "type": "string",
10529
+ "maxLength": 32767
10530
+ },
10531
+ "applicationId": {
10532
+ "type": "string",
10533
+ "pattern": "^[A-Fa-f\\d]{24}$"
10534
+ },
10535
+ "startX": {
10536
+ "type": "number"
10537
+ },
10538
+ "startY": {
10539
+ "type": "number"
10540
+ },
10541
+ "width": {
10542
+ "type": "number"
10543
+ },
10544
+ "height": {
10545
+ "type": "number"
10546
+ },
10547
+ "blockType": {
10548
+ "type": "string",
10549
+ "enum": [
10550
+ "device-list"
10551
+ ]
10552
+ },
10553
+ "config": {
10554
+ "type": "object",
10555
+ "properties": {
10556
+ "additionalAttributes": {
10557
+ "oneOf": [
10558
+ {
10559
+ "type": "null"
10560
+ },
10561
+ {
10562
+ "type": "array",
10563
+ "maxItems": 100,
10564
+ "items": {
10565
+ "type": "string",
10566
+ "maxLength": 255
10567
+ }
10568
+ }
10569
+ ]
10570
+ },
10571
+ "excludeConnectionInfo": {
10572
+ "type": "boolean"
10573
+ },
10574
+ "deviceLinkNewWindow": {
10575
+ "type": "boolean"
10576
+ },
10577
+ "deviceLinkType": {
10578
+ "type": "string",
10579
+ "enum": [
10580
+ "custom",
10581
+ "default"
10582
+ ]
10583
+ },
10584
+ "deviceLinkUrl": {
10585
+ "type": "string",
10586
+ "maxLength": 2048
10587
+ },
10588
+ "match": {
10589
+ "type": "string",
10590
+ "enum": [
10591
+ "unfiltered",
10592
+ "all",
10593
+ "any"
10594
+ ]
10595
+ },
10596
+ "showPublicFilter": {
10597
+ "type": "boolean"
10598
+ },
10599
+ "sortField": {
10600
+ "type": "string",
10601
+ "enum": [
10602
+ "id",
10603
+ "creationDate",
10604
+ "lastUpdated",
10605
+ "name"
10606
+ ]
10607
+ },
10608
+ "sortDirection": {
10609
+ "type": "string",
10610
+ "enum": [
10611
+ "asc",
10612
+ "desc",
10613
+ "ASC",
10614
+ "DESC",
10615
+ ""
10616
+ ]
10617
+ },
10618
+ "filter": {
10619
+ "oneOf": [
10620
+ {
10621
+ "type": "string",
10622
+ "maxLength": 255
10623
+ },
10624
+ {
10625
+ "type": "object",
10626
+ "properties": {
10627
+ "ids": {
10628
+ "type": "array",
10629
+ "maxItems": 100,
10630
+ "items": {
10631
+ "type": "string",
10632
+ "maxLength": 255
10633
+ }
10634
+ },
10635
+ "tags": {
10636
+ "type": "array",
10637
+ "maxItems": 100,
10638
+ "items": {
10639
+ "type": "object",
10640
+ "properties": {
10641
+ "key": {
10642
+ "type": "string",
10643
+ "maxLength": 255
10644
+ },
10645
+ "value": {
10646
+ "type": "string",
10647
+ "maxLength": 255
10648
+ },
10649
+ "fromCtx": {
10650
+ "type": "string",
10651
+ "maxLength": 255
10652
+ }
10653
+ },
10654
+ "additionalProperties": false
10655
+ }
10656
+ },
10657
+ "searchParam": {
10658
+ "type": "string",
10659
+ "maxLength": 255
10660
+ }
10661
+ },
10662
+ "additionalProperties": false
10663
+ }
10664
+ ]
10665
+ },
10666
+ "query": {
10667
+ "type": "string",
10668
+ "maxLength": 32767
10669
+ },
10670
+ "columns": {
10671
+ "type": "array",
10672
+ "maxItems": 100,
10673
+ "items": {
10674
+ "type": "object",
10675
+ "properties": {
10676
+ "id": {
10677
+ "type": "string",
10678
+ "maxLength": 48
10679
+ },
10680
+ "type": {
10681
+ "type": "string",
10682
+ "enum": [
10683
+ "id",
10684
+ "connectionStatus",
10685
+ "attribute",
10686
+ "tag",
10687
+ "name",
10688
+ "custom",
10689
+ "created",
10690
+ "updated"
10691
+ ]
10692
+ },
10693
+ "source": {
10694
+ "type": "string",
10695
+ "maxLength": 255
10696
+ },
10697
+ "headerTemplate": {
10698
+ "type": "string",
10699
+ "maxLength": 1024
10700
+ },
10701
+ "rowTemplate": {
10702
+ "type": "string",
10703
+ "maxLength": 32767
10704
+ }
10705
+ },
10706
+ "additionalProperties": false
10707
+ }
10708
+ }
10709
+ },
10710
+ "additionalProperties": false
10711
+ }
10712
+ },
10713
+ "required": [
10714
+ "blockType",
10715
+ "startX",
10716
+ "startY",
10717
+ "width",
10718
+ "height"
10719
+ ],
10720
+ "additionalProperties": false
10721
+ },
10722
+ {
10723
+ "type": "object",
10724
+ "properties": {
10725
+ "id": {
10726
+ "type": "string",
10727
+ "maxLength": 48
10728
+ },
10729
+ "title": {
10730
+ "type": "string",
10731
+ "maxLength": 255
10732
+ },
10733
+ "description": {
10734
+ "type": "string",
10735
+ "maxLength": 32767
10736
+ },
10737
+ "applicationId": {
10738
+ "type": "string",
10739
+ "pattern": "^[A-Fa-f\\d]{24}$"
10740
+ },
10741
+ "startX": {
10742
+ "type": "number"
10743
+ },
10744
+ "startY": {
10745
+ "type": "number"
10746
+ },
10747
+ "width": {
10748
+ "type": "number"
10749
+ },
10750
+ "height": {
10751
+ "type": "number"
10752
+ },
10753
+ "blockType": {
10754
+ "type": "string",
10755
+ "enum": [
10756
+ "device-log"
10757
+ ]
10758
+ },
10759
+ "config": {
10760
+ "type": "object",
10761
+ "properties": {
10762
+ "deviceIds": {
10763
+ "type": "array",
10764
+ "maxItems": 100,
10765
+ "items": {
10766
+ "type": "string",
10767
+ "maxLength": 255
10768
+ }
10769
+ },
10770
+ "includeDeviceInfo": {
10771
+ "type": "boolean"
10620
10772
  }
10621
10773
  },
10622
10774
  "additionalProperties": false
@@ -14713,6 +14865,11 @@ Schema for the body of an Application scoped Dashboard creation request
14713
14865
  "maxLength": 1024
14714
14866
  }
14715
14867
  },
14868
+ "callbackUrl": {
14869
+ "type": "string",
14870
+ "format": "uri",
14871
+ "maxLength": 1024
14872
+ },
14716
14873
  "subject": {
14717
14874
  "type": "string",
14718
14875
  "maxLength": 255
@@ -14735,12 +14892,25 @@ Schema for the body of an Application scoped Dashboard creation request
14735
14892
  "locale": {
14736
14893
  "type": "string",
14737
14894
  "maxLength": 5
14895
+ },
14896
+ "ctx": {
14897
+ "ref": "#/definitions/dashboardContextInstance"
14738
14898
  }
14739
14899
  },
14740
14900
  "additionalProperties": false,
14741
- "required": [
14742
- "cron",
14743
- "toEmail"
14901
+ "anyOf": [
14902
+ {
14903
+ "required": [
14904
+ "cron",
14905
+ "toEmail"
14906
+ ]
14907
+ },
14908
+ {
14909
+ "required": [
14910
+ "cron",
14911
+ "callbackUrl"
14912
+ ]
14913
+ }
14744
14914
  ]
14745
14915
  }
14746
14916
  },
@@ -15122,6 +15292,10 @@ Schema for the body of an application export request
15122
15292
  "type": "string",
15123
15293
  "format": "email",
15124
15294
  "maxLength": 1024
15295
+ },
15296
+ "callbackUrl": {
15297
+ "type": "string",
15298
+ "maxLength": 1024
15125
15299
  }
15126
15300
  },
15127
15301
  "additionalProperties": false
@@ -15241,7 +15415,39 @@ Schema for additional application import options
15241
15415
  "properties": {
15242
15416
  "importUrl": {
15243
15417
  "type": "string",
15244
- "format": "url"
15418
+ "format": "uri",
15419
+ "maxLength": 1024
15420
+ },
15421
+ "callbackUrl": {
15422
+ "type": "string",
15423
+ "format": "uri",
15424
+ "maxLength": 1024
15425
+ },
15426
+ "include": {
15427
+ "type": "array",
15428
+ "items": {
15429
+ "enum": [
15430
+ "ApplicationCertificateAuthority",
15431
+ "Dashboard",
15432
+ "DataTableRow",
15433
+ "DataTable",
15434
+ "DeviceRecipe",
15435
+ "Device",
15436
+ "ExperienceEndpoint",
15437
+ "ExperienceFlowVersion",
15438
+ "ExperienceGroup",
15439
+ "ExperienceUser",
15440
+ "ExperienceVersion",
15441
+ "ExperienceView",
15442
+ "File",
15443
+ "FlowVersion",
15444
+ "Flow",
15445
+ "Integration",
15446
+ "Notebook",
15447
+ "Webhook"
15448
+ ]
15449
+ },
15450
+ "uniqueItems": true
15245
15451
  }
15246
15452
  },
15247
15453
  "additionalProperties": false
@@ -15251,7 +15457,11 @@ Schema for additional application import options
15251
15457
 
15252
15458
  ```json
15253
15459
  {
15254
- "importUrl": "https://storage.mySite.com/myZipFile.zip"
15460
+ "importUrl": "https://storage.mySite.com/myZipFile.zip",
15461
+ "include": [
15462
+ "Flow",
15463
+ "Device"
15464
+ ]
15255
15465
  }
15256
15466
  ```
15257
15467
 
@@ -15890,7 +16100,7 @@ Schema for the body of an Application modification request
15890
16100
  },
15891
16101
  "endpointSlug": {
15892
16102
  "type": "string",
15893
- "minLength": 4,
16103
+ "minLength": 3,
15894
16104
  "maxLength": 63,
15895
16105
  "pattern": "^[0-9a-z-]*$"
15896
16106
  },
@@ -16172,7 +16382,7 @@ Schema for the body of an Application creation request
16172
16382
  },
16173
16383
  "endpointSlug": {
16174
16384
  "type": "string",
16175
- "minLength": 4,
16385
+ "minLength": 3,
16176
16386
  "maxLength": 63,
16177
16387
  "pattern": "^[0-9a-z-]*$"
16178
16388
  },
@@ -17128,7 +17338,7 @@ Schema for a collection of Applications
17128
17338
  },
17129
17339
  "endpointSlug": {
17130
17340
  "type": "string",
17131
- "minLength": 4,
17341
+ "minLength": 3,
17132
17342
  "maxLength": 63,
17133
17343
  "pattern": "^[0-9a-z-]*$"
17134
17344
  },
@@ -18462,6 +18672,11 @@ Schema for a single Dashboard
18462
18672
  "maxLength": 1024
18463
18673
  }
18464
18674
  },
18675
+ "callbackUrl": {
18676
+ "type": "string",
18677
+ "format": "uri",
18678
+ "maxLength": 1024
18679
+ },
18465
18680
  "subject": {
18466
18681
  "type": "string",
18467
18682
  "maxLength": 255
@@ -18484,12 +18699,25 @@ Schema for a single Dashboard
18484
18699
  "locale": {
18485
18700
  "type": "string",
18486
18701
  "maxLength": 5
18702
+ },
18703
+ "ctx": {
18704
+ "ref": "#/definitions/dashboardContextInstance"
18487
18705
  }
18488
18706
  },
18489
18707
  "additionalProperties": false,
18490
- "required": [
18491
- "cron",
18492
- "toEmail"
18708
+ "anyOf": [
18709
+ {
18710
+ "required": [
18711
+ "cron",
18712
+ "toEmail"
18713
+ ]
18714
+ },
18715
+ {
18716
+ "required": [
18717
+ "cron",
18718
+ "callbackUrl"
18719
+ ]
18720
+ }
18493
18721
  ]
18494
18722
  }
18495
18723
  },
@@ -19486,228 +19714,369 @@ Schema for a single Dashboard
19486
19714
  "blockType": {
19487
19715
  "type": "string",
19488
19716
  "enum": [
19489
- "device-list"
19717
+ "device-count"
19490
19718
  ]
19491
19719
  },
19492
19720
  "config": {
19493
19721
  "type": "object",
19494
19722
  "properties": {
19495
- "additionalAttributes": {
19496
- "oneOf": [
19497
- {
19498
- "type": "null"
19499
- },
19500
- {
19501
- "type": "array",
19502
- "maxItems": 100,
19503
- "items": {
19723
+ "segments": {
19724
+ "type": "array",
19725
+ "minItems": 1,
19726
+ "maxItems": 100,
19727
+ "items": {
19728
+ "type": "object",
19729
+ "properties": {
19730
+ "id": {
19504
19731
  "type": "string",
19505
- "maxLength": 255
19732
+ "maxLength": 48
19733
+ },
19734
+ "query": {
19735
+ "type": "string",
19736
+ "maxLength": 32767
19506
19737
  }
19507
- }
19508
- ]
19509
- },
19510
- "excludeConnectionInfo": {
19511
- "type": "boolean"
19512
- },
19513
- "deviceLinkNewWindow": {
19514
- "type": "boolean"
19515
- },
19516
- "deviceLinkType": {
19517
- "type": "string",
19518
- "enum": [
19519
- "custom",
19520
- "default"
19521
- ]
19522
- },
19523
- "deviceLinkUrl": {
19524
- "type": "string",
19525
- "maxLength": 2048
19526
- },
19527
- "match": {
19528
- "type": "string",
19529
- "enum": [
19530
- "unfiltered",
19531
- "all",
19532
- "any"
19533
- ]
19534
- },
19535
- "showPublicFilter": {
19536
- "type": "boolean"
19537
- },
19538
- "sortField": {
19539
- "type": "string",
19540
- "enum": [
19541
- "id",
19542
- "creationDate",
19543
- "lastUpdated",
19544
- "name"
19545
- ]
19546
- },
19547
- "sortDirection": {
19548
- "type": "string",
19549
- "enum": [
19550
- "asc",
19551
- "desc",
19552
- "ASC",
19553
- "DESC",
19554
- ""
19555
- ]
19556
- },
19557
- "filter": {
19558
- "oneOf": [
19559
- {
19560
- "type": "string",
19561
- "maxLength": 255
19562
19738
  },
19563
- {
19564
- "type": "object",
19565
- "properties": {
19566
- "ids": {
19567
- "type": "array",
19568
- "maxItems": 100,
19569
- "items": {
19570
- "type": "string",
19571
- "maxLength": 255
19572
- }
19573
- },
19574
- "tags": {
19575
- "type": "array",
19576
- "maxItems": 100,
19577
- "items": {
19578
- "type": "object",
19579
- "properties": {
19580
- "key": {
19581
- "type": "string",
19582
- "maxLength": 255
19583
- },
19584
- "value": {
19585
- "type": "string",
19586
- "maxLength": 255
19587
- },
19588
- "fromCtx": {
19589
- "type": "string",
19590
- "maxLength": 255
19591
- }
19592
- },
19593
- "additionalProperties": false
19594
- }
19595
- },
19596
- "searchParam": {
19597
- "type": "string",
19598
- "maxLength": 255
19599
- }
19600
- },
19601
- "additionalProperties": false
19602
- }
19603
- ]
19604
- },
19605
- "query": {
19606
- "type": "string",
19607
- "maxLength": 32767
19739
+ "required": [
19740
+ "id",
19741
+ "query"
19742
+ ],
19743
+ "additionalProperties": false
19744
+ }
19608
19745
  },
19609
- "columns": {
19746
+ "conditions": {
19610
19747
  "type": "array",
19611
19748
  "maxItems": 100,
19612
19749
  "items": {
19613
19750
  "type": "object",
19614
19751
  "properties": {
19752
+ "color": {
19753
+ "type": "string",
19754
+ "maxLength": 64
19755
+ },
19615
19756
  "id": {
19616
19757
  "type": "string",
19617
19758
  "maxLength": 48
19618
19759
  },
19619
- "type": {
19760
+ "label": {
19620
19761
  "type": "string",
19621
- "enum": [
19622
- "id",
19623
- "connectionStatus",
19624
- "attribute",
19625
- "tag",
19626
- "name",
19627
- "custom",
19628
- "created",
19629
- "updated"
19630
- ]
19762
+ "maxLength": 32767
19631
19763
  },
19632
- "source": {
19764
+ "condition": {
19633
19765
  "type": "string",
19634
- "maxLength": 255
19766
+ "maxLength": 2048
19635
19767
  },
19636
- "headerTemplate": {
19768
+ "imageUrl": {
19637
19769
  "type": "string",
19638
- "maxLength": 1024
19770
+ "maxLength": 32767
19639
19771
  },
19640
- "rowTemplate": {
19772
+ "shape": {
19641
19773
  "type": "string",
19642
- "maxLength": 32767
19774
+ "enum": [
19775
+ "circle",
19776
+ "square",
19777
+ "triangle-down",
19778
+ "triangle-up",
19779
+ "octagon"
19780
+ ]
19643
19781
  }
19644
19782
  },
19645
19783
  "additionalProperties": false
19646
19784
  }
19647
- }
19648
- },
19649
- "additionalProperties": false
19650
- }
19651
- },
19652
- "required": [
19653
- "blockType",
19654
- "startX",
19655
- "startY",
19656
- "width",
19657
- "height"
19658
- ],
19659
- "additionalProperties": false
19660
- },
19661
- {
19662
- "type": "object",
19663
- "properties": {
19664
- "id": {
19665
- "type": "string",
19666
- "maxLength": 48
19667
- },
19668
- "title": {
19669
- "type": "string",
19670
- "maxLength": 255
19671
- },
19672
- "description": {
19673
- "type": "string",
19674
- "maxLength": 32767
19675
- },
19676
- "applicationId": {
19677
- "type": "string",
19678
- "pattern": "^[A-Fa-f\\d]{24}$"
19679
- },
19680
- "startX": {
19681
- "type": "number"
19682
- },
19683
- "startY": {
19684
- "type": "number"
19685
- },
19686
- "width": {
19687
- "type": "number"
19688
- },
19689
- "height": {
19690
- "type": "number"
19691
- },
19692
- "blockType": {
19693
- "type": "string",
19694
- "enum": [
19695
- "device-log"
19696
- ]
19697
- },
19698
- "config": {
19699
- "type": "object",
19700
- "properties": {
19701
- "deviceIds": {
19702
- "type": "array",
19703
- "maxItems": 100,
19704
- "items": {
19705
- "type": "string",
19706
- "maxLength": 255
19707
- }
19708
19785
  },
19709
- "includeDeviceInfo": {
19710
- "type": "boolean"
19786
+ "defaultCondition": {
19787
+ "type": "object",
19788
+ "properties": {
19789
+ "color": {
19790
+ "type": "string",
19791
+ "maxLength": 64
19792
+ },
19793
+ "label": {
19794
+ "type": "string",
19795
+ "maxLength": 32767
19796
+ },
19797
+ "value": {
19798
+ "type": "string",
19799
+ "maxLength": 32767
19800
+ }
19801
+ },
19802
+ "required": [
19803
+ "color"
19804
+ ],
19805
+ "additionalProperties": false
19806
+ }
19807
+ },
19808
+ "required": [
19809
+ "segments",
19810
+ "defaultCondition"
19811
+ ],
19812
+ "additionalProperties": false
19813
+ }
19814
+ },
19815
+ "required": [
19816
+ "blockType",
19817
+ "startX",
19818
+ "startY",
19819
+ "width",
19820
+ "height"
19821
+ ],
19822
+ "additionalProperties": false
19823
+ },
19824
+ {
19825
+ "type": "object",
19826
+ "properties": {
19827
+ "id": {
19828
+ "type": "string",
19829
+ "maxLength": 48
19830
+ },
19831
+ "title": {
19832
+ "type": "string",
19833
+ "maxLength": 255
19834
+ },
19835
+ "description": {
19836
+ "type": "string",
19837
+ "maxLength": 32767
19838
+ },
19839
+ "applicationId": {
19840
+ "type": "string",
19841
+ "pattern": "^[A-Fa-f\\d]{24}$"
19842
+ },
19843
+ "startX": {
19844
+ "type": "number"
19845
+ },
19846
+ "startY": {
19847
+ "type": "number"
19848
+ },
19849
+ "width": {
19850
+ "type": "number"
19851
+ },
19852
+ "height": {
19853
+ "type": "number"
19854
+ },
19855
+ "blockType": {
19856
+ "type": "string",
19857
+ "enum": [
19858
+ "device-list"
19859
+ ]
19860
+ },
19861
+ "config": {
19862
+ "type": "object",
19863
+ "properties": {
19864
+ "additionalAttributes": {
19865
+ "oneOf": [
19866
+ {
19867
+ "type": "null"
19868
+ },
19869
+ {
19870
+ "type": "array",
19871
+ "maxItems": 100,
19872
+ "items": {
19873
+ "type": "string",
19874
+ "maxLength": 255
19875
+ }
19876
+ }
19877
+ ]
19878
+ },
19879
+ "excludeConnectionInfo": {
19880
+ "type": "boolean"
19881
+ },
19882
+ "deviceLinkNewWindow": {
19883
+ "type": "boolean"
19884
+ },
19885
+ "deviceLinkType": {
19886
+ "type": "string",
19887
+ "enum": [
19888
+ "custom",
19889
+ "default"
19890
+ ]
19891
+ },
19892
+ "deviceLinkUrl": {
19893
+ "type": "string",
19894
+ "maxLength": 2048
19895
+ },
19896
+ "match": {
19897
+ "type": "string",
19898
+ "enum": [
19899
+ "unfiltered",
19900
+ "all",
19901
+ "any"
19902
+ ]
19903
+ },
19904
+ "showPublicFilter": {
19905
+ "type": "boolean"
19906
+ },
19907
+ "sortField": {
19908
+ "type": "string",
19909
+ "enum": [
19910
+ "id",
19911
+ "creationDate",
19912
+ "lastUpdated",
19913
+ "name"
19914
+ ]
19915
+ },
19916
+ "sortDirection": {
19917
+ "type": "string",
19918
+ "enum": [
19919
+ "asc",
19920
+ "desc",
19921
+ "ASC",
19922
+ "DESC",
19923
+ ""
19924
+ ]
19925
+ },
19926
+ "filter": {
19927
+ "oneOf": [
19928
+ {
19929
+ "type": "string",
19930
+ "maxLength": 255
19931
+ },
19932
+ {
19933
+ "type": "object",
19934
+ "properties": {
19935
+ "ids": {
19936
+ "type": "array",
19937
+ "maxItems": 100,
19938
+ "items": {
19939
+ "type": "string",
19940
+ "maxLength": 255
19941
+ }
19942
+ },
19943
+ "tags": {
19944
+ "type": "array",
19945
+ "maxItems": 100,
19946
+ "items": {
19947
+ "type": "object",
19948
+ "properties": {
19949
+ "key": {
19950
+ "type": "string",
19951
+ "maxLength": 255
19952
+ },
19953
+ "value": {
19954
+ "type": "string",
19955
+ "maxLength": 255
19956
+ },
19957
+ "fromCtx": {
19958
+ "type": "string",
19959
+ "maxLength": 255
19960
+ }
19961
+ },
19962
+ "additionalProperties": false
19963
+ }
19964
+ },
19965
+ "searchParam": {
19966
+ "type": "string",
19967
+ "maxLength": 255
19968
+ }
19969
+ },
19970
+ "additionalProperties": false
19971
+ }
19972
+ ]
19973
+ },
19974
+ "query": {
19975
+ "type": "string",
19976
+ "maxLength": 32767
19977
+ },
19978
+ "columns": {
19979
+ "type": "array",
19980
+ "maxItems": 100,
19981
+ "items": {
19982
+ "type": "object",
19983
+ "properties": {
19984
+ "id": {
19985
+ "type": "string",
19986
+ "maxLength": 48
19987
+ },
19988
+ "type": {
19989
+ "type": "string",
19990
+ "enum": [
19991
+ "id",
19992
+ "connectionStatus",
19993
+ "attribute",
19994
+ "tag",
19995
+ "name",
19996
+ "custom",
19997
+ "created",
19998
+ "updated"
19999
+ ]
20000
+ },
20001
+ "source": {
20002
+ "type": "string",
20003
+ "maxLength": 255
20004
+ },
20005
+ "headerTemplate": {
20006
+ "type": "string",
20007
+ "maxLength": 1024
20008
+ },
20009
+ "rowTemplate": {
20010
+ "type": "string",
20011
+ "maxLength": 32767
20012
+ }
20013
+ },
20014
+ "additionalProperties": false
20015
+ }
20016
+ }
20017
+ },
20018
+ "additionalProperties": false
20019
+ }
20020
+ },
20021
+ "required": [
20022
+ "blockType",
20023
+ "startX",
20024
+ "startY",
20025
+ "width",
20026
+ "height"
20027
+ ],
20028
+ "additionalProperties": false
20029
+ },
20030
+ {
20031
+ "type": "object",
20032
+ "properties": {
20033
+ "id": {
20034
+ "type": "string",
20035
+ "maxLength": 48
20036
+ },
20037
+ "title": {
20038
+ "type": "string",
20039
+ "maxLength": 255
20040
+ },
20041
+ "description": {
20042
+ "type": "string",
20043
+ "maxLength": 32767
20044
+ },
20045
+ "applicationId": {
20046
+ "type": "string",
20047
+ "pattern": "^[A-Fa-f\\d]{24}$"
20048
+ },
20049
+ "startX": {
20050
+ "type": "number"
20051
+ },
20052
+ "startY": {
20053
+ "type": "number"
20054
+ },
20055
+ "width": {
20056
+ "type": "number"
20057
+ },
20058
+ "height": {
20059
+ "type": "number"
20060
+ },
20061
+ "blockType": {
20062
+ "type": "string",
20063
+ "enum": [
20064
+ "device-log"
20065
+ ]
20066
+ },
20067
+ "config": {
20068
+ "type": "object",
20069
+ "properties": {
20070
+ "deviceIds": {
20071
+ "type": "array",
20072
+ "maxItems": 100,
20073
+ "items": {
20074
+ "type": "string",
20075
+ "maxLength": 255
20076
+ }
20077
+ },
20078
+ "includeDeviceInfo": {
20079
+ "type": "boolean"
19711
20080
  }
19712
20081
  },
19713
20082
  "additionalProperties": false
@@ -25235,6 +25604,147 @@ Schema for the body of a Dashboard modification request
25235
25604
  ],
25236
25605
  "additionalProperties": false
25237
25606
  },
25607
+ {
25608
+ "type": "object",
25609
+ "properties": {
25610
+ "id": {
25611
+ "type": "string",
25612
+ "maxLength": 48
25613
+ },
25614
+ "title": {
25615
+ "type": "string",
25616
+ "maxLength": 255
25617
+ },
25618
+ "description": {
25619
+ "type": "string",
25620
+ "maxLength": 32767
25621
+ },
25622
+ "applicationId": {
25623
+ "type": "string",
25624
+ "pattern": "^[A-Fa-f\\d]{24}$"
25625
+ },
25626
+ "startX": {
25627
+ "type": "number"
25628
+ },
25629
+ "startY": {
25630
+ "type": "number"
25631
+ },
25632
+ "width": {
25633
+ "type": "number"
25634
+ },
25635
+ "height": {
25636
+ "type": "number"
25637
+ },
25638
+ "blockType": {
25639
+ "type": "string",
25640
+ "enum": [
25641
+ "device-count"
25642
+ ]
25643
+ },
25644
+ "config": {
25645
+ "type": "object",
25646
+ "properties": {
25647
+ "segments": {
25648
+ "type": "array",
25649
+ "minItems": 1,
25650
+ "maxItems": 100,
25651
+ "items": {
25652
+ "type": "object",
25653
+ "properties": {
25654
+ "id": {
25655
+ "type": "string",
25656
+ "maxLength": 48
25657
+ },
25658
+ "query": {
25659
+ "type": "string",
25660
+ "maxLength": 32767
25661
+ }
25662
+ },
25663
+ "required": [
25664
+ "id",
25665
+ "query"
25666
+ ],
25667
+ "additionalProperties": false
25668
+ }
25669
+ },
25670
+ "conditions": {
25671
+ "type": "array",
25672
+ "maxItems": 100,
25673
+ "items": {
25674
+ "type": "object",
25675
+ "properties": {
25676
+ "color": {
25677
+ "type": "string",
25678
+ "maxLength": 64
25679
+ },
25680
+ "id": {
25681
+ "type": "string",
25682
+ "maxLength": 48
25683
+ },
25684
+ "label": {
25685
+ "type": "string",
25686
+ "maxLength": 32767
25687
+ },
25688
+ "condition": {
25689
+ "type": "string",
25690
+ "maxLength": 2048
25691
+ },
25692
+ "imageUrl": {
25693
+ "type": "string",
25694
+ "maxLength": 32767
25695
+ },
25696
+ "shape": {
25697
+ "type": "string",
25698
+ "enum": [
25699
+ "circle",
25700
+ "square",
25701
+ "triangle-down",
25702
+ "triangle-up",
25703
+ "octagon"
25704
+ ]
25705
+ }
25706
+ },
25707
+ "additionalProperties": false
25708
+ }
25709
+ },
25710
+ "defaultCondition": {
25711
+ "type": "object",
25712
+ "properties": {
25713
+ "color": {
25714
+ "type": "string",
25715
+ "maxLength": 64
25716
+ },
25717
+ "label": {
25718
+ "type": "string",
25719
+ "maxLength": 32767
25720
+ },
25721
+ "value": {
25722
+ "type": "string",
25723
+ "maxLength": 32767
25724
+ }
25725
+ },
25726
+ "required": [
25727
+ "color"
25728
+ ],
25729
+ "additionalProperties": false
25730
+ }
25731
+ },
25732
+ "required": [
25733
+ "segments",
25734
+ "defaultCondition"
25735
+ ],
25736
+ "additionalProperties": false
25737
+ }
25738
+ },
25739
+ "required": [
25740
+ "blockType",
25741
+ "startX",
25742
+ "startY",
25743
+ "width",
25744
+ "height"
25745
+ ],
25746
+ "additionalProperties": false
25747
+ },
25238
25748
  {
25239
25749
  "type": "object",
25240
25750
  "properties": {
@@ -29571,6 +30081,11 @@ Schema for the body of a Dashboard modification request
29571
30081
  "maxLength": 1024
29572
30082
  }
29573
30083
  },
30084
+ "callbackUrl": {
30085
+ "type": "string",
30086
+ "format": "uri",
30087
+ "maxLength": 1024
30088
+ },
29574
30089
  "subject": {
29575
30090
  "type": "string",
29576
30091
  "maxLength": 255
@@ -29593,12 +30108,25 @@ Schema for the body of a Dashboard modification request
29593
30108
  "locale": {
29594
30109
  "type": "string",
29595
30110
  "maxLength": 5
30111
+ },
30112
+ "ctx": {
30113
+ "ref": "#/definitions/dashboardContextInstance"
29596
30114
  }
29597
30115
  },
29598
30116
  "additionalProperties": false,
29599
- "required": [
29600
- "cron",
29601
- "toEmail"
30117
+ "anyOf": [
30118
+ {
30119
+ "required": [
30120
+ "cron",
30121
+ "toEmail"
30122
+ ]
30123
+ },
30124
+ {
30125
+ "required": [
30126
+ "cron",
30127
+ "callbackUrl"
30128
+ ]
30129
+ }
29602
30130
  ]
29603
30131
  }
29604
30132
  },
@@ -30951,6 +31479,147 @@ Schema for the body of a Dashboard creation request
30951
31479
  ],
30952
31480
  "additionalProperties": false
30953
31481
  },
31482
+ {
31483
+ "type": "object",
31484
+ "properties": {
31485
+ "id": {
31486
+ "type": "string",
31487
+ "maxLength": 48
31488
+ },
31489
+ "title": {
31490
+ "type": "string",
31491
+ "maxLength": 255
31492
+ },
31493
+ "description": {
31494
+ "type": "string",
31495
+ "maxLength": 32767
31496
+ },
31497
+ "applicationId": {
31498
+ "type": "string",
31499
+ "pattern": "^[A-Fa-f\\d]{24}$"
31500
+ },
31501
+ "startX": {
31502
+ "type": "number"
31503
+ },
31504
+ "startY": {
31505
+ "type": "number"
31506
+ },
31507
+ "width": {
31508
+ "type": "number"
31509
+ },
31510
+ "height": {
31511
+ "type": "number"
31512
+ },
31513
+ "blockType": {
31514
+ "type": "string",
31515
+ "enum": [
31516
+ "device-count"
31517
+ ]
31518
+ },
31519
+ "config": {
31520
+ "type": "object",
31521
+ "properties": {
31522
+ "segments": {
31523
+ "type": "array",
31524
+ "minItems": 1,
31525
+ "maxItems": 100,
31526
+ "items": {
31527
+ "type": "object",
31528
+ "properties": {
31529
+ "id": {
31530
+ "type": "string",
31531
+ "maxLength": 48
31532
+ },
31533
+ "query": {
31534
+ "type": "string",
31535
+ "maxLength": 32767
31536
+ }
31537
+ },
31538
+ "required": [
31539
+ "id",
31540
+ "query"
31541
+ ],
31542
+ "additionalProperties": false
31543
+ }
31544
+ },
31545
+ "conditions": {
31546
+ "type": "array",
31547
+ "maxItems": 100,
31548
+ "items": {
31549
+ "type": "object",
31550
+ "properties": {
31551
+ "color": {
31552
+ "type": "string",
31553
+ "maxLength": 64
31554
+ },
31555
+ "id": {
31556
+ "type": "string",
31557
+ "maxLength": 48
31558
+ },
31559
+ "label": {
31560
+ "type": "string",
31561
+ "maxLength": 32767
31562
+ },
31563
+ "condition": {
31564
+ "type": "string",
31565
+ "maxLength": 2048
31566
+ },
31567
+ "imageUrl": {
31568
+ "type": "string",
31569
+ "maxLength": 32767
31570
+ },
31571
+ "shape": {
31572
+ "type": "string",
31573
+ "enum": [
31574
+ "circle",
31575
+ "square",
31576
+ "triangle-down",
31577
+ "triangle-up",
31578
+ "octagon"
31579
+ ]
31580
+ }
31581
+ },
31582
+ "additionalProperties": false
31583
+ }
31584
+ },
31585
+ "defaultCondition": {
31586
+ "type": "object",
31587
+ "properties": {
31588
+ "color": {
31589
+ "type": "string",
31590
+ "maxLength": 64
31591
+ },
31592
+ "label": {
31593
+ "type": "string",
31594
+ "maxLength": 32767
31595
+ },
31596
+ "value": {
31597
+ "type": "string",
31598
+ "maxLength": 32767
31599
+ }
31600
+ },
31601
+ "required": [
31602
+ "color"
31603
+ ],
31604
+ "additionalProperties": false
31605
+ }
31606
+ },
31607
+ "required": [
31608
+ "segments",
31609
+ "defaultCondition"
31610
+ ],
31611
+ "additionalProperties": false
31612
+ }
31613
+ },
31614
+ "required": [
31615
+ "blockType",
31616
+ "startX",
31617
+ "startY",
31618
+ "width",
31619
+ "height"
31620
+ ],
31621
+ "additionalProperties": false
31622
+ },
30954
31623
  {
30955
31624
  "type": "object",
30956
31625
  "properties": {
@@ -35303,6 +35972,11 @@ Schema for the body of a Dashboard creation request
35303
35972
  "maxLength": 1024
35304
35973
  }
35305
35974
  },
35975
+ "callbackUrl": {
35976
+ "type": "string",
35977
+ "format": "uri",
35978
+ "maxLength": 1024
35979
+ },
35306
35980
  "subject": {
35307
35981
  "type": "string",
35308
35982
  "maxLength": 255
@@ -35325,12 +35999,25 @@ Schema for the body of a Dashboard creation request
35325
35999
  "locale": {
35326
36000
  "type": "string",
35327
36001
  "maxLength": 5
36002
+ },
36003
+ "ctx": {
36004
+ "ref": "#/definitions/dashboardContextInstance"
35328
36005
  }
35329
36006
  },
35330
36007
  "additionalProperties": false,
35331
- "required": [
35332
- "cron",
35333
- "toEmail"
36008
+ "anyOf": [
36009
+ {
36010
+ "required": [
36011
+ "cron",
36012
+ "toEmail"
36013
+ ]
36014
+ },
36015
+ {
36016
+ "required": [
36017
+ "cron",
36018
+ "callbackUrl"
36019
+ ]
36020
+ }
35334
36021
  ]
35335
36022
  }
35336
36023
  },
@@ -35695,9 +36382,6 @@ Schema for the body of a Dashboard report request
35695
36382
  {
35696
36383
  "$schema": "http://json-schema.org/draft-04/schema#",
35697
36384
  "type": "object",
35698
- "required": [
35699
- "toEmail"
35700
- ],
35701
36385
  "properties": {
35702
36386
  "toEmail": {
35703
36387
  "type": "array",
@@ -35709,6 +36393,11 @@ Schema for the body of a Dashboard report request
35709
36393
  "maxLength": 1024
35710
36394
  }
35711
36395
  },
36396
+ "callbackUrl": {
36397
+ "type": "string",
36398
+ "format": "uri",
36399
+ "maxLength": 1024
36400
+ },
35712
36401
  "subject": {
35713
36402
  "type": "string",
35714
36403
  "maxLength": 255
@@ -35734,8 +36423,23 @@ Schema for the body of a Dashboard report request
35734
36423
  "locale": {
35735
36424
  "type": "string",
35736
36425
  "maxLength": 5
36426
+ },
36427
+ "ctx": {
36428
+ "ref": "#/definitions/dashboardContextInstance"
35737
36429
  }
35738
36430
  },
36431
+ "anyOf": [
36432
+ {
36433
+ "required": [
36434
+ "toEmail"
36435
+ ]
36436
+ },
36437
+ {
36438
+ "required": [
36439
+ "callbackUrl"
36440
+ ]
36441
+ }
36442
+ ],
35739
36443
  "additionalProperties": false
35740
36444
  }
35741
36445
  ```
@@ -35941,6 +36645,11 @@ Schema for a collection of Dashboards
35941
36645
  "maxLength": 1024
35942
36646
  }
35943
36647
  },
36648
+ "callbackUrl": {
36649
+ "type": "string",
36650
+ "format": "uri",
36651
+ "maxLength": 1024
36652
+ },
35944
36653
  "subject": {
35945
36654
  "type": "string",
35946
36655
  "maxLength": 255
@@ -35963,12 +36672,25 @@ Schema for a collection of Dashboards
35963
36672
  "locale": {
35964
36673
  "type": "string",
35965
36674
  "maxLength": 5
36675
+ },
36676
+ "ctx": {
36677
+ "ref": "#/definitions/dashboardContextInstance"
35966
36678
  }
35967
36679
  },
35968
36680
  "additionalProperties": false,
35969
- "required": [
35970
- "cron",
35971
- "toEmail"
36681
+ "anyOf": [
36682
+ {
36683
+ "required": [
36684
+ "cron",
36685
+ "toEmail"
36686
+ ]
36687
+ },
36688
+ {
36689
+ "required": [
36690
+ "cron",
36691
+ "callbackUrl"
36692
+ ]
36693
+ }
35972
36694
  ]
35973
36695
  }
35974
36696
  },
@@ -36931,6 +37653,147 @@ Schema for a collection of Dashboards
36931
37653
  ],
36932
37654
  "additionalProperties": false
36933
37655
  },
37656
+ {
37657
+ "type": "object",
37658
+ "properties": {
37659
+ "id": {
37660
+ "type": "string",
37661
+ "maxLength": 48
37662
+ },
37663
+ "title": {
37664
+ "type": "string",
37665
+ "maxLength": 255
37666
+ },
37667
+ "description": {
37668
+ "type": "string",
37669
+ "maxLength": 32767
37670
+ },
37671
+ "applicationId": {
37672
+ "type": "string",
37673
+ "pattern": "^[A-Fa-f\\d]{24}$"
37674
+ },
37675
+ "startX": {
37676
+ "type": "number"
37677
+ },
37678
+ "startY": {
37679
+ "type": "number"
37680
+ },
37681
+ "width": {
37682
+ "type": "number"
37683
+ },
37684
+ "height": {
37685
+ "type": "number"
37686
+ },
37687
+ "blockType": {
37688
+ "type": "string",
37689
+ "enum": [
37690
+ "device-count"
37691
+ ]
37692
+ },
37693
+ "config": {
37694
+ "type": "object",
37695
+ "properties": {
37696
+ "segments": {
37697
+ "type": "array",
37698
+ "minItems": 1,
37699
+ "maxItems": 100,
37700
+ "items": {
37701
+ "type": "object",
37702
+ "properties": {
37703
+ "id": {
37704
+ "type": "string",
37705
+ "maxLength": 48
37706
+ },
37707
+ "query": {
37708
+ "type": "string",
37709
+ "maxLength": 32767
37710
+ }
37711
+ },
37712
+ "required": [
37713
+ "id",
37714
+ "query"
37715
+ ],
37716
+ "additionalProperties": false
37717
+ }
37718
+ },
37719
+ "conditions": {
37720
+ "type": "array",
37721
+ "maxItems": 100,
37722
+ "items": {
37723
+ "type": "object",
37724
+ "properties": {
37725
+ "color": {
37726
+ "type": "string",
37727
+ "maxLength": 64
37728
+ },
37729
+ "id": {
37730
+ "type": "string",
37731
+ "maxLength": 48
37732
+ },
37733
+ "label": {
37734
+ "type": "string",
37735
+ "maxLength": 32767
37736
+ },
37737
+ "condition": {
37738
+ "type": "string",
37739
+ "maxLength": 2048
37740
+ },
37741
+ "imageUrl": {
37742
+ "type": "string",
37743
+ "maxLength": 32767
37744
+ },
37745
+ "shape": {
37746
+ "type": "string",
37747
+ "enum": [
37748
+ "circle",
37749
+ "square",
37750
+ "triangle-down",
37751
+ "triangle-up",
37752
+ "octagon"
37753
+ ]
37754
+ }
37755
+ },
37756
+ "additionalProperties": false
37757
+ }
37758
+ },
37759
+ "defaultCondition": {
37760
+ "type": "object",
37761
+ "properties": {
37762
+ "color": {
37763
+ "type": "string",
37764
+ "maxLength": 64
37765
+ },
37766
+ "label": {
37767
+ "type": "string",
37768
+ "maxLength": 32767
37769
+ },
37770
+ "value": {
37771
+ "type": "string",
37772
+ "maxLength": 32767
37773
+ }
37774
+ },
37775
+ "required": [
37776
+ "color"
37777
+ ],
37778
+ "additionalProperties": false
37779
+ }
37780
+ },
37781
+ "required": [
37782
+ "segments",
37783
+ "defaultCondition"
37784
+ ],
37785
+ "additionalProperties": false
37786
+ }
37787
+ },
37788
+ "required": [
37789
+ "blockType",
37790
+ "startX",
37791
+ "startY",
37792
+ "width",
37793
+ "height"
37794
+ ],
37795
+ "additionalProperties": false
37796
+ },
36934
37797
  {
36935
37798
  "type": "object",
36936
37799
  "properties": {
@@ -57617,7 +58480,7 @@ The body of an experience bootstrap request
57617
58480
  },
57618
58481
  "slug": {
57619
58482
  "type": "string",
57620
- "minLength": 4,
58483
+ "minLength": 3,
57621
58484
  "maxLength": 63,
57622
58485
  "pattern": "^[0-9a-z-]*$"
57623
58486
  }
@@ -67486,7 +68349,7 @@ Schema for a single Experience Slug
67486
68349
  },
67487
68350
  "slug": {
67488
68351
  "type": "string",
67489
- "minLength": 4,
68352
+ "minLength": 3,
67490
68353
  "maxLength": 63,
67491
68354
  "pattern": "^[0-9a-z-]*$"
67492
68355
  },
@@ -67539,7 +68402,7 @@ Schema for the body of an Experience Slug modification request
67539
68402
  },
67540
68403
  "slug": {
67541
68404
  "type": "string",
67542
- "minLength": 4,
68405
+ "minLength": 3,
67543
68406
  "maxLength": 63,
67544
68407
  "pattern": "^[0-9a-z-]*$"
67545
68408
  }
@@ -67583,7 +68446,7 @@ Schema for the body of an Experience Slug creation request
67583
68446
  },
67584
68447
  "slug": {
67585
68448
  "type": "string",
67586
- "minLength": 4,
68449
+ "minLength": 3,
67587
68450
  "maxLength": 63,
67588
68451
  "pattern": "^[0-9a-z-]*$"
67589
68452
  }
@@ -67645,7 +68508,7 @@ Schema for a collection of Experience Slugs
67645
68508
  },
67646
68509
  "slug": {
67647
68510
  "type": "string",
67648
- "minLength": 4,
68511
+ "minLength": 3,
67649
68512
  "maxLength": 63,
67650
68513
  "pattern": "^[0-9a-z-]*$"
67651
68514
  },
@@ -67747,7 +68610,8 @@ Schema for a single Experience User
67747
68610
  },
67748
68611
  "avatarUrl": {
67749
68612
  "type": "string",
67750
- "format": "url"
68613
+ "format": "uri",
68614
+ "maxLength": 1024
67751
68615
  },
67752
68616
  "tokenCutoff": {
67753
68617
  "type": "string",
@@ -68013,7 +68877,8 @@ Schema for a collection of Experience Users
68013
68877
  },
68014
68878
  "avatarUrl": {
68015
68879
  "type": "string",
68016
- "format": "url"
68880
+ "format": "uri",
68881
+ "maxLength": 1024
68017
68882
  },
68018
68883
  "tokenCutoff": {
68019
68884
  "type": "string",
@@ -106633,6 +107498,7 @@ Schema for the body of a Github login request
106633
107498
  "applicationCertificateAuthorities.post",
106634
107499
  "applicationDashboard.get",
106635
107500
  "applicationDashboard.patch",
107501
+ "applicationDashboard.sendReport",
106636
107502
  "applicationDashboard.delete",
106637
107503
  "applicationDashboards.get",
106638
107504
  "applicationDashboards.post",
@@ -108527,6 +109393,15 @@ Schema for a single Instance Custom Node
108527
109393
  },
108528
109394
  "flowCount": {
108529
109395
  "type": "integer"
109396
+ },
109397
+ "orgName": {
109398
+ "type": "string",
109399
+ "minLength": 1,
109400
+ "maxLength": 255
109401
+ },
109402
+ "orgIconColor": {
109403
+ "type": "string",
109404
+ "maxLength": 64
108530
109405
  }
108531
109406
  },
108532
109407
  "additionalProperties": false
@@ -110559,6 +111434,15 @@ Schema for a collection of Custom Nodes within an instance
110559
111434
  },
110560
111435
  "flowCount": {
110561
111436
  "type": "integer"
111437
+ },
111438
+ "orgName": {
111439
+ "type": "string",
111440
+ "minLength": 1,
111441
+ "maxLength": 255
111442
+ },
111443
+ "orgIconColor": {
111444
+ "type": "string",
111445
+ "maxLength": 64
110562
111446
  }
110563
111447
  },
110564
111448
  "additionalProperties": false
@@ -110696,7 +111580,8 @@ Schema for an Instance member
110696
111580
  },
110697
111581
  "avatarUrl": {
110698
111582
  "type": "string",
110699
- "format": "url"
111583
+ "format": "uri",
111584
+ "maxLength": 1024
110700
111585
  },
110701
111586
  "twoFactorAuthEnabled": {
110702
111587
  "type": "boolean"
@@ -110859,7 +111744,8 @@ Schema for a collection of Instance members
110859
111744
  },
110860
111745
  "avatarUrl": {
110861
111746
  "type": "string",
110862
- "format": "url"
111747
+ "format": "uri",
111748
+ "maxLength": 1024
110863
111749
  },
110864
111750
  "twoFactorAuthEnabled": {
110865
111751
  "type": "boolean"
@@ -110929,6 +111815,14 @@ Schema for the body of an Organization owned by an instance
110929
111815
  "$schema": "http://json-schema.org/draft-04/schema#",
110930
111816
  "type": "object",
110931
111817
  "properties": {
111818
+ "creationDate": {
111819
+ "type": "string",
111820
+ "format": "date-time"
111821
+ },
111822
+ "lastUpdated": {
111823
+ "type": "string",
111824
+ "format": "date-time"
111825
+ },
110932
111826
  "name": {
110933
111827
  "type": "string",
110934
111828
  "minLength": 1,
@@ -111134,7 +112028,8 @@ Schema for an Instance Organization member
111134
112028
  },
111135
112029
  "avatarUrl": {
111136
112030
  "type": "string",
111137
- "format": "url"
112031
+ "format": "uri",
112032
+ "maxLength": 1024
111138
112033
  },
111139
112034
  "twoFactorAuthEnabled": {
111140
112035
  "type": "boolean"
@@ -112063,6 +112958,14 @@ Schema for a collection of Organizations within an instance
112063
112958
  "description": "Schema for the body of an Organization owned by an instance",
112064
112959
  "type": "object",
112065
112960
  "properties": {
112961
+ "creationDate": {
112962
+ "type": "string",
112963
+ "format": "date-time"
112964
+ },
112965
+ "lastUpdated": {
112966
+ "type": "string",
112967
+ "format": "date-time"
112968
+ },
112066
112969
  "name": {
112067
112970
  "type": "string",
112068
112971
  "minLength": 1,
@@ -112617,289 +113520,291 @@ Schema for a single Integration
112617
113520
  "type": "string",
112618
113521
  "minLength": 1,
112619
113522
  "maxLength": 1024
112620
- }
112621
- },
112622
- "azureEventHubConfig": {
112623
- "type": "object",
112624
- "properties": {
112625
- "hubName": {
112626
- "type": "string",
112627
- "maxLength": 256,
112628
- "minLength": 1
112629
- },
112630
- "consumerGroup": {
112631
- "type": "string",
112632
- "maxLength": 256,
112633
- "minLength": 1
112634
- },
112635
- "connectionString": {
112636
- "type": "string",
112637
- "minLength": 1,
112638
- "maxLength": 1024
112639
- }
112640
113523
  },
112641
- "additionalProperties": false,
112642
- "required": [
112643
- "hubName",
112644
- "consumerGroup",
112645
- "connectionString"
112646
- ]
112647
- },
112648
- "googlePubSubConfig": {
112649
- "type": "object",
112650
- "properties": {
112651
- "projectId": {
112652
- "type": "string",
112653
- "minLength": 1,
112654
- "maxLength": 1024
112655
- },
112656
- "keyJson": {
112657
- "type": "string",
112658
- "maxLength": 32767,
112659
- "minLength": 4
112660
- }
112661
- },
112662
- "additionalProperties": false,
112663
- "required": [
112664
- "projectId",
112665
- "keyJson"
112666
- ]
112667
- },
112668
- "mqttConfig": {
112669
- "type": "object",
112670
- "properties": {
112671
- "clientId": {
112672
- "type": "string",
112673
- "minLength": 1,
112674
- "maxLength": 1024
112675
- },
112676
- "username": {
112677
- "type": "string",
112678
- "minLength": 1,
112679
- "maxLength": 1024
112680
- },
112681
- "password": {
112682
- "type": "string",
112683
- "minLength": 1,
112684
- "maxLength": 1024
112685
- },
112686
- "clean": {
112687
- "type": "boolean"
112688
- },
112689
- "port": {
112690
- "type": "number",
112691
- "minimum": 1,
112692
- "maximum": 65535
112693
- },
112694
- "protocol": {
112695
- "type": "string",
112696
- "enum": [
112697
- "mqtt",
112698
- "mqtts",
112699
- "ws",
112700
- "wss"
112701
- ]
112702
- },
112703
- "host": {
112704
- "type": "string",
112705
- "minLength": 1,
112706
- "maxLength": 1024
112707
- },
112708
- "privateKey": {
112709
- "type": "string",
112710
- "maxLength": 32767,
112711
- "minLength": 4
112712
- },
112713
- "certificate": {
112714
- "type": "string",
112715
- "maxLength": 32767,
112716
- "minLength": 4
112717
- },
112718
- "caCertificate": {
112719
- "type": "string",
112720
- "maxLength": 32767,
112721
- "minLength": 4
112722
- },
112723
- "disableSSLVerification": {
112724
- "type": "boolean"
112725
- }
112726
- },
112727
- "additionalProperties": false,
112728
- "required": [
112729
- "port",
112730
- "protocol",
112731
- "host"
112732
- ]
112733
- },
112734
- "particleConfig": {
112735
- "type": "object",
112736
- "properties": {
112737
- "accessToken": {
112738
- "type": "string",
112739
- "minLength": 1,
112740
- "maxLength": 1024
112741
- },
112742
- "productSlugOrId": {
112743
- "type": "string",
112744
- "minLength": 1,
112745
- "maxLength": 1024
112746
- },
112747
- "orgSlugOrId": {
112748
- "type": "string",
112749
- "minLength": 1,
112750
- "maxLength": 1024
112751
- },
112752
- "deviceNameOrId": {
112753
- "type": "string",
112754
- "minLength": 1,
112755
- "maxLength": 1024
112756
- }
112757
- },
112758
- "additionalProperties": false,
112759
- "required": [
112760
- "accessToken"
112761
- ]
112762
- },
112763
- "meridianConfig": {
112764
- "type": "object",
112765
- "properties": {
112766
- "authenticationToken": {
112767
- "type": "string",
112768
- "minLength": 1,
112769
- "maxLength": 1024
112770
- },
112771
- "locationId": {
112772
- "type": "string",
112773
- "minLength": 1,
112774
- "maxLength": 1024
112775
- },
112776
- "assetUpdates": {
112777
- "type": "boolean"
112778
- },
112779
- "zoneUpdates": {
112780
- "type": "boolean"
112781
- }
112782
- },
112783
- "additionalProperties": false,
112784
- "required": [
112785
- "authenticationToken",
112786
- "locationId"
112787
- ]
112788
- },
112789
- "status": {
112790
- "lastKeepAlive": {
112791
- "type": [
112792
- "number"
112793
- ]
112794
- },
112795
- "nextAttempt": {
112796
- "type": [
112797
- "number"
112798
- ]
112799
- },
112800
- "connectInfo": {
112801
- "type": "object",
112802
- "properties": {
112803
- "ts": {
112804
- "type": [
112805
- "number",
112806
- "null"
112807
- ]
112808
- }
112809
- }
112810
- },
112811
- "disconnectInfo": {
112812
- "type": "object",
112813
- "properties": {
112814
- "ts": {
112815
- "type": [
112816
- "number",
112817
- "null"
112818
- ]
112819
- },
112820
- "error": {
112821
- "type": "string"
112822
- }
112823
- }
112824
- }
112825
- }
112826
- }
112827
- }
112828
- ```
112829
- ### <a name="integration-example"></a> Example
112830
-
112831
- ```json
112832
- {
112833
- "id": "58ec07f20c747f65243d0d76",
112834
- "integrationId": "58ec07f20c747f65243d0d76",
112835
- "applicationId": "575ec8687ae143cd83dc4a97",
112836
- "creationDate": "2016-06-13T04:00:00.000Z",
112837
- "lastUpdated": "2016-06-13T04:00:00.000Z",
112838
- "name": "Example Integrations",
112839
- "integrationType": "mqtt",
112840
- "enabled": true,
112841
- "topics": [
112842
- "myTopic"
112843
- ],
112844
- "mqttConfig": {
112845
- "clientId": "exampleClientId",
112846
- "username": "exampleUsername",
112847
- "password": "examplePassword",
112848
- "port": 8883,
112849
- "protocol": "mqtts",
112850
- "host": "broker.example.com"
112851
- },
112852
- "status": {
112853
- "lastKeepAlive": 1491863679994,
112854
- "connectInfo": {
112855
- "ts": 1490629589313
112856
- },
112857
- "disconnectInfo": {
112858
- "ts": 1490629587190,
112859
- "error": "Keepalive Timeout"
112860
- }
112861
- }
112862
- }
112863
- ```
112864
-
112865
- <br/>
112866
-
112867
- ## Integration Patch
112868
-
112869
- Schema for the body of an Integration modification request
112870
-
112871
- ### <a name="integration-patch-schema"></a> Schema
112872
-
112873
- ```json
112874
- {
112875
- "$schema": "http://json-schema.org/draft-04/schema#",
112876
- "type": "object",
112877
- "properties": {
112878
- "name": {
112879
- "type": "string",
112880
- "minLength": 1,
112881
- "maxLength": 255
112882
- },
112883
- "integrationType": {
112884
- "type": "string",
112885
- "enum": [
112886
- "azureEventHub",
112887
- "googlePubSub",
112888
- "meridian",
112889
- "mqtt",
112890
- "particle"
112891
- ]
112892
- },
112893
- "enabled": {
112894
- "type": "boolean"
112895
- },
112896
- "topics": {
112897
- "type": "array",
112898
- "items": {
112899
- "type": "string",
112900
- "minLength": 1,
112901
- "maxLength": 1024
112902
- }
113524
+ "uniqueItems": true
113525
+ },
113526
+ "azureEventHubConfig": {
113527
+ "type": "object",
113528
+ "properties": {
113529
+ "hubName": {
113530
+ "type": "string",
113531
+ "maxLength": 256,
113532
+ "minLength": 1
113533
+ },
113534
+ "consumerGroup": {
113535
+ "type": "string",
113536
+ "maxLength": 256,
113537
+ "minLength": 1
113538
+ },
113539
+ "connectionString": {
113540
+ "type": "string",
113541
+ "minLength": 1,
113542
+ "maxLength": 1024
113543
+ }
113544
+ },
113545
+ "additionalProperties": false,
113546
+ "required": [
113547
+ "hubName",
113548
+ "consumerGroup",
113549
+ "connectionString"
113550
+ ]
113551
+ },
113552
+ "googlePubSubConfig": {
113553
+ "type": "object",
113554
+ "properties": {
113555
+ "projectId": {
113556
+ "type": "string",
113557
+ "minLength": 1,
113558
+ "maxLength": 1024
113559
+ },
113560
+ "keyJson": {
113561
+ "type": "string",
113562
+ "maxLength": 32767,
113563
+ "minLength": 4
113564
+ }
113565
+ },
113566
+ "additionalProperties": false,
113567
+ "required": [
113568
+ "projectId",
113569
+ "keyJson"
113570
+ ]
113571
+ },
113572
+ "mqttConfig": {
113573
+ "type": "object",
113574
+ "properties": {
113575
+ "clientId": {
113576
+ "type": "string",
113577
+ "minLength": 1,
113578
+ "maxLength": 1024
113579
+ },
113580
+ "username": {
113581
+ "type": "string",
113582
+ "minLength": 1,
113583
+ "maxLength": 1024
113584
+ },
113585
+ "password": {
113586
+ "type": "string",
113587
+ "minLength": 1,
113588
+ "maxLength": 1024
113589
+ },
113590
+ "clean": {
113591
+ "type": "boolean"
113592
+ },
113593
+ "port": {
113594
+ "type": "number",
113595
+ "minimum": 1,
113596
+ "maximum": 65535
113597
+ },
113598
+ "protocol": {
113599
+ "type": "string",
113600
+ "enum": [
113601
+ "mqtt",
113602
+ "mqtts",
113603
+ "ws",
113604
+ "wss"
113605
+ ]
113606
+ },
113607
+ "host": {
113608
+ "type": "string",
113609
+ "minLength": 1,
113610
+ "maxLength": 1024
113611
+ },
113612
+ "privateKey": {
113613
+ "type": "string",
113614
+ "maxLength": 32767,
113615
+ "minLength": 4
113616
+ },
113617
+ "certificate": {
113618
+ "type": "string",
113619
+ "maxLength": 32767,
113620
+ "minLength": 4
113621
+ },
113622
+ "caCertificate": {
113623
+ "type": "string",
113624
+ "maxLength": 32767,
113625
+ "minLength": 4
113626
+ },
113627
+ "disableSSLVerification": {
113628
+ "type": "boolean"
113629
+ }
113630
+ },
113631
+ "additionalProperties": false,
113632
+ "required": [
113633
+ "port",
113634
+ "protocol",
113635
+ "host"
113636
+ ]
113637
+ },
113638
+ "particleConfig": {
113639
+ "type": "object",
113640
+ "properties": {
113641
+ "accessToken": {
113642
+ "type": "string",
113643
+ "minLength": 1,
113644
+ "maxLength": 1024
113645
+ },
113646
+ "productSlugOrId": {
113647
+ "type": "string",
113648
+ "minLength": 1,
113649
+ "maxLength": 1024
113650
+ },
113651
+ "orgSlugOrId": {
113652
+ "type": "string",
113653
+ "minLength": 1,
113654
+ "maxLength": 1024
113655
+ },
113656
+ "deviceNameOrId": {
113657
+ "type": "string",
113658
+ "minLength": 1,
113659
+ "maxLength": 1024
113660
+ }
113661
+ },
113662
+ "additionalProperties": false,
113663
+ "required": [
113664
+ "accessToken"
113665
+ ]
113666
+ },
113667
+ "meridianConfig": {
113668
+ "type": "object",
113669
+ "properties": {
113670
+ "authenticationToken": {
113671
+ "type": "string",
113672
+ "minLength": 1,
113673
+ "maxLength": 1024
113674
+ },
113675
+ "locationId": {
113676
+ "type": "string",
113677
+ "minLength": 1,
113678
+ "maxLength": 1024
113679
+ },
113680
+ "assetUpdates": {
113681
+ "type": "boolean"
113682
+ },
113683
+ "zoneUpdates": {
113684
+ "type": "boolean"
113685
+ }
113686
+ },
113687
+ "additionalProperties": false,
113688
+ "required": [
113689
+ "authenticationToken",
113690
+ "locationId"
113691
+ ]
113692
+ },
113693
+ "status": {
113694
+ "lastKeepAlive": {
113695
+ "type": [
113696
+ "number"
113697
+ ]
113698
+ },
113699
+ "nextAttempt": {
113700
+ "type": [
113701
+ "number"
113702
+ ]
113703
+ },
113704
+ "connectInfo": {
113705
+ "type": "object",
113706
+ "properties": {
113707
+ "ts": {
113708
+ "type": [
113709
+ "number",
113710
+ "null"
113711
+ ]
113712
+ }
113713
+ }
113714
+ },
113715
+ "disconnectInfo": {
113716
+ "type": "object",
113717
+ "properties": {
113718
+ "ts": {
113719
+ "type": [
113720
+ "number",
113721
+ "null"
113722
+ ]
113723
+ },
113724
+ "error": {
113725
+ "type": "string"
113726
+ }
113727
+ }
113728
+ }
113729
+ }
113730
+ }
113731
+ }
113732
+ ```
113733
+ ### <a name="integration-example"></a> Example
113734
+
113735
+ ```json
113736
+ {
113737
+ "id": "58ec07f20c747f65243d0d76",
113738
+ "integrationId": "58ec07f20c747f65243d0d76",
113739
+ "applicationId": "575ec8687ae143cd83dc4a97",
113740
+ "creationDate": "2016-06-13T04:00:00.000Z",
113741
+ "lastUpdated": "2016-06-13T04:00:00.000Z",
113742
+ "name": "Example Integrations",
113743
+ "integrationType": "mqtt",
113744
+ "enabled": true,
113745
+ "topics": [
113746
+ "myTopic"
113747
+ ],
113748
+ "mqttConfig": {
113749
+ "clientId": "exampleClientId",
113750
+ "username": "exampleUsername",
113751
+ "password": "examplePassword",
113752
+ "port": 8883,
113753
+ "protocol": "mqtts",
113754
+ "host": "broker.example.com"
113755
+ },
113756
+ "status": {
113757
+ "lastKeepAlive": 1491863679994,
113758
+ "connectInfo": {
113759
+ "ts": 1490629589313
113760
+ },
113761
+ "disconnectInfo": {
113762
+ "ts": 1490629587190,
113763
+ "error": "Keepalive Timeout"
113764
+ }
113765
+ }
113766
+ }
113767
+ ```
113768
+
113769
+ <br/>
113770
+
113771
+ ## Integration Patch
113772
+
113773
+ Schema for the body of an Integration modification request
113774
+
113775
+ ### <a name="integration-patch-schema"></a> Schema
113776
+
113777
+ ```json
113778
+ {
113779
+ "$schema": "http://json-schema.org/draft-04/schema#",
113780
+ "type": "object",
113781
+ "properties": {
113782
+ "name": {
113783
+ "type": "string",
113784
+ "minLength": 1,
113785
+ "maxLength": 255
113786
+ },
113787
+ "integrationType": {
113788
+ "type": "string",
113789
+ "enum": [
113790
+ "azureEventHub",
113791
+ "googlePubSub",
113792
+ "meridian",
113793
+ "mqtt",
113794
+ "particle"
113795
+ ]
113796
+ },
113797
+ "enabled": {
113798
+ "type": "boolean"
113799
+ },
113800
+ "topics": {
113801
+ "type": "array",
113802
+ "items": {
113803
+ "type": "string",
113804
+ "minLength": 1,
113805
+ "maxLength": 1024
113806
+ },
113807
+ "uniqueItems": true
112903
113808
  },
112904
113809
  "azureEventHubConfig": {
112905
113810
  "type": "object",
@@ -113119,7 +114024,8 @@ Schema for the body of an Integration creation request
113119
114024
  "type": "string",
113120
114025
  "minLength": 1,
113121
114026
  "maxLength": 1024
113122
- }
114027
+ },
114028
+ "uniqueItems": true
113123
114029
  },
113124
114030
  "azureEventHubConfig": {
113125
114031
  "type": "object",
@@ -113380,7 +114286,8 @@ Schema for a collection of Integrations
113380
114286
  "type": "string",
113381
114287
  "minLength": 1,
113382
114288
  "maxLength": 1024
113383
- }
114289
+ },
114290
+ "uniqueItems": true
113384
114291
  },
113385
114292
  "azureEventHubConfig": {
113386
114293
  "type": "object",
@@ -113912,7 +114819,8 @@ Schema for information about the currently authenticated user
113912
114819
  },
113913
114820
  "avatarUrl": {
113914
114821
  "type": "string",
113915
- "format": "url"
114822
+ "format": "uri",
114823
+ "maxLength": 1024
113916
114824
  },
113917
114825
  "limits": {
113918
114826
  "type": "object",
@@ -119172,7 +120080,8 @@ Schema for a single Organization
119172
120080
  },
119173
120081
  "avatarUrl": {
119174
120082
  "type": "string",
119175
- "format": "url"
120083
+ "format": "uri",
120084
+ "maxLength": 1024
119176
120085
  },
119177
120086
  "role": {
119178
120087
  "type": "string",
@@ -120650,7 +121559,8 @@ Schema for a collection of Organizations
120650
121559
  },
120651
121560
  "avatarUrl": {
120652
121561
  "type": "string",
120653
- "format": "url"
121562
+ "format": "uri",
121563
+ "maxLength": 1024
120654
121564
  },
120655
121565
  "role": {
120656
121566
  "type": "string",
@@ -123218,6 +124128,7 @@ Schema for the body of a User authentication request
123218
124128
  "applicationCertificateAuthorities.post",
123219
124129
  "applicationDashboard.get",
123220
124130
  "applicationDashboard.patch",
124131
+ "applicationDashboard.sendReport",
123221
124132
  "applicationDashboard.delete",
123222
124133
  "applicationDashboards.get",
123223
124134
  "applicationDashboards.post",
@@ -123744,6 +124655,7 @@ Schema for the body of a User creation request
123744
124655
  "applicationCertificateAuthorities.post",
123745
124656
  "applicationDashboard.get",
123746
124657
  "applicationDashboard.patch",
124658
+ "applicationDashboard.sendReport",
123747
124659
  "applicationDashboard.delete",
123748
124660
  "applicationDashboards.get",
123749
124661
  "applicationDashboards.post",