losant_rest 1.19.0 → 1.19.1
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 +872 -38
- data/docs/applications.md +49 -0
- data/docs/device.md +12 -3
- data/docs/me.md +116 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/platform_rest/application.rb +932 -0
- data/lib/platform_rest/application_api_token.rb +176 -0
- data/lib/platform_rest/application_api_tokens.rb +136 -0
- data/lib/platform_rest/application_certificate.rb +176 -0
- data/lib/platform_rest/application_certificate_authorities.rb +138 -0
- data/lib/platform_rest/application_certificate_authority.rb +176 -0
- data/lib/platform_rest/application_certificates.rb +138 -0
- data/lib/platform_rest/application_dashboard.rb +225 -0
- data/lib/platform_rest/application_dashboards.rb +138 -0
- data/lib/platform_rest/application_key.rb +176 -0
- data/lib/platform_rest/application_keys.rb +141 -0
- data/lib/platform_rest/application_template.rb +79 -0
- data/lib/platform_rest/application_templates.rb +176 -0
- data/lib/platform_rest/applications.rb +209 -0
- data/lib/platform_rest/audit_log.rb +81 -0
- data/lib/platform_rest/audit_logs.rb +93 -0
- data/lib/platform_rest/auth.rb +245 -0
- data/lib/platform_rest/client.rb +410 -0
- data/lib/platform_rest/credential.rb +224 -0
- data/lib/platform_rest/credentials.rb +138 -0
- data/lib/platform_rest/dashboard.rb +268 -0
- data/lib/platform_rest/dashboards.rb +136 -0
- data/lib/platform_rest/data.rb +176 -0
- data/lib/platform_rest/data_table.rb +274 -0
- data/lib/platform_rest/data_table_row.rb +182 -0
- data/lib/platform_rest/data_table_rows.rb +343 -0
- data/lib/platform_rest/data_tables.rb +138 -0
- data/lib/platform_rest/device.rb +767 -0
- data/lib/platform_rest/device_recipe.rb +234 -0
- data/lib/platform_rest/device_recipes.rb +146 -0
- data/lib/platform_rest/devices.rb +707 -0
- data/lib/platform_rest/edge_deployment.rb +81 -0
- data/lib/platform_rest/edge_deployments.rb +236 -0
- data/lib/platform_rest/embedded_deployment.rb +81 -0
- data/lib/platform_rest/embedded_deployments.rb +280 -0
- data/lib/platform_rest/error.rb +34 -0
- data/lib/platform_rest/event.rb +176 -0
- data/lib/platform_rest/events.rb +341 -0
- data/lib/platform_rest/experience.rb +142 -0
- data/lib/platform_rest/experience_domain.rb +176 -0
- data/lib/platform_rest/experience_domains.rb +126 -0
- data/lib/platform_rest/experience_endpoint.rb +230 -0
- data/lib/platform_rest/experience_endpoints.rb +200 -0
- data/lib/platform_rest/experience_group.rb +180 -0
- data/lib/platform_rest/experience_groups.rb +141 -0
- data/lib/platform_rest/experience_slug.rb +176 -0
- data/lib/platform_rest/experience_slugs.rb +126 -0
- data/lib/platform_rest/experience_user.rb +176 -0
- data/lib/platform_rest/experience_users.rb +142 -0
- data/lib/platform_rest/experience_version.rb +176 -0
- data/lib/platform_rest/experience_versions.rb +138 -0
- data/lib/platform_rest/experience_view.rb +228 -0
- data/lib/platform_rest/experience_views.rb +142 -0
- data/lib/platform_rest/file.rb +226 -0
- data/lib/platform_rest/files.rb +144 -0
- data/lib/platform_rest/flow.rb +580 -0
- data/lib/platform_rest/flow_version.rb +352 -0
- data/lib/platform_rest/flow_versions.rb +201 -0
- data/lib/platform_rest/flows.rb +310 -0
- data/lib/platform_rest/instance.rb +377 -0
- data/lib/platform_rest/instance_api_token.rb +176 -0
- data/lib/platform_rest/instance_api_tokens.rb +136 -0
- data/lib/platform_rest/instance_custom_node.rb +282 -0
- data/lib/platform_rest/instance_custom_nodes.rb +136 -0
- data/lib/platform_rest/instance_member.rb +176 -0
- data/lib/platform_rest/instance_members.rb +134 -0
- data/lib/platform_rest/instance_org.rb +336 -0
- data/lib/platform_rest/instance_org_invite.rb +182 -0
- data/lib/platform_rest/instance_org_invites.rb +138 -0
- data/lib/platform_rest/instance_org_member.rb +182 -0
- data/lib/platform_rest/instance_org_members.rb +138 -0
- data/lib/platform_rest/instance_orgs.rb +139 -0
- data/lib/platform_rest/instance_sandbox.rb +181 -0
- data/lib/platform_rest/instance_sandboxes.rb +98 -0
- data/lib/platform_rest/instances.rb +88 -0
- data/lib/platform_rest/integration.rb +178 -0
- data/lib/platform_rest/integrations.rb +138 -0
- data/lib/platform_rest/me.rb +923 -0
- data/lib/platform_rest/notebook.rb +423 -0
- data/lib/platform_rest/notebooks.rb +138 -0
- data/lib/platform_rest/org.rb +663 -0
- data/lib/platform_rest/org_invites.rb +124 -0
- data/lib/platform_rest/orgs.rb +140 -0
- data/lib/platform_rest/resource_job.rb +326 -0
- data/lib/platform_rest/resource_jobs.rb +138 -0
- data/lib/platform_rest/user_api_token.rb +170 -0
- data/lib/platform_rest/user_api_tokens.rb +132 -0
- data/lib/platform_rest/utils.rb +44 -0
- data/lib/platform_rest/webhook.rb +178 -0
- data/lib/platform_rest/webhooks.rb +138 -0
- data/lib/platform_rest.rb +129 -0
- data/schemas/apiTokenPost.json +4 -0
- data/schemas/applicationDashboardPost.json +66 -0
- data/schemas/dashboard.json +66 -0
- data/schemas/dashboardPatch.json +66 -0
- data/schemas/dashboardPost.json +66 -0
- data/schemas/dashboards.json +66 -0
- data/schemas/deviceConnectionStatus.json +10 -0
- data/schemas/deviceLog.json +3 -0
- data/schemas/event.json +8 -0
- data/schemas/eventPlusNewCount.json +8 -0
- data/schemas/events.json +8 -0
- data/schemas/githubLogin.json +4 -0
- data/schemas/integrationPatch.json +0 -10
- data/schemas/orgInviteActionUser.json +18 -0
- data/schemas/orgInviteResultUser.json +18 -0
- data/schemas/orgInviteUser.json +51 -0
- data/schemas/orgInvitesUser.json +59 -0
- data/schemas/payloadCountsBreakdown.json +1 -25
- data/schemas/periodSummaries.json +172 -0
- data/schemas/samlResponse.json +4 -0
- data/schemas/userCredentials.json +4 -0
- data/schemas/userPost.json +4 -0
- metadata +98 -2
data/docs/_schemas.md
CHANGED
@@ -240,11 +240,15 @@
|
|
240
240
|
* [Organization](#organization)
|
241
241
|
* [Organization Invitation](#organization-invitation)
|
242
242
|
* [Organization Invitation Action](#organization-invitation-action)
|
243
|
+
* [Organization Invitation Action For User](#organization-invitation-action-for-user)
|
243
244
|
* [Instance Organization Invitations](#instance-organization-invitations)
|
244
245
|
* [Organization Invitation Information](#organization-invitation-information)
|
245
246
|
* [Organization Invitation Post](#organization-invitation-post)
|
246
247
|
* [Organization Invitation Result](#organization-invitation-result)
|
248
|
+
* [Organization Invitation Result For User](#organization-invitation-result-for-user)
|
249
|
+
* [Organization Invitation Information For User](#organization-invitation-information-for-user)
|
247
250
|
* [Organization Invitations](#organization-invitations)
|
251
|
+
* [User Organization Invitations](#user-organization-invitations)
|
248
252
|
* [Organization Member Patch](#organization-member-patch)
|
249
253
|
* [Organization Patch](#organization-patch)
|
250
254
|
* [Organization Post](#organization-post)
|
@@ -256,6 +260,7 @@
|
|
256
260
|
* [Password Reset Response](#password-reset-response)
|
257
261
|
* [Payload Counts Breakdown](#payload-counts-breakdown)
|
258
262
|
* [Payload Stats](#payload-stats)
|
263
|
+
* [Application Period Summaries](#application-period-summaries)
|
259
264
|
* [Recent Item](#recent-item)
|
260
265
|
* [Recent Item List](#recent-item-list)
|
261
266
|
* [Resource Job](#resource-job)
|
@@ -9018,6 +9023,7 @@ Schema for the body of an API Token creation request
|
|
9018
9023
|
"applications.post",
|
9019
9024
|
"applications.import",
|
9020
9025
|
"applications.detailedSummary",
|
9026
|
+
"applications.periodSummaries",
|
9021
9027
|
"auditLog.get",
|
9022
9028
|
"auditLogs.get",
|
9023
9029
|
"dashboard.patch",
|
@@ -9152,6 +9158,9 @@ Schema for the body of an API Token creation request
|
|
9152
9158
|
"me.deviceCounts",
|
9153
9159
|
"me.notebookMinuteCounts",
|
9154
9160
|
"me.transferResources",
|
9161
|
+
"me.invite",
|
9162
|
+
"me.invites",
|
9163
|
+
"me.respondToInvite",
|
9155
9164
|
"orgs.*",
|
9156
9165
|
"orgs.get",
|
9157
9166
|
"orgs.post"
|
@@ -13712,6 +13721,10 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
13712
13721
|
}
|
13713
13722
|
]
|
13714
13723
|
},
|
13724
|
+
"yAxisId": {
|
13725
|
+
"type": "string",
|
13726
|
+
"maxLength": 48
|
13727
|
+
},
|
13715
13728
|
"lineType": {
|
13716
13729
|
"type": "string",
|
13717
13730
|
"enum": [
|
@@ -13765,6 +13778,62 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
13765
13778
|
},
|
13766
13779
|
"additionalProperties": false
|
13767
13780
|
}
|
13781
|
+
},
|
13782
|
+
"yAxes": {
|
13783
|
+
"type": "array",
|
13784
|
+
"maxItems": 10,
|
13785
|
+
"items": {
|
13786
|
+
"type": "object",
|
13787
|
+
"properties": {
|
13788
|
+
"id": {
|
13789
|
+
"type": "string",
|
13790
|
+
"maxLength": 48
|
13791
|
+
},
|
13792
|
+
"label": {
|
13793
|
+
"type": "string",
|
13794
|
+
"maxLength": 255
|
13795
|
+
},
|
13796
|
+
"position": {
|
13797
|
+
"type": "string",
|
13798
|
+
"enum": [
|
13799
|
+
"left",
|
13800
|
+
"right",
|
13801
|
+
"hidden"
|
13802
|
+
],
|
13803
|
+
"default": "left"
|
13804
|
+
},
|
13805
|
+
"min": {
|
13806
|
+
"oneOf": [
|
13807
|
+
{
|
13808
|
+
"type": "number"
|
13809
|
+
},
|
13810
|
+
{
|
13811
|
+
"type": "string",
|
13812
|
+
"maxLength": 128
|
13813
|
+
}
|
13814
|
+
]
|
13815
|
+
},
|
13816
|
+
"max": {
|
13817
|
+
"oneOf": [
|
13818
|
+
{
|
13819
|
+
"type": "number"
|
13820
|
+
},
|
13821
|
+
{
|
13822
|
+
"type": "string",
|
13823
|
+
"maxLength": 128
|
13824
|
+
}
|
13825
|
+
]
|
13826
|
+
},
|
13827
|
+
"format": {
|
13828
|
+
"type": "string",
|
13829
|
+
"maxLength": 255
|
13830
|
+
}
|
13831
|
+
},
|
13832
|
+
"additionalProperties": false,
|
13833
|
+
"required": [
|
13834
|
+
"id"
|
13835
|
+
]
|
13836
|
+
}
|
13768
13837
|
}
|
13769
13838
|
},
|
13770
13839
|
"additionalProperties": false
|
@@ -14135,6 +14204,9 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
14135
14204
|
"defaultZoom": {
|
14136
14205
|
"type": "number"
|
14137
14206
|
},
|
14207
|
+
"disableZoom": {
|
14208
|
+
"type": "boolean"
|
14209
|
+
},
|
14138
14210
|
"segments": {
|
14139
14211
|
"type": "array",
|
14140
14212
|
"maxItems": 300,
|
@@ -16702,6 +16774,9 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
16702
16774
|
}
|
16703
16775
|
]
|
16704
16776
|
},
|
16777
|
+
"disableZoom": {
|
16778
|
+
"type": "boolean"
|
16779
|
+
},
|
16705
16780
|
"deviceIds": {
|
16706
16781
|
"type": "array",
|
16707
16782
|
"maxItems": 100,
|
@@ -32360,6 +32435,10 @@ Schema for a single Dashboard
|
|
32360
32435
|
}
|
32361
32436
|
]
|
32362
32437
|
},
|
32438
|
+
"yAxisId": {
|
32439
|
+
"type": "string",
|
32440
|
+
"maxLength": 48
|
32441
|
+
},
|
32363
32442
|
"lineType": {
|
32364
32443
|
"type": "string",
|
32365
32444
|
"enum": [
|
@@ -32413,6 +32492,62 @@ Schema for a single Dashboard
|
|
32413
32492
|
},
|
32414
32493
|
"additionalProperties": false
|
32415
32494
|
}
|
32495
|
+
},
|
32496
|
+
"yAxes": {
|
32497
|
+
"type": "array",
|
32498
|
+
"maxItems": 10,
|
32499
|
+
"items": {
|
32500
|
+
"type": "object",
|
32501
|
+
"properties": {
|
32502
|
+
"id": {
|
32503
|
+
"type": "string",
|
32504
|
+
"maxLength": 48
|
32505
|
+
},
|
32506
|
+
"label": {
|
32507
|
+
"type": "string",
|
32508
|
+
"maxLength": 255
|
32509
|
+
},
|
32510
|
+
"position": {
|
32511
|
+
"type": "string",
|
32512
|
+
"enum": [
|
32513
|
+
"left",
|
32514
|
+
"right",
|
32515
|
+
"hidden"
|
32516
|
+
],
|
32517
|
+
"default": "left"
|
32518
|
+
},
|
32519
|
+
"min": {
|
32520
|
+
"oneOf": [
|
32521
|
+
{
|
32522
|
+
"type": "number"
|
32523
|
+
},
|
32524
|
+
{
|
32525
|
+
"type": "string",
|
32526
|
+
"maxLength": 128
|
32527
|
+
}
|
32528
|
+
]
|
32529
|
+
},
|
32530
|
+
"max": {
|
32531
|
+
"oneOf": [
|
32532
|
+
{
|
32533
|
+
"type": "number"
|
32534
|
+
},
|
32535
|
+
{
|
32536
|
+
"type": "string",
|
32537
|
+
"maxLength": 128
|
32538
|
+
}
|
32539
|
+
]
|
32540
|
+
},
|
32541
|
+
"format": {
|
32542
|
+
"type": "string",
|
32543
|
+
"maxLength": 255
|
32544
|
+
}
|
32545
|
+
},
|
32546
|
+
"additionalProperties": false,
|
32547
|
+
"required": [
|
32548
|
+
"id"
|
32549
|
+
]
|
32550
|
+
}
|
32416
32551
|
}
|
32417
32552
|
},
|
32418
32553
|
"additionalProperties": false
|
@@ -32783,6 +32918,9 @@ Schema for a single Dashboard
|
|
32783
32918
|
"defaultZoom": {
|
32784
32919
|
"type": "number"
|
32785
32920
|
},
|
32921
|
+
"disableZoom": {
|
32922
|
+
"type": "boolean"
|
32923
|
+
},
|
32786
32924
|
"segments": {
|
32787
32925
|
"type": "array",
|
32788
32926
|
"maxItems": 300,
|
@@ -35350,6 +35488,9 @@ Schema for a single Dashboard
|
|
35350
35488
|
}
|
35351
35489
|
]
|
35352
35490
|
},
|
35491
|
+
"disableZoom": {
|
35492
|
+
"type": "boolean"
|
35493
|
+
},
|
35353
35494
|
"deviceIds": {
|
35354
35495
|
"type": "array",
|
35355
35496
|
"maxItems": 100,
|
@@ -38509,6 +38650,10 @@ Schema for the body of a Dashboard modification request
|
|
38509
38650
|
}
|
38510
38651
|
]
|
38511
38652
|
},
|
38653
|
+
"yAxisId": {
|
38654
|
+
"type": "string",
|
38655
|
+
"maxLength": 48
|
38656
|
+
},
|
38512
38657
|
"lineType": {
|
38513
38658
|
"type": "string",
|
38514
38659
|
"enum": [
|
@@ -38562,6 +38707,62 @@ Schema for the body of a Dashboard modification request
|
|
38562
38707
|
},
|
38563
38708
|
"additionalProperties": false
|
38564
38709
|
}
|
38710
|
+
},
|
38711
|
+
"yAxes": {
|
38712
|
+
"type": "array",
|
38713
|
+
"maxItems": 10,
|
38714
|
+
"items": {
|
38715
|
+
"type": "object",
|
38716
|
+
"properties": {
|
38717
|
+
"id": {
|
38718
|
+
"type": "string",
|
38719
|
+
"maxLength": 48
|
38720
|
+
},
|
38721
|
+
"label": {
|
38722
|
+
"type": "string",
|
38723
|
+
"maxLength": 255
|
38724
|
+
},
|
38725
|
+
"position": {
|
38726
|
+
"type": "string",
|
38727
|
+
"enum": [
|
38728
|
+
"left",
|
38729
|
+
"right",
|
38730
|
+
"hidden"
|
38731
|
+
],
|
38732
|
+
"default": "left"
|
38733
|
+
},
|
38734
|
+
"min": {
|
38735
|
+
"oneOf": [
|
38736
|
+
{
|
38737
|
+
"type": "number"
|
38738
|
+
},
|
38739
|
+
{
|
38740
|
+
"type": "string",
|
38741
|
+
"maxLength": 128
|
38742
|
+
}
|
38743
|
+
]
|
38744
|
+
},
|
38745
|
+
"max": {
|
38746
|
+
"oneOf": [
|
38747
|
+
{
|
38748
|
+
"type": "number"
|
38749
|
+
},
|
38750
|
+
{
|
38751
|
+
"type": "string",
|
38752
|
+
"maxLength": 128
|
38753
|
+
}
|
38754
|
+
]
|
38755
|
+
},
|
38756
|
+
"format": {
|
38757
|
+
"type": "string",
|
38758
|
+
"maxLength": 255
|
38759
|
+
}
|
38760
|
+
},
|
38761
|
+
"additionalProperties": false,
|
38762
|
+
"required": [
|
38763
|
+
"id"
|
38764
|
+
]
|
38765
|
+
}
|
38565
38766
|
}
|
38566
38767
|
},
|
38567
38768
|
"additionalProperties": false
|
@@ -38932,6 +39133,9 @@ Schema for the body of a Dashboard modification request
|
|
38932
39133
|
"defaultZoom": {
|
38933
39134
|
"type": "number"
|
38934
39135
|
},
|
39136
|
+
"disableZoom": {
|
39137
|
+
"type": "boolean"
|
39138
|
+
},
|
38935
39139
|
"segments": {
|
38936
39140
|
"type": "array",
|
38937
39141
|
"maxItems": 300,
|
@@ -41499,6 +41703,9 @@ Schema for the body of a Dashboard modification request
|
|
41499
41703
|
}
|
41500
41704
|
]
|
41501
41705
|
},
|
41706
|
+
"disableZoom": {
|
41707
|
+
"type": "boolean"
|
41708
|
+
},
|
41502
41709
|
"deviceIds": {
|
41503
41710
|
"type": "array",
|
41504
41711
|
"maxItems": 100,
|
@@ -44656,6 +44863,10 @@ Schema for the body of a Dashboard creation request
|
|
44656
44863
|
}
|
44657
44864
|
]
|
44658
44865
|
},
|
44866
|
+
"yAxisId": {
|
44867
|
+
"type": "string",
|
44868
|
+
"maxLength": 48
|
44869
|
+
},
|
44659
44870
|
"lineType": {
|
44660
44871
|
"type": "string",
|
44661
44872
|
"enum": [
|
@@ -44709,6 +44920,62 @@ Schema for the body of a Dashboard creation request
|
|
44709
44920
|
},
|
44710
44921
|
"additionalProperties": false
|
44711
44922
|
}
|
44923
|
+
},
|
44924
|
+
"yAxes": {
|
44925
|
+
"type": "array",
|
44926
|
+
"maxItems": 10,
|
44927
|
+
"items": {
|
44928
|
+
"type": "object",
|
44929
|
+
"properties": {
|
44930
|
+
"id": {
|
44931
|
+
"type": "string",
|
44932
|
+
"maxLength": 48
|
44933
|
+
},
|
44934
|
+
"label": {
|
44935
|
+
"type": "string",
|
44936
|
+
"maxLength": 255
|
44937
|
+
},
|
44938
|
+
"position": {
|
44939
|
+
"type": "string",
|
44940
|
+
"enum": [
|
44941
|
+
"left",
|
44942
|
+
"right",
|
44943
|
+
"hidden"
|
44944
|
+
],
|
44945
|
+
"default": "left"
|
44946
|
+
},
|
44947
|
+
"min": {
|
44948
|
+
"oneOf": [
|
44949
|
+
{
|
44950
|
+
"type": "number"
|
44951
|
+
},
|
44952
|
+
{
|
44953
|
+
"type": "string",
|
44954
|
+
"maxLength": 128
|
44955
|
+
}
|
44956
|
+
]
|
44957
|
+
},
|
44958
|
+
"max": {
|
44959
|
+
"oneOf": [
|
44960
|
+
{
|
44961
|
+
"type": "number"
|
44962
|
+
},
|
44963
|
+
{
|
44964
|
+
"type": "string",
|
44965
|
+
"maxLength": 128
|
44966
|
+
}
|
44967
|
+
]
|
44968
|
+
},
|
44969
|
+
"format": {
|
44970
|
+
"type": "string",
|
44971
|
+
"maxLength": 255
|
44972
|
+
}
|
44973
|
+
},
|
44974
|
+
"additionalProperties": false,
|
44975
|
+
"required": [
|
44976
|
+
"id"
|
44977
|
+
]
|
44978
|
+
}
|
44712
44979
|
}
|
44713
44980
|
},
|
44714
44981
|
"additionalProperties": false
|
@@ -45079,6 +45346,9 @@ Schema for the body of a Dashboard creation request
|
|
45079
45346
|
"defaultZoom": {
|
45080
45347
|
"type": "number"
|
45081
45348
|
},
|
45349
|
+
"disableZoom": {
|
45350
|
+
"type": "boolean"
|
45351
|
+
},
|
45082
45352
|
"segments": {
|
45083
45353
|
"type": "array",
|
45084
45354
|
"maxItems": 300,
|
@@ -47646,6 +47916,9 @@ Schema for the body of a Dashboard creation request
|
|
47646
47916
|
}
|
47647
47917
|
]
|
47648
47918
|
},
|
47919
|
+
"disableZoom": {
|
47920
|
+
"type": "boolean"
|
47921
|
+
},
|
47649
47922
|
"deviceIds": {
|
47650
47923
|
"type": "array",
|
47651
47924
|
"maxItems": 100,
|
@@ -51202,6 +51475,10 @@ Schema for a collection of Dashboards
|
|
51202
51475
|
}
|
51203
51476
|
]
|
51204
51477
|
},
|
51478
|
+
"yAxisId": {
|
51479
|
+
"type": "string",
|
51480
|
+
"maxLength": 48
|
51481
|
+
},
|
51205
51482
|
"lineType": {
|
51206
51483
|
"type": "string",
|
51207
51484
|
"enum": [
|
@@ -51255,6 +51532,62 @@ Schema for a collection of Dashboards
|
|
51255
51532
|
},
|
51256
51533
|
"additionalProperties": false
|
51257
51534
|
}
|
51535
|
+
},
|
51536
|
+
"yAxes": {
|
51537
|
+
"type": "array",
|
51538
|
+
"maxItems": 10,
|
51539
|
+
"items": {
|
51540
|
+
"type": "object",
|
51541
|
+
"properties": {
|
51542
|
+
"id": {
|
51543
|
+
"type": "string",
|
51544
|
+
"maxLength": 48
|
51545
|
+
},
|
51546
|
+
"label": {
|
51547
|
+
"type": "string",
|
51548
|
+
"maxLength": 255
|
51549
|
+
},
|
51550
|
+
"position": {
|
51551
|
+
"type": "string",
|
51552
|
+
"enum": [
|
51553
|
+
"left",
|
51554
|
+
"right",
|
51555
|
+
"hidden"
|
51556
|
+
],
|
51557
|
+
"default": "left"
|
51558
|
+
},
|
51559
|
+
"min": {
|
51560
|
+
"oneOf": [
|
51561
|
+
{
|
51562
|
+
"type": "number"
|
51563
|
+
},
|
51564
|
+
{
|
51565
|
+
"type": "string",
|
51566
|
+
"maxLength": 128
|
51567
|
+
}
|
51568
|
+
]
|
51569
|
+
},
|
51570
|
+
"max": {
|
51571
|
+
"oneOf": [
|
51572
|
+
{
|
51573
|
+
"type": "number"
|
51574
|
+
},
|
51575
|
+
{
|
51576
|
+
"type": "string",
|
51577
|
+
"maxLength": 128
|
51578
|
+
}
|
51579
|
+
]
|
51580
|
+
},
|
51581
|
+
"format": {
|
51582
|
+
"type": "string",
|
51583
|
+
"maxLength": 255
|
51584
|
+
}
|
51585
|
+
},
|
51586
|
+
"additionalProperties": false,
|
51587
|
+
"required": [
|
51588
|
+
"id"
|
51589
|
+
]
|
51590
|
+
}
|
51258
51591
|
}
|
51259
51592
|
},
|
51260
51593
|
"additionalProperties": false
|
@@ -51625,6 +51958,9 @@ Schema for a collection of Dashboards
|
|
51625
51958
|
"defaultZoom": {
|
51626
51959
|
"type": "number"
|
51627
51960
|
},
|
51961
|
+
"disableZoom": {
|
51962
|
+
"type": "boolean"
|
51963
|
+
},
|
51628
51964
|
"segments": {
|
51629
51965
|
"type": "array",
|
51630
51966
|
"maxItems": 300,
|
@@ -54192,6 +54528,9 @@ Schema for a collection of Dashboards
|
|
54192
54528
|
}
|
54193
54529
|
]
|
54194
54530
|
},
|
54531
|
+
"disableZoom": {
|
54532
|
+
"type": "boolean"
|
54533
|
+
},
|
54195
54534
|
"deviceIds": {
|
54196
54535
|
"type": "array",
|
54197
54536
|
"maxItems": 100,
|
@@ -58374,6 +58713,11 @@ Schema for the body of a request to set a device's connection status
|
|
58374
58713
|
]
|
58375
58714
|
}
|
58376
58715
|
]
|
58716
|
+
},
|
58717
|
+
"ipAddress": {
|
58718
|
+
"type": "string",
|
58719
|
+
"minLength": 2,
|
58720
|
+
"maxLength": 39
|
58377
58721
|
}
|
58378
58722
|
},
|
58379
58723
|
"required": [
|
@@ -58445,6 +58789,11 @@ Schema for the body of a request to set a device's connection status
|
|
58445
58789
|
},
|
58446
58790
|
"messagesToClient": {
|
58447
58791
|
"type": "number"
|
58792
|
+
},
|
58793
|
+
"ipAddress": {
|
58794
|
+
"type": "string",
|
58795
|
+
"minLength": 2,
|
58796
|
+
"maxLength": 39
|
58448
58797
|
}
|
58449
58798
|
},
|
58450
58799
|
"required": [
|
@@ -58630,6 +58979,9 @@ Log of connection information for a Device
|
|
58630
58979
|
},
|
58631
58980
|
"messagesToClient": {
|
58632
58981
|
"type": "number"
|
58982
|
+
},
|
58983
|
+
"ipAddress": {
|
58984
|
+
"type": "string"
|
58633
58985
|
}
|
58634
58986
|
}
|
58635
58987
|
}
|
@@ -72061,6 +72413,14 @@ Schema for a single Event
|
|
72061
72413
|
"maxLength": 32767
|
72062
72414
|
},
|
72063
72415
|
"data": {},
|
72416
|
+
"state": {
|
72417
|
+
"type": "string",
|
72418
|
+
"enum": [
|
72419
|
+
"new",
|
72420
|
+
"acknowledged",
|
72421
|
+
"resolved"
|
72422
|
+
]
|
72423
|
+
},
|
72064
72424
|
"stateChange": {
|
72065
72425
|
"type": "object",
|
72066
72426
|
"properties": {
|
@@ -72302,6 +72662,14 @@ Schema for an event plus a count of new events
|
|
72302
72662
|
"maxLength": 32767
|
72303
72663
|
},
|
72304
72664
|
"data": {},
|
72665
|
+
"state": {
|
72666
|
+
"type": "string",
|
72667
|
+
"enum": [
|
72668
|
+
"new",
|
72669
|
+
"acknowledged",
|
72670
|
+
"resolved"
|
72671
|
+
]
|
72672
|
+
},
|
72305
72673
|
"stateChange": {
|
72306
72674
|
"type": "object",
|
72307
72675
|
"properties": {
|
@@ -72655,6 +73023,14 @@ Schema for a collection of Events
|
|
72655
73023
|
"maxLength": 32767
|
72656
73024
|
},
|
72657
73025
|
"data": {},
|
73026
|
+
"state": {
|
73027
|
+
"type": "string",
|
73028
|
+
"enum": [
|
73029
|
+
"new",
|
73030
|
+
"acknowledged",
|
73031
|
+
"resolved"
|
73032
|
+
]
|
73033
|
+
},
|
72658
73034
|
"stateChange": {
|
72659
73035
|
"type": "object",
|
72660
73036
|
"properties": {
|
@@ -125660,6 +126036,7 @@ Schema for the body of a Github login request
|
|
125660
126036
|
"applications.post",
|
125661
126037
|
"applications.import",
|
125662
126038
|
"applications.detailedSummary",
|
126039
|
+
"applications.periodSummaries",
|
125663
126040
|
"auditLog.get",
|
125664
126041
|
"auditLogs.get",
|
125665
126042
|
"dashboard.patch",
|
@@ -125794,6 +126171,9 @@ Schema for the body of a Github login request
|
|
125794
126171
|
"me.deviceCounts",
|
125795
126172
|
"me.notebookMinuteCounts",
|
125796
126173
|
"me.transferResources",
|
126174
|
+
"me.invite",
|
126175
|
+
"me.invites",
|
126176
|
+
"me.respondToInvite",
|
125797
126177
|
"orgs.*",
|
125798
126178
|
"orgs.get",
|
125799
126179
|
"orgs.post"
|
@@ -134463,16 +134843,6 @@ Schema for the body of an Integration modification request
|
|
134463
134843
|
"minLength": 1,
|
134464
134844
|
"maxLength": 255
|
134465
134845
|
},
|
134466
|
-
"integrationType": {
|
134467
|
-
"type": "string",
|
134468
|
-
"enum": [
|
134469
|
-
"azureEventHub",
|
134470
|
-
"googlePubSub",
|
134471
|
-
"mqtt",
|
134472
|
-
"particle",
|
134473
|
-
"sqs"
|
134474
|
-
]
|
134475
|
-
},
|
134476
134846
|
"enabled": {
|
134477
134847
|
"type": "boolean"
|
134478
134848
|
},
|
@@ -143490,6 +143860,42 @@ Schema for the body of a request to accept or reject an invitation
|
|
143490
143860
|
|
143491
143861
|
<br/>
|
143492
143862
|
|
143863
|
+
## Organization Invitation Action For User
|
143864
|
+
|
143865
|
+
Schema for the body of a request to accept or reject an invitation
|
143866
|
+
|
143867
|
+
### <a name="organization-invitation-action-for-user-schema"></a> Schema
|
143868
|
+
|
143869
|
+
```json
|
143870
|
+
{
|
143871
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
143872
|
+
"type": "object",
|
143873
|
+
"properties": {
|
143874
|
+
"action": {
|
143875
|
+
"type": "string",
|
143876
|
+
"enum": [
|
143877
|
+
"accept",
|
143878
|
+
"dismiss",
|
143879
|
+
"reject"
|
143880
|
+
]
|
143881
|
+
}
|
143882
|
+
},
|
143883
|
+
"additionalProperties": false,
|
143884
|
+
"required": [
|
143885
|
+
"action"
|
143886
|
+
]
|
143887
|
+
}
|
143888
|
+
```
|
143889
|
+
### <a name="organization-invitation-action-for-user-example"></a> Example
|
143890
|
+
|
143891
|
+
```json
|
143892
|
+
{
|
143893
|
+
"action": "accept"
|
143894
|
+
}
|
143895
|
+
```
|
143896
|
+
|
143897
|
+
<br/>
|
143898
|
+
|
143493
143899
|
## Instance Organization Invitations
|
143494
143900
|
|
143495
143901
|
Schema for an collection of pending invitations to an Instance Organization
|
@@ -143854,6 +144260,117 @@ Schema for the result of accepting/rejecting an invitation
|
|
143854
144260
|
|
143855
144261
|
<br/>
|
143856
144262
|
|
144263
|
+
## Organization Invitation Result For User
|
144264
|
+
|
144265
|
+
Schema for the result of accepting/rejecting an invitation
|
144266
|
+
|
144267
|
+
### <a name="organization-invitation-result-for-user-schema"></a> Schema
|
144268
|
+
|
144269
|
+
```json
|
144270
|
+
{
|
144271
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
144272
|
+
"type": "object",
|
144273
|
+
"properties": {
|
144274
|
+
"result": {
|
144275
|
+
"type": "string",
|
144276
|
+
"enum": [
|
144277
|
+
"accepted",
|
144278
|
+
"rejected",
|
144279
|
+
"dismissed"
|
144280
|
+
]
|
144281
|
+
},
|
144282
|
+
"orgId": {
|
144283
|
+
"type": "string",
|
144284
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
144285
|
+
}
|
144286
|
+
}
|
144287
|
+
}
|
144288
|
+
```
|
144289
|
+
### <a name="organization-invitation-result-for-user-example"></a> Example
|
144290
|
+
|
144291
|
+
```json
|
144292
|
+
{
|
144293
|
+
"result": "rejected",
|
144294
|
+
"orgId": "575ed6e87ae143cd83dc4aa8"
|
144295
|
+
}
|
144296
|
+
```
|
144297
|
+
|
144298
|
+
<br/>
|
144299
|
+
|
144300
|
+
## Organization Invitation Information For User
|
144301
|
+
|
144302
|
+
Schema for information about an invitation
|
144303
|
+
|
144304
|
+
### <a name="organization-invitation-information-for-user-schema"></a> Schema
|
144305
|
+
|
144306
|
+
```json
|
144307
|
+
{
|
144308
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
144309
|
+
"type": "object",
|
144310
|
+
"properties": {
|
144311
|
+
"orgName": {
|
144312
|
+
"type": "string",
|
144313
|
+
"minLength": 1,
|
144314
|
+
"maxLength": 255
|
144315
|
+
},
|
144316
|
+
"role": {
|
144317
|
+
"type": "string",
|
144318
|
+
"enum": [
|
144319
|
+
"admin",
|
144320
|
+
"edit",
|
144321
|
+
"collaborate",
|
144322
|
+
"view",
|
144323
|
+
"none"
|
144324
|
+
]
|
144325
|
+
},
|
144326
|
+
"requiresMFA": {
|
144327
|
+
"type": "boolean"
|
144328
|
+
},
|
144329
|
+
"inviteDate": {
|
144330
|
+
"type": "string",
|
144331
|
+
"format": "date-time"
|
144332
|
+
},
|
144333
|
+
"ttl": {
|
144334
|
+
"type": "number"
|
144335
|
+
},
|
144336
|
+
"expired": {
|
144337
|
+
"type": "boolean"
|
144338
|
+
},
|
144339
|
+
"id": {
|
144340
|
+
"type": "string",
|
144341
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
144342
|
+
},
|
144343
|
+
"invitedBy": {
|
144344
|
+
"type": "object",
|
144345
|
+
"properties": {
|
144346
|
+
"fullName": {
|
144347
|
+
"type": "string"
|
144348
|
+
},
|
144349
|
+
"email": {
|
144350
|
+
"type": "string",
|
144351
|
+
"format": "email",
|
144352
|
+
"maxLength": 1024
|
144353
|
+
}
|
144354
|
+
}
|
144355
|
+
}
|
144356
|
+
}
|
144357
|
+
}
|
144358
|
+
```
|
144359
|
+
### <a name="organization-invitation-information-for-user-example"></a> Example
|
144360
|
+
|
144361
|
+
```json
|
144362
|
+
{
|
144363
|
+
"orgName": "My org",
|
144364
|
+
"role": "edit",
|
144365
|
+
"requiresMFA": false,
|
144366
|
+
"inviteDate": "2023-09-06T16:41:15.049Z",
|
144367
|
+
"ttl": 4233600000,
|
144368
|
+
"expired": true
|
144369
|
+
}
|
144370
|
+
```
|
144371
|
+
|
144372
|
+
<br/>
|
144373
|
+
|
143857
144374
|
## Organization Invitations
|
143858
144375
|
|
143859
144376
|
Schema for an array of pending invitations to an Organization
|
@@ -143990,6 +144507,98 @@ Schema for an array of pending invitations to an Organization
|
|
143990
144507
|
|
143991
144508
|
<br/>
|
143992
144509
|
|
144510
|
+
## User Organization Invitations
|
144511
|
+
|
144512
|
+
Schema for an array of pending organization invitations for a user
|
144513
|
+
|
144514
|
+
### <a name="user-organization-invitations-schema"></a> Schema
|
144515
|
+
|
144516
|
+
```json
|
144517
|
+
{
|
144518
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
144519
|
+
"type": "array",
|
144520
|
+
"items": {
|
144521
|
+
"type": "object",
|
144522
|
+
"properties": {
|
144523
|
+
"title": "Organization Invitation Information For User",
|
144524
|
+
"description": "Schema for information about an invitation",
|
144525
|
+
"type": "object",
|
144526
|
+
"properties": {
|
144527
|
+
"orgName": {
|
144528
|
+
"type": "string",
|
144529
|
+
"minLength": 1,
|
144530
|
+
"maxLength": 255
|
144531
|
+
},
|
144532
|
+
"role": {
|
144533
|
+
"type": "string",
|
144534
|
+
"enum": [
|
144535
|
+
"admin",
|
144536
|
+
"edit",
|
144537
|
+
"collaborate",
|
144538
|
+
"view",
|
144539
|
+
"none"
|
144540
|
+
]
|
144541
|
+
},
|
144542
|
+
"requiresMFA": {
|
144543
|
+
"type": "boolean"
|
144544
|
+
},
|
144545
|
+
"inviteDate": {
|
144546
|
+
"type": "string",
|
144547
|
+
"format": "date-time"
|
144548
|
+
},
|
144549
|
+
"ttl": {
|
144550
|
+
"type": "number"
|
144551
|
+
},
|
144552
|
+
"expired": {
|
144553
|
+
"type": "boolean"
|
144554
|
+
},
|
144555
|
+
"id": {
|
144556
|
+
"type": "string",
|
144557
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
144558
|
+
},
|
144559
|
+
"invitedBy": {
|
144560
|
+
"type": "object",
|
144561
|
+
"properties": {
|
144562
|
+
"fullName": {
|
144563
|
+
"type": "string"
|
144564
|
+
},
|
144565
|
+
"email": {
|
144566
|
+
"type": "string",
|
144567
|
+
"format": "email",
|
144568
|
+
"maxLength": 1024
|
144569
|
+
}
|
144570
|
+
}
|
144571
|
+
}
|
144572
|
+
}
|
144573
|
+
}
|
144574
|
+
}
|
144575
|
+
}
|
144576
|
+
```
|
144577
|
+
### <a name="user-organization-invitations-example"></a> Example
|
144578
|
+
|
144579
|
+
```json
|
144580
|
+
[
|
144581
|
+
{
|
144582
|
+
"orgName": "My org",
|
144583
|
+
"role": "edit",
|
144584
|
+
"requiresMFA": false,
|
144585
|
+
"inviteDate": "2023-09-06T16:41:15.049Z",
|
144586
|
+
"ttl": 4233600000,
|
144587
|
+
"expired": true
|
144588
|
+
},
|
144589
|
+
{
|
144590
|
+
"orgName": "Some Other Org",
|
144591
|
+
"role": "view",
|
144592
|
+
"requiresMFA": true,
|
144593
|
+
"inviteDate": "2023-09-10T14:47:13.023Z",
|
144594
|
+
"ttl": 4233600000,
|
144595
|
+
"expired": false
|
144596
|
+
}
|
144597
|
+
]
|
144598
|
+
```
|
144599
|
+
|
144600
|
+
<br/>
|
144601
|
+
|
143993
144602
|
## Organization Member Patch
|
143994
144603
|
|
143995
144604
|
Schema for the body of a request to modify an Organization member
|
@@ -145880,27 +146489,6 @@ Schema for the result of a payload counts breakdown request
|
|
145880
146489
|
"type": "string",
|
145881
146490
|
"format": "date-time"
|
145882
146491
|
},
|
145883
|
-
"resolution": {
|
145884
|
-
"type": "number",
|
145885
|
-
"enum": [
|
145886
|
-
86400000,
|
145887
|
-
3600000
|
145888
|
-
]
|
145889
|
-
},
|
145890
|
-
"asBytes": {
|
145891
|
-
"type": "boolean",
|
145892
|
-
"enum": [
|
145893
|
-
true,
|
145894
|
-
false
|
145895
|
-
]
|
145896
|
-
},
|
145897
|
-
"includeNonBillable": {
|
145898
|
-
"type": "boolean",
|
145899
|
-
"enum": [
|
145900
|
-
true,
|
145901
|
-
false
|
145902
|
-
]
|
145903
|
-
},
|
145904
146492
|
"counts": {
|
145905
146493
|
"type": "array",
|
145906
146494
|
"items": {
|
@@ -145910,11 +146498,8 @@ Schema for the result of a payload counts breakdown request
|
|
145910
146498
|
"type": "string",
|
145911
146499
|
"format": "date-time"
|
145912
146500
|
},
|
145913
|
-
"
|
146501
|
+
"value": {
|
145914
146502
|
"type": "integer"
|
145915
|
-
},
|
145916
|
-
"bytes": {
|
145917
|
-
"type": "number"
|
145918
146503
|
}
|
145919
146504
|
}
|
145920
146505
|
}
|
@@ -145928,9 +146513,6 @@ Schema for the result of a payload counts breakdown request
|
|
145928
146513
|
{
|
145929
146514
|
"start": "1999-05-20T05:00:00.000Z",
|
145930
146515
|
"end": "1999-06-20T04:59:59.999Z",
|
145931
|
-
"asBytes": true,
|
145932
|
-
"includeNonBillable": true,
|
145933
|
-
"resolution": 3600000,
|
145934
146516
|
"counts": [
|
145935
146517
|
{
|
145936
146518
|
"date": "1999-06-20T00:00:00.000Z",
|
@@ -146112,6 +146694,246 @@ Schema for the result of a payload stats request
|
|
146112
146694
|
|
146113
146695
|
<br/>
|
146114
146696
|
|
146697
|
+
## Application Period Summaries
|
146698
|
+
|
146699
|
+
Schema for a collection of Application Period Summaries
|
146700
|
+
|
146701
|
+
### <a name="application-period-summaries-schema"></a> Schema
|
146702
|
+
|
146703
|
+
```json
|
146704
|
+
{
|
146705
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
146706
|
+
"type": "object",
|
146707
|
+
"properties": {
|
146708
|
+
"items": {
|
146709
|
+
"type": "array",
|
146710
|
+
"items": {
|
146711
|
+
"type": "object",
|
146712
|
+
"properties": {
|
146713
|
+
"name": {
|
146714
|
+
"type": "string",
|
146715
|
+
"minLength": 1,
|
146716
|
+
"maxLength": 255
|
146717
|
+
},
|
146718
|
+
"id": {
|
146719
|
+
"type": "string",
|
146720
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
146721
|
+
},
|
146722
|
+
"applicationId": {
|
146723
|
+
"type": "string",
|
146724
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
146725
|
+
},
|
146726
|
+
"summary": {
|
146727
|
+
"type": "object",
|
146728
|
+
"properties": {
|
146729
|
+
"deviceCounts": {
|
146730
|
+
"title": "Device Counts",
|
146731
|
+
"description": "Schema for the result of a device counts request",
|
146732
|
+
"type": "object",
|
146733
|
+
"properties": {
|
146734
|
+
"start": {
|
146735
|
+
"type": "string",
|
146736
|
+
"format": "date-time"
|
146737
|
+
},
|
146738
|
+
"end": {
|
146739
|
+
"type": "string",
|
146740
|
+
"format": "date-time"
|
146741
|
+
},
|
146742
|
+
"counts": {
|
146743
|
+
"type": "array",
|
146744
|
+
"items": {
|
146745
|
+
"type": "object",
|
146746
|
+
"properties": {
|
146747
|
+
"date": {
|
146748
|
+
"type": "string",
|
146749
|
+
"format": "date-time"
|
146750
|
+
},
|
146751
|
+
"created": {
|
146752
|
+
"type": "integer"
|
146753
|
+
},
|
146754
|
+
"deleted": {
|
146755
|
+
"type": "integer"
|
146756
|
+
},
|
146757
|
+
"total": {
|
146758
|
+
"type": "integer"
|
146759
|
+
}
|
146760
|
+
}
|
146761
|
+
}
|
146762
|
+
}
|
146763
|
+
}
|
146764
|
+
},
|
146765
|
+
"notebookMinuteCounts": {
|
146766
|
+
"title": "Notebook Minute Counts",
|
146767
|
+
"description": "Schema for the result of a notebook minute counts request",
|
146768
|
+
"type": "object",
|
146769
|
+
"properties": {
|
146770
|
+
"start": {
|
146771
|
+
"type": "string",
|
146772
|
+
"format": "date-time"
|
146773
|
+
},
|
146774
|
+
"end": {
|
146775
|
+
"type": "string",
|
146776
|
+
"format": "date-time"
|
146777
|
+
},
|
146778
|
+
"counts": {
|
146779
|
+
"type": "array",
|
146780
|
+
"items": {
|
146781
|
+
"type": "object",
|
146782
|
+
"properties": {
|
146783
|
+
"date": {
|
146784
|
+
"type": "string",
|
146785
|
+
"format": "date-time"
|
146786
|
+
},
|
146787
|
+
"minutes": {
|
146788
|
+
"type": "integer"
|
146789
|
+
},
|
146790
|
+
"completed": {
|
146791
|
+
"type": "integer"
|
146792
|
+
},
|
146793
|
+
"canceled": {
|
146794
|
+
"type": "integer"
|
146795
|
+
},
|
146796
|
+
"errored": {
|
146797
|
+
"type": "integer"
|
146798
|
+
},
|
146799
|
+
"timeout": {
|
146800
|
+
"type": "integer"
|
146801
|
+
}
|
146802
|
+
}
|
146803
|
+
}
|
146804
|
+
}
|
146805
|
+
}
|
146806
|
+
},
|
146807
|
+
"payloadCounts": {
|
146808
|
+
"title": "Payload Counts Breakdown",
|
146809
|
+
"description": "Schema for the result of a payload counts breakdown request",
|
146810
|
+
"type": "object",
|
146811
|
+
"properties": {
|
146812
|
+
"start": {
|
146813
|
+
"type": "string",
|
146814
|
+
"format": "date-time"
|
146815
|
+
},
|
146816
|
+
"end": {
|
146817
|
+
"type": "string",
|
146818
|
+
"format": "date-time"
|
146819
|
+
},
|
146820
|
+
"counts": {
|
146821
|
+
"type": "array",
|
146822
|
+
"items": {
|
146823
|
+
"type": "object",
|
146824
|
+
"properties": {
|
146825
|
+
"date": {
|
146826
|
+
"type": "string",
|
146827
|
+
"format": "date-time"
|
146828
|
+
},
|
146829
|
+
"value": {
|
146830
|
+
"type": "integer"
|
146831
|
+
}
|
146832
|
+
}
|
146833
|
+
}
|
146834
|
+
}
|
146835
|
+
}
|
146836
|
+
}
|
146837
|
+
}
|
146838
|
+
}
|
146839
|
+
},
|
146840
|
+
"additionalProperties": false
|
146841
|
+
}
|
146842
|
+
},
|
146843
|
+
"count": {
|
146844
|
+
"type": "integer"
|
146845
|
+
},
|
146846
|
+
"totalCount": {
|
146847
|
+
"type": "integer"
|
146848
|
+
},
|
146849
|
+
"perPage": {
|
146850
|
+
"type": "integer"
|
146851
|
+
},
|
146852
|
+
"page": {
|
146853
|
+
"type": "integer"
|
146854
|
+
},
|
146855
|
+
"filter": {
|
146856
|
+
"type": "string"
|
146857
|
+
},
|
146858
|
+
"filterField": {
|
146859
|
+
"type": "string"
|
146860
|
+
},
|
146861
|
+
"sortField": {
|
146862
|
+
"type": "string"
|
146863
|
+
},
|
146864
|
+
"sortDirection": {
|
146865
|
+
"type": "string",
|
146866
|
+
"enum": [
|
146867
|
+
"asc",
|
146868
|
+
"desc",
|
146869
|
+
"ASC",
|
146870
|
+
"DESC",
|
146871
|
+
""
|
146872
|
+
]
|
146873
|
+
}
|
146874
|
+
}
|
146875
|
+
}
|
146876
|
+
```
|
146877
|
+
### <a name="application-period-summaries-example"></a> Example
|
146878
|
+
|
146879
|
+
```json
|
146880
|
+
{
|
146881
|
+
"items": [
|
146882
|
+
{
|
146883
|
+
"name": "my app",
|
146884
|
+
"id": "575ec8687ae143cd83dc4a97",
|
146885
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
146886
|
+
"summary": {
|
146887
|
+
"payloadCounts": {
|
146888
|
+
"start": "1999-05-20T05:00:00.000Z",
|
146889
|
+
"end": "1999-06-20T04:59:59.999Z",
|
146890
|
+
"counts": [
|
146891
|
+
{
|
146892
|
+
"date": "1999-06-20T00:00:00.000Z",
|
146893
|
+
"value": 17
|
146894
|
+
}
|
146895
|
+
]
|
146896
|
+
},
|
146897
|
+
"deviceCounts": {
|
146898
|
+
"start": "1999-05-20T05:00:00.000Z",
|
146899
|
+
"end": "1999-06-20T04:59:59.999Z",
|
146900
|
+
"counts": [
|
146901
|
+
{
|
146902
|
+
"created": 4,
|
146903
|
+
"deleted": 1,
|
146904
|
+
"date": "1999-06-20T00:00:00.000Z",
|
146905
|
+
"total": 17
|
146906
|
+
}
|
146907
|
+
]
|
146908
|
+
},
|
146909
|
+
"notebookMinuteCounts": {
|
146910
|
+
"start": "1999-05-20T05:00:00.000Z",
|
146911
|
+
"end": "1999-06-20T04:59:59.999Z",
|
146912
|
+
"counts": [
|
146913
|
+
{
|
146914
|
+
"date": "1999-06-20T00:00:00.000Z",
|
146915
|
+
"minutes": 17,
|
146916
|
+
"completed": 4,
|
146917
|
+
"canceled": 0,
|
146918
|
+
"errored": 1,
|
146919
|
+
"timeout": 0
|
146920
|
+
}
|
146921
|
+
]
|
146922
|
+
}
|
146923
|
+
}
|
146924
|
+
}
|
146925
|
+
],
|
146926
|
+
"count": 1,
|
146927
|
+
"totalCount": 8,
|
146928
|
+
"perPage": 1,
|
146929
|
+
"page": 0,
|
146930
|
+
"sortField": "name",
|
146931
|
+
"sortDirection": "asc"
|
146932
|
+
}
|
146933
|
+
```
|
146934
|
+
|
146935
|
+
<br/>
|
146936
|
+
|
146115
146937
|
## Recent Item
|
146116
146938
|
|
146117
146939
|
Schema for the body of a request to add a recent item
|
@@ -147374,6 +148196,7 @@ SAML Response body for login
|
|
147374
148196
|
"applications.post",
|
147375
148197
|
"applications.import",
|
147376
148198
|
"applications.detailedSummary",
|
148199
|
+
"applications.periodSummaries",
|
147377
148200
|
"auditLog.get",
|
147378
148201
|
"auditLogs.get",
|
147379
148202
|
"dashboard.patch",
|
@@ -147508,6 +148331,9 @@ SAML Response body for login
|
|
147508
148331
|
"me.deviceCounts",
|
147509
148332
|
"me.notebookMinuteCounts",
|
147510
148333
|
"me.transferResources",
|
148334
|
+
"me.invite",
|
148335
|
+
"me.invites",
|
148336
|
+
"me.respondToInvite",
|
147511
148337
|
"orgs.*",
|
147512
148338
|
"orgs.get",
|
147513
148339
|
"orgs.post"
|
@@ -150164,6 +150990,7 @@ Schema for the body of a User authentication request
|
|
150164
150990
|
"applications.post",
|
150165
150991
|
"applications.import",
|
150166
150992
|
"applications.detailedSummary",
|
150993
|
+
"applications.periodSummaries",
|
150167
150994
|
"auditLog.get",
|
150168
150995
|
"auditLogs.get",
|
150169
150996
|
"dashboard.patch",
|
@@ -150298,6 +151125,9 @@ Schema for the body of a User authentication request
|
|
150298
151125
|
"me.deviceCounts",
|
150299
151126
|
"me.notebookMinuteCounts",
|
150300
151127
|
"me.transferResources",
|
151128
|
+
"me.invite",
|
151129
|
+
"me.invites",
|
151130
|
+
"me.respondToInvite",
|
150301
151131
|
"orgs.*",
|
150302
151132
|
"orgs.get",
|
150303
151133
|
"orgs.post"
|
@@ -150734,6 +151564,7 @@ Schema for the body of a User creation request
|
|
150734
151564
|
"applications.post",
|
150735
151565
|
"applications.import",
|
150736
151566
|
"applications.detailedSummary",
|
151567
|
+
"applications.periodSummaries",
|
150737
151568
|
"auditLog.get",
|
150738
151569
|
"auditLogs.get",
|
150739
151570
|
"dashboard.patch",
|
@@ -150868,6 +151699,9 @@ Schema for the body of a User creation request
|
|
150868
151699
|
"me.deviceCounts",
|
150869
151700
|
"me.notebookMinuteCounts",
|
150870
151701
|
"me.transferResources",
|
151702
|
+
"me.invite",
|
151703
|
+
"me.invites",
|
151704
|
+
"me.respondToInvite",
|
150871
151705
|
"orgs.*",
|
150872
151706
|
"orgs.get",
|
150873
151707
|
"orgs.post"
|