losant_rest 1.13.0 → 1.13.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 +2317 -650
- data/docs/application.md +5 -5
- data/docs/applicationApiTokens.md +1 -1
- data/docs/applications.md +1 -1
- data/docs/dataTable.md +1 -1
- data/docs/dataTableRows.md +1 -1
- data/docs/dataTables.md +1 -1
- data/docs/devices.md +2 -2
- data/docs/experience.md +1 -1
- data/docs/experienceDomains.md +1 -1
- data/docs/experienceGroup.md +2 -0
- data/docs/experienceSlugs.md +1 -1
- data/docs/experienceVersion.md +3 -3
- data/docs/experienceVersions.md +2 -2
- data/docs/experienceView.md +4 -4
- data/docs/experienceViews.md +2 -2
- data/docs/file.md +5 -5
- data/docs/files.md +2 -2
- data/docs/flowVersions.md +44 -0
- data/docs/instance.md +38 -0
- data/docs/instanceApiToken.md +133 -0
- data/docs/instanceApiTokens.md +91 -0
- data/docs/instanceMembers.md +1 -1
- data/docs/instanceOrgMembers.md +1 -1
- data/docs/userApiToken.md +125 -0
- data/docs/userApiTokens.md +87 -0
- data/lib/losant_rest.rb +4 -0
- data/lib/losant_rest/application.rb +5 -5
- data/lib/losant_rest/application_api_tokens.rb +1 -1
- data/lib/losant_rest/applications.rb +1 -1
- data/lib/losant_rest/client.rb +18 -2
- data/lib/losant_rest/data_table.rb +1 -1
- data/lib/losant_rest/data_table_rows.rb +1 -1
- data/lib/losant_rest/data_tables.rb +1 -1
- data/lib/losant_rest/devices.rb +2 -2
- data/lib/losant_rest/experience.rb +1 -1
- data/lib/losant_rest/experience_domains.rb +1 -1
- data/lib/losant_rest/experience_group.rb +4 -0
- data/lib/losant_rest/experience_slugs.rb +1 -1
- data/lib/losant_rest/experience_version.rb +3 -3
- data/lib/losant_rest/experience_versions.rb +2 -2
- data/lib/losant_rest/experience_view.rb +4 -4
- data/lib/losant_rest/experience_views.rb +2 -2
- data/lib/losant_rest/file.rb +4 -4
- data/lib/losant_rest/files.rb +2 -2
- data/lib/losant_rest/flow_versions.rb +50 -0
- data/lib/losant_rest/instance.rb +46 -1
- data/lib/losant_rest/instance_api_token.rb +176 -0
- data/lib/losant_rest/instance_api_tokens.rb +136 -0
- data/lib/losant_rest/instance_member.rb +1 -1
- data/lib/losant_rest/instance_members.rb +2 -2
- data/lib/losant_rest/instance_org.rb +1 -1
- data/lib/losant_rest/instance_org_member.rb +1 -1
- data/lib/losant_rest/instance_org_members.rb +2 -2
- data/lib/losant_rest/instance_orgs.rb +1 -1
- data/lib/losant_rest/instances.rb +1 -1
- data/lib/losant_rest/user_api_token.rb +170 -0
- data/lib/losant_rest/user_api_tokens.rb +132 -0
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +420 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/applicationDashboardPost.json +20 -16
- data/schemas/auditLog.json +4 -0
- data/schemas/auditLogFilter.json +4 -0
- data/schemas/auditLogs.json +4 -0
- data/schemas/bulkDeleteResponse.json +12 -0
- data/schemas/dashboard.json +20 -16
- data/schemas/dashboardPatch.json +20 -16
- data/schemas/dashboardPost.json +20 -16
- data/schemas/dashboardSendReport.json +4 -0
- data/schemas/dashboards.json +20 -16
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/githubLogin.json +19 -1
- data/schemas/historicalSummary.json +3 -0
- data/schemas/instance.json +60 -0
- data/schemas/instanceOrgPost.json +166 -0
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +1 -0
- data/schemas/notebook.json +15 -0
- data/schemas/notebooks.json +15 -0
- data/schemas/userCredentials.json +19 -1
- data/schemas/userPost.json +19 -1
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- metadata +15 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e69641435075c3d54c8265452e8cbec7855547106544f940792294b4c1f84973
|
4
|
+
data.tar.gz: 2c8bcd57ea14363b5368417c75c5e9f45db4cc0ab1af7bea661a75511c9342e4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ddbac9c8f48cdf9c5b09ede56a82d130ecd3418cc2c63a7e321e9cde794540ad0b3bf2d8e2253d66e7314d57603e22fd9752946292475e27d55283ecdcc6ea5d
|
7
|
+
data.tar.gz: 97e4ef537026bfdc0c1069ad247b66ad02473f69689c9f49813598fdaed5e5129ee462188d6a28c15e284ee0673660c72abe54d1babab494dbf1bb49ffe9ffb2
|
data/docs/_schemas.md
CHANGED
@@ -9,9 +9,9 @@
|
|
9
9
|
* [Advanced Query](#advanced-query)
|
10
10
|
* [API Token](#api-token)
|
11
11
|
* [API Token Patch](#api-token-patch)
|
12
|
+
* [API Token Post](#api-token-post)
|
12
13
|
* [API Tokens](#api-tokens)
|
13
14
|
* [Application](#application)
|
14
|
-
* [Application API Token Post](#application-api-token-post)
|
15
15
|
* [Application Apply Template Patch Schema](#application-apply-template-patch-schema)
|
16
16
|
* [Application Certificate](#application-certificate)
|
17
17
|
* [Application Certificate Authorities](#application-certificate-authorities)
|
@@ -49,6 +49,7 @@
|
|
49
49
|
* [Audit Logs](#audit-logs)
|
50
50
|
* [Authenticated Device](#authenticated-device)
|
51
51
|
* [Authenticated User](#authenticated-user)
|
52
|
+
* [Bulk Deletion Response](#bulk-deletion-response)
|
52
53
|
* [Change Password](#change-password)
|
53
54
|
* [Composite Device State](#composite-device-state)
|
54
55
|
* [Dashboard](#dashboard)
|
@@ -96,7 +97,6 @@
|
|
96
97
|
* [Devices](#devices)
|
97
98
|
* [Devices Data Removed](#devices-data-removed)
|
98
99
|
* [Devices Delete Post](#devices-delete-post)
|
99
|
-
* [Devices Deleted](#devices-deleted)
|
100
100
|
* [Devices Metadata Export Post](#devices-metadata-export-post)
|
101
101
|
* [Devices Patch](#devices-patch)
|
102
102
|
* [Devices Remove Data Post](#devices-remove-data-post)
|
@@ -168,6 +168,7 @@
|
|
168
168
|
* [Workflow Version Patch](#workflow-version-patch)
|
169
169
|
* [Workflow Version Post](#workflow-version-post)
|
170
170
|
* [Workflow Versions](#workflow-versions)
|
171
|
+
* [Flow Versions Delete Post](#flow-versions-delete-post)
|
171
172
|
* [Workflows](#workflows)
|
172
173
|
* [Workflows Import Post](#workflows-import-post)
|
173
174
|
* [Workflow Import Result](#workflow-import-result)
|
@@ -187,6 +188,7 @@
|
|
187
188
|
* [Instance Owned Organization Patch](#instance-owned-organization-patch)
|
188
189
|
* [Instance Owned Organization Post](#instance-owned-organization-post)
|
189
190
|
* [Instance Organizations](#instance-organizations)
|
191
|
+
* [Instance Patch](#instance-patch)
|
190
192
|
* [Instance Report Options Post](#instance-report-options-post)
|
191
193
|
* [Instances](#instances)
|
192
194
|
* [Integration](#integration)
|
@@ -6644,7 +6646,8 @@ Schema for a single API Token
|
|
6644
6646
|
"ownerType": {
|
6645
6647
|
"type": "string",
|
6646
6648
|
"enum": [
|
6647
|
-
"application"
|
6649
|
+
"application",
|
6650
|
+
"user"
|
6648
6651
|
]
|
6649
6652
|
},
|
6650
6653
|
"creatorId": {
|
@@ -6772,6 +6775,449 @@ Schema for the body of an API Token modification request
|
|
6772
6775
|
|
6773
6776
|
<br/>
|
6774
6777
|
|
6778
|
+
## API Token Post
|
6779
|
+
|
6780
|
+
Schema for the body of an API Token creation request
|
6781
|
+
|
6782
|
+
### <a name="api-token-post-schema"></a> Schema
|
6783
|
+
|
6784
|
+
```json
|
6785
|
+
{
|
6786
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
6787
|
+
"type": "object",
|
6788
|
+
"properties": {
|
6789
|
+
"name": {
|
6790
|
+
"type": "string",
|
6791
|
+
"minLength": 1,
|
6792
|
+
"maxLength": 255
|
6793
|
+
},
|
6794
|
+
"description": {
|
6795
|
+
"type": "string",
|
6796
|
+
"maxLength": 32767
|
6797
|
+
},
|
6798
|
+
"expirationDate": {
|
6799
|
+
"type": "string",
|
6800
|
+
"format": "date-time"
|
6801
|
+
},
|
6802
|
+
"scope": {
|
6803
|
+
"type": "array",
|
6804
|
+
"uniqueItems": true,
|
6805
|
+
"items": {
|
6806
|
+
"oneOf": [
|
6807
|
+
{
|
6808
|
+
"oneOf": [
|
6809
|
+
{
|
6810
|
+
"type": "string",
|
6811
|
+
"enum": [
|
6812
|
+
"all.Application",
|
6813
|
+
"all.Application.read",
|
6814
|
+
"all.Application.cli",
|
6815
|
+
"all.Device",
|
6816
|
+
"all.Device.read",
|
6817
|
+
"application.*",
|
6818
|
+
"applicationApiToken.*",
|
6819
|
+
"applicationApiTokens.*",
|
6820
|
+
"applicationCertificate.*",
|
6821
|
+
"applicationCertificates.*",
|
6822
|
+
"applicationCertificateAuthority.*",
|
6823
|
+
"applicationCertificateAuthorities.*",
|
6824
|
+
"applicationDashboards.*",
|
6825
|
+
"applicationDashboard.*",
|
6826
|
+
"applicationKey.*",
|
6827
|
+
"applicationKeys.*",
|
6828
|
+
"data.*",
|
6829
|
+
"dataTable.*",
|
6830
|
+
"dataTables.*",
|
6831
|
+
"dataTableRow.*",
|
6832
|
+
"dataTableRows.*",
|
6833
|
+
"device.*",
|
6834
|
+
"deviceRecipe.*",
|
6835
|
+
"deviceRecipes.*",
|
6836
|
+
"devices.*",
|
6837
|
+
"edgeDeployments.*",
|
6838
|
+
"event.*",
|
6839
|
+
"events.*",
|
6840
|
+
"experience.*",
|
6841
|
+
"experienceDomain.*",
|
6842
|
+
"experienceDomains.*",
|
6843
|
+
"experienceEndpoint.*",
|
6844
|
+
"experienceEndpoints.*",
|
6845
|
+
"experienceGroup.*",
|
6846
|
+
"experienceGroups.*",
|
6847
|
+
"experienceSlug.*",
|
6848
|
+
"experienceSlugs.*",
|
6849
|
+
"experienceUser.*",
|
6850
|
+
"experienceUsers.*",
|
6851
|
+
"experienceVersion.*",
|
6852
|
+
"experienceVersions.*",
|
6853
|
+
"experienceView.*",
|
6854
|
+
"experienceViews.*",
|
6855
|
+
"integration.*",
|
6856
|
+
"integrations.*",
|
6857
|
+
"file.*",
|
6858
|
+
"files.*",
|
6859
|
+
"flow.*",
|
6860
|
+
"flows.*",
|
6861
|
+
"flowVersion.*",
|
6862
|
+
"flowVersions.*",
|
6863
|
+
"notebook.*",
|
6864
|
+
"notebooks.*",
|
6865
|
+
"webhook.*",
|
6866
|
+
"webhooks.*",
|
6867
|
+
"application.applyTemplate",
|
6868
|
+
"application.archiveData",
|
6869
|
+
"application.backfillArchiveData",
|
6870
|
+
"application.clone",
|
6871
|
+
"application.export",
|
6872
|
+
"application.import",
|
6873
|
+
"application.fullEventsArchive",
|
6874
|
+
"application.fullDataTablesArchive",
|
6875
|
+
"application.debug",
|
6876
|
+
"application.delete",
|
6877
|
+
"application.get",
|
6878
|
+
"application.mqttPublishMessage",
|
6879
|
+
"application.mqttSubscriptionStream",
|
6880
|
+
"application.patch",
|
6881
|
+
"application.payloadCounts",
|
6882
|
+
"application.search",
|
6883
|
+
"applicationApiToken.delete",
|
6884
|
+
"applicationApiToken.get",
|
6885
|
+
"applicationApiToken.patch",
|
6886
|
+
"applicationApiTokens.get",
|
6887
|
+
"applicationApiTokens.post",
|
6888
|
+
"applicationCertificate.delete",
|
6889
|
+
"applicationCertificate.get",
|
6890
|
+
"applicationCertificate.patch",
|
6891
|
+
"applicationCertificates.get",
|
6892
|
+
"applicationCertificates.post",
|
6893
|
+
"applicationCertificateAuthority.delete",
|
6894
|
+
"applicationCertificateAuthority.get",
|
6895
|
+
"applicationCertificateAuthority.patch",
|
6896
|
+
"applicationCertificateAuthorities.get",
|
6897
|
+
"applicationCertificateAuthorities.post",
|
6898
|
+
"applicationDashboard.get",
|
6899
|
+
"applicationDashboard.patch",
|
6900
|
+
"applicationDashboard.delete",
|
6901
|
+
"applicationDashboards.get",
|
6902
|
+
"applicationDashboards.post",
|
6903
|
+
"applicationKey.delete",
|
6904
|
+
"applicationKey.get",
|
6905
|
+
"applicationKey.patch",
|
6906
|
+
"applicationKeys.get",
|
6907
|
+
"applicationKeys.post",
|
6908
|
+
"data.export",
|
6909
|
+
"data.lastValueQuery",
|
6910
|
+
"data.timeSeriesQuery",
|
6911
|
+
"dataTable.addColumn",
|
6912
|
+
"dataTable.delete",
|
6913
|
+
"dataTable.get",
|
6914
|
+
"dataTable.patch",
|
6915
|
+
"dataTable.removeColumn",
|
6916
|
+
"dataTableRow.delete",
|
6917
|
+
"dataTableRow.get",
|
6918
|
+
"dataTableRow.patch",
|
6919
|
+
"dataTableRows.get",
|
6920
|
+
"dataTableRows.post",
|
6921
|
+
"dataTableRows.query",
|
6922
|
+
"dataTableRows.export",
|
6923
|
+
"dataTableRows.delete",
|
6924
|
+
"dataTableRows.truncate",
|
6925
|
+
"dataTables.get",
|
6926
|
+
"dataTables.post",
|
6927
|
+
"device.commandStream",
|
6928
|
+
"device.debug",
|
6929
|
+
"device.delete",
|
6930
|
+
"device.export",
|
6931
|
+
"device.get",
|
6932
|
+
"device.getCommand",
|
6933
|
+
"device.getCompositeState",
|
6934
|
+
"device.getLogEntries",
|
6935
|
+
"device.getState",
|
6936
|
+
"device.patch",
|
6937
|
+
"device.removeData",
|
6938
|
+
"device.sendCommand",
|
6939
|
+
"device.sendState",
|
6940
|
+
"device.setConnectionStatus",
|
6941
|
+
"device.stateStream",
|
6942
|
+
"deviceRecipe.bulkCreate",
|
6943
|
+
"deviceRecipe.delete",
|
6944
|
+
"deviceRecipe.get",
|
6945
|
+
"deviceRecipe.patch",
|
6946
|
+
"deviceRecipes.get",
|
6947
|
+
"deviceRecipes.post",
|
6948
|
+
"devices.attributeNames",
|
6949
|
+
"devices.patch",
|
6950
|
+
"devices.delete",
|
6951
|
+
"devices.removeData",
|
6952
|
+
"devices.detailedSummary",
|
6953
|
+
"devices.export",
|
6954
|
+
"devices.get",
|
6955
|
+
"devices.post",
|
6956
|
+
"devices.sendCommand",
|
6957
|
+
"devices.tagKeys",
|
6958
|
+
"devices.tagValues",
|
6959
|
+
"edgeDeployments.get",
|
6960
|
+
"edgeDeployments.release",
|
6961
|
+
"edgeDeployments.remove",
|
6962
|
+
"edgeDeployments.replace",
|
6963
|
+
"event.delete",
|
6964
|
+
"event.get",
|
6965
|
+
"event.patch",
|
6966
|
+
"events.delete",
|
6967
|
+
"events.get",
|
6968
|
+
"events.mostRecentBySeverity",
|
6969
|
+
"events.patch",
|
6970
|
+
"events.post",
|
6971
|
+
"events.export",
|
6972
|
+
"experience.delete",
|
6973
|
+
"experience.bootstrap",
|
6974
|
+
"experienceDomain.delete",
|
6975
|
+
"experienceDomain.get",
|
6976
|
+
"experienceDomain.patch",
|
6977
|
+
"experienceDomains.get",
|
6978
|
+
"experienceDomains.post",
|
6979
|
+
"experienceEndpoint.delete",
|
6980
|
+
"experienceEndpoint.get",
|
6981
|
+
"experienceEndpoint.linkedResources",
|
6982
|
+
"experienceEndpoint.patch",
|
6983
|
+
"experienceEndpoints.get",
|
6984
|
+
"experienceEndpoints.post",
|
6985
|
+
"experienceEndpoints.stats",
|
6986
|
+
"experienceGroup.delete",
|
6987
|
+
"experienceGroup.get",
|
6988
|
+
"experienceGroup.patch",
|
6989
|
+
"experienceGroups.detailedSummary",
|
6990
|
+
"experienceGroups.get",
|
6991
|
+
"experienceGroups.post",
|
6992
|
+
"experienceSlug.delete",
|
6993
|
+
"experienceSlug.get",
|
6994
|
+
"experienceSlug.patch",
|
6995
|
+
"experienceSlugs.get",
|
6996
|
+
"experienceSlugs.post",
|
6997
|
+
"experienceUser.delete",
|
6998
|
+
"experienceUser.get",
|
6999
|
+
"experienceUser.patch",
|
7000
|
+
"experienceUsers.detailedSummary",
|
7001
|
+
"experienceUsers.get",
|
7002
|
+
"experienceUsers.post",
|
7003
|
+
"experienceVersion.delete",
|
7004
|
+
"experienceVersion.get",
|
7005
|
+
"experienceVersion.patch",
|
7006
|
+
"experienceVersions.get",
|
7007
|
+
"experienceVersions.post",
|
7008
|
+
"experienceView.debug",
|
7009
|
+
"experienceView.delete",
|
7010
|
+
"experienceView.get",
|
7011
|
+
"experienceView.linkedResources",
|
7012
|
+
"experienceView.patch",
|
7013
|
+
"experienceViews.debug",
|
7014
|
+
"experienceViews.detailedSummary",
|
7015
|
+
"experienceViews.get",
|
7016
|
+
"experienceViews.post",
|
7017
|
+
"file.get",
|
7018
|
+
"file.patch",
|
7019
|
+
"file.move",
|
7020
|
+
"file.delete",
|
7021
|
+
"file.upload",
|
7022
|
+
"files.get",
|
7023
|
+
"files.post",
|
7024
|
+
"flow.clearStorageEntries",
|
7025
|
+
"flow.debug",
|
7026
|
+
"flow.delete",
|
7027
|
+
"flow.errors",
|
7028
|
+
"flow.get",
|
7029
|
+
"flow.getStorageEntries",
|
7030
|
+
"flow.log",
|
7031
|
+
"flow.patch",
|
7032
|
+
"flow.pressVirtualButton",
|
7033
|
+
"flow.setStorageEntry",
|
7034
|
+
"flow.getStorageEntriesMetadata",
|
7035
|
+
"flow.stats",
|
7036
|
+
"flows.get",
|
7037
|
+
"flows.getByVersion",
|
7038
|
+
"flows.import",
|
7039
|
+
"flows.post",
|
7040
|
+
"flowVersion.delete",
|
7041
|
+
"flowVersion.errors",
|
7042
|
+
"flowVersion.get",
|
7043
|
+
"flowVersion.log",
|
7044
|
+
"flowVersion.patch",
|
7045
|
+
"flowVersion.stats",
|
7046
|
+
"flowVersions.delete",
|
7047
|
+
"flowVersions.get",
|
7048
|
+
"flowVersions.post",
|
7049
|
+
"integration.delete",
|
7050
|
+
"integration.get",
|
7051
|
+
"integration.patch",
|
7052
|
+
"integrations.get",
|
7053
|
+
"integrations.post",
|
7054
|
+
"notebook.delete",
|
7055
|
+
"notebook.execute",
|
7056
|
+
"notebook.get",
|
7057
|
+
"notebook.logs",
|
7058
|
+
"notebook.patch",
|
7059
|
+
"notebook.requestInputDataExport",
|
7060
|
+
"notebook.upload",
|
7061
|
+
"notebooks.get",
|
7062
|
+
"notebooks.post",
|
7063
|
+
"webhook.delete",
|
7064
|
+
"webhook.get",
|
7065
|
+
"webhook.patch",
|
7066
|
+
"webhooks.get",
|
7067
|
+
"webhooks.post"
|
7068
|
+
]
|
7069
|
+
},
|
7070
|
+
{
|
7071
|
+
"type": "string",
|
7072
|
+
"enum": [
|
7073
|
+
"all.Organization",
|
7074
|
+
"all.Organization.read",
|
7075
|
+
"applications.*",
|
7076
|
+
"auditLog.*",
|
7077
|
+
"auditLogs.*",
|
7078
|
+
"dashboard.*",
|
7079
|
+
"dashboards.*",
|
7080
|
+
"org.*",
|
7081
|
+
"applications.get",
|
7082
|
+
"applications.post",
|
7083
|
+
"applications.import",
|
7084
|
+
"applications.detailedSummary",
|
7085
|
+
"auditLog.get",
|
7086
|
+
"auditLogs.get",
|
7087
|
+
"dashboard.patch",
|
7088
|
+
"dashboard.delete",
|
7089
|
+
"dashboard.sendReport",
|
7090
|
+
"dashboards.get",
|
7091
|
+
"dashboards.post",
|
7092
|
+
"org.get",
|
7093
|
+
"org.patch",
|
7094
|
+
"org.delete",
|
7095
|
+
"org.pendingInvites",
|
7096
|
+
"org.inviteMember",
|
7097
|
+
"org.revokeInvite",
|
7098
|
+
"org.modifyMember",
|
7099
|
+
"org.removeMember",
|
7100
|
+
"org.payloadCounts",
|
7101
|
+
"org.invoices",
|
7102
|
+
"org.currentCard",
|
7103
|
+
"org.chargeDetails",
|
7104
|
+
"org.transferResources"
|
7105
|
+
]
|
7106
|
+
}
|
7107
|
+
]
|
7108
|
+
},
|
7109
|
+
{
|
7110
|
+
"type": "string",
|
7111
|
+
"enum": [
|
7112
|
+
"all.Instance",
|
7113
|
+
"all.Instance.read",
|
7114
|
+
"instance.*",
|
7115
|
+
"instance.get",
|
7116
|
+
"instance.patch",
|
7117
|
+
"instance.historicalSummaries",
|
7118
|
+
"instance.generateReport",
|
7119
|
+
"instanceOrg.*",
|
7120
|
+
"instanceOrg.get",
|
7121
|
+
"instanceOrg.patch",
|
7122
|
+
"instanceOrg.delete",
|
7123
|
+
"instanceOrgs.*",
|
7124
|
+
"instanceOrgs.get",
|
7125
|
+
"instanceOrgs.post",
|
7126
|
+
"instanceMember.*",
|
7127
|
+
"instanceMember.get",
|
7128
|
+
"instanceMember.patch",
|
7129
|
+
"instanceMember.delete",
|
7130
|
+
"instanceMembers.*",
|
7131
|
+
"instanceMembers.get",
|
7132
|
+
"instanceMembers.post",
|
7133
|
+
"instanceOrgMember.*",
|
7134
|
+
"instanceOrgMember.get",
|
7135
|
+
"instanceOrgMember.patch",
|
7136
|
+
"instanceOrgMember.delete",
|
7137
|
+
"instanceOrgMembers.*",
|
7138
|
+
"instanceOrgMembers.get",
|
7139
|
+
"instanceOrgMembers.post",
|
7140
|
+
"instanceApiTokens.*",
|
7141
|
+
"instanceApiTokens.get",
|
7142
|
+
"instanceApiTokens.post",
|
7143
|
+
"instanceApiToken.*",
|
7144
|
+
"instanceApiToken.get",
|
7145
|
+
"instanceApiToken.patch",
|
7146
|
+
"instanceApiToken.delete"
|
7147
|
+
]
|
7148
|
+
},
|
7149
|
+
{
|
7150
|
+
"type": "string",
|
7151
|
+
"enum": [
|
7152
|
+
"all.User",
|
7153
|
+
"all.User.read",
|
7154
|
+
"all.User.cli",
|
7155
|
+
"userApiToken.*",
|
7156
|
+
"userApiToken.get",
|
7157
|
+
"userApiToken.patch",
|
7158
|
+
"userApiToken.delete",
|
7159
|
+
"userApiTokens.*",
|
7160
|
+
"userApiTokens.get",
|
7161
|
+
"userApiTokens.post",
|
7162
|
+
"applicationTemplate.*",
|
7163
|
+
"applicationTemplate.get",
|
7164
|
+
"applicationTemplates.*",
|
7165
|
+
"applicationTemplates.get",
|
7166
|
+
"applicationTemplates.getCategories",
|
7167
|
+
"applicationTemplates.getUniqueKeywords",
|
7168
|
+
"instances.*",
|
7169
|
+
"instances.get",
|
7170
|
+
"me.*",
|
7171
|
+
"me.get",
|
7172
|
+
"me.patch",
|
7173
|
+
"me.delete",
|
7174
|
+
"me.verifyEmail",
|
7175
|
+
"me.changePassword",
|
7176
|
+
"me.enableTwoFactorAuth",
|
7177
|
+
"me.disableTwoFactorAuth",
|
7178
|
+
"me.disconnectGithub",
|
7179
|
+
"me.connectGithub",
|
7180
|
+
"me.addRecentItem",
|
7181
|
+
"me.fetchRecentItems",
|
7182
|
+
"me.payloadCounts",
|
7183
|
+
"me.transferResources",
|
7184
|
+
"orgs.*",
|
7185
|
+
"orgs.get",
|
7186
|
+
"orgs.post"
|
7187
|
+
]
|
7188
|
+
}
|
7189
|
+
]
|
7190
|
+
}
|
7191
|
+
},
|
7192
|
+
"status": {
|
7193
|
+
"type": "string",
|
7194
|
+
"enum": [
|
7195
|
+
"active",
|
7196
|
+
"inactive"
|
7197
|
+
]
|
7198
|
+
}
|
7199
|
+
},
|
7200
|
+
"additionalProperties": false,
|
7201
|
+
"required": [
|
7202
|
+
"name"
|
7203
|
+
]
|
7204
|
+
}
|
7205
|
+
```
|
7206
|
+
### <a name="api-token-post-example"></a> Example
|
7207
|
+
|
7208
|
+
```json
|
7209
|
+
{
|
7210
|
+
"name": "My New API Token",
|
7211
|
+
"expirationDate": "2017-06-13T04:00:00.000Z",
|
7212
|
+
"scope": [
|
7213
|
+
"all.Application"
|
7214
|
+
],
|
7215
|
+
"status": "active"
|
7216
|
+
}
|
7217
|
+
```
|
7218
|
+
|
7219
|
+
<br/>
|
7220
|
+
|
6775
7221
|
## API Tokens
|
6776
7222
|
|
6777
7223
|
Schema for a collection of API Tokens
|
@@ -6805,7 +7251,8 @@ Schema for a collection of API Tokens
|
|
6805
7251
|
"ownerType": {
|
6806
7252
|
"type": "string",
|
6807
7253
|
"enum": [
|
6808
|
-
"application"
|
7254
|
+
"application",
|
7255
|
+
"user"
|
6809
7256
|
]
|
6810
7257
|
},
|
6811
7258
|
"creatorId": {
|
@@ -6905,7 +7352,8 @@ Schema for a collection of API Tokens
|
|
6905
7352
|
"ownerType": {
|
6906
7353
|
"type": "string",
|
6907
7354
|
"enum": [
|
6908
|
-
"application"
|
7355
|
+
"application",
|
7356
|
+
"user"
|
6909
7357
|
]
|
6910
7358
|
}
|
6911
7359
|
}
|
@@ -7350,322 +7798,6 @@ Schema for a single Application
|
|
7350
7798
|
|
7351
7799
|
<br/>
|
7352
7800
|
|
7353
|
-
## Application API Token Post
|
7354
|
-
|
7355
|
-
Schema for the body of an Application API Token creation request
|
7356
|
-
|
7357
|
-
### <a name="application-api-token-post-schema"></a> Schema
|
7358
|
-
|
7359
|
-
```json
|
7360
|
-
{
|
7361
|
-
"$schema": "http://json-schema.org/draft-04/schema#",
|
7362
|
-
"type": "object",
|
7363
|
-
"properties": {
|
7364
|
-
"name": {
|
7365
|
-
"type": "string",
|
7366
|
-
"minLength": 1,
|
7367
|
-
"maxLength": 255
|
7368
|
-
},
|
7369
|
-
"description": {
|
7370
|
-
"type": "string",
|
7371
|
-
"maxLength": 32767
|
7372
|
-
},
|
7373
|
-
"expirationDate": {
|
7374
|
-
"type": "string",
|
7375
|
-
"format": "date-time"
|
7376
|
-
},
|
7377
|
-
"scope": {
|
7378
|
-
"type": "array",
|
7379
|
-
"uniqueItems": true,
|
7380
|
-
"items": {
|
7381
|
-
"type": "string",
|
7382
|
-
"enum": [
|
7383
|
-
"all.Application",
|
7384
|
-
"all.Application.read",
|
7385
|
-
"all.Device",
|
7386
|
-
"all.Device.read",
|
7387
|
-
"application.*",
|
7388
|
-
"applicationApiToken.*",
|
7389
|
-
"applicationApiTokens.*",
|
7390
|
-
"applicationCertificate.*",
|
7391
|
-
"applicationCertificates.*",
|
7392
|
-
"applicationCertificateAuthority.*",
|
7393
|
-
"applicationCertificateAuthorities.*",
|
7394
|
-
"applicationDashboards.*",
|
7395
|
-
"applicationDashboard.*",
|
7396
|
-
"applicationKey.*",
|
7397
|
-
"applicationKeys.*",
|
7398
|
-
"data.*",
|
7399
|
-
"dataTable.*",
|
7400
|
-
"dataTables.*",
|
7401
|
-
"dataTableRow.*",
|
7402
|
-
"dataTableRows.*",
|
7403
|
-
"device.*",
|
7404
|
-
"deviceRecipe.*",
|
7405
|
-
"deviceRecipes.*",
|
7406
|
-
"devices.*",
|
7407
|
-
"edgeDeployments.*",
|
7408
|
-
"event.*",
|
7409
|
-
"events.*",
|
7410
|
-
"experience.*",
|
7411
|
-
"experienceDomain.*",
|
7412
|
-
"experienceDomains.*",
|
7413
|
-
"experienceEndpoint.*",
|
7414
|
-
"experienceEndpoints.*",
|
7415
|
-
"experienceGroup.*",
|
7416
|
-
"experienceGroups.*",
|
7417
|
-
"experienceSlug.*",
|
7418
|
-
"experienceSlugs.*",
|
7419
|
-
"experienceUser.*",
|
7420
|
-
"experienceUsers.*",
|
7421
|
-
"experienceVersion.*",
|
7422
|
-
"experienceVersions.*",
|
7423
|
-
"experienceView.*",
|
7424
|
-
"experienceViews.*",
|
7425
|
-
"integration.*",
|
7426
|
-
"integrations.*",
|
7427
|
-
"file.*",
|
7428
|
-
"files.*",
|
7429
|
-
"flow.*",
|
7430
|
-
"flows.*",
|
7431
|
-
"flowVersion.*",
|
7432
|
-
"flowVersions.*",
|
7433
|
-
"notebook.*",
|
7434
|
-
"notebooks.*",
|
7435
|
-
"webhook.*",
|
7436
|
-
"webhooks.*",
|
7437
|
-
"application.applyTemplate",
|
7438
|
-
"application.archiveData",
|
7439
|
-
"application.backfillArchiveData",
|
7440
|
-
"application.clone",
|
7441
|
-
"application.export",
|
7442
|
-
"application.import",
|
7443
|
-
"application.fullEventsArchive",
|
7444
|
-
"application.fullDataTablesArchive",
|
7445
|
-
"application.debug",
|
7446
|
-
"application.delete",
|
7447
|
-
"application.get",
|
7448
|
-
"application.mqttPublishMessage",
|
7449
|
-
"application.mqttSubscriptionStream",
|
7450
|
-
"application.patch",
|
7451
|
-
"application.payloadCounts",
|
7452
|
-
"application.search",
|
7453
|
-
"applicationApiToken.delete",
|
7454
|
-
"applicationApiToken.get",
|
7455
|
-
"applicationApiToken.patch",
|
7456
|
-
"applicationApiTokens.get",
|
7457
|
-
"applicationApiTokens.post",
|
7458
|
-
"applicationCertificate.delete",
|
7459
|
-
"applicationCertificate.get",
|
7460
|
-
"applicationCertificate.patch",
|
7461
|
-
"applicationCertificates.get",
|
7462
|
-
"applicationCertificates.post",
|
7463
|
-
"applicationCertificateAuthority.delete",
|
7464
|
-
"applicationCertificateAuthority.get",
|
7465
|
-
"applicationCertificateAuthority.patch",
|
7466
|
-
"applicationCertificateAuthorities.get",
|
7467
|
-
"applicationCertificateAuthorities.post",
|
7468
|
-
"applicationDashboard.get",
|
7469
|
-
"applicationDashboard.patch",
|
7470
|
-
"applicationDashboard.delete",
|
7471
|
-
"applicationDashboards.get",
|
7472
|
-
"applicationDashboards.post",
|
7473
|
-
"applicationKey.delete",
|
7474
|
-
"applicationKey.get",
|
7475
|
-
"applicationKey.patch",
|
7476
|
-
"applicationKeys.get",
|
7477
|
-
"applicationKeys.post",
|
7478
|
-
"data.export",
|
7479
|
-
"data.lastValueQuery",
|
7480
|
-
"data.timeSeriesQuery",
|
7481
|
-
"dataTable.addColumn",
|
7482
|
-
"dataTable.delete",
|
7483
|
-
"dataTable.get",
|
7484
|
-
"dataTable.patch",
|
7485
|
-
"dataTable.removeColumn",
|
7486
|
-
"dataTableRow.delete",
|
7487
|
-
"dataTableRow.get",
|
7488
|
-
"dataTableRow.patch",
|
7489
|
-
"dataTableRows.get",
|
7490
|
-
"dataTableRows.post",
|
7491
|
-
"dataTableRows.query",
|
7492
|
-
"dataTableRows.export",
|
7493
|
-
"dataTableRows.delete",
|
7494
|
-
"dataTableRows.truncate",
|
7495
|
-
"dataTables.get",
|
7496
|
-
"dataTables.post",
|
7497
|
-
"device.commandStream",
|
7498
|
-
"device.debug",
|
7499
|
-
"device.delete",
|
7500
|
-
"device.export",
|
7501
|
-
"device.get",
|
7502
|
-
"device.getCommand",
|
7503
|
-
"device.getCompositeState",
|
7504
|
-
"device.getLogEntries",
|
7505
|
-
"device.getState",
|
7506
|
-
"device.patch",
|
7507
|
-
"device.removeData",
|
7508
|
-
"device.sendCommand",
|
7509
|
-
"device.sendState",
|
7510
|
-
"device.setConnectionStatus",
|
7511
|
-
"device.stateStream",
|
7512
|
-
"deviceRecipe.bulkCreate",
|
7513
|
-
"deviceRecipe.delete",
|
7514
|
-
"deviceRecipe.get",
|
7515
|
-
"deviceRecipe.patch",
|
7516
|
-
"deviceRecipes.get",
|
7517
|
-
"deviceRecipes.post",
|
7518
|
-
"devices.attributeNames",
|
7519
|
-
"devices.patch",
|
7520
|
-
"devices.delete",
|
7521
|
-
"devices.removeData",
|
7522
|
-
"devices.detailedSummary",
|
7523
|
-
"devices.export",
|
7524
|
-
"devices.get",
|
7525
|
-
"devices.post",
|
7526
|
-
"devices.sendCommand",
|
7527
|
-
"devices.tagKeys",
|
7528
|
-
"devices.tagValues",
|
7529
|
-
"edgeDeployments.get",
|
7530
|
-
"edgeDeployments.release",
|
7531
|
-
"edgeDeployments.remove",
|
7532
|
-
"edgeDeployments.replace",
|
7533
|
-
"event.delete",
|
7534
|
-
"event.get",
|
7535
|
-
"event.patch",
|
7536
|
-
"events.delete",
|
7537
|
-
"events.get",
|
7538
|
-
"events.mostRecentBySeverity",
|
7539
|
-
"events.patch",
|
7540
|
-
"events.post",
|
7541
|
-
"events.export",
|
7542
|
-
"experience.delete",
|
7543
|
-
"experience.bootstrap",
|
7544
|
-
"experienceDomain.delete",
|
7545
|
-
"experienceDomain.get",
|
7546
|
-
"experienceDomain.patch",
|
7547
|
-
"experienceDomains.get",
|
7548
|
-
"experienceDomains.post",
|
7549
|
-
"experienceEndpoint.delete",
|
7550
|
-
"experienceEndpoint.get",
|
7551
|
-
"experienceEndpoint.linkedResources",
|
7552
|
-
"experienceEndpoint.patch",
|
7553
|
-
"experienceEndpoints.get",
|
7554
|
-
"experienceEndpoints.post",
|
7555
|
-
"experienceEndpoints.stats",
|
7556
|
-
"experienceGroup.delete",
|
7557
|
-
"experienceGroup.get",
|
7558
|
-
"experienceGroup.patch",
|
7559
|
-
"experienceGroups.detailedSummary",
|
7560
|
-
"experienceGroups.get",
|
7561
|
-
"experienceGroups.post",
|
7562
|
-
"experienceSlug.delete",
|
7563
|
-
"experienceSlug.get",
|
7564
|
-
"experienceSlug.patch",
|
7565
|
-
"experienceSlugs.get",
|
7566
|
-
"experienceSlugs.post",
|
7567
|
-
"experienceUser.delete",
|
7568
|
-
"experienceUser.get",
|
7569
|
-
"experienceUser.patch",
|
7570
|
-
"experienceUsers.detailedSummary",
|
7571
|
-
"experienceUsers.get",
|
7572
|
-
"experienceUsers.post",
|
7573
|
-
"experienceVersion.delete",
|
7574
|
-
"experienceVersion.get",
|
7575
|
-
"experienceVersion.patch",
|
7576
|
-
"experienceVersions.get",
|
7577
|
-
"experienceVersions.post",
|
7578
|
-
"experienceView.debug",
|
7579
|
-
"experienceView.delete",
|
7580
|
-
"experienceView.get",
|
7581
|
-
"experienceView.linkedResources",
|
7582
|
-
"experienceView.patch",
|
7583
|
-
"experienceViews.debug",
|
7584
|
-
"experienceViews.detailedSummary",
|
7585
|
-
"experienceViews.get",
|
7586
|
-
"experienceViews.post",
|
7587
|
-
"file.get",
|
7588
|
-
"file.patch",
|
7589
|
-
"file.move",
|
7590
|
-
"file.delete",
|
7591
|
-
"file.upload",
|
7592
|
-
"files.get",
|
7593
|
-
"files.post",
|
7594
|
-
"flow.clearStorageEntries",
|
7595
|
-
"flow.debug",
|
7596
|
-
"flow.delete",
|
7597
|
-
"flow.errors",
|
7598
|
-
"flow.get",
|
7599
|
-
"flow.getStorageEntries",
|
7600
|
-
"flow.log",
|
7601
|
-
"flow.patch",
|
7602
|
-
"flow.pressVirtualButton",
|
7603
|
-
"flow.setStorageEntry",
|
7604
|
-
"flow.getStorageEntriesMetadata",
|
7605
|
-
"flow.stats",
|
7606
|
-
"flows.get",
|
7607
|
-
"flows.getByVersion",
|
7608
|
-
"flows.import",
|
7609
|
-
"flows.post",
|
7610
|
-
"flowVersion.delete",
|
7611
|
-
"flowVersion.errors",
|
7612
|
-
"flowVersion.get",
|
7613
|
-
"flowVersion.log",
|
7614
|
-
"flowVersion.patch",
|
7615
|
-
"flowVersion.stats",
|
7616
|
-
"flowVersions.get",
|
7617
|
-
"flowVersions.post",
|
7618
|
-
"integration.delete",
|
7619
|
-
"integration.get",
|
7620
|
-
"integration.patch",
|
7621
|
-
"integrations.get",
|
7622
|
-
"integrations.post",
|
7623
|
-
"notebook.delete",
|
7624
|
-
"notebook.execute",
|
7625
|
-
"notebook.get",
|
7626
|
-
"notebook.logs",
|
7627
|
-
"notebook.patch",
|
7628
|
-
"notebook.requestInputDataExport",
|
7629
|
-
"notebook.upload",
|
7630
|
-
"notebooks.get",
|
7631
|
-
"notebooks.post",
|
7632
|
-
"webhook.delete",
|
7633
|
-
"webhook.get",
|
7634
|
-
"webhook.patch",
|
7635
|
-
"webhooks.get",
|
7636
|
-
"webhooks.post"
|
7637
|
-
]
|
7638
|
-
}
|
7639
|
-
},
|
7640
|
-
"status": {
|
7641
|
-
"type": "string",
|
7642
|
-
"enum": [
|
7643
|
-
"active",
|
7644
|
-
"inactive"
|
7645
|
-
]
|
7646
|
-
}
|
7647
|
-
},
|
7648
|
-
"additionalProperties": false,
|
7649
|
-
"required": [
|
7650
|
-
"name"
|
7651
|
-
]
|
7652
|
-
}
|
7653
|
-
```
|
7654
|
-
### <a name="application-api-token-post-example"></a> Example
|
7655
|
-
|
7656
|
-
```json
|
7657
|
-
{
|
7658
|
-
"name": "My New API Token",
|
7659
|
-
"expirationDate": "2017-06-13T04:00:00.000Z",
|
7660
|
-
"scope": [
|
7661
|
-
"all.Application"
|
7662
|
-
],
|
7663
|
-
"status": "active"
|
7664
|
-
}
|
7665
|
-
```
|
7666
|
-
|
7667
|
-
<br/>
|
7668
|
-
|
7669
7801
|
## Application Apply Template Patch Schema
|
7670
7802
|
|
7671
7803
|
Schema for the body of an application template import request
|
@@ -9345,7 +9477,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
9345
9477
|
},
|
9346
9478
|
{
|
9347
9479
|
"type": "string",
|
9348
|
-
"maxLength":
|
9480
|
+
"maxLength": 128
|
9349
9481
|
}
|
9350
9482
|
]
|
9351
9483
|
},
|
@@ -9356,7 +9488,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
9356
9488
|
},
|
9357
9489
|
{
|
9358
9490
|
"type": "string",
|
9359
|
-
"maxLength":
|
9491
|
+
"maxLength": 128
|
9360
9492
|
}
|
9361
9493
|
]
|
9362
9494
|
},
|
@@ -10797,7 +10929,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
10797
10929
|
},
|
10798
10930
|
{
|
10799
10931
|
"type": "string",
|
10800
|
-
"maxLength":
|
10932
|
+
"maxLength": 128
|
10801
10933
|
}
|
10802
10934
|
]
|
10803
10935
|
},
|
@@ -10808,7 +10940,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
10808
10940
|
},
|
10809
10941
|
{
|
10810
10942
|
"type": "string",
|
10811
|
-
"maxLength":
|
10943
|
+
"maxLength": 128
|
10812
10944
|
}
|
10813
10945
|
]
|
10814
10946
|
},
|
@@ -10829,7 +10961,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
10829
10961
|
},
|
10830
10962
|
{
|
10831
10963
|
"type": "string",
|
10832
|
-
"maxLength":
|
10964
|
+
"maxLength": 128
|
10833
10965
|
}
|
10834
10966
|
]
|
10835
10967
|
},
|
@@ -11292,7 +11424,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
11292
11424
|
},
|
11293
11425
|
{
|
11294
11426
|
"type": "string",
|
11295
|
-
"maxLength":
|
11427
|
+
"maxLength": 128
|
11296
11428
|
}
|
11297
11429
|
]
|
11298
11430
|
},
|
@@ -11303,7 +11435,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
11303
11435
|
},
|
11304
11436
|
{
|
11305
11437
|
"type": "string",
|
11306
|
-
"maxLength":
|
11438
|
+
"maxLength": 128
|
11307
11439
|
}
|
11308
11440
|
]
|
11309
11441
|
},
|
@@ -11450,7 +11582,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
11450
11582
|
},
|
11451
11583
|
{
|
11452
11584
|
"type": "string",
|
11453
|
-
"maxLength":
|
11585
|
+
"maxLength": 128
|
11454
11586
|
}
|
11455
11587
|
]
|
11456
11588
|
},
|
@@ -12225,7 +12357,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
12225
12357
|
},
|
12226
12358
|
{
|
12227
12359
|
"type": "string",
|
12228
|
-
"maxLength":
|
12360
|
+
"maxLength": 128
|
12229
12361
|
}
|
12230
12362
|
]
|
12231
12363
|
},
|
@@ -12236,7 +12368,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
12236
12368
|
},
|
12237
12369
|
{
|
12238
12370
|
"type": "string",
|
12239
|
-
"maxLength":
|
12371
|
+
"maxLength": 128
|
12240
12372
|
}
|
12241
12373
|
]
|
12242
12374
|
},
|
@@ -12844,7 +12976,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
12844
12976
|
},
|
12845
12977
|
{
|
12846
12978
|
"type": "string",
|
12847
|
-
"maxLength":
|
12979
|
+
"maxLength": 128
|
12848
12980
|
}
|
12849
12981
|
]
|
12850
12982
|
},
|
@@ -12855,7 +12987,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
12855
12987
|
},
|
12856
12988
|
{
|
12857
12989
|
"type": "string",
|
12858
|
-
"maxLength":
|
12990
|
+
"maxLength": 128
|
12859
12991
|
}
|
12860
12992
|
]
|
12861
12993
|
},
|
@@ -12866,7 +12998,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
12866
12998
|
},
|
12867
12999
|
{
|
12868
13000
|
"type": "string",
|
12869
|
-
"maxLength":
|
13001
|
+
"maxLength": 128
|
12870
13002
|
}
|
12871
13003
|
]
|
12872
13004
|
},
|
@@ -12877,7 +13009,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
12877
13009
|
},
|
12878
13010
|
{
|
12879
13011
|
"type": "string",
|
12880
|
-
"maxLength":
|
13012
|
+
"maxLength": 128
|
12881
13013
|
}
|
12882
13014
|
]
|
12883
13015
|
}
|
@@ -13724,7 +13856,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
13724
13856
|
},
|
13725
13857
|
{
|
13726
13858
|
"type": "string",
|
13727
|
-
"maxLength":
|
13859
|
+
"maxLength": 128
|
13728
13860
|
}
|
13729
13861
|
]
|
13730
13862
|
},
|
@@ -14235,7 +14367,7 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
14235
14367
|
},
|
14236
14368
|
{
|
14237
14369
|
"type": "string",
|
14238
|
-
"maxLength":
|
14370
|
+
"maxLength": 128
|
14239
14371
|
}
|
14240
14372
|
]
|
14241
14373
|
},
|
@@ -14548,6 +14680,10 @@ Schema for the body of an Application scoped Dashboard creation request
|
|
14548
14680
|
"timezone": {
|
14549
14681
|
"type": "string",
|
14550
14682
|
"maxLength": 255
|
14683
|
+
},
|
14684
|
+
"locale": {
|
14685
|
+
"type": "string",
|
14686
|
+
"maxLength": 5
|
14551
14687
|
}
|
14552
14688
|
},
|
14553
14689
|
"additionalProperties": false,
|
@@ -17380,7 +17516,10 @@ Schema for a single Audit Log entry
|
|
17380
17516
|
"type": "string",
|
17381
17517
|
"enum": [
|
17382
17518
|
"ApiToken",
|
17519
|
+
"ApplicationCertificateAuthority",
|
17520
|
+
"ApplicationCertificate",
|
17383
17521
|
"ApplicationKey",
|
17522
|
+
"Dashboard",
|
17384
17523
|
"DataTable",
|
17385
17524
|
"Device",
|
17386
17525
|
"DeviceRecipe",
|
@@ -17395,6 +17534,7 @@ Schema for a single Audit Log entry
|
|
17395
17534
|
"File",
|
17396
17535
|
"Flow",
|
17397
17536
|
"Integration",
|
17537
|
+
"Notebook",
|
17398
17538
|
"Webhook"
|
17399
17539
|
]
|
17400
17540
|
},
|
@@ -17527,7 +17667,10 @@ Schema for the filter of an audit log query
|
|
17527
17667
|
"type": "string",
|
17528
17668
|
"enum": [
|
17529
17669
|
"ApiToken",
|
17670
|
+
"ApplicationCertificateAuthority",
|
17671
|
+
"ApplicationCertificate",
|
17530
17672
|
"ApplicationKey",
|
17673
|
+
"Dashboard",
|
17531
17674
|
"DataTable",
|
17532
17675
|
"Device",
|
17533
17676
|
"DeviceRecipe",
|
@@ -17542,6 +17685,7 @@ Schema for the filter of an audit log query
|
|
17542
17685
|
"File",
|
17543
17686
|
"Flow",
|
17544
17687
|
"Integration",
|
17688
|
+
"Notebook",
|
17545
17689
|
"Webhook"
|
17546
17690
|
]
|
17547
17691
|
},
|
@@ -17691,7 +17835,10 @@ Schema for a collection of Audit Logs
|
|
17691
17835
|
"type": "string",
|
17692
17836
|
"enum": [
|
17693
17837
|
"ApiToken",
|
17838
|
+
"ApplicationCertificateAuthority",
|
17839
|
+
"ApplicationCertificate",
|
17694
17840
|
"ApplicationKey",
|
17841
|
+
"Dashboard",
|
17695
17842
|
"DataTable",
|
17696
17843
|
"Device",
|
17697
17844
|
"DeviceRecipe",
|
@@ -17706,6 +17853,7 @@ Schema for a collection of Audit Logs
|
|
17706
17853
|
"File",
|
17707
17854
|
"Flow",
|
17708
17855
|
"Integration",
|
17856
|
+
"Notebook",
|
17709
17857
|
"Webhook"
|
17710
17858
|
]
|
17711
17859
|
},
|
@@ -17977,6 +18125,36 @@ Schema for the successful response when authenticating a User
|
|
17977
18125
|
|
17978
18126
|
<br/>
|
17979
18127
|
|
18128
|
+
## Bulk Deletion Response
|
18129
|
+
|
18130
|
+
Schema for the response to a bulk deletion
|
18131
|
+
|
18132
|
+
### <a name="bulk-deletion-response-schema"></a> Schema
|
18133
|
+
|
18134
|
+
```json
|
18135
|
+
{
|
18136
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
18137
|
+
"type": "object",
|
18138
|
+
"properties": {
|
18139
|
+
"removed": {
|
18140
|
+
"type": "number"
|
18141
|
+
},
|
18142
|
+
"failed": {
|
18143
|
+
"type": "number"
|
18144
|
+
}
|
18145
|
+
}
|
18146
|
+
}
|
18147
|
+
```
|
18148
|
+
### <a name="bulk-deletion-response-example"></a> Example
|
18149
|
+
|
18150
|
+
```json
|
18151
|
+
{
|
18152
|
+
"removed": 3
|
18153
|
+
}
|
18154
|
+
```
|
18155
|
+
|
18156
|
+
<br/>
|
18157
|
+
|
17980
18158
|
## Change Password
|
17981
18159
|
|
17982
18160
|
Schema for the body of a request to change the current user's password
|
@@ -18221,6 +18399,10 @@ Schema for a single Dashboard
|
|
18221
18399
|
"timezone": {
|
18222
18400
|
"type": "string",
|
18223
18401
|
"maxLength": 255
|
18402
|
+
},
|
18403
|
+
"locale": {
|
18404
|
+
"type": "string",
|
18405
|
+
"maxLength": 5
|
18224
18406
|
}
|
18225
18407
|
},
|
18226
18408
|
"additionalProperties": false,
|
@@ -18353,7 +18535,7 @@ Schema for a single Dashboard
|
|
18353
18535
|
},
|
18354
18536
|
{
|
18355
18537
|
"type": "string",
|
18356
|
-
"maxLength":
|
18538
|
+
"maxLength": 128
|
18357
18539
|
}
|
18358
18540
|
]
|
18359
18541
|
},
|
@@ -18364,7 +18546,7 @@ Schema for a single Dashboard
|
|
18364
18546
|
},
|
18365
18547
|
{
|
18366
18548
|
"type": "string",
|
18367
|
-
"maxLength":
|
18549
|
+
"maxLength": 128
|
18368
18550
|
}
|
18369
18551
|
]
|
18370
18552
|
},
|
@@ -19805,7 +19987,7 @@ Schema for a single Dashboard
|
|
19805
19987
|
},
|
19806
19988
|
{
|
19807
19989
|
"type": "string",
|
19808
|
-
"maxLength":
|
19990
|
+
"maxLength": 128
|
19809
19991
|
}
|
19810
19992
|
]
|
19811
19993
|
},
|
@@ -19816,7 +19998,7 @@ Schema for a single Dashboard
|
|
19816
19998
|
},
|
19817
19999
|
{
|
19818
20000
|
"type": "string",
|
19819
|
-
"maxLength":
|
20001
|
+
"maxLength": 128
|
19820
20002
|
}
|
19821
20003
|
]
|
19822
20004
|
},
|
@@ -19837,7 +20019,7 @@ Schema for a single Dashboard
|
|
19837
20019
|
},
|
19838
20020
|
{
|
19839
20021
|
"type": "string",
|
19840
|
-
"maxLength":
|
20022
|
+
"maxLength": 128
|
19841
20023
|
}
|
19842
20024
|
]
|
19843
20025
|
},
|
@@ -20300,7 +20482,7 @@ Schema for a single Dashboard
|
|
20300
20482
|
},
|
20301
20483
|
{
|
20302
20484
|
"type": "string",
|
20303
|
-
"maxLength":
|
20485
|
+
"maxLength": 128
|
20304
20486
|
}
|
20305
20487
|
]
|
20306
20488
|
},
|
@@ -20311,7 +20493,7 @@ Schema for a single Dashboard
|
|
20311
20493
|
},
|
20312
20494
|
{
|
20313
20495
|
"type": "string",
|
20314
|
-
"maxLength":
|
20496
|
+
"maxLength": 128
|
20315
20497
|
}
|
20316
20498
|
]
|
20317
20499
|
},
|
@@ -20458,7 +20640,7 @@ Schema for a single Dashboard
|
|
20458
20640
|
},
|
20459
20641
|
{
|
20460
20642
|
"type": "string",
|
20461
|
-
"maxLength":
|
20643
|
+
"maxLength": 128
|
20462
20644
|
}
|
20463
20645
|
]
|
20464
20646
|
},
|
@@ -21233,7 +21415,7 @@ Schema for a single Dashboard
|
|
21233
21415
|
},
|
21234
21416
|
{
|
21235
21417
|
"type": "string",
|
21236
|
-
"maxLength":
|
21418
|
+
"maxLength": 128
|
21237
21419
|
}
|
21238
21420
|
]
|
21239
21421
|
},
|
@@ -21244,7 +21426,7 @@ Schema for a single Dashboard
|
|
21244
21426
|
},
|
21245
21427
|
{
|
21246
21428
|
"type": "string",
|
21247
|
-
"maxLength":
|
21429
|
+
"maxLength": 128
|
21248
21430
|
}
|
21249
21431
|
]
|
21250
21432
|
},
|
@@ -21852,7 +22034,7 @@ Schema for a single Dashboard
|
|
21852
22034
|
},
|
21853
22035
|
{
|
21854
22036
|
"type": "string",
|
21855
|
-
"maxLength":
|
22037
|
+
"maxLength": 128
|
21856
22038
|
}
|
21857
22039
|
]
|
21858
22040
|
},
|
@@ -21863,7 +22045,7 @@ Schema for a single Dashboard
|
|
21863
22045
|
},
|
21864
22046
|
{
|
21865
22047
|
"type": "string",
|
21866
|
-
"maxLength":
|
22048
|
+
"maxLength": 128
|
21867
22049
|
}
|
21868
22050
|
]
|
21869
22051
|
},
|
@@ -21874,7 +22056,7 @@ Schema for a single Dashboard
|
|
21874
22056
|
},
|
21875
22057
|
{
|
21876
22058
|
"type": "string",
|
21877
|
-
"maxLength":
|
22059
|
+
"maxLength": 128
|
21878
22060
|
}
|
21879
22061
|
]
|
21880
22062
|
},
|
@@ -21885,7 +22067,7 @@ Schema for a single Dashboard
|
|
21885
22067
|
},
|
21886
22068
|
{
|
21887
22069
|
"type": "string",
|
21888
|
-
"maxLength":
|
22070
|
+
"maxLength": 128
|
21889
22071
|
}
|
21890
22072
|
]
|
21891
22073
|
}
|
@@ -22732,7 +22914,7 @@ Schema for a single Dashboard
|
|
22732
22914
|
},
|
22733
22915
|
{
|
22734
22916
|
"type": "string",
|
22735
|
-
"maxLength":
|
22917
|
+
"maxLength": 128
|
22736
22918
|
}
|
22737
22919
|
]
|
22738
22920
|
},
|
@@ -23243,7 +23425,7 @@ Schema for a single Dashboard
|
|
23243
23425
|
},
|
23244
23426
|
{
|
23245
23427
|
"type": "string",
|
23246
|
-
"maxLength":
|
23428
|
+
"maxLength": 128
|
23247
23429
|
}
|
23248
23430
|
]
|
23249
23431
|
},
|
@@ -23850,7 +24032,7 @@ Schema for a single Dashboard
|
|
23850
24032
|
"toEmail": [
|
23851
24033
|
"test@email.com"
|
23852
24034
|
],
|
23853
|
-
"cron": "0 0 12 * *
|
24035
|
+
"cron": "0 0 12 * * TUE-THU",
|
23854
24036
|
"theme": "dark",
|
23855
24037
|
"subject": "Daily Dashboard Report"
|
23856
24038
|
}
|
@@ -24133,7 +24315,7 @@ Schema for the body of a Dashboard modification request
|
|
24133
24315
|
},
|
24134
24316
|
{
|
24135
24317
|
"type": "string",
|
24136
|
-
"maxLength":
|
24318
|
+
"maxLength": 128
|
24137
24319
|
}
|
24138
24320
|
]
|
24139
24321
|
},
|
@@ -24144,7 +24326,7 @@ Schema for the body of a Dashboard modification request
|
|
24144
24326
|
},
|
24145
24327
|
{
|
24146
24328
|
"type": "string",
|
24147
|
-
"maxLength":
|
24329
|
+
"maxLength": 128
|
24148
24330
|
}
|
24149
24331
|
]
|
24150
24332
|
},
|
@@ -25585,7 +25767,7 @@ Schema for the body of a Dashboard modification request
|
|
25585
25767
|
},
|
25586
25768
|
{
|
25587
25769
|
"type": "string",
|
25588
|
-
"maxLength":
|
25770
|
+
"maxLength": 128
|
25589
25771
|
}
|
25590
25772
|
]
|
25591
25773
|
},
|
@@ -25596,7 +25778,7 @@ Schema for the body of a Dashboard modification request
|
|
25596
25778
|
},
|
25597
25779
|
{
|
25598
25780
|
"type": "string",
|
25599
|
-
"maxLength":
|
25781
|
+
"maxLength": 128
|
25600
25782
|
}
|
25601
25783
|
]
|
25602
25784
|
},
|
@@ -25617,7 +25799,7 @@ Schema for the body of a Dashboard modification request
|
|
25617
25799
|
},
|
25618
25800
|
{
|
25619
25801
|
"type": "string",
|
25620
|
-
"maxLength":
|
25802
|
+
"maxLength": 128
|
25621
25803
|
}
|
25622
25804
|
]
|
25623
25805
|
},
|
@@ -26080,7 +26262,7 @@ Schema for the body of a Dashboard modification request
|
|
26080
26262
|
},
|
26081
26263
|
{
|
26082
26264
|
"type": "string",
|
26083
|
-
"maxLength":
|
26265
|
+
"maxLength": 128
|
26084
26266
|
}
|
26085
26267
|
]
|
26086
26268
|
},
|
@@ -26091,7 +26273,7 @@ Schema for the body of a Dashboard modification request
|
|
26091
26273
|
},
|
26092
26274
|
{
|
26093
26275
|
"type": "string",
|
26094
|
-
"maxLength":
|
26276
|
+
"maxLength": 128
|
26095
26277
|
}
|
26096
26278
|
]
|
26097
26279
|
},
|
@@ -26238,7 +26420,7 @@ Schema for the body of a Dashboard modification request
|
|
26238
26420
|
},
|
26239
26421
|
{
|
26240
26422
|
"type": "string",
|
26241
|
-
"maxLength":
|
26423
|
+
"maxLength": 128
|
26242
26424
|
}
|
26243
26425
|
]
|
26244
26426
|
},
|
@@ -27013,7 +27195,7 @@ Schema for the body of a Dashboard modification request
|
|
27013
27195
|
},
|
27014
27196
|
{
|
27015
27197
|
"type": "string",
|
27016
|
-
"maxLength":
|
27198
|
+
"maxLength": 128
|
27017
27199
|
}
|
27018
27200
|
]
|
27019
27201
|
},
|
@@ -27024,7 +27206,7 @@ Schema for the body of a Dashboard modification request
|
|
27024
27206
|
},
|
27025
27207
|
{
|
27026
27208
|
"type": "string",
|
27027
|
-
"maxLength":
|
27209
|
+
"maxLength": 128
|
27028
27210
|
}
|
27029
27211
|
]
|
27030
27212
|
},
|
@@ -27632,7 +27814,7 @@ Schema for the body of a Dashboard modification request
|
|
27632
27814
|
},
|
27633
27815
|
{
|
27634
27816
|
"type": "string",
|
27635
|
-
"maxLength":
|
27817
|
+
"maxLength": 128
|
27636
27818
|
}
|
27637
27819
|
]
|
27638
27820
|
},
|
@@ -27643,7 +27825,7 @@ Schema for the body of a Dashboard modification request
|
|
27643
27825
|
},
|
27644
27826
|
{
|
27645
27827
|
"type": "string",
|
27646
|
-
"maxLength":
|
27828
|
+
"maxLength": 128
|
27647
27829
|
}
|
27648
27830
|
]
|
27649
27831
|
},
|
@@ -27654,7 +27836,7 @@ Schema for the body of a Dashboard modification request
|
|
27654
27836
|
},
|
27655
27837
|
{
|
27656
27838
|
"type": "string",
|
27657
|
-
"maxLength":
|
27839
|
+
"maxLength": 128
|
27658
27840
|
}
|
27659
27841
|
]
|
27660
27842
|
},
|
@@ -27665,7 +27847,7 @@ Schema for the body of a Dashboard modification request
|
|
27665
27847
|
},
|
27666
27848
|
{
|
27667
27849
|
"type": "string",
|
27668
|
-
"maxLength":
|
27850
|
+
"maxLength": 128
|
27669
27851
|
}
|
27670
27852
|
]
|
27671
27853
|
}
|
@@ -28512,7 +28694,7 @@ Schema for the body of a Dashboard modification request
|
|
28512
28694
|
},
|
28513
28695
|
{
|
28514
28696
|
"type": "string",
|
28515
|
-
"maxLength":
|
28697
|
+
"maxLength": 128
|
28516
28698
|
}
|
28517
28699
|
]
|
28518
28700
|
},
|
@@ -29023,7 +29205,7 @@ Schema for the body of a Dashboard modification request
|
|
29023
29205
|
},
|
29024
29206
|
{
|
29025
29207
|
"type": "string",
|
29026
|
-
"maxLength":
|
29208
|
+
"maxLength": 128
|
29027
29209
|
}
|
29028
29210
|
]
|
29029
29211
|
},
|
@@ -29320,6 +29502,10 @@ Schema for the body of a Dashboard modification request
|
|
29320
29502
|
"timezone": {
|
29321
29503
|
"type": "string",
|
29322
29504
|
"maxLength": 255
|
29505
|
+
},
|
29506
|
+
"locale": {
|
29507
|
+
"type": "string",
|
29508
|
+
"maxLength": 5
|
29323
29509
|
}
|
29324
29510
|
},
|
29325
29511
|
"additionalProperties": false,
|
@@ -29842,7 +30028,7 @@ Schema for the body of a Dashboard creation request
|
|
29842
30028
|
},
|
29843
30029
|
{
|
29844
30030
|
"type": "string",
|
29845
|
-
"maxLength":
|
30031
|
+
"maxLength": 128
|
29846
30032
|
}
|
29847
30033
|
]
|
29848
30034
|
},
|
@@ -29853,7 +30039,7 @@ Schema for the body of a Dashboard creation request
|
|
29853
30039
|
},
|
29854
30040
|
{
|
29855
30041
|
"type": "string",
|
29856
|
-
"maxLength":
|
30042
|
+
"maxLength": 128
|
29857
30043
|
}
|
29858
30044
|
]
|
29859
30045
|
},
|
@@ -31294,7 +31480,7 @@ Schema for the body of a Dashboard creation request
|
|
31294
31480
|
},
|
31295
31481
|
{
|
31296
31482
|
"type": "string",
|
31297
|
-
"maxLength":
|
31483
|
+
"maxLength": 128
|
31298
31484
|
}
|
31299
31485
|
]
|
31300
31486
|
},
|
@@ -31305,7 +31491,7 @@ Schema for the body of a Dashboard creation request
|
|
31305
31491
|
},
|
31306
31492
|
{
|
31307
31493
|
"type": "string",
|
31308
|
-
"maxLength":
|
31494
|
+
"maxLength": 128
|
31309
31495
|
}
|
31310
31496
|
]
|
31311
31497
|
},
|
@@ -31326,7 +31512,7 @@ Schema for the body of a Dashboard creation request
|
|
31326
31512
|
},
|
31327
31513
|
{
|
31328
31514
|
"type": "string",
|
31329
|
-
"maxLength":
|
31515
|
+
"maxLength": 128
|
31330
31516
|
}
|
31331
31517
|
]
|
31332
31518
|
},
|
@@ -31789,7 +31975,7 @@ Schema for the body of a Dashboard creation request
|
|
31789
31975
|
},
|
31790
31976
|
{
|
31791
31977
|
"type": "string",
|
31792
|
-
"maxLength":
|
31978
|
+
"maxLength": 128
|
31793
31979
|
}
|
31794
31980
|
]
|
31795
31981
|
},
|
@@ -31800,7 +31986,7 @@ Schema for the body of a Dashboard creation request
|
|
31800
31986
|
},
|
31801
31987
|
{
|
31802
31988
|
"type": "string",
|
31803
|
-
"maxLength":
|
31989
|
+
"maxLength": 128
|
31804
31990
|
}
|
31805
31991
|
]
|
31806
31992
|
},
|
@@ -31947,7 +32133,7 @@ Schema for the body of a Dashboard creation request
|
|
31947
32133
|
},
|
31948
32134
|
{
|
31949
32135
|
"type": "string",
|
31950
|
-
"maxLength":
|
32136
|
+
"maxLength": 128
|
31951
32137
|
}
|
31952
32138
|
]
|
31953
32139
|
},
|
@@ -32722,7 +32908,7 @@ Schema for the body of a Dashboard creation request
|
|
32722
32908
|
},
|
32723
32909
|
{
|
32724
32910
|
"type": "string",
|
32725
|
-
"maxLength":
|
32911
|
+
"maxLength": 128
|
32726
32912
|
}
|
32727
32913
|
]
|
32728
32914
|
},
|
@@ -32733,7 +32919,7 @@ Schema for the body of a Dashboard creation request
|
|
32733
32919
|
},
|
32734
32920
|
{
|
32735
32921
|
"type": "string",
|
32736
|
-
"maxLength":
|
32922
|
+
"maxLength": 128
|
32737
32923
|
}
|
32738
32924
|
]
|
32739
32925
|
},
|
@@ -33341,7 +33527,7 @@ Schema for the body of a Dashboard creation request
|
|
33341
33527
|
},
|
33342
33528
|
{
|
33343
33529
|
"type": "string",
|
33344
|
-
"maxLength":
|
33530
|
+
"maxLength": 128
|
33345
33531
|
}
|
33346
33532
|
]
|
33347
33533
|
},
|
@@ -33352,7 +33538,7 @@ Schema for the body of a Dashboard creation request
|
|
33352
33538
|
},
|
33353
33539
|
{
|
33354
33540
|
"type": "string",
|
33355
|
-
"maxLength":
|
33541
|
+
"maxLength": 128
|
33356
33542
|
}
|
33357
33543
|
]
|
33358
33544
|
},
|
@@ -33363,7 +33549,7 @@ Schema for the body of a Dashboard creation request
|
|
33363
33549
|
},
|
33364
33550
|
{
|
33365
33551
|
"type": "string",
|
33366
|
-
"maxLength":
|
33552
|
+
"maxLength": 128
|
33367
33553
|
}
|
33368
33554
|
]
|
33369
33555
|
},
|
@@ -33374,7 +33560,7 @@ Schema for the body of a Dashboard creation request
|
|
33374
33560
|
},
|
33375
33561
|
{
|
33376
33562
|
"type": "string",
|
33377
|
-
"maxLength":
|
33563
|
+
"maxLength": 128
|
33378
33564
|
}
|
33379
33565
|
]
|
33380
33566
|
}
|
@@ -34221,7 +34407,7 @@ Schema for the body of a Dashboard creation request
|
|
34221
34407
|
},
|
34222
34408
|
{
|
34223
34409
|
"type": "string",
|
34224
|
-
"maxLength":
|
34410
|
+
"maxLength": 128
|
34225
34411
|
}
|
34226
34412
|
]
|
34227
34413
|
},
|
@@ -34732,7 +34918,7 @@ Schema for the body of a Dashboard creation request
|
|
34732
34918
|
},
|
34733
34919
|
{
|
34734
34920
|
"type": "string",
|
34735
|
-
"maxLength":
|
34921
|
+
"maxLength": 128
|
34736
34922
|
}
|
34737
34923
|
]
|
34738
34924
|
},
|
@@ -35045,6 +35231,10 @@ Schema for the body of a Dashboard creation request
|
|
35045
35231
|
"timezone": {
|
35046
35232
|
"type": "string",
|
35047
35233
|
"maxLength": 255
|
35234
|
+
},
|
35235
|
+
"locale": {
|
35236
|
+
"type": "string",
|
35237
|
+
"maxLength": 5
|
35048
35238
|
}
|
35049
35239
|
},
|
35050
35240
|
"additionalProperties": false,
|
@@ -35450,6 +35640,10 @@ Schema for the body of a Dashboard report request
|
|
35450
35640
|
"timezone": {
|
35451
35641
|
"type": "string",
|
35452
35642
|
"max": 255
|
35643
|
+
},
|
35644
|
+
"locale": {
|
35645
|
+
"type": "string",
|
35646
|
+
"max": 5
|
35453
35647
|
}
|
35454
35648
|
},
|
35455
35649
|
"additionalProperties": false
|
@@ -35466,7 +35660,8 @@ Schema for the body of a Dashboard report request
|
|
35466
35660
|
"message": "Lookit",
|
35467
35661
|
"time": 1551887386704,
|
35468
35662
|
"theme": "dark",
|
35469
|
-
"timezone": "America/New_York"
|
35663
|
+
"timezone": "America/New_York",
|
35664
|
+
"locale": "en-us"
|
35470
35665
|
}
|
35471
35666
|
```
|
35472
35667
|
|
@@ -35674,6 +35869,10 @@ Schema for a collection of Dashboards
|
|
35674
35869
|
"timezone": {
|
35675
35870
|
"type": "string",
|
35676
35871
|
"maxLength": 255
|
35872
|
+
},
|
35873
|
+
"locale": {
|
35874
|
+
"type": "string",
|
35875
|
+
"maxLength": 5
|
35677
35876
|
}
|
35678
35877
|
},
|
35679
35878
|
"additionalProperties": false,
|
@@ -35806,7 +36005,7 @@ Schema for a collection of Dashboards
|
|
35806
36005
|
},
|
35807
36006
|
{
|
35808
36007
|
"type": "string",
|
35809
|
-
"maxLength":
|
36008
|
+
"maxLength": 128
|
35810
36009
|
}
|
35811
36010
|
]
|
35812
36011
|
},
|
@@ -35817,7 +36016,7 @@ Schema for a collection of Dashboards
|
|
35817
36016
|
},
|
35818
36017
|
{
|
35819
36018
|
"type": "string",
|
35820
|
-
"maxLength":
|
36019
|
+
"maxLength": 128
|
35821
36020
|
}
|
35822
36021
|
]
|
35823
36022
|
},
|
@@ -37258,7 +37457,7 @@ Schema for a collection of Dashboards
|
|
37258
37457
|
},
|
37259
37458
|
{
|
37260
37459
|
"type": "string",
|
37261
|
-
"maxLength":
|
37460
|
+
"maxLength": 128
|
37262
37461
|
}
|
37263
37462
|
]
|
37264
37463
|
},
|
@@ -37269,7 +37468,7 @@ Schema for a collection of Dashboards
|
|
37269
37468
|
},
|
37270
37469
|
{
|
37271
37470
|
"type": "string",
|
37272
|
-
"maxLength":
|
37471
|
+
"maxLength": 128
|
37273
37472
|
}
|
37274
37473
|
]
|
37275
37474
|
},
|
@@ -37290,7 +37489,7 @@ Schema for a collection of Dashboards
|
|
37290
37489
|
},
|
37291
37490
|
{
|
37292
37491
|
"type": "string",
|
37293
|
-
"maxLength":
|
37492
|
+
"maxLength": 128
|
37294
37493
|
}
|
37295
37494
|
]
|
37296
37495
|
},
|
@@ -37753,7 +37952,7 @@ Schema for a collection of Dashboards
|
|
37753
37952
|
},
|
37754
37953
|
{
|
37755
37954
|
"type": "string",
|
37756
|
-
"maxLength":
|
37955
|
+
"maxLength": 128
|
37757
37956
|
}
|
37758
37957
|
]
|
37759
37958
|
},
|
@@ -37764,7 +37963,7 @@ Schema for a collection of Dashboards
|
|
37764
37963
|
},
|
37765
37964
|
{
|
37766
37965
|
"type": "string",
|
37767
|
-
"maxLength":
|
37966
|
+
"maxLength": 128
|
37768
37967
|
}
|
37769
37968
|
]
|
37770
37969
|
},
|
@@ -37911,7 +38110,7 @@ Schema for a collection of Dashboards
|
|
37911
38110
|
},
|
37912
38111
|
{
|
37913
38112
|
"type": "string",
|
37914
|
-
"maxLength":
|
38113
|
+
"maxLength": 128
|
37915
38114
|
}
|
37916
38115
|
]
|
37917
38116
|
},
|
@@ -38686,7 +38885,7 @@ Schema for a collection of Dashboards
|
|
38686
38885
|
},
|
38687
38886
|
{
|
38688
38887
|
"type": "string",
|
38689
|
-
"maxLength":
|
38888
|
+
"maxLength": 128
|
38690
38889
|
}
|
38691
38890
|
]
|
38692
38891
|
},
|
@@ -38697,7 +38896,7 @@ Schema for a collection of Dashboards
|
|
38697
38896
|
},
|
38698
38897
|
{
|
38699
38898
|
"type": "string",
|
38700
|
-
"maxLength":
|
38899
|
+
"maxLength": 128
|
38701
38900
|
}
|
38702
38901
|
]
|
38703
38902
|
},
|
@@ -39305,7 +39504,7 @@ Schema for a collection of Dashboards
|
|
39305
39504
|
},
|
39306
39505
|
{
|
39307
39506
|
"type": "string",
|
39308
|
-
"maxLength":
|
39507
|
+
"maxLength": 128
|
39309
39508
|
}
|
39310
39509
|
]
|
39311
39510
|
},
|
@@ -39316,7 +39515,7 @@ Schema for a collection of Dashboards
|
|
39316
39515
|
},
|
39317
39516
|
{
|
39318
39517
|
"type": "string",
|
39319
|
-
"maxLength":
|
39518
|
+
"maxLength": 128
|
39320
39519
|
}
|
39321
39520
|
]
|
39322
39521
|
},
|
@@ -39327,7 +39526,7 @@ Schema for a collection of Dashboards
|
|
39327
39526
|
},
|
39328
39527
|
{
|
39329
39528
|
"type": "string",
|
39330
|
-
"maxLength":
|
39529
|
+
"maxLength": 128
|
39331
39530
|
}
|
39332
39531
|
]
|
39333
39532
|
},
|
@@ -39338,7 +39537,7 @@ Schema for a collection of Dashboards
|
|
39338
39537
|
},
|
39339
39538
|
{
|
39340
39539
|
"type": "string",
|
39341
|
-
"maxLength":
|
39540
|
+
"maxLength": 128
|
39342
39541
|
}
|
39343
39542
|
]
|
39344
39543
|
}
|
@@ -40185,7 +40384,7 @@ Schema for a collection of Dashboards
|
|
40185
40384
|
},
|
40186
40385
|
{
|
40187
40386
|
"type": "string",
|
40188
|
-
"maxLength":
|
40387
|
+
"maxLength": 128
|
40189
40388
|
}
|
40190
40389
|
]
|
40191
40390
|
},
|
@@ -40696,7 +40895,7 @@ Schema for a collection of Dashboards
|
|
40696
40895
|
},
|
40697
40896
|
{
|
40698
40897
|
"type": "string",
|
40699
|
-
"maxLength":
|
40898
|
+
"maxLength": 128
|
40700
40899
|
}
|
40701
40900
|
]
|
40702
40901
|
},
|
@@ -41347,7 +41546,7 @@ Schema for a collection of Dashboards
|
|
41347
41546
|
"toEmail": [
|
41348
41547
|
"test@email.com"
|
41349
41548
|
],
|
41350
|
-
"cron": "0 0 12 * *
|
41549
|
+
"cron": "0 0 12 * * TUE-THU",
|
41351
41550
|
"theme": "dark",
|
41352
41551
|
"subject": "Daily Dashboard Report"
|
41353
41552
|
}
|
@@ -47349,36 +47548,6 @@ Schema for the body of a bulk device delete request
|
|
47349
47548
|
|
47350
47549
|
<br/>
|
47351
47550
|
|
47352
|
-
## Devices Deleted
|
47353
|
-
|
47354
|
-
Schema for response to devices removal
|
47355
|
-
|
47356
|
-
### <a name="devices-deleted-schema"></a> Schema
|
47357
|
-
|
47358
|
-
```json
|
47359
|
-
{
|
47360
|
-
"$schema": "http://json-schema.org/draft-04/schema#",
|
47361
|
-
"type": "object",
|
47362
|
-
"properties": {
|
47363
|
-
"removed": {
|
47364
|
-
"type": "number"
|
47365
|
-
},
|
47366
|
-
"failed": {
|
47367
|
-
"type": "number"
|
47368
|
-
}
|
47369
|
-
}
|
47370
|
-
}
|
47371
|
-
```
|
47372
|
-
### <a name="devices-deleted-example"></a> Example
|
47373
|
-
|
47374
|
-
```json
|
47375
|
-
{
|
47376
|
-
"removed": 3
|
47377
|
-
}
|
47378
|
-
```
|
47379
|
-
|
47380
|
-
<br/>
|
47381
|
-
|
47382
47551
|
## Devices Metadata Export Post
|
47383
47552
|
|
47384
47553
|
Schema for the body of a device metadata export request
|
@@ -56390,6 +56559,12 @@ Schema for a single Experience Group
|
|
56390
56559
|
"type": "null"
|
56391
56560
|
}
|
56392
56561
|
]
|
56562
|
+
},
|
56563
|
+
"directDeviceCount": {
|
56564
|
+
"type": "number"
|
56565
|
+
},
|
56566
|
+
"totalDeviceCount": {
|
56567
|
+
"type": "number"
|
56393
56568
|
}
|
56394
56569
|
}
|
56395
56570
|
}
|
@@ -56786,6 +56961,12 @@ Schema for a collection of Experience Groups
|
|
56786
56961
|
"type": "null"
|
56787
56962
|
}
|
56788
56963
|
]
|
56964
|
+
},
|
56965
|
+
"directDeviceCount": {
|
56966
|
+
"type": "number"
|
56967
|
+
},
|
56968
|
+
"totalDeviceCount": {
|
56969
|
+
"type": "number"
|
56789
56970
|
}
|
56790
56971
|
}
|
56791
56972
|
}
|
@@ -83237,231 +83418,1195 @@ Schema for a collection of Workflow Versions
|
|
83237
83418
|
|
83238
83419
|
<br/>
|
83239
83420
|
|
83240
|
-
##
|
83421
|
+
## Flow Versions Delete Post
|
83241
83422
|
|
83242
|
-
Schema for
|
83423
|
+
Schema for the body of a bulk flow versions delete request
|
83243
83424
|
|
83244
|
-
### <a name="
|
83425
|
+
### <a name="flow-versions-delete-post-schema"></a> Schema
|
83245
83426
|
|
83246
83427
|
```json
|
83247
83428
|
{
|
83248
83429
|
"$schema": "http://json-schema.org/draft-04/schema#",
|
83249
83430
|
"type": "object",
|
83250
83431
|
"properties": {
|
83251
|
-
"
|
83252
|
-
"type": "
|
83253
|
-
"
|
83254
|
-
|
83255
|
-
|
83256
|
-
|
83257
|
-
|
83258
|
-
|
83259
|
-
|
83260
|
-
|
83261
|
-
|
83262
|
-
"
|
83263
|
-
|
83264
|
-
"
|
83265
|
-
},
|
83266
|
-
"applicationId": {
|
83267
|
-
"type": "string",
|
83268
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
83269
|
-
},
|
83270
|
-
"creationDate": {
|
83271
|
-
"type": "string",
|
83272
|
-
"format": "date-time"
|
83273
|
-
},
|
83274
|
-
"lastUpdated": {
|
83275
|
-
"type": "string",
|
83276
|
-
"format": "date-time"
|
83277
|
-
},
|
83278
|
-
"name": {
|
83279
|
-
"type": "string",
|
83280
|
-
"minLength": 1,
|
83281
|
-
"maxLength": 255
|
83282
|
-
},
|
83283
|
-
"description": {
|
83284
|
-
"type": "string",
|
83285
|
-
"maxLength": 32767
|
83286
|
-
},
|
83287
|
-
"iconData": {
|
83288
|
-
"type": "string",
|
83289
|
-
"maxLength": 32767,
|
83290
|
-
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
|
83291
|
-
},
|
83292
|
-
"enabled": {
|
83293
|
-
"type": "boolean"
|
83294
|
-
},
|
83295
|
-
"defaultVersionId": {
|
83296
|
-
"type": "string",
|
83297
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
83432
|
+
"email": {
|
83433
|
+
"type": "string",
|
83434
|
+
"format": "email",
|
83435
|
+
"maxLength": 1024
|
83436
|
+
},
|
83437
|
+
"query": {
|
83438
|
+
"title": "Advanced Workflow Version Query",
|
83439
|
+
"description": "Schema for advanced workflow queries",
|
83440
|
+
"type": "object",
|
83441
|
+
"properties": {
|
83442
|
+
"$and": {
|
83443
|
+
"type": "array",
|
83444
|
+
"items": {
|
83445
|
+
"$ref": "#/definitions/advancedFlowVersionQuery"
|
83298
83446
|
},
|
83299
|
-
"
|
83300
|
-
|
83301
|
-
|
83447
|
+
"maxItems": 100
|
83448
|
+
},
|
83449
|
+
"$or": {
|
83450
|
+
"type": "array",
|
83451
|
+
"items": {
|
83452
|
+
"$ref": "#/definitions/advancedFlowVersionQuery"
|
83302
83453
|
},
|
83303
|
-
"
|
83304
|
-
|
83305
|
-
|
83306
|
-
|
83307
|
-
|
83308
|
-
|
83309
|
-
"customNode"
|
83310
|
-
]
|
83454
|
+
"maxItems": 100
|
83455
|
+
},
|
83456
|
+
"$nor": {
|
83457
|
+
"type": "array",
|
83458
|
+
"items": {
|
83459
|
+
"$ref": "#/definitions/advancedFlowVersionQuery"
|
83311
83460
|
},
|
83312
|
-
"
|
83313
|
-
|
83314
|
-
|
83461
|
+
"maxItems": 100
|
83462
|
+
},
|
83463
|
+
"name": {
|
83464
|
+
"oneOf": [
|
83465
|
+
{
|
83466
|
+
"type": [
|
83467
|
+
"string",
|
83468
|
+
"number",
|
83469
|
+
"boolean",
|
83470
|
+
"null"
|
83471
|
+
]
|
83472
|
+
},
|
83473
|
+
{
|
83474
|
+
"type": "object",
|
83475
|
+
"properties": {
|
83476
|
+
"$eq": {
|
83477
|
+
"type": [
|
83478
|
+
"string",
|
83479
|
+
"number",
|
83480
|
+
"boolean",
|
83481
|
+
"null"
|
83482
|
+
]
|
83483
|
+
},
|
83484
|
+
"$ne": {
|
83485
|
+
"type": [
|
83486
|
+
"string",
|
83487
|
+
"number",
|
83488
|
+
"boolean",
|
83489
|
+
"null"
|
83490
|
+
]
|
83491
|
+
},
|
83492
|
+
"$gt": {
|
83493
|
+
"type": [
|
83494
|
+
"string",
|
83495
|
+
"number",
|
83496
|
+
"boolean",
|
83497
|
+
"null"
|
83498
|
+
]
|
83499
|
+
},
|
83500
|
+
"$lt": {
|
83501
|
+
"type": [
|
83502
|
+
"string",
|
83503
|
+
"number",
|
83504
|
+
"boolean",
|
83505
|
+
"null"
|
83506
|
+
]
|
83507
|
+
},
|
83508
|
+
"$gte": {
|
83509
|
+
"type": [
|
83510
|
+
"string",
|
83511
|
+
"number",
|
83512
|
+
"boolean",
|
83513
|
+
"null"
|
83514
|
+
]
|
83515
|
+
},
|
83516
|
+
"$lte": {
|
83517
|
+
"type": [
|
83518
|
+
"string",
|
83519
|
+
"number",
|
83520
|
+
"boolean",
|
83521
|
+
"null"
|
83522
|
+
]
|
83523
|
+
},
|
83524
|
+
"$startsWith": {
|
83525
|
+
"type": "string",
|
83526
|
+
"minLength": 1
|
83527
|
+
},
|
83528
|
+
"$endsWith": {
|
83529
|
+
"type": "string",
|
83530
|
+
"minLength": 1
|
83531
|
+
},
|
83532
|
+
"$contains": {
|
83533
|
+
"type": "string",
|
83534
|
+
"minLength": 1
|
83535
|
+
},
|
83536
|
+
"$ci": {
|
83537
|
+
"type": "boolean"
|
83538
|
+
},
|
83539
|
+
"$in": {
|
83540
|
+
"type": "array",
|
83541
|
+
"maxItems": 100,
|
83542
|
+
"items": {
|
83543
|
+
"type": [
|
83544
|
+
"string",
|
83545
|
+
"number",
|
83546
|
+
"boolean"
|
83547
|
+
]
|
83548
|
+
}
|
83549
|
+
},
|
83550
|
+
"$nin": {
|
83551
|
+
"type": "array",
|
83552
|
+
"maxItems": 100,
|
83553
|
+
"items": {
|
83554
|
+
"type": [
|
83555
|
+
"string",
|
83556
|
+
"number",
|
83557
|
+
"boolean"
|
83558
|
+
]
|
83559
|
+
}
|
83560
|
+
}
|
83561
|
+
},
|
83562
|
+
"additionalProperties": false
|
83563
|
+
}
|
83564
|
+
]
|
83565
|
+
},
|
83566
|
+
"id": {
|
83567
|
+
"oneOf": [
|
83568
|
+
{
|
83315
83569
|
"oneOf": [
|
83316
83570
|
{
|
83317
|
-
"type": "
|
83318
|
-
"
|
83319
|
-
"key": {
|
83320
|
-
"type": "string",
|
83321
|
-
"maxLength": 1024
|
83322
|
-
},
|
83323
|
-
"type": {
|
83324
|
-
"type": "string",
|
83325
|
-
"enum": [
|
83326
|
-
"customNodeStart",
|
83327
|
-
"deviceCommand",
|
83328
|
-
"deviceIdConnect",
|
83329
|
-
"deviceTagConnect",
|
83330
|
-
"deviceIdDisconnect",
|
83331
|
-
"deviceTagDisconnect",
|
83332
|
-
"integration",
|
83333
|
-
"notebook",
|
83334
|
-
"onBoot",
|
83335
|
-
"onConnect",
|
83336
|
-
"onDisconnect",
|
83337
|
-
"request",
|
83338
|
-
"udp",
|
83339
|
-
"webhook"
|
83340
|
-
]
|
83341
|
-
},
|
83342
|
-
"config": {
|
83343
|
-
"type": "object",
|
83344
|
-
"additionalProperties": false
|
83345
|
-
},
|
83346
|
-
"meta": {
|
83347
|
-
"type": "object",
|
83348
|
-
"properties": {
|
83349
|
-
"category": {
|
83350
|
-
"type": "string",
|
83351
|
-
"enum": [
|
83352
|
-
"trigger"
|
83353
|
-
]
|
83354
|
-
},
|
83355
|
-
"name": {
|
83356
|
-
"type": "string",
|
83357
|
-
"enum": [
|
83358
|
-
"customNodeStart",
|
83359
|
-
"deviceCommand",
|
83360
|
-
"deviceIdsTagsConnect",
|
83361
|
-
"deviceIdsTagsDisconnect",
|
83362
|
-
"flowError",
|
83363
|
-
"googlePubSub",
|
83364
|
-
"meridian",
|
83365
|
-
"mqtt",
|
83366
|
-
"notebook",
|
83367
|
-
"onBoot",
|
83368
|
-
"onConnect",
|
83369
|
-
"onDisconnect",
|
83370
|
-
"particle",
|
83371
|
-
"request",
|
83372
|
-
"udp",
|
83373
|
-
"webhook"
|
83374
|
-
]
|
83375
|
-
},
|
83376
|
-
"label": {
|
83377
|
-
"type": "string",
|
83378
|
-
"minLength": 1,
|
83379
|
-
"maxLength": 255
|
83380
|
-
},
|
83381
|
-
"x": {
|
83382
|
-
"type": "number"
|
83383
|
-
},
|
83384
|
-
"y": {
|
83385
|
-
"type": "number"
|
83386
|
-
},
|
83387
|
-
"uiId": {
|
83388
|
-
"type": "string",
|
83389
|
-
"maxLength": 48
|
83390
|
-
},
|
83391
|
-
"description": {
|
83392
|
-
"type": "string",
|
83393
|
-
"maxLength": 32767
|
83394
|
-
},
|
83395
|
-
"icon": {
|
83396
|
-
"type": "string",
|
83397
|
-
"maxLength": 1024
|
83398
|
-
},
|
83399
|
-
"color": {
|
83400
|
-
"type": "string",
|
83401
|
-
"maxLength": 1024
|
83402
|
-
},
|
83403
|
-
"inputCount": {
|
83404
|
-
"type": "number"
|
83405
|
-
},
|
83406
|
-
"outputCount": {
|
83407
|
-
"type": "number"
|
83408
|
-
},
|
83409
|
-
"triggerId": {
|
83410
|
-
"type": "string",
|
83411
|
-
"maxLength": 48
|
83412
|
-
},
|
83413
|
-
"id": {
|
83414
|
-
"type": "string",
|
83415
|
-
"maxLength": 48
|
83416
|
-
}
|
83417
|
-
},
|
83418
|
-
"additionalProperties": false
|
83419
|
-
},
|
83420
|
-
"outputIds": {
|
83421
|
-
"type": "array",
|
83422
|
-
"items": {
|
83423
|
-
"type": "array",
|
83424
|
-
"items": {
|
83425
|
-
"type": "string",
|
83426
|
-
"maxLength": 255
|
83427
|
-
},
|
83428
|
-
"maxItems": 100
|
83429
|
-
},
|
83430
|
-
"maxItems": 100
|
83431
|
-
}
|
83432
|
-
},
|
83433
|
-
"required": [
|
83434
|
-
"type"
|
83435
|
-
],
|
83436
|
-
"additionalProperties": false
|
83571
|
+
"type": "string",
|
83572
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
83437
83573
|
},
|
83438
83574
|
{
|
83439
|
-
"type": "
|
83440
|
-
|
83441
|
-
|
83575
|
+
"type": "null"
|
83576
|
+
}
|
83577
|
+
]
|
83578
|
+
},
|
83579
|
+
{
|
83580
|
+
"type": "object",
|
83581
|
+
"properties": {
|
83582
|
+
"$eq": {
|
83583
|
+
"oneOf": [
|
83584
|
+
{
|
83442
83585
|
"type": "string",
|
83443
|
-
"
|
83586
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
83444
83587
|
},
|
83445
|
-
|
83588
|
+
{
|
83589
|
+
"type": "null"
|
83590
|
+
}
|
83591
|
+
]
|
83592
|
+
},
|
83593
|
+
"$ne": {
|
83594
|
+
"oneOf": [
|
83595
|
+
{
|
83446
83596
|
"type": "string",
|
83447
|
-
"
|
83448
|
-
"dataTable"
|
83449
|
-
]
|
83597
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
83450
83598
|
},
|
83451
|
-
|
83452
|
-
"type": "
|
83453
|
-
|
83454
|
-
|
83455
|
-
|
83456
|
-
|
83457
|
-
|
83458
|
-
|
83459
|
-
|
83460
|
-
|
83461
|
-
|
83462
|
-
|
83463
|
-
|
83464
|
-
|
83599
|
+
{
|
83600
|
+
"type": "null"
|
83601
|
+
}
|
83602
|
+
]
|
83603
|
+
},
|
83604
|
+
"$in": {
|
83605
|
+
"type": "array",
|
83606
|
+
"maxItems": 100,
|
83607
|
+
"items": {
|
83608
|
+
"type": "string",
|
83609
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
83610
|
+
}
|
83611
|
+
},
|
83612
|
+
"$nin": {
|
83613
|
+
"type": "array",
|
83614
|
+
"maxItems": 100,
|
83615
|
+
"items": {
|
83616
|
+
"type": "string",
|
83617
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
83618
|
+
}
|
83619
|
+
}
|
83620
|
+
},
|
83621
|
+
"additionalProperties": false,
|
83622
|
+
"minProperties": 1,
|
83623
|
+
"maxProperties": 1
|
83624
|
+
}
|
83625
|
+
]
|
83626
|
+
},
|
83627
|
+
"creationDate": {
|
83628
|
+
"oneOf": [
|
83629
|
+
{
|
83630
|
+
"type": [
|
83631
|
+
"string",
|
83632
|
+
"number",
|
83633
|
+
"boolean",
|
83634
|
+
"null"
|
83635
|
+
]
|
83636
|
+
},
|
83637
|
+
{
|
83638
|
+
"type": "object",
|
83639
|
+
"properties": {
|
83640
|
+
"$eq": {
|
83641
|
+
"type": [
|
83642
|
+
"string",
|
83643
|
+
"number",
|
83644
|
+
"boolean",
|
83645
|
+
"null"
|
83646
|
+
]
|
83647
|
+
},
|
83648
|
+
"$ne": {
|
83649
|
+
"type": [
|
83650
|
+
"string",
|
83651
|
+
"number",
|
83652
|
+
"boolean",
|
83653
|
+
"null"
|
83654
|
+
]
|
83655
|
+
},
|
83656
|
+
"$gt": {
|
83657
|
+
"type": [
|
83658
|
+
"string",
|
83659
|
+
"number",
|
83660
|
+
"boolean",
|
83661
|
+
"null"
|
83662
|
+
]
|
83663
|
+
},
|
83664
|
+
"$lt": {
|
83665
|
+
"type": [
|
83666
|
+
"string",
|
83667
|
+
"number",
|
83668
|
+
"boolean",
|
83669
|
+
"null"
|
83670
|
+
]
|
83671
|
+
},
|
83672
|
+
"$gte": {
|
83673
|
+
"type": [
|
83674
|
+
"string",
|
83675
|
+
"number",
|
83676
|
+
"boolean",
|
83677
|
+
"null"
|
83678
|
+
]
|
83679
|
+
},
|
83680
|
+
"$lte": {
|
83681
|
+
"type": [
|
83682
|
+
"string",
|
83683
|
+
"number",
|
83684
|
+
"boolean",
|
83685
|
+
"null"
|
83686
|
+
]
|
83687
|
+
},
|
83688
|
+
"$startsWith": {
|
83689
|
+
"type": "string",
|
83690
|
+
"minLength": 1
|
83691
|
+
},
|
83692
|
+
"$endsWith": {
|
83693
|
+
"type": "string",
|
83694
|
+
"minLength": 1
|
83695
|
+
},
|
83696
|
+
"$contains": {
|
83697
|
+
"type": "string",
|
83698
|
+
"minLength": 1
|
83699
|
+
},
|
83700
|
+
"$ci": {
|
83701
|
+
"type": "boolean"
|
83702
|
+
},
|
83703
|
+
"$in": {
|
83704
|
+
"type": "array",
|
83705
|
+
"maxItems": 100,
|
83706
|
+
"items": {
|
83707
|
+
"type": [
|
83708
|
+
"string",
|
83709
|
+
"number",
|
83710
|
+
"boolean"
|
83711
|
+
]
|
83712
|
+
}
|
83713
|
+
},
|
83714
|
+
"$nin": {
|
83715
|
+
"type": "array",
|
83716
|
+
"maxItems": 100,
|
83717
|
+
"items": {
|
83718
|
+
"type": [
|
83719
|
+
"string",
|
83720
|
+
"number",
|
83721
|
+
"boolean"
|
83722
|
+
]
|
83723
|
+
}
|
83724
|
+
}
|
83725
|
+
},
|
83726
|
+
"additionalProperties": false
|
83727
|
+
}
|
83728
|
+
]
|
83729
|
+
},
|
83730
|
+
"lastUpdated": {
|
83731
|
+
"oneOf": [
|
83732
|
+
{
|
83733
|
+
"type": [
|
83734
|
+
"string",
|
83735
|
+
"number",
|
83736
|
+
"boolean",
|
83737
|
+
"null"
|
83738
|
+
]
|
83739
|
+
},
|
83740
|
+
{
|
83741
|
+
"type": "object",
|
83742
|
+
"properties": {
|
83743
|
+
"$eq": {
|
83744
|
+
"type": [
|
83745
|
+
"string",
|
83746
|
+
"number",
|
83747
|
+
"boolean",
|
83748
|
+
"null"
|
83749
|
+
]
|
83750
|
+
},
|
83751
|
+
"$ne": {
|
83752
|
+
"type": [
|
83753
|
+
"string",
|
83754
|
+
"number",
|
83755
|
+
"boolean",
|
83756
|
+
"null"
|
83757
|
+
]
|
83758
|
+
},
|
83759
|
+
"$gt": {
|
83760
|
+
"type": [
|
83761
|
+
"string",
|
83762
|
+
"number",
|
83763
|
+
"boolean",
|
83764
|
+
"null"
|
83765
|
+
]
|
83766
|
+
},
|
83767
|
+
"$lt": {
|
83768
|
+
"type": [
|
83769
|
+
"string",
|
83770
|
+
"number",
|
83771
|
+
"boolean",
|
83772
|
+
"null"
|
83773
|
+
]
|
83774
|
+
},
|
83775
|
+
"$gte": {
|
83776
|
+
"type": [
|
83777
|
+
"string",
|
83778
|
+
"number",
|
83779
|
+
"boolean",
|
83780
|
+
"null"
|
83781
|
+
]
|
83782
|
+
},
|
83783
|
+
"$lte": {
|
83784
|
+
"type": [
|
83785
|
+
"string",
|
83786
|
+
"number",
|
83787
|
+
"boolean",
|
83788
|
+
"null"
|
83789
|
+
]
|
83790
|
+
},
|
83791
|
+
"$startsWith": {
|
83792
|
+
"type": "string",
|
83793
|
+
"minLength": 1
|
83794
|
+
},
|
83795
|
+
"$endsWith": {
|
83796
|
+
"type": "string",
|
83797
|
+
"minLength": 1
|
83798
|
+
},
|
83799
|
+
"$contains": {
|
83800
|
+
"type": "string",
|
83801
|
+
"minLength": 1
|
83802
|
+
},
|
83803
|
+
"$ci": {
|
83804
|
+
"type": "boolean"
|
83805
|
+
},
|
83806
|
+
"$in": {
|
83807
|
+
"type": "array",
|
83808
|
+
"maxItems": 100,
|
83809
|
+
"items": {
|
83810
|
+
"type": [
|
83811
|
+
"string",
|
83812
|
+
"number",
|
83813
|
+
"boolean"
|
83814
|
+
]
|
83815
|
+
}
|
83816
|
+
},
|
83817
|
+
"$nin": {
|
83818
|
+
"type": "array",
|
83819
|
+
"maxItems": 100,
|
83820
|
+
"items": {
|
83821
|
+
"type": [
|
83822
|
+
"string",
|
83823
|
+
"number",
|
83824
|
+
"boolean"
|
83825
|
+
]
|
83826
|
+
}
|
83827
|
+
}
|
83828
|
+
},
|
83829
|
+
"additionalProperties": false
|
83830
|
+
}
|
83831
|
+
]
|
83832
|
+
},
|
83833
|
+
"flowClass": {
|
83834
|
+
"oneOf": [
|
83835
|
+
{
|
83836
|
+
"type": [
|
83837
|
+
"string",
|
83838
|
+
"number",
|
83839
|
+
"boolean",
|
83840
|
+
"null"
|
83841
|
+
]
|
83842
|
+
},
|
83843
|
+
{
|
83844
|
+
"type": "object",
|
83845
|
+
"properties": {
|
83846
|
+
"$eq": {
|
83847
|
+
"type": [
|
83848
|
+
"string",
|
83849
|
+
"number",
|
83850
|
+
"boolean",
|
83851
|
+
"null"
|
83852
|
+
]
|
83853
|
+
},
|
83854
|
+
"$ne": {
|
83855
|
+
"type": [
|
83856
|
+
"string",
|
83857
|
+
"number",
|
83858
|
+
"boolean",
|
83859
|
+
"null"
|
83860
|
+
]
|
83861
|
+
},
|
83862
|
+
"$gt": {
|
83863
|
+
"type": [
|
83864
|
+
"string",
|
83865
|
+
"number",
|
83866
|
+
"boolean",
|
83867
|
+
"null"
|
83868
|
+
]
|
83869
|
+
},
|
83870
|
+
"$lt": {
|
83871
|
+
"type": [
|
83872
|
+
"string",
|
83873
|
+
"number",
|
83874
|
+
"boolean",
|
83875
|
+
"null"
|
83876
|
+
]
|
83877
|
+
},
|
83878
|
+
"$gte": {
|
83879
|
+
"type": [
|
83880
|
+
"string",
|
83881
|
+
"number",
|
83882
|
+
"boolean",
|
83883
|
+
"null"
|
83884
|
+
]
|
83885
|
+
},
|
83886
|
+
"$lte": {
|
83887
|
+
"type": [
|
83888
|
+
"string",
|
83889
|
+
"number",
|
83890
|
+
"boolean",
|
83891
|
+
"null"
|
83892
|
+
]
|
83893
|
+
},
|
83894
|
+
"$startsWith": {
|
83895
|
+
"type": "string",
|
83896
|
+
"minLength": 1
|
83897
|
+
},
|
83898
|
+
"$endsWith": {
|
83899
|
+
"type": "string",
|
83900
|
+
"minLength": 1
|
83901
|
+
},
|
83902
|
+
"$contains": {
|
83903
|
+
"type": "string",
|
83904
|
+
"minLength": 1
|
83905
|
+
},
|
83906
|
+
"$ci": {
|
83907
|
+
"type": "boolean"
|
83908
|
+
},
|
83909
|
+
"$in": {
|
83910
|
+
"type": "array",
|
83911
|
+
"maxItems": 100,
|
83912
|
+
"items": {
|
83913
|
+
"type": [
|
83914
|
+
"string",
|
83915
|
+
"number",
|
83916
|
+
"boolean"
|
83917
|
+
]
|
83918
|
+
}
|
83919
|
+
},
|
83920
|
+
"$nin": {
|
83921
|
+
"type": "array",
|
83922
|
+
"maxItems": 100,
|
83923
|
+
"items": {
|
83924
|
+
"type": [
|
83925
|
+
"string",
|
83926
|
+
"number",
|
83927
|
+
"boolean"
|
83928
|
+
]
|
83929
|
+
}
|
83930
|
+
}
|
83931
|
+
},
|
83932
|
+
"additionalProperties": false
|
83933
|
+
}
|
83934
|
+
]
|
83935
|
+
},
|
83936
|
+
"enabled": {
|
83937
|
+
"oneOf": [
|
83938
|
+
{
|
83939
|
+
"type": [
|
83940
|
+
"string",
|
83941
|
+
"number",
|
83942
|
+
"boolean",
|
83943
|
+
"null"
|
83944
|
+
]
|
83945
|
+
},
|
83946
|
+
{
|
83947
|
+
"type": "object",
|
83948
|
+
"properties": {
|
83949
|
+
"$eq": {
|
83950
|
+
"type": [
|
83951
|
+
"string",
|
83952
|
+
"number",
|
83953
|
+
"boolean",
|
83954
|
+
"null"
|
83955
|
+
]
|
83956
|
+
},
|
83957
|
+
"$ne": {
|
83958
|
+
"type": [
|
83959
|
+
"string",
|
83960
|
+
"number",
|
83961
|
+
"boolean",
|
83962
|
+
"null"
|
83963
|
+
]
|
83964
|
+
},
|
83965
|
+
"$gt": {
|
83966
|
+
"type": [
|
83967
|
+
"string",
|
83968
|
+
"number",
|
83969
|
+
"boolean",
|
83970
|
+
"null"
|
83971
|
+
]
|
83972
|
+
},
|
83973
|
+
"$lt": {
|
83974
|
+
"type": [
|
83975
|
+
"string",
|
83976
|
+
"number",
|
83977
|
+
"boolean",
|
83978
|
+
"null"
|
83979
|
+
]
|
83980
|
+
},
|
83981
|
+
"$gte": {
|
83982
|
+
"type": [
|
83983
|
+
"string",
|
83984
|
+
"number",
|
83985
|
+
"boolean",
|
83986
|
+
"null"
|
83987
|
+
]
|
83988
|
+
},
|
83989
|
+
"$lte": {
|
83990
|
+
"type": [
|
83991
|
+
"string",
|
83992
|
+
"number",
|
83993
|
+
"boolean",
|
83994
|
+
"null"
|
83995
|
+
]
|
83996
|
+
},
|
83997
|
+
"$startsWith": {
|
83998
|
+
"type": "string",
|
83999
|
+
"minLength": 1
|
84000
|
+
},
|
84001
|
+
"$endsWith": {
|
84002
|
+
"type": "string",
|
84003
|
+
"minLength": 1
|
84004
|
+
},
|
84005
|
+
"$contains": {
|
84006
|
+
"type": "string",
|
84007
|
+
"minLength": 1
|
84008
|
+
},
|
84009
|
+
"$ci": {
|
84010
|
+
"type": "boolean"
|
84011
|
+
},
|
84012
|
+
"$in": {
|
84013
|
+
"type": "array",
|
84014
|
+
"maxItems": 100,
|
84015
|
+
"items": {
|
84016
|
+
"type": [
|
84017
|
+
"string",
|
84018
|
+
"number",
|
84019
|
+
"boolean"
|
84020
|
+
]
|
84021
|
+
}
|
84022
|
+
},
|
84023
|
+
"$nin": {
|
84024
|
+
"type": "array",
|
84025
|
+
"maxItems": 100,
|
84026
|
+
"items": {
|
84027
|
+
"type": [
|
84028
|
+
"string",
|
84029
|
+
"number",
|
84030
|
+
"boolean"
|
84031
|
+
]
|
84032
|
+
}
|
84033
|
+
}
|
84034
|
+
},
|
84035
|
+
"additionalProperties": false
|
84036
|
+
}
|
84037
|
+
]
|
84038
|
+
},
|
84039
|
+
"version": {
|
84040
|
+
"oneOf": [
|
84041
|
+
{
|
84042
|
+
"type": [
|
84043
|
+
"string",
|
84044
|
+
"number",
|
84045
|
+
"boolean",
|
84046
|
+
"null"
|
84047
|
+
]
|
84048
|
+
},
|
84049
|
+
{
|
84050
|
+
"type": "object",
|
84051
|
+
"properties": {
|
84052
|
+
"$eq": {
|
84053
|
+
"type": [
|
84054
|
+
"string",
|
84055
|
+
"number",
|
84056
|
+
"boolean",
|
84057
|
+
"null"
|
84058
|
+
]
|
84059
|
+
},
|
84060
|
+
"$ne": {
|
84061
|
+
"type": [
|
84062
|
+
"string",
|
84063
|
+
"number",
|
84064
|
+
"boolean",
|
84065
|
+
"null"
|
84066
|
+
]
|
84067
|
+
},
|
84068
|
+
"$gt": {
|
84069
|
+
"type": [
|
84070
|
+
"string",
|
84071
|
+
"number",
|
84072
|
+
"boolean",
|
84073
|
+
"null"
|
84074
|
+
]
|
84075
|
+
},
|
84076
|
+
"$lt": {
|
84077
|
+
"type": [
|
84078
|
+
"string",
|
84079
|
+
"number",
|
84080
|
+
"boolean",
|
84081
|
+
"null"
|
84082
|
+
]
|
84083
|
+
},
|
84084
|
+
"$gte": {
|
84085
|
+
"type": [
|
84086
|
+
"string",
|
84087
|
+
"number",
|
84088
|
+
"boolean",
|
84089
|
+
"null"
|
84090
|
+
]
|
84091
|
+
},
|
84092
|
+
"$lte": {
|
84093
|
+
"type": [
|
84094
|
+
"string",
|
84095
|
+
"number",
|
84096
|
+
"boolean",
|
84097
|
+
"null"
|
84098
|
+
]
|
84099
|
+
},
|
84100
|
+
"$startsWith": {
|
84101
|
+
"type": "string",
|
84102
|
+
"minLength": 1
|
84103
|
+
},
|
84104
|
+
"$endsWith": {
|
84105
|
+
"type": "string",
|
84106
|
+
"minLength": 1
|
84107
|
+
},
|
84108
|
+
"$contains": {
|
84109
|
+
"type": "string",
|
84110
|
+
"minLength": 1
|
84111
|
+
},
|
84112
|
+
"$ci": {
|
84113
|
+
"type": "boolean"
|
84114
|
+
},
|
84115
|
+
"$in": {
|
84116
|
+
"type": "array",
|
84117
|
+
"maxItems": 100,
|
84118
|
+
"items": {
|
84119
|
+
"type": [
|
84120
|
+
"string",
|
84121
|
+
"number",
|
84122
|
+
"boolean"
|
84123
|
+
]
|
84124
|
+
}
|
84125
|
+
},
|
84126
|
+
"$nin": {
|
84127
|
+
"type": "array",
|
84128
|
+
"maxItems": 100,
|
84129
|
+
"items": {
|
84130
|
+
"type": [
|
84131
|
+
"string",
|
84132
|
+
"number",
|
84133
|
+
"boolean"
|
84134
|
+
]
|
84135
|
+
}
|
84136
|
+
}
|
84137
|
+
},
|
84138
|
+
"additionalProperties": false
|
84139
|
+
}
|
84140
|
+
]
|
84141
|
+
},
|
84142
|
+
"triggers": {
|
84143
|
+
"oneOf": [
|
84144
|
+
{
|
84145
|
+
"type": "object",
|
84146
|
+
"properties": {
|
84147
|
+
"type": {
|
84148
|
+
"type": "string",
|
84149
|
+
"maxLength": 255
|
84150
|
+
},
|
84151
|
+
"key": {
|
84152
|
+
"type": "string",
|
84153
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
84154
|
+
},
|
84155
|
+
"config": {
|
84156
|
+
"type": "object",
|
84157
|
+
"patternProperties": {
|
84158
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
84159
|
+
"type": [
|
84160
|
+
"string",
|
84161
|
+
"number",
|
84162
|
+
"boolean",
|
84163
|
+
"null"
|
84164
|
+
],
|
84165
|
+
"maxLength": 1024
|
84166
|
+
}
|
84167
|
+
}
|
84168
|
+
}
|
84169
|
+
},
|
84170
|
+
"required": [
|
84171
|
+
"type"
|
84172
|
+
],
|
84173
|
+
"additionalProperties": false
|
84174
|
+
},
|
84175
|
+
{
|
84176
|
+
"type": "object",
|
84177
|
+
"properties": {
|
84178
|
+
"$eq": {
|
84179
|
+
"type": "object",
|
84180
|
+
"properties": {
|
84181
|
+
"type": {
|
84182
|
+
"type": "string",
|
84183
|
+
"maxLength": 255
|
84184
|
+
},
|
84185
|
+
"key": {
|
84186
|
+
"type": "string",
|
84187
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
84188
|
+
},
|
84189
|
+
"config": {
|
84190
|
+
"type": "object",
|
84191
|
+
"patternProperties": {
|
84192
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
84193
|
+
"type": [
|
84194
|
+
"string",
|
84195
|
+
"number",
|
84196
|
+
"boolean",
|
84197
|
+
"null"
|
84198
|
+
],
|
84199
|
+
"maxLength": 1024
|
84200
|
+
}
|
84201
|
+
}
|
84202
|
+
}
|
84203
|
+
},
|
84204
|
+
"required": [
|
84205
|
+
"type"
|
84206
|
+
],
|
84207
|
+
"additionalProperties": false
|
84208
|
+
}
|
84209
|
+
},
|
84210
|
+
"required": [
|
84211
|
+
"$eq"
|
84212
|
+
],
|
84213
|
+
"additionalProperties": false
|
84214
|
+
},
|
84215
|
+
{
|
84216
|
+
"type": "object",
|
84217
|
+
"properties": {
|
84218
|
+
"$ne": {
|
84219
|
+
"type": "object",
|
84220
|
+
"properties": {
|
84221
|
+
"type": {
|
84222
|
+
"type": "string",
|
84223
|
+
"maxLength": 255
|
84224
|
+
},
|
84225
|
+
"key": {
|
84226
|
+
"type": "string",
|
84227
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
84228
|
+
},
|
84229
|
+
"config": {
|
84230
|
+
"type": "object",
|
84231
|
+
"patternProperties": {
|
84232
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
84233
|
+
"type": [
|
84234
|
+
"string",
|
84235
|
+
"number",
|
84236
|
+
"boolean",
|
84237
|
+
"null"
|
84238
|
+
],
|
84239
|
+
"maxLength": 1024
|
84240
|
+
}
|
84241
|
+
}
|
84242
|
+
}
|
84243
|
+
},
|
84244
|
+
"required": [
|
84245
|
+
"type"
|
84246
|
+
],
|
84247
|
+
"additionalProperties": false
|
84248
|
+
}
|
84249
|
+
},
|
84250
|
+
"required": [
|
84251
|
+
"$ne"
|
84252
|
+
],
|
84253
|
+
"additionalProperties": false
|
84254
|
+
}
|
84255
|
+
]
|
84256
|
+
},
|
84257
|
+
"nodes": {
|
84258
|
+
"oneOf": [
|
84259
|
+
{
|
84260
|
+
"type": "object",
|
84261
|
+
"properties": {
|
84262
|
+
"type": {
|
84263
|
+
"type": "string",
|
84264
|
+
"maxLength": 255
|
84265
|
+
},
|
84266
|
+
"config": {
|
84267
|
+
"type": "object",
|
84268
|
+
"patternProperties": {
|
84269
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
84270
|
+
"type": [
|
84271
|
+
"string",
|
84272
|
+
"number",
|
84273
|
+
"boolean",
|
84274
|
+
"null"
|
84275
|
+
],
|
84276
|
+
"maxLength": 1024
|
84277
|
+
}
|
84278
|
+
}
|
84279
|
+
}
|
84280
|
+
},
|
84281
|
+
"required": [
|
84282
|
+
"type"
|
84283
|
+
],
|
84284
|
+
"additionalProperties": false
|
84285
|
+
},
|
84286
|
+
{
|
84287
|
+
"type": "object",
|
84288
|
+
"properties": {
|
84289
|
+
"$eq": {
|
84290
|
+
"type": "object",
|
84291
|
+
"properties": {
|
84292
|
+
"type": {
|
84293
|
+
"type": "string",
|
84294
|
+
"maxLength": 255
|
84295
|
+
},
|
84296
|
+
"config": {
|
84297
|
+
"type": "object",
|
84298
|
+
"patternProperties": {
|
84299
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
84300
|
+
"type": [
|
84301
|
+
"string",
|
84302
|
+
"number",
|
84303
|
+
"boolean",
|
84304
|
+
"null"
|
84305
|
+
],
|
84306
|
+
"maxLength": 1024
|
84307
|
+
}
|
84308
|
+
}
|
84309
|
+
}
|
84310
|
+
},
|
84311
|
+
"required": [
|
84312
|
+
"type"
|
84313
|
+
],
|
84314
|
+
"additionalProperties": false
|
84315
|
+
}
|
84316
|
+
},
|
84317
|
+
"required": [
|
84318
|
+
"$eq"
|
84319
|
+
],
|
84320
|
+
"additionalProperties": false
|
84321
|
+
},
|
84322
|
+
{
|
84323
|
+
"type": "object",
|
84324
|
+
"properties": {
|
84325
|
+
"$ne": {
|
84326
|
+
"type": "object",
|
84327
|
+
"properties": {
|
84328
|
+
"type": {
|
84329
|
+
"type": "string",
|
84330
|
+
"maxLength": 255
|
84331
|
+
},
|
84332
|
+
"config": {
|
84333
|
+
"type": "object",
|
84334
|
+
"patternProperties": {
|
84335
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
84336
|
+
"type": [
|
84337
|
+
"string",
|
84338
|
+
"number",
|
84339
|
+
"boolean",
|
84340
|
+
"null"
|
84341
|
+
],
|
84342
|
+
"maxLength": 1024
|
84343
|
+
}
|
84344
|
+
}
|
84345
|
+
}
|
84346
|
+
},
|
84347
|
+
"required": [
|
84348
|
+
"type"
|
84349
|
+
],
|
84350
|
+
"additionalProperties": false
|
84351
|
+
}
|
84352
|
+
},
|
84353
|
+
"required": [
|
84354
|
+
"$ne"
|
84355
|
+
],
|
84356
|
+
"additionalProperties": false
|
84357
|
+
}
|
84358
|
+
]
|
84359
|
+
}
|
84360
|
+
},
|
84361
|
+
"additionalProperties": false
|
84362
|
+
}
|
84363
|
+
},
|
84364
|
+
"additionalProperties": false,
|
84365
|
+
"required": [
|
84366
|
+
"query"
|
84367
|
+
]
|
84368
|
+
}
|
84369
|
+
```
|
84370
|
+
### <a name="flow-versions-delete-post-example"></a> Example
|
84371
|
+
|
84372
|
+
```json
|
84373
|
+
{
|
84374
|
+
"query": {
|
84375
|
+
"version": {
|
84376
|
+
"$ne": "versionToKeep"
|
84377
|
+
}
|
84378
|
+
},
|
84379
|
+
"email": "email@example.com"
|
84380
|
+
}
|
84381
|
+
```
|
84382
|
+
|
84383
|
+
<br/>
|
84384
|
+
|
84385
|
+
## Workflows
|
84386
|
+
|
84387
|
+
Schema for a collection of Workflows
|
84388
|
+
|
84389
|
+
### <a name="workflows-schema"></a> Schema
|
84390
|
+
|
84391
|
+
```json
|
84392
|
+
{
|
84393
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
84394
|
+
"type": "object",
|
84395
|
+
"properties": {
|
84396
|
+
"items": {
|
84397
|
+
"type": "array",
|
84398
|
+
"items": {
|
84399
|
+
"title": "Workflow",
|
84400
|
+
"description": "Schema for a single Workflow",
|
84401
|
+
"type": "object",
|
84402
|
+
"properties": {
|
84403
|
+
"id": {
|
84404
|
+
"type": "string",
|
84405
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
84406
|
+
},
|
84407
|
+
"flowId": {
|
84408
|
+
"type": "string",
|
84409
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
84410
|
+
},
|
84411
|
+
"applicationId": {
|
84412
|
+
"type": "string",
|
84413
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
84414
|
+
},
|
84415
|
+
"creationDate": {
|
84416
|
+
"type": "string",
|
84417
|
+
"format": "date-time"
|
84418
|
+
},
|
84419
|
+
"lastUpdated": {
|
84420
|
+
"type": "string",
|
84421
|
+
"format": "date-time"
|
84422
|
+
},
|
84423
|
+
"name": {
|
84424
|
+
"type": "string",
|
84425
|
+
"minLength": 1,
|
84426
|
+
"maxLength": 255
|
84427
|
+
},
|
84428
|
+
"description": {
|
84429
|
+
"type": "string",
|
84430
|
+
"maxLength": 32767
|
84431
|
+
},
|
84432
|
+
"iconData": {
|
84433
|
+
"type": "string",
|
84434
|
+
"maxLength": 32767,
|
84435
|
+
"pattern": "^data:image/(jpg|jpeg|png|svg\\+xml);base64,[0-9a-zA-Z+/=]*$"
|
84436
|
+
},
|
84437
|
+
"enabled": {
|
84438
|
+
"type": "boolean"
|
84439
|
+
},
|
84440
|
+
"defaultVersionId": {
|
84441
|
+
"type": "string",
|
84442
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
84443
|
+
},
|
84444
|
+
"minimumAgentVersion": {
|
84445
|
+
"type": "string",
|
84446
|
+
"pattern": "^(0|([1-9]\\d*))\\.(0|([1-9]\\d*))\\.(0|([1-9]\\d*))$"
|
84447
|
+
},
|
84448
|
+
"flowClass": {
|
84449
|
+
"type": "string",
|
84450
|
+
"enum": [
|
84451
|
+
"cloud",
|
84452
|
+
"edge",
|
84453
|
+
"experience",
|
84454
|
+
"customNode"
|
84455
|
+
]
|
84456
|
+
},
|
84457
|
+
"triggers": {
|
84458
|
+
"type": "array",
|
84459
|
+
"items": {
|
84460
|
+
"oneOf": [
|
84461
|
+
{
|
84462
|
+
"type": "object",
|
84463
|
+
"properties": {
|
84464
|
+
"key": {
|
84465
|
+
"type": "string",
|
84466
|
+
"maxLength": 1024
|
84467
|
+
},
|
84468
|
+
"type": {
|
84469
|
+
"type": "string",
|
84470
|
+
"enum": [
|
84471
|
+
"customNodeStart",
|
84472
|
+
"deviceCommand",
|
84473
|
+
"deviceIdConnect",
|
84474
|
+
"deviceTagConnect",
|
84475
|
+
"deviceIdDisconnect",
|
84476
|
+
"deviceTagDisconnect",
|
84477
|
+
"integration",
|
84478
|
+
"notebook",
|
84479
|
+
"onBoot",
|
84480
|
+
"onConnect",
|
84481
|
+
"onDisconnect",
|
84482
|
+
"request",
|
84483
|
+
"udp",
|
84484
|
+
"webhook"
|
84485
|
+
]
|
84486
|
+
},
|
84487
|
+
"config": {
|
84488
|
+
"type": "object",
|
84489
|
+
"additionalProperties": false
|
84490
|
+
},
|
84491
|
+
"meta": {
|
84492
|
+
"type": "object",
|
84493
|
+
"properties": {
|
84494
|
+
"category": {
|
84495
|
+
"type": "string",
|
84496
|
+
"enum": [
|
84497
|
+
"trigger"
|
84498
|
+
]
|
84499
|
+
},
|
84500
|
+
"name": {
|
84501
|
+
"type": "string",
|
84502
|
+
"enum": [
|
84503
|
+
"customNodeStart",
|
84504
|
+
"deviceCommand",
|
84505
|
+
"deviceIdsTagsConnect",
|
84506
|
+
"deviceIdsTagsDisconnect",
|
84507
|
+
"flowError",
|
84508
|
+
"googlePubSub",
|
84509
|
+
"meridian",
|
84510
|
+
"mqtt",
|
84511
|
+
"notebook",
|
84512
|
+
"onBoot",
|
84513
|
+
"onConnect",
|
84514
|
+
"onDisconnect",
|
84515
|
+
"particle",
|
84516
|
+
"request",
|
84517
|
+
"udp",
|
84518
|
+
"webhook"
|
84519
|
+
]
|
84520
|
+
},
|
84521
|
+
"label": {
|
84522
|
+
"type": "string",
|
84523
|
+
"minLength": 1,
|
84524
|
+
"maxLength": 255
|
84525
|
+
},
|
84526
|
+
"x": {
|
84527
|
+
"type": "number"
|
84528
|
+
},
|
84529
|
+
"y": {
|
84530
|
+
"type": "number"
|
84531
|
+
},
|
84532
|
+
"uiId": {
|
84533
|
+
"type": "string",
|
84534
|
+
"maxLength": 48
|
84535
|
+
},
|
84536
|
+
"description": {
|
84537
|
+
"type": "string",
|
84538
|
+
"maxLength": 32767
|
84539
|
+
},
|
84540
|
+
"icon": {
|
84541
|
+
"type": "string",
|
84542
|
+
"maxLength": 1024
|
84543
|
+
},
|
84544
|
+
"color": {
|
84545
|
+
"type": "string",
|
84546
|
+
"maxLength": 1024
|
84547
|
+
},
|
84548
|
+
"inputCount": {
|
84549
|
+
"type": "number"
|
84550
|
+
},
|
84551
|
+
"outputCount": {
|
84552
|
+
"type": "number"
|
84553
|
+
},
|
84554
|
+
"triggerId": {
|
84555
|
+
"type": "string",
|
84556
|
+
"maxLength": 48
|
84557
|
+
},
|
84558
|
+
"id": {
|
84559
|
+
"type": "string",
|
84560
|
+
"maxLength": 48
|
84561
|
+
}
|
84562
|
+
},
|
84563
|
+
"additionalProperties": false
|
84564
|
+
},
|
84565
|
+
"outputIds": {
|
84566
|
+
"type": "array",
|
84567
|
+
"items": {
|
84568
|
+
"type": "array",
|
84569
|
+
"items": {
|
84570
|
+
"type": "string",
|
84571
|
+
"maxLength": 255
|
84572
|
+
},
|
84573
|
+
"maxItems": 100
|
84574
|
+
},
|
84575
|
+
"maxItems": 100
|
84576
|
+
}
|
84577
|
+
},
|
84578
|
+
"required": [
|
84579
|
+
"type"
|
84580
|
+
],
|
84581
|
+
"additionalProperties": false
|
84582
|
+
},
|
84583
|
+
{
|
84584
|
+
"type": "object",
|
84585
|
+
"properties": {
|
84586
|
+
"key": {
|
84587
|
+
"type": "string",
|
84588
|
+
"maxLength": 1024
|
84589
|
+
},
|
84590
|
+
"type": {
|
84591
|
+
"type": "string",
|
84592
|
+
"enum": [
|
84593
|
+
"dataTable"
|
84594
|
+
]
|
84595
|
+
},
|
84596
|
+
"config": {
|
84597
|
+
"type": "object",
|
84598
|
+
"properties": {
|
84599
|
+
"bulkInsert": {
|
84600
|
+
"type": "boolean"
|
84601
|
+
},
|
84602
|
+
"delete": {
|
84603
|
+
"type": "boolean"
|
84604
|
+
},
|
84605
|
+
"insert": {
|
84606
|
+
"type": "boolean"
|
84607
|
+
},
|
84608
|
+
"update": {
|
84609
|
+
"type": "boolean"
|
83465
84610
|
}
|
83466
84611
|
},
|
83467
84612
|
"additionalProperties": false
|
@@ -96291,6 +97436,7 @@ Schema for the body of a Github login request
|
|
96291
97436
|
"enum": [
|
96292
97437
|
"all.Application",
|
96293
97438
|
"all.Application.read",
|
97439
|
+
"all.Application.cli",
|
96294
97440
|
"all.Device",
|
96295
97441
|
"all.Device.read",
|
96296
97442
|
"application.*",
|
@@ -96522,6 +97668,7 @@ Schema for the body of a Github login request
|
|
96522
97668
|
"flowVersion.log",
|
96523
97669
|
"flowVersion.patch",
|
96524
97670
|
"flowVersion.stats",
|
97671
|
+
"flowVersions.delete",
|
96525
97672
|
"flowVersions.get",
|
96526
97673
|
"flowVersions.post",
|
96527
97674
|
"integration.delete",
|
@@ -96591,6 +97738,7 @@ Schema for the body of a Github login request
|
|
96591
97738
|
"all.Instance.read",
|
96592
97739
|
"instance.*",
|
96593
97740
|
"instance.get",
|
97741
|
+
"instance.patch",
|
96594
97742
|
"instance.historicalSummaries",
|
96595
97743
|
"instance.generateReport",
|
96596
97744
|
"instanceOrg.*",
|
@@ -96613,7 +97761,14 @@ Schema for the body of a Github login request
|
|
96613
97761
|
"instanceOrgMember.delete",
|
96614
97762
|
"instanceOrgMembers.*",
|
96615
97763
|
"instanceOrgMembers.get",
|
96616
|
-
"instanceOrgMembers.post"
|
97764
|
+
"instanceOrgMembers.post",
|
97765
|
+
"instanceApiTokens.*",
|
97766
|
+
"instanceApiTokens.get",
|
97767
|
+
"instanceApiTokens.post",
|
97768
|
+
"instanceApiToken.*",
|
97769
|
+
"instanceApiToken.get",
|
97770
|
+
"instanceApiToken.patch",
|
97771
|
+
"instanceApiToken.delete"
|
96617
97772
|
]
|
96618
97773
|
},
|
96619
97774
|
{
|
@@ -96621,6 +97776,14 @@ Schema for the body of a Github login request
|
|
96621
97776
|
"enum": [
|
96622
97777
|
"all.User",
|
96623
97778
|
"all.User.read",
|
97779
|
+
"all.User.cli",
|
97780
|
+
"userApiToken.*",
|
97781
|
+
"userApiToken.get",
|
97782
|
+
"userApiToken.patch",
|
97783
|
+
"userApiToken.delete",
|
97784
|
+
"userApiTokens.*",
|
97785
|
+
"userApiTokens.get",
|
97786
|
+
"userApiTokens.post",
|
96624
97787
|
"applicationTemplate.*",
|
96625
97788
|
"applicationTemplate.get",
|
96626
97789
|
"applicationTemplates.*",
|
@@ -96957,6 +98120,9 @@ Schema for a historical summary report
|
|
96957
98120
|
"dashboardCount": {
|
96958
98121
|
"type": "number"
|
96959
98122
|
},
|
98123
|
+
"dashboardCountProrated": {
|
98124
|
+
"type": "number"
|
98125
|
+
},
|
96960
98126
|
"dataTableCount": {
|
96961
98127
|
"type": "number"
|
96962
98128
|
},
|
@@ -97361,6 +98527,66 @@ Schema for a single Instance
|
|
97361
98527
|
"allowAuditLogging": {
|
97362
98528
|
"type": "boolean"
|
97363
98529
|
},
|
98530
|
+
"reportConfigs": {
|
98531
|
+
"type": "array",
|
98532
|
+
"items": {
|
98533
|
+
"type": "object",
|
98534
|
+
"max": 10,
|
98535
|
+
"properties": {
|
98536
|
+
"id": {
|
98537
|
+
"type": "string",
|
98538
|
+
"maxLength": 48
|
98539
|
+
},
|
98540
|
+
"cron": {
|
98541
|
+
"type": "string",
|
98542
|
+
"maxLength": 255
|
98543
|
+
},
|
98544
|
+
"timezone": {
|
98545
|
+
"type": "string",
|
98546
|
+
"maxLength": 255
|
98547
|
+
},
|
98548
|
+
"emails": {
|
98549
|
+
"type": "array",
|
98550
|
+
"max": 10,
|
98551
|
+
"items": {
|
98552
|
+
"type": "string",
|
98553
|
+
"format": "email",
|
98554
|
+
"maxLength": 1024
|
98555
|
+
}
|
98556
|
+
},
|
98557
|
+
"callbackUrl": {
|
98558
|
+
"type": "string",
|
98559
|
+
"maxLength": 1024
|
98560
|
+
},
|
98561
|
+
"resourceGroupBy": {
|
98562
|
+
"type": "string",
|
98563
|
+
"enum": [
|
98564
|
+
"application",
|
98565
|
+
"organization"
|
98566
|
+
]
|
98567
|
+
},
|
98568
|
+
"dateGroupBy": {
|
98569
|
+
"type": "string",
|
98570
|
+
"enum": [
|
98571
|
+
"day",
|
98572
|
+
"month"
|
98573
|
+
]
|
98574
|
+
},
|
98575
|
+
"periods": {
|
98576
|
+
"type": "integer",
|
98577
|
+
"minimum": 1,
|
98578
|
+
"maximum": 90
|
98579
|
+
},
|
98580
|
+
"includeSandbox": {
|
98581
|
+
"type": "boolean"
|
98582
|
+
}
|
98583
|
+
},
|
98584
|
+
"required": [
|
98585
|
+
"cron"
|
98586
|
+
],
|
98587
|
+
"additionalProperties": false
|
98588
|
+
}
|
98589
|
+
},
|
97364
98590
|
"limits": {
|
97365
98591
|
"organization": {
|
97366
98592
|
"type": "number"
|
@@ -98240,7 +99466,8 @@ Schema for an Instance Organization member creation request
|
|
98240
99466
|
"resourceId": "575ef90f7ae143cd83dc4a4f",
|
98241
99467
|
"role": "none"
|
98242
99468
|
}
|
98243
|
-
]
|
99469
|
+
],
|
99470
|
+
"userId": "675ed18f7ae143cd83dc4bb7"
|
98244
99471
|
}
|
98245
99472
|
```
|
98246
99473
|
|
@@ -98561,6 +99788,172 @@ Schema for the body of an Organization creation request within an instance
|
|
98561
99788
|
}
|
98562
99789
|
}
|
98563
99790
|
},
|
99791
|
+
"members": {
|
99792
|
+
"type": "array",
|
99793
|
+
"max": "10",
|
99794
|
+
"items": {
|
99795
|
+
"title": "Instance Org Member Post",
|
99796
|
+
"description": "Schema for an Instance Organization member creation request",
|
99797
|
+
"oneOf": [
|
99798
|
+
{
|
99799
|
+
"type": "object",
|
99800
|
+
"properties": {
|
99801
|
+
"userId": {
|
99802
|
+
"type": "string",
|
99803
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
99804
|
+
},
|
99805
|
+
"role": {
|
99806
|
+
"type": "string",
|
99807
|
+
"enum": [
|
99808
|
+
"admin",
|
99809
|
+
"edit",
|
99810
|
+
"collaborate",
|
99811
|
+
"view",
|
99812
|
+
"none"
|
99813
|
+
]
|
99814
|
+
},
|
99815
|
+
"applicationRoles": {
|
99816
|
+
"type": "array",
|
99817
|
+
"items": {
|
99818
|
+
"type": "object",
|
99819
|
+
"properties": {
|
99820
|
+
"resourceId": {
|
99821
|
+
"type": "string",
|
99822
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
99823
|
+
},
|
99824
|
+
"role": {
|
99825
|
+
"type": "string",
|
99826
|
+
"enum": [
|
99827
|
+
"collaborate",
|
99828
|
+
"view",
|
99829
|
+
"none"
|
99830
|
+
]
|
99831
|
+
}
|
99832
|
+
},
|
99833
|
+
"required": [
|
99834
|
+
"resourceId",
|
99835
|
+
"role"
|
99836
|
+
],
|
99837
|
+
"additionalProperties": false
|
99838
|
+
},
|
99839
|
+
"maxItems": 1000
|
99840
|
+
},
|
99841
|
+
"dashboardRoles": {
|
99842
|
+
"type": "array",
|
99843
|
+
"items": {
|
99844
|
+
"type": "object",
|
99845
|
+
"properties": {
|
99846
|
+
"resourceId": {
|
99847
|
+
"type": "string",
|
99848
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
99849
|
+
},
|
99850
|
+
"role": {
|
99851
|
+
"type": "string",
|
99852
|
+
"enum": [
|
99853
|
+
"collaborate",
|
99854
|
+
"view",
|
99855
|
+
"none"
|
99856
|
+
]
|
99857
|
+
}
|
99858
|
+
},
|
99859
|
+
"required": [
|
99860
|
+
"resourceId",
|
99861
|
+
"role"
|
99862
|
+
],
|
99863
|
+
"additionalProperties": false
|
99864
|
+
},
|
99865
|
+
"maxItems": 1000
|
99866
|
+
}
|
99867
|
+
},
|
99868
|
+
"additionalProperties": false,
|
99869
|
+
"required": [
|
99870
|
+
"userId",
|
99871
|
+
"role"
|
99872
|
+
]
|
99873
|
+
},
|
99874
|
+
{
|
99875
|
+
"type": "object",
|
99876
|
+
"properties": {
|
99877
|
+
"email": {
|
99878
|
+
"type": "string",
|
99879
|
+
"format": "email",
|
99880
|
+
"maxLength": 1024
|
99881
|
+
},
|
99882
|
+
"role": {
|
99883
|
+
"type": "string",
|
99884
|
+
"enum": [
|
99885
|
+
"admin",
|
99886
|
+
"edit",
|
99887
|
+
"collaborate",
|
99888
|
+
"view",
|
99889
|
+
"none"
|
99890
|
+
]
|
99891
|
+
},
|
99892
|
+
"applicationRoles": {
|
99893
|
+
"type": "array",
|
99894
|
+
"items": {
|
99895
|
+
"type": "object",
|
99896
|
+
"properties": {
|
99897
|
+
"resourceId": {
|
99898
|
+
"type": "string",
|
99899
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
99900
|
+
},
|
99901
|
+
"role": {
|
99902
|
+
"type": "string",
|
99903
|
+
"enum": [
|
99904
|
+
"collaborate",
|
99905
|
+
"view",
|
99906
|
+
"none"
|
99907
|
+
]
|
99908
|
+
}
|
99909
|
+
},
|
99910
|
+
"required": [
|
99911
|
+
"resourceId",
|
99912
|
+
"role"
|
99913
|
+
],
|
99914
|
+
"additionalProperties": false
|
99915
|
+
},
|
99916
|
+
"maxItems": 1000
|
99917
|
+
},
|
99918
|
+
"dashboardRoles": {
|
99919
|
+
"type": "array",
|
99920
|
+
"items": {
|
99921
|
+
"type": "object",
|
99922
|
+
"properties": {
|
99923
|
+
"resourceId": {
|
99924
|
+
"type": "string",
|
99925
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
99926
|
+
},
|
99927
|
+
"role": {
|
99928
|
+
"type": "string",
|
99929
|
+
"enum": [
|
99930
|
+
"collaborate",
|
99931
|
+
"view",
|
99932
|
+
"none"
|
99933
|
+
]
|
99934
|
+
}
|
99935
|
+
},
|
99936
|
+
"required": [
|
99937
|
+
"resourceId",
|
99938
|
+
"role"
|
99939
|
+
],
|
99940
|
+
"additionalProperties": false
|
99941
|
+
},
|
99942
|
+
"maxItems": 1000
|
99943
|
+
},
|
99944
|
+
"disallowTransfer": {
|
99945
|
+
"type": "boolean"
|
99946
|
+
}
|
99947
|
+
},
|
99948
|
+
"additionalProperties": false,
|
99949
|
+
"required": [
|
99950
|
+
"email",
|
99951
|
+
"role"
|
99952
|
+
]
|
99953
|
+
}
|
99954
|
+
]
|
99955
|
+
}
|
99956
|
+
},
|
98564
99957
|
"whitelistedEmailDomains": {
|
98565
99958
|
"type": "array",
|
98566
99959
|
"items": {
|
@@ -98596,7 +99989,7 @@ Schema for the body of an Organization creation request within an instance
|
|
98596
99989
|
{
|
98597
99990
|
"name": "My Org",
|
98598
99991
|
"limits": {
|
98599
|
-
"
|
99992
|
+
"member": 500
|
98600
99993
|
},
|
98601
99994
|
"auditLogEnabled": true
|
98602
99995
|
}
|
@@ -98812,6 +100205,111 @@ Schema for a collection of Organizations within an instance
|
|
98812
100205
|
|
98813
100206
|
<br/>
|
98814
100207
|
|
100208
|
+
## Instance Patch
|
100209
|
+
|
100210
|
+
Schema for instance patch request
|
100211
|
+
|
100212
|
+
### <a name="instance-patch-schema"></a> Schema
|
100213
|
+
|
100214
|
+
```json
|
100215
|
+
{
|
100216
|
+
"$schema": "http://json-schema.org/draft-04/schema#",
|
100217
|
+
"type": "object",
|
100218
|
+
"properties": {
|
100219
|
+
"reportConfigs": {
|
100220
|
+
"type": "array",
|
100221
|
+
"items": {
|
100222
|
+
"type": "object",
|
100223
|
+
"max": 10,
|
100224
|
+
"properties": {
|
100225
|
+
"id": {
|
100226
|
+
"type": "string",
|
100227
|
+
"maxLength": 48
|
100228
|
+
},
|
100229
|
+
"cron": {
|
100230
|
+
"type": "string",
|
100231
|
+
"maxLength": 255
|
100232
|
+
},
|
100233
|
+
"timezone": {
|
100234
|
+
"type": "string",
|
100235
|
+
"maxLength": 255
|
100236
|
+
},
|
100237
|
+
"emails": {
|
100238
|
+
"type": "array",
|
100239
|
+
"max": 10,
|
100240
|
+
"items": {
|
100241
|
+
"type": "string",
|
100242
|
+
"format": "email",
|
100243
|
+
"maxLength": 1024
|
100244
|
+
}
|
100245
|
+
},
|
100246
|
+
"callbackUrl": {
|
100247
|
+
"type": "string",
|
100248
|
+
"maxLength": 1024
|
100249
|
+
},
|
100250
|
+
"resourceGroupBy": {
|
100251
|
+
"type": "string",
|
100252
|
+
"enum": [
|
100253
|
+
"application",
|
100254
|
+
"organization"
|
100255
|
+
]
|
100256
|
+
},
|
100257
|
+
"dateGroupBy": {
|
100258
|
+
"type": "string",
|
100259
|
+
"enum": [
|
100260
|
+
"day",
|
100261
|
+
"month"
|
100262
|
+
]
|
100263
|
+
},
|
100264
|
+
"periods": {
|
100265
|
+
"type": "integer",
|
100266
|
+
"minimum": 1,
|
100267
|
+
"maximum": 90
|
100268
|
+
},
|
100269
|
+
"includeSandbox": {
|
100270
|
+
"type": "boolean"
|
100271
|
+
}
|
100272
|
+
},
|
100273
|
+
"required": [
|
100274
|
+
"cron"
|
100275
|
+
],
|
100276
|
+
"additionalProperties": false
|
100277
|
+
}
|
100278
|
+
}
|
100279
|
+
},
|
100280
|
+
"additionalProperties": false
|
100281
|
+
}
|
100282
|
+
```
|
100283
|
+
### <a name="instance-patch-example"></a> Example
|
100284
|
+
|
100285
|
+
```json
|
100286
|
+
{
|
100287
|
+
"reportConfigs": [
|
100288
|
+
{
|
100289
|
+
"email": [
|
100290
|
+
"email@example.com"
|
100291
|
+
],
|
100292
|
+
"callbackUrl": "https://www.example.com/callback",
|
100293
|
+
"resourceGroupBy": "organization",
|
100294
|
+
"dateGroupBy": "month",
|
100295
|
+
"includeSandbox": false,
|
100296
|
+
"periods": 3
|
100297
|
+
},
|
100298
|
+
{
|
100299
|
+
"email": [
|
100300
|
+
"email@example.com",
|
100301
|
+
"anotheremail@example.com"
|
100302
|
+
],
|
100303
|
+
"resourceGroupBy": "application",
|
100304
|
+
"dateGroupBy": "month",
|
100305
|
+
"includeSandbox": true
|
100306
|
+
}
|
100307
|
+
]
|
100308
|
+
}
|
100309
|
+
```
|
100310
|
+
|
100311
|
+
<br/>
|
100312
|
+
|
98815
100313
|
## Instance Report Options Post
|
98816
100314
|
|
98817
100315
|
Schema for the body of a instance report request
|
@@ -98842,6 +100340,7 @@ Schema for the body of a instance report request
|
|
98842
100340
|
"dateGroupBy": {
|
98843
100341
|
"type": "string",
|
98844
100342
|
"enum": [
|
100343
|
+
"day",
|
98845
100344
|
"month"
|
98846
100345
|
]
|
98847
100346
|
},
|
@@ -98866,7 +100365,7 @@ Schema for the body of a instance report request
|
|
98866
100365
|
{
|
98867
100366
|
"email": "email@example.com",
|
98868
100367
|
"callbackUrl": "https://www.example.com/callback",
|
98869
|
-
"
|
100368
|
+
"resourceGroupBy": "organization",
|
98870
100369
|
"dateGroupBy": "month",
|
98871
100370
|
"includeSandbox": false,
|
98872
100371
|
"start": "2020-01-01T00:00:00.000Z",
|
@@ -102819,6 +104318,21 @@ Schema for a single Notebook
|
|
102819
104318
|
}
|
102820
104319
|
]
|
102821
104320
|
}
|
104321
|
+
},
|
104322
|
+
"stats": {
|
104323
|
+
"type": "object",
|
104324
|
+
"properties": {
|
104325
|
+
"minutesThisPeriod": {
|
104326
|
+
"type": "number"
|
104327
|
+
},
|
104328
|
+
"runsThisPeriod": {
|
104329
|
+
"type": "number"
|
104330
|
+
},
|
104331
|
+
"errorsThisPeriod": {
|
104332
|
+
"type": "number"
|
104333
|
+
}
|
104334
|
+
},
|
104335
|
+
"additionalProperties": false
|
102822
104336
|
}
|
102823
104337
|
}
|
102824
104338
|
}
|
@@ -102943,7 +104457,12 @@ Schema for a single Notebook
|
|
102943
104457
|
"outputType": "directory",
|
102944
104458
|
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}"
|
102945
104459
|
}
|
102946
|
-
]
|
104460
|
+
],
|
104461
|
+
"stats": {
|
104462
|
+
"minutesThisPeriod": 3,
|
104463
|
+
"runsThisPeriod": 2,
|
104464
|
+
"errorsThisPeriod": 1
|
104465
|
+
}
|
102947
104466
|
}
|
102948
104467
|
```
|
102949
104468
|
|
@@ -105068,6 +106587,21 @@ Schema for a collection of Notebooks
|
|
105068
106587
|
}
|
105069
106588
|
]
|
105070
106589
|
}
|
106590
|
+
},
|
106591
|
+
"stats": {
|
106592
|
+
"type": "object",
|
106593
|
+
"properties": {
|
106594
|
+
"minutesThisPeriod": {
|
106595
|
+
"type": "number"
|
106596
|
+
},
|
106597
|
+
"runsThisPeriod": {
|
106598
|
+
"type": "number"
|
106599
|
+
},
|
106600
|
+
"errorsThisPeriod": {
|
106601
|
+
"type": "number"
|
106602
|
+
}
|
106603
|
+
},
|
106604
|
+
"additionalProperties": false
|
105071
106605
|
}
|
105072
106606
|
}
|
105073
106607
|
}
|
@@ -105232,7 +106766,12 @@ Schema for a collection of Notebooks
|
|
105232
106766
|
"outputType": "directory",
|
105233
106767
|
"destinationDirectoryTemplate": "/{{notebook.name}}/{{execution.runStartedAt}}"
|
105234
106768
|
}
|
105235
|
-
]
|
106769
|
+
],
|
106770
|
+
"stats": {
|
106771
|
+
"minutesThisPeriod": 3,
|
106772
|
+
"runsThisPeriod": 2,
|
106773
|
+
"errorsThisPeriod": 1
|
106774
|
+
}
|
105236
106775
|
}
|
105237
106776
|
],
|
105238
106777
|
"count": 1,
|
@@ -107956,6 +109495,7 @@ Schema for the body of a User authentication request
|
|
107956
109495
|
"enum": [
|
107957
109496
|
"all.Application",
|
107958
109497
|
"all.Application.read",
|
109498
|
+
"all.Application.cli",
|
107959
109499
|
"all.Device",
|
107960
109500
|
"all.Device.read",
|
107961
109501
|
"application.*",
|
@@ -108187,6 +109727,7 @@ Schema for the body of a User authentication request
|
|
108187
109727
|
"flowVersion.log",
|
108188
109728
|
"flowVersion.patch",
|
108189
109729
|
"flowVersion.stats",
|
109730
|
+
"flowVersions.delete",
|
108190
109731
|
"flowVersions.get",
|
108191
109732
|
"flowVersions.post",
|
108192
109733
|
"integration.delete",
|
@@ -108256,6 +109797,7 @@ Schema for the body of a User authentication request
|
|
108256
109797
|
"all.Instance.read",
|
108257
109798
|
"instance.*",
|
108258
109799
|
"instance.get",
|
109800
|
+
"instance.patch",
|
108259
109801
|
"instance.historicalSummaries",
|
108260
109802
|
"instance.generateReport",
|
108261
109803
|
"instanceOrg.*",
|
@@ -108278,7 +109820,14 @@ Schema for the body of a User authentication request
|
|
108278
109820
|
"instanceOrgMember.delete",
|
108279
109821
|
"instanceOrgMembers.*",
|
108280
109822
|
"instanceOrgMembers.get",
|
108281
|
-
"instanceOrgMembers.post"
|
109823
|
+
"instanceOrgMembers.post",
|
109824
|
+
"instanceApiTokens.*",
|
109825
|
+
"instanceApiTokens.get",
|
109826
|
+
"instanceApiTokens.post",
|
109827
|
+
"instanceApiToken.*",
|
109828
|
+
"instanceApiToken.get",
|
109829
|
+
"instanceApiToken.patch",
|
109830
|
+
"instanceApiToken.delete"
|
108282
109831
|
]
|
108283
109832
|
},
|
108284
109833
|
{
|
@@ -108286,6 +109835,14 @@ Schema for the body of a User authentication request
|
|
108286
109835
|
"enum": [
|
108287
109836
|
"all.User",
|
108288
109837
|
"all.User.read",
|
109838
|
+
"all.User.cli",
|
109839
|
+
"userApiToken.*",
|
109840
|
+
"userApiToken.get",
|
109841
|
+
"userApiToken.patch",
|
109842
|
+
"userApiToken.delete",
|
109843
|
+
"userApiTokens.*",
|
109844
|
+
"userApiTokens.get",
|
109845
|
+
"userApiTokens.post",
|
108289
109846
|
"applicationTemplate.*",
|
108290
109847
|
"applicationTemplate.get",
|
108291
109848
|
"applicationTemplates.*",
|
@@ -108435,6 +109992,7 @@ Schema for the body of a User creation request
|
|
108435
109992
|
"enum": [
|
108436
109993
|
"all.Application",
|
108437
109994
|
"all.Application.read",
|
109995
|
+
"all.Application.cli",
|
108438
109996
|
"all.Device",
|
108439
109997
|
"all.Device.read",
|
108440
109998
|
"application.*",
|
@@ -108666,6 +110224,7 @@ Schema for the body of a User creation request
|
|
108666
110224
|
"flowVersion.log",
|
108667
110225
|
"flowVersion.patch",
|
108668
110226
|
"flowVersion.stats",
|
110227
|
+
"flowVersions.delete",
|
108669
110228
|
"flowVersions.get",
|
108670
110229
|
"flowVersions.post",
|
108671
110230
|
"integration.delete",
|
@@ -108735,6 +110294,7 @@ Schema for the body of a User creation request
|
|
108735
110294
|
"all.Instance.read",
|
108736
110295
|
"instance.*",
|
108737
110296
|
"instance.get",
|
110297
|
+
"instance.patch",
|
108738
110298
|
"instance.historicalSummaries",
|
108739
110299
|
"instance.generateReport",
|
108740
110300
|
"instanceOrg.*",
|
@@ -108757,7 +110317,14 @@ Schema for the body of a User creation request
|
|
108757
110317
|
"instanceOrgMember.delete",
|
108758
110318
|
"instanceOrgMembers.*",
|
108759
110319
|
"instanceOrgMembers.get",
|
108760
|
-
"instanceOrgMembers.post"
|
110320
|
+
"instanceOrgMembers.post",
|
110321
|
+
"instanceApiTokens.*",
|
110322
|
+
"instanceApiTokens.get",
|
110323
|
+
"instanceApiTokens.post",
|
110324
|
+
"instanceApiToken.*",
|
110325
|
+
"instanceApiToken.get",
|
110326
|
+
"instanceApiToken.patch",
|
110327
|
+
"instanceApiToken.delete"
|
108761
110328
|
]
|
108762
110329
|
},
|
108763
110330
|
{
|
@@ -108765,6 +110332,14 @@ Schema for the body of a User creation request
|
|
108765
110332
|
"enum": [
|
108766
110333
|
"all.User",
|
108767
110334
|
"all.User.read",
|
110335
|
+
"all.User.cli",
|
110336
|
+
"userApiToken.*",
|
110337
|
+
"userApiToken.get",
|
110338
|
+
"userApiToken.patch",
|
110339
|
+
"userApiToken.delete",
|
110340
|
+
"userApiTokens.*",
|
110341
|
+
"userApiTokens.get",
|
110342
|
+
"userApiTokens.post",
|
108768
110343
|
"applicationTemplate.*",
|
108769
110344
|
"applicationTemplate.get",
|
108770
110345
|
"applicationTemplates.*",
|
@@ -108913,6 +110488,40 @@ Schema for the result of a validateContext call when invalid context is passed
|
|
108913
110488
|
}
|
108914
110489
|
}
|
108915
110490
|
}
|
110491
|
+
},
|
110492
|
+
"attributes": {
|
110493
|
+
"type": "object",
|
110494
|
+
"patternProperties": {
|
110495
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
110496
|
+
"type": "object",
|
110497
|
+
"properties": {
|
110498
|
+
"dataType": {
|
110499
|
+
"type": "string",
|
110500
|
+
"enum": [
|
110501
|
+
"string",
|
110502
|
+
"number",
|
110503
|
+
"gps",
|
110504
|
+
"boolean",
|
110505
|
+
"blob"
|
110506
|
+
]
|
110507
|
+
},
|
110508
|
+
"description": {
|
110509
|
+
"type": "string",
|
110510
|
+
"maxLength": 32767
|
110511
|
+
},
|
110512
|
+
"tags": {
|
110513
|
+
"type": "object",
|
110514
|
+
"patternProperties": {
|
110515
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
110516
|
+
"type": "string",
|
110517
|
+
"minLength": 1,
|
110518
|
+
"maxLength": 255
|
110519
|
+
}
|
110520
|
+
}
|
110521
|
+
}
|
110522
|
+
}
|
110523
|
+
}
|
110524
|
+
}
|
108916
110525
|
}
|
108917
110526
|
}
|
108918
110527
|
}
|
@@ -108936,7 +110545,8 @@ Schema for the result of a validateContext call when invalid context is passed
|
|
108936
110545
|
"name": "Cincinnati",
|
108937
110546
|
"tags": {
|
108938
110547
|
"type": [
|
108939
|
-
"Weather Station"
|
110548
|
+
"Weather Station",
|
110549
|
+
"Sensor"
|
108940
110550
|
],
|
108941
110551
|
"region": [
|
108942
110552
|
"Midwest"
|
@@ -108944,6 +110554,17 @@ Schema for the result of a validateContext call when invalid context is passed
|
|
108944
110554
|
"DeviceRecipe": [
|
108945
110555
|
"Weather Station"
|
108946
110556
|
]
|
110557
|
+
},
|
110558
|
+
"attributes": {
|
110559
|
+
"temperature": {
|
110560
|
+
"dataType": "number",
|
110561
|
+
"tags": {
|
110562
|
+
"units": "celsius"
|
110563
|
+
}
|
110564
|
+
},
|
110565
|
+
"dew-point": {
|
110566
|
+
"dataType": "number"
|
110567
|
+
}
|
108947
110568
|
}
|
108948
110569
|
},
|
108949
110570
|
"deviceId-noValidationNoFullDevice": "589de9bca1975a00017b2296",
|
@@ -109037,6 +110658,40 @@ Schema for the result of a successful validateContext call
|
|
109037
110658
|
}
|
109038
110659
|
}
|
109039
110660
|
}
|
110661
|
+
},
|
110662
|
+
"attributes": {
|
110663
|
+
"type": "object",
|
110664
|
+
"patternProperties": {
|
110665
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
110666
|
+
"type": "object",
|
110667
|
+
"properties": {
|
110668
|
+
"dataType": {
|
110669
|
+
"type": "string",
|
110670
|
+
"enum": [
|
110671
|
+
"string",
|
110672
|
+
"number",
|
110673
|
+
"gps",
|
110674
|
+
"boolean",
|
110675
|
+
"blob"
|
110676
|
+
]
|
110677
|
+
},
|
110678
|
+
"description": {
|
110679
|
+
"type": "string",
|
110680
|
+
"maxLength": 32767
|
110681
|
+
},
|
110682
|
+
"tags": {
|
110683
|
+
"type": "object",
|
110684
|
+
"patternProperties": {
|
110685
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
110686
|
+
"type": "string",
|
110687
|
+
"minLength": 1,
|
110688
|
+
"maxLength": 255
|
110689
|
+
}
|
110690
|
+
}
|
110691
|
+
}
|
110692
|
+
}
|
110693
|
+
}
|
110694
|
+
}
|
109040
110695
|
}
|
109041
110696
|
}
|
109042
110697
|
}
|
@@ -109059,7 +110714,8 @@ Schema for the result of a successful validateContext call
|
|
109059
110714
|
"name": "Cincinnati",
|
109060
110715
|
"tags": {
|
109061
110716
|
"type": [
|
109062
|
-
"Weather Station"
|
110717
|
+
"Weather Station",
|
110718
|
+
"Sensor"
|
109063
110719
|
],
|
109064
110720
|
"region": [
|
109065
110721
|
"Midwest"
|
@@ -109067,6 +110723,17 @@ Schema for the result of a successful validateContext call
|
|
109067
110723
|
"DeviceRecipe": [
|
109068
110724
|
"Weather Station"
|
109069
110725
|
]
|
110726
|
+
},
|
110727
|
+
"attributes": {
|
110728
|
+
"temperature": {
|
110729
|
+
"dataType": "number",
|
110730
|
+
"tags": {
|
110731
|
+
"units": "celsius"
|
110732
|
+
}
|
110733
|
+
},
|
110734
|
+
"dew-point": {
|
110735
|
+
"dataType": "number"
|
110736
|
+
}
|
109070
110737
|
}
|
109071
110738
|
},
|
109072
110739
|
"deviceId-noValidationNoFullDevice": "589de9bca1975a00017b2296",
|