losant_rest 1.16.6 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +2916 -598
- data/docs/applicationApiTokens.md +1 -1
- data/docs/events.md +1 -1
- data/docs/notebook.md +1 -1
- data/docs/resourceJob.md +263 -0
- data/docs/resourceJobs.md +93 -0
- data/lib/losant_rest/application_api_tokens.rb +1 -1
- data/lib/losant_rest/client.rb +10 -2
- data/lib/losant_rest/events.rb +1 -1
- data/lib/losant_rest/notebook.rb +1 -1
- data/lib/losant_rest/resource_job.rb +326 -0
- data/lib/losant_rest/resource_jobs.rb +138 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +2 -0
- data/schemas/apiTokenPost.json +10 -0
- data/schemas/applicationCreationByTemplateResult.json +1 -9
- data/schemas/applicationExportPost.json +4 -0
- data/schemas/applicationTemplate.json +3 -0
- data/schemas/applicationTemplates.json +3 -0
- data/schemas/auditLog.json +2 -1
- data/schemas/auditLogFilter.json +2 -1
- data/schemas/auditLogs.json +2 -1
- data/schemas/dataTableRowInsertResult.json +2 -1
- data/schemas/eventPlusNewCount.json +161 -0
- data/schemas/experienceLinkedResources.json +33 -6
- data/schemas/flow.json +8 -2
- data/schemas/flowPatch.json +8 -2
- data/schemas/flowPost.json +8 -2
- data/schemas/flowVersion.json +25 -4
- data/schemas/flowVersionPost.json +8 -2
- data/schemas/flowVersions.json +25 -4
- data/schemas/flows.json +8 -2
- data/schemas/flowsImportPost.json +16 -4
- data/schemas/flowsImportResult.json +33 -6
- data/schemas/githubLogin.json +10 -0
- data/schemas/historicalSummaries.json +524 -1
- data/schemas/historicalSummary.json +22 -0
- data/schemas/importIntoApplicationOptions.json +6 -1
- data/schemas/importNewApplicationOptions.json +6 -1
- data/schemas/instance.json +12 -0
- data/schemas/instanceCustomNodePatch.json +8 -2
- data/schemas/instanceCustomNodePost.json +8 -2
- data/schemas/instanceOrg.json +3 -0
- data/schemas/instanceOrgPatch.json +4 -0
- data/schemas/instanceOrgPost.json +4 -0
- data/schemas/instanceOrgs.json +3 -0
- data/schemas/instanceSandbox.json +11 -0
- data/schemas/instanceSandboxes.json +433 -1
- data/schemas/instances.json +217 -1
- data/schemas/me.json +11 -0
- data/schemas/notebookExecutionLogs.json +3 -1
- data/schemas/org.json +11 -0
- data/schemas/orgs.json +11 -0
- data/schemas/payloadStats.json +8 -0
- data/schemas/resourceJob.json +86 -0
- data/schemas/resourceJobExecutionLogs.json +127 -0
- data/schemas/resourceJobExecutionOptions.json +11 -0
- data/schemas/resourceJobPatch.json +55 -0
- data/schemas/resourceJobPost.json +66 -0
- data/schemas/resourceJobs.json +131 -0
- data/schemas/samlResponse.json +10 -0
- data/schemas/userCredentials.json +10 -0
- data/schemas/userPost.json +10 -0
- data/schemas/validateContextError.json +4 -0
- data/schemas/validationErrors.json +1 -9
- metadata +13 -2
data/docs/_schemas.md
CHANGED
@@ -121,6 +121,7 @@
|
|
121
121
|
* [Error](#error)
|
122
122
|
* [Event](#event)
|
123
123
|
* [Event Patch](#event-patch)
|
124
|
+
* [Event Plus New Count](#event-plus-new-count)
|
124
125
|
* [Event Post](#event-post)
|
125
126
|
* [Event Tags Summary](#event-tags-summary)
|
126
127
|
* [Events](#events)
|
@@ -246,6 +247,12 @@
|
|
246
247
|
* [Payload Stats](#payload-stats)
|
247
248
|
* [Recent Item](#recent-item)
|
248
249
|
* [Recent Item List](#recent-item-list)
|
250
|
+
* [Resource Job](#resource-job)
|
251
|
+
* [Resource Job Execution Logs](#resource-job-execution-logs)
|
252
|
+
* [Resource Job Execution Options](#resource-job-execution-options)
|
253
|
+
* [Resource Job Patch](#resource-job-patch)
|
254
|
+
* [Resource Job Post](#resource-job-post)
|
255
|
+
* [Resource Jobs](#resource-jobs)
|
249
256
|
* [Resource Transfer](#resource-transfer)
|
250
257
|
* [SAML Response](#saml-response)
|
251
258
|
* [SSO Request](#sso-request)
|
@@ -7547,6 +7554,8 @@ Schema for the body of an API Token creation request
|
|
7547
7554
|
"flows.*",
|
7548
7555
|
"flowVersion.*",
|
7549
7556
|
"flowVersions.*",
|
7557
|
+
"resourceJobs.*",
|
7558
|
+
"resourceJob.*",
|
7550
7559
|
"notebook.*",
|
7551
7560
|
"notebooks.*",
|
7552
7561
|
"webhook.*",
|
@@ -7759,6 +7768,14 @@ Schema for the body of an API Token creation request
|
|
7759
7768
|
"notebook.upload",
|
7760
7769
|
"notebooks.get",
|
7761
7770
|
"notebooks.post",
|
7771
|
+
"resourceJob.get",
|
7772
|
+
"resourceJob.logs",
|
7773
|
+
"resourceJob.patch",
|
7774
|
+
"resourceJob.delete",
|
7775
|
+
"resourceJob.execute",
|
7776
|
+
"resourceJob.cancelExecution",
|
7777
|
+
"resourceJobs.get",
|
7778
|
+
"resourceJobs.post",
|
7762
7779
|
"webhook.delete",
|
7763
7780
|
"webhook.get",
|
7764
7781
|
"webhook.patch",
|
@@ -8506,7 +8523,7 @@ Schema for a single Application
|
|
8506
8523
|
"s3": {
|
8507
8524
|
"bucket": "bucketName",
|
8508
8525
|
"accessKeyId": "awsAccessKey",
|
8509
|
-
"
|
8526
|
+
"secretAccessKey": "awsSecretKey",
|
8510
8527
|
"region": "us-west-1"
|
8511
8528
|
},
|
8512
8529
|
"mode": "all",
|
@@ -8875,7 +8892,7 @@ Schema for a collection of Application Certificate Authorities
|
|
8875
8892
|
"status": "active",
|
8876
8893
|
"name": "my certificate authority",
|
8877
8894
|
"description": "An example certificate authority description",
|
8878
|
-
"caBundle": "
|
8895
|
+
"caBundle": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
|
8879
8896
|
"caInfo": [
|
8880
8897
|
{
|
8881
8898
|
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
@@ -9001,7 +9018,7 @@ Schema for a single Application Certificate Authority
|
|
9001
9018
|
"status": "active",
|
9002
9019
|
"name": "my certificate authority",
|
9003
9020
|
"description": "An example certificate authority description",
|
9004
|
-
"caBundle": "
|
9021
|
+
"caBundle": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
|
9005
9022
|
"caInfo": [
|
9006
9023
|
{
|
9007
9024
|
"serialNumber": "ad:0e:ff:63:27:83:e5:3e:6b:a9:fb:57:0d:37:fc:e9",
|
@@ -9110,7 +9127,7 @@ Schema for the body of an Application Certificate Authority creation request
|
|
9110
9127
|
{
|
9111
9128
|
"name": "my certificate authority",
|
9112
9129
|
"description": "An example new authority description",
|
9113
|
-
"caBundle": "
|
9130
|
+
"caBundle": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----"
|
9114
9131
|
}
|
9115
9132
|
```
|
9116
9133
|
|
@@ -9292,7 +9309,7 @@ Schema for the body of an Application Certificate creation request
|
|
9292
9309
|
```json
|
9293
9310
|
{
|
9294
9311
|
"description": "An example new certificate description",
|
9295
|
-
"certificate": "
|
9312
|
+
"certificate": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
|
9296
9313
|
"filterType": "all",
|
9297
9314
|
"pubTopics": [],
|
9298
9315
|
"subTopics": []
|
@@ -10012,15 +10029,7 @@ Schema for creating an application by template result
|
|
10012
10029
|
"type": "string"
|
10013
10030
|
},
|
10014
10031
|
"id": {
|
10015
|
-
"
|
10016
|
-
{
|
10017
|
-
"type": "string",
|
10018
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
10019
|
-
},
|
10020
|
-
{
|
10021
|
-
"type": "string"
|
10022
|
-
}
|
10023
|
-
]
|
10032
|
+
"type": "string"
|
10024
10033
|
},
|
10025
10034
|
"message": {
|
10026
10035
|
"type": "string"
|
@@ -10057,7 +10066,7 @@ Schema for creating an application by template result
|
|
10057
10066
|
"s3": {
|
10058
10067
|
"bucket": "bucketName",
|
10059
10068
|
"accessKeyId": "awsAccessKey",
|
10060
|
-
"
|
10069
|
+
"secretAccessKey": "awsSecretKey",
|
10061
10070
|
"region": "us-west-1"
|
10062
10071
|
},
|
10063
10072
|
"mode": "all",
|
@@ -16134,6 +16143,10 @@ Schema for the body of an application export request
|
|
16134
16143
|
"type": "string",
|
16135
16144
|
"format": "uri",
|
16136
16145
|
"maxLength": 1024
|
16146
|
+
},
|
16147
|
+
"forceJob": {
|
16148
|
+
"type": "boolean",
|
16149
|
+
"default": false
|
16137
16150
|
}
|
16138
16151
|
},
|
16139
16152
|
"additionalProperties": false
|
@@ -17520,7 +17533,7 @@ Results of a search of an application's resources
|
|
17520
17533
|
```json
|
17521
17534
|
[
|
17522
17535
|
{
|
17523
|
-
"
|
17536
|
+
"_type": "device",
|
17524
17537
|
"name": "My Device #1",
|
17525
17538
|
"metadata": {
|
17526
17539
|
"descriptor": "a basic description of device #1"
|
@@ -17648,6 +17661,9 @@ Schema for a single Application Template
|
|
17648
17661
|
"notebookCount": {
|
17649
17662
|
"type": "integer"
|
17650
17663
|
},
|
17664
|
+
"resourceJobCount": {
|
17665
|
+
"type": "integer"
|
17666
|
+
},
|
17651
17667
|
"dataTableCsvSize": {
|
17652
17668
|
"type": "integer"
|
17653
17669
|
},
|
@@ -17687,6 +17703,7 @@ Schema for a single Application Template
|
|
17687
17703
|
"flowCount": 1,
|
17688
17704
|
"integrationCount": 0,
|
17689
17705
|
"notebookCount": 0,
|
17706
|
+
"resourceJobCount": 0,
|
17690
17707
|
"dataTableCsvSize": 4008,
|
17691
17708
|
"webhookCount": 0
|
17692
17709
|
}
|
@@ -17958,477 +17975,481 @@ Schema for a collection of Application Templates
|
|
17958
17975
|
"notebookCount": {
|
17959
17976
|
"type": "integer"
|
17960
17977
|
},
|
17961
|
-
"
|
17962
|
-
"type": "integer"
|
17963
|
-
},
|
17964
|
-
"webhookCount": {
|
17965
|
-
"type": "integer"
|
17966
|
-
}
|
17967
|
-
}
|
17968
|
-
}
|
17969
|
-
}
|
17970
|
-
}
|
17971
|
-
},
|
17972
|
-
"count": {
|
17973
|
-
"type": "integer"
|
17974
|
-
},
|
17975
|
-
"totalCount": {
|
17976
|
-
"type": "integer"
|
17977
|
-
},
|
17978
|
-
"perPage": {
|
17979
|
-
"type": "integer"
|
17980
|
-
},
|
17981
|
-
"page": {
|
17982
|
-
"type": "integer"
|
17983
|
-
},
|
17984
|
-
"filter": {
|
17985
|
-
"type": "string"
|
17986
|
-
},
|
17987
|
-
"filterField": {
|
17988
|
-
"type": "string"
|
17989
|
-
},
|
17990
|
-
"categoryId": {
|
17991
|
-
"type": "string",
|
17992
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
17993
|
-
},
|
17994
|
-
"keywords": {
|
17995
|
-
"type": "array",
|
17996
|
-
"items": {
|
17997
|
-
"type": "string",
|
17998
|
-
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
17999
|
-
},
|
18000
|
-
"maxItems": 100
|
18001
|
-
},
|
18002
|
-
"sortField": {
|
18003
|
-
"type": "string"
|
18004
|
-
},
|
18005
|
-
"sortDirection": {
|
18006
|
-
"type": "string",
|
18007
|
-
"enum": [
|
18008
|
-
"asc",
|
18009
|
-
"desc",
|
18010
|
-
"ASC",
|
18011
|
-
"DESC",
|
18012
|
-
""
|
18013
|
-
]
|
18014
|
-
}
|
18015
|
-
}
|
18016
|
-
}
|
18017
|
-
```
|
18018
|
-
### <a name="application-templates-example"></a> Example
|
18019
|
-
|
18020
|
-
```json
|
18021
|
-
{
|
18022
|
-
"items": [
|
18023
|
-
{
|
18024
|
-
"id": "586e9d5151265cb9d72f6ec6",
|
18025
|
-
"creationDate": "2020-01-13T04:00:00.000Z",
|
18026
|
-
"lastUpdated": "2020-01-13T04:00:00.000Z",
|
18027
|
-
"name": "smart environment",
|
18028
|
-
"description": "a smart env set up",
|
18029
|
-
"public": true,
|
18030
|
-
"authorName": "Example Author",
|
18031
|
-
"authorUrl": "https://example.com/theAuther",
|
18032
|
-
"templateUrl": "https://example.com/theTemplate",
|
18033
|
-
"summary": {
|
18034
|
-
"applicationCertificateAuthorityCount": 0,
|
18035
|
-
"dashboardCount": 0,
|
18036
|
-
"deviceCount": 1,
|
18037
|
-
"deviceRecipeCount": 0,
|
18038
|
-
"dataTableCount": 2,
|
18039
|
-
"fileCount": 0,
|
18040
|
-
"experienceGroupCount": 1,
|
18041
|
-
"experienceUserCount": 1,
|
18042
|
-
"experienceVersionCount": 3,
|
18043
|
-
"experienceViewCount": 6,
|
18044
|
-
"experienceEndpointCount": 6,
|
18045
|
-
"flowCount": 1,
|
18046
|
-
"integrationCount": 0,
|
18047
|
-
"notebookCount": 0,
|
18048
|
-
"dataTableCsvSize": 4008,
|
18049
|
-
"webhookCount": 0
|
18050
|
-
}
|
18051
|
-
}
|
18052
|
-
],
|
18053
|
-
"count": 1,
|
18054
|
-
"totalCount": 8,
|
18055
|
-
"perPage": 1,
|
18056
|
-
"page": 0,
|
18057
|
-
"sortField": "name",
|
18058
|
-
"sortDirection": "asc"
|
18059
|
-
}
|
18060
|
-
```
|
18061
|
-
|
18062
|
-
<br/>
|
18063
|
-
|
18064
|
-
## Applications
|
18065
|
-
|
18066
|
-
Schema for a collection of Applications
|
18067
|
-
|
18068
|
-
### <a name="applications-schema"></a> Schema
|
18069
|
-
|
18070
|
-
```json
|
18071
|
-
{
|
18072
|
-
"$schema": "http://json-schema.org/draft-07/schema#",
|
18073
|
-
"type": "object",
|
18074
|
-
"properties": {
|
18075
|
-
"items": {
|
18076
|
-
"type": "array",
|
18077
|
-
"items": {
|
18078
|
-
"title": "Application",
|
18079
|
-
"description": "Schema for a single Application",
|
18080
|
-
"type": "object",
|
18081
|
-
"properties": {
|
18082
|
-
"id": {
|
18083
|
-
"type": "string",
|
18084
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
18085
|
-
},
|
18086
|
-
"applicationId": {
|
18087
|
-
"type": "string",
|
18088
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
18089
|
-
},
|
18090
|
-
"creationDate": {
|
18091
|
-
"type": "string",
|
18092
|
-
"format": "date-time"
|
18093
|
-
},
|
18094
|
-
"lastUpdated": {
|
18095
|
-
"type": "string",
|
18096
|
-
"format": "date-time"
|
18097
|
-
},
|
18098
|
-
"appliedTemplateIds": {
|
18099
|
-
"type": "array",
|
18100
|
-
"items": {
|
18101
|
-
"type": "string",
|
18102
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
18103
|
-
},
|
18104
|
-
"maxItems": 1000
|
18105
|
-
},
|
18106
|
-
"ownerId": {
|
18107
|
-
"type": "string",
|
18108
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
18109
|
-
},
|
18110
|
-
"ownerType": {
|
18111
|
-
"type": "string",
|
18112
|
-
"enum": [
|
18113
|
-
"user",
|
18114
|
-
"organization"
|
18115
|
-
]
|
18116
|
-
},
|
18117
|
-
"organizationName": {
|
18118
|
-
"type": "string",
|
18119
|
-
"minLength": 1,
|
18120
|
-
"maxLength": 255
|
18121
|
-
},
|
18122
|
-
"organizationIconColor": {
|
18123
|
-
"type": "string",
|
18124
|
-
"maxLength": 64
|
18125
|
-
},
|
18126
|
-
"name": {
|
18127
|
-
"type": "string",
|
18128
|
-
"minLength": 1,
|
18129
|
-
"maxLength": 255
|
18130
|
-
},
|
18131
|
-
"description": {
|
18132
|
-
"type": "string",
|
18133
|
-
"maxLength": 1024
|
18134
|
-
},
|
18135
|
-
"endpointSlug": {
|
18136
|
-
"type": "string",
|
18137
|
-
"minLength": 3,
|
18138
|
-
"maxLength": 63,
|
18139
|
-
"pattern": "^[0-9a-z-]*$"
|
18140
|
-
},
|
18141
|
-
"expUserTokenCutoff": {
|
18142
|
-
"type": "string",
|
18143
|
-
"format": "date-time"
|
18144
|
-
},
|
18145
|
-
"endpointDefaultCors": {
|
18146
|
-
"type": "boolean"
|
18147
|
-
},
|
18148
|
-
"globals": {
|
18149
|
-
"type": "array",
|
18150
|
-
"maxItems": 100,
|
18151
|
-
"items": {
|
18152
|
-
"type": "object",
|
18153
|
-
"properties": {
|
18154
|
-
"key": {
|
18155
|
-
"type": "string",
|
18156
|
-
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
18157
|
-
},
|
18158
|
-
"json": {
|
18159
|
-
"type": "string",
|
18160
|
-
"minLength": 1,
|
18161
|
-
"maxLength": 32767
|
18162
|
-
},
|
18163
|
-
"cloudOnly": {
|
18164
|
-
"type": "boolean",
|
18165
|
-
"default": false
|
18166
|
-
},
|
18167
|
-
"description": {
|
18168
|
-
"type": "string",
|
18169
|
-
"maxLength": 1024
|
18170
|
-
}
|
18171
|
-
},
|
18172
|
-
"additionalProperties": false,
|
18173
|
-
"required": [
|
18174
|
-
"key",
|
18175
|
-
"json"
|
18176
|
-
]
|
18177
|
-
}
|
18178
|
-
},
|
18179
|
-
"blobUrlTTL": {
|
18180
|
-
"type": "number",
|
18181
|
-
"minimum": 3600,
|
18182
|
-
"maximum": 604800
|
18183
|
-
},
|
18184
|
-
"summary": {
|
18185
|
-
"type": "object",
|
18186
|
-
"properties": {
|
18187
|
-
"apiTokenCount": {
|
18188
|
-
"type": "integer"
|
18189
|
-
},
|
18190
|
-
"dataTableCount": {
|
18191
|
-
"type": "integer"
|
18192
|
-
},
|
18193
|
-
"deviceCount": {
|
18194
|
-
"type": "integer"
|
18195
|
-
},
|
18196
|
-
"deviceRecipeCount": {
|
18197
|
-
"type": "integer"
|
18198
|
-
},
|
18199
|
-
"eventCount": {
|
18200
|
-
"type": "integer"
|
18201
|
-
},
|
18202
|
-
"experienceDomainCount": {
|
18203
|
-
"type": "integer"
|
18204
|
-
},
|
18205
|
-
"experienceEndpointCount": {
|
18206
|
-
"type": "integer"
|
18207
|
-
},
|
18208
|
-
"experienceGroupCount": {
|
18209
|
-
"type": "integer"
|
18210
|
-
},
|
18211
|
-
"experienceSlugCount": {
|
18212
|
-
"type": "integer"
|
18213
|
-
},
|
18214
|
-
"experienceUserCount": {
|
18215
|
-
"type": "integer"
|
18216
|
-
},
|
18217
|
-
"experienceVersionCount": {
|
18218
|
-
"type": "integer"
|
18219
|
-
},
|
18220
|
-
"experienceViewCount": {
|
18221
|
-
"type": "integer"
|
18222
|
-
},
|
18223
|
-
"fileCount": {
|
18224
|
-
"type": "integer"
|
18225
|
-
},
|
18226
|
-
"flowCount": {
|
18227
|
-
"type": "integer"
|
18228
|
-
},
|
18229
|
-
"integrationCount": {
|
17978
|
+
"resourceJobCount": {
|
18230
17979
|
"type": "integer"
|
18231
17980
|
},
|
18232
|
-
"
|
17981
|
+
"dataTableCsvSize": {
|
18233
17982
|
"type": "integer"
|
18234
17983
|
},
|
18235
|
-
"storageStats": {
|
18236
|
-
"type": "object",
|
18237
|
-
"properties": {
|
18238
|
-
"count": {
|
18239
|
-
"type": "integer"
|
18240
|
-
},
|
18241
|
-
"size": {
|
18242
|
-
"type": "integer"
|
18243
|
-
}
|
18244
|
-
}
|
18245
|
-
},
|
18246
17984
|
"webhookCount": {
|
18247
17985
|
"type": "integer"
|
18248
17986
|
}
|
18249
17987
|
}
|
18250
|
-
}
|
18251
|
-
|
18252
|
-
|
18253
|
-
|
18254
|
-
|
18255
|
-
|
18256
|
-
|
18257
|
-
|
18258
|
-
|
18259
|
-
|
18260
|
-
|
18261
|
-
|
18262
|
-
|
18263
|
-
|
18264
|
-
|
18265
|
-
|
18266
|
-
|
18267
|
-
|
18268
|
-
|
18269
|
-
|
18270
|
-
|
18271
|
-
|
18272
|
-
|
18273
|
-
|
18274
|
-
|
18275
|
-
|
18276
|
-
|
18277
|
-
|
18278
|
-
|
18279
|
-
|
18280
|
-
|
18281
|
-
|
18282
|
-
|
18283
|
-
|
18284
|
-
|
18285
|
-
|
18286
|
-
|
18287
|
-
|
18288
|
-
|
18289
|
-
|
18290
|
-
|
18291
|
-
|
18292
|
-
|
18293
|
-
|
18294
|
-
|
18295
|
-
|
18296
|
-
|
18297
|
-
|
18298
|
-
|
18299
|
-
|
18300
|
-
|
18301
|
-
|
18302
|
-
|
18303
|
-
|
18304
|
-
|
18305
|
-
|
18306
|
-
|
18307
|
-
|
18308
|
-
|
18309
|
-
|
18310
|
-
|
18311
|
-
|
18312
|
-
|
18313
|
-
|
18314
|
-
|
18315
|
-
|
18316
|
-
|
18317
|
-
|
18318
|
-
|
18319
|
-
|
18320
|
-
|
18321
|
-
|
18322
|
-
|
18323
|
-
|
18324
|
-
|
18325
|
-
|
18326
|
-
|
18327
|
-
|
18328
|
-
|
18329
|
-
|
18330
|
-
|
18331
|
-
|
18332
|
-
|
18333
|
-
|
18334
|
-
|
18335
|
-
|
18336
|
-
|
18337
|
-
|
18338
|
-
|
18339
|
-
|
18340
|
-
|
18341
|
-
|
18342
|
-
|
18343
|
-
|
18344
|
-
|
18345
|
-
|
18346
|
-
|
18347
|
-
|
18348
|
-
|
18349
|
-
|
18350
|
-
|
18351
|
-
|
18352
|
-
|
18353
|
-
|
18354
|
-
|
18355
|
-
|
18356
|
-
|
18357
|
-
|
18358
|
-
|
18359
|
-
|
18360
|
-
|
18361
|
-
|
18362
|
-
|
18363
|
-
|
18364
|
-
|
18365
|
-
|
18366
|
-
|
18367
|
-
|
18368
|
-
|
18369
|
-
|
18370
|
-
|
18371
|
-
|
18372
|
-
|
18373
|
-
|
18374
|
-
|
18375
|
-
|
18376
|
-
|
18377
|
-
|
18378
|
-
|
18379
|
-
|
18380
|
-
|
18381
|
-
|
18382
|
-
|
18383
|
-
|
18384
|
-
|
18385
|
-
|
18386
|
-
|
18387
|
-
|
18388
|
-
|
18389
|
-
|
18390
|
-
|
18391
|
-
|
18392
|
-
|
18393
|
-
|
18394
|
-
|
18395
|
-
|
18396
|
-
|
18397
|
-
|
18398
|
-
|
18399
|
-
|
18400
|
-
|
18401
|
-
|
18402
|
-
|
18403
|
-
|
18404
|
-
|
18405
|
-
|
18406
|
-
|
18407
|
-
|
18408
|
-
|
18409
|
-
|
18410
|
-
|
18411
|
-
|
18412
|
-
|
18413
|
-
|
18414
|
-
|
18415
|
-
|
18416
|
-
|
18417
|
-
|
18418
|
-
|
18419
|
-
|
18420
|
-
|
18421
|
-
|
18422
|
-
|
18423
|
-
|
18424
|
-
|
18425
|
-
|
18426
|
-
|
18427
|
-
|
18428
|
-
|
18429
|
-
|
18430
|
-
|
18431
|
-
|
17988
|
+
}
|
17989
|
+
}
|
17990
|
+
}
|
17991
|
+
},
|
17992
|
+
"count": {
|
17993
|
+
"type": "integer"
|
17994
|
+
},
|
17995
|
+
"totalCount": {
|
17996
|
+
"type": "integer"
|
17997
|
+
},
|
17998
|
+
"perPage": {
|
17999
|
+
"type": "integer"
|
18000
|
+
},
|
18001
|
+
"page": {
|
18002
|
+
"type": "integer"
|
18003
|
+
},
|
18004
|
+
"filter": {
|
18005
|
+
"type": "string"
|
18006
|
+
},
|
18007
|
+
"filterField": {
|
18008
|
+
"type": "string"
|
18009
|
+
},
|
18010
|
+
"categoryId": {
|
18011
|
+
"type": "string",
|
18012
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18013
|
+
},
|
18014
|
+
"keywords": {
|
18015
|
+
"type": "array",
|
18016
|
+
"items": {
|
18017
|
+
"type": "string",
|
18018
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
18019
|
+
},
|
18020
|
+
"maxItems": 100
|
18021
|
+
},
|
18022
|
+
"sortField": {
|
18023
|
+
"type": "string"
|
18024
|
+
},
|
18025
|
+
"sortDirection": {
|
18026
|
+
"type": "string",
|
18027
|
+
"enum": [
|
18028
|
+
"asc",
|
18029
|
+
"desc",
|
18030
|
+
"ASC",
|
18031
|
+
"DESC",
|
18032
|
+
""
|
18033
|
+
]
|
18034
|
+
}
|
18035
|
+
}
|
18036
|
+
}
|
18037
|
+
```
|
18038
|
+
### <a name="application-templates-example"></a> Example
|
18039
|
+
|
18040
|
+
```json
|
18041
|
+
{
|
18042
|
+
"items": [
|
18043
|
+
{
|
18044
|
+
"id": "586e9d5151265cb9d72f6ec6",
|
18045
|
+
"creationDate": "2020-01-13T04:00:00.000Z",
|
18046
|
+
"lastUpdated": "2020-01-13T04:00:00.000Z",
|
18047
|
+
"name": "smart environment",
|
18048
|
+
"description": "a smart env set up",
|
18049
|
+
"public": true,
|
18050
|
+
"authorName": "Example Author",
|
18051
|
+
"authorUrl": "https://example.com/theAuther",
|
18052
|
+
"templateUrl": "https://example.com/theTemplate",
|
18053
|
+
"summary": {
|
18054
|
+
"applicationCertificateAuthorityCount": 0,
|
18055
|
+
"dashboardCount": 0,
|
18056
|
+
"deviceCount": 1,
|
18057
|
+
"deviceRecipeCount": 0,
|
18058
|
+
"dataTableCount": 2,
|
18059
|
+
"fileCount": 0,
|
18060
|
+
"experienceGroupCount": 1,
|
18061
|
+
"experienceUserCount": 1,
|
18062
|
+
"experienceVersionCount": 3,
|
18063
|
+
"experienceViewCount": 6,
|
18064
|
+
"experienceEndpointCount": 6,
|
18065
|
+
"flowCount": 1,
|
18066
|
+
"integrationCount": 0,
|
18067
|
+
"notebookCount": 0,
|
18068
|
+
"resourceJobCount": 0,
|
18069
|
+
"dataTableCsvSize": 4008,
|
18070
|
+
"webhookCount": 0
|
18071
|
+
}
|
18072
|
+
}
|
18073
|
+
],
|
18074
|
+
"count": 1,
|
18075
|
+
"totalCount": 8,
|
18076
|
+
"perPage": 1,
|
18077
|
+
"page": 0,
|
18078
|
+
"sortField": "name",
|
18079
|
+
"sortDirection": "asc"
|
18080
|
+
}
|
18081
|
+
```
|
18082
|
+
|
18083
|
+
<br/>
|
18084
|
+
|
18085
|
+
## Applications
|
18086
|
+
|
18087
|
+
Schema for a collection of Applications
|
18088
|
+
|
18089
|
+
### <a name="applications-schema"></a> Schema
|
18090
|
+
|
18091
|
+
```json
|
18092
|
+
{
|
18093
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
18094
|
+
"type": "object",
|
18095
|
+
"properties": {
|
18096
|
+
"items": {
|
18097
|
+
"type": "array",
|
18098
|
+
"items": {
|
18099
|
+
"title": "Application",
|
18100
|
+
"description": "Schema for a single Application",
|
18101
|
+
"type": "object",
|
18102
|
+
"properties": {
|
18103
|
+
"id": {
|
18104
|
+
"type": "string",
|
18105
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18106
|
+
},
|
18107
|
+
"applicationId": {
|
18108
|
+
"type": "string",
|
18109
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18110
|
+
},
|
18111
|
+
"creationDate": {
|
18112
|
+
"type": "string",
|
18113
|
+
"format": "date-time"
|
18114
|
+
},
|
18115
|
+
"lastUpdated": {
|
18116
|
+
"type": "string",
|
18117
|
+
"format": "date-time"
|
18118
|
+
},
|
18119
|
+
"appliedTemplateIds": {
|
18120
|
+
"type": "array",
|
18121
|
+
"items": {
|
18122
|
+
"type": "string",
|
18123
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18124
|
+
},
|
18125
|
+
"maxItems": 1000
|
18126
|
+
},
|
18127
|
+
"ownerId": {
|
18128
|
+
"type": "string",
|
18129
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18130
|
+
},
|
18131
|
+
"ownerType": {
|
18132
|
+
"type": "string",
|
18133
|
+
"enum": [
|
18134
|
+
"user",
|
18135
|
+
"organization"
|
18136
|
+
]
|
18137
|
+
},
|
18138
|
+
"organizationName": {
|
18139
|
+
"type": "string",
|
18140
|
+
"minLength": 1,
|
18141
|
+
"maxLength": 255
|
18142
|
+
},
|
18143
|
+
"organizationIconColor": {
|
18144
|
+
"type": "string",
|
18145
|
+
"maxLength": 64
|
18146
|
+
},
|
18147
|
+
"name": {
|
18148
|
+
"type": "string",
|
18149
|
+
"minLength": 1,
|
18150
|
+
"maxLength": 255
|
18151
|
+
},
|
18152
|
+
"description": {
|
18153
|
+
"type": "string",
|
18154
|
+
"maxLength": 1024
|
18155
|
+
},
|
18156
|
+
"endpointSlug": {
|
18157
|
+
"type": "string",
|
18158
|
+
"minLength": 3,
|
18159
|
+
"maxLength": 63,
|
18160
|
+
"pattern": "^[0-9a-z-]*$"
|
18161
|
+
},
|
18162
|
+
"expUserTokenCutoff": {
|
18163
|
+
"type": "string",
|
18164
|
+
"format": "date-time"
|
18165
|
+
},
|
18166
|
+
"endpointDefaultCors": {
|
18167
|
+
"type": "boolean"
|
18168
|
+
},
|
18169
|
+
"globals": {
|
18170
|
+
"type": "array",
|
18171
|
+
"maxItems": 100,
|
18172
|
+
"items": {
|
18173
|
+
"type": "object",
|
18174
|
+
"properties": {
|
18175
|
+
"key": {
|
18176
|
+
"type": "string",
|
18177
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
18178
|
+
},
|
18179
|
+
"json": {
|
18180
|
+
"type": "string",
|
18181
|
+
"minLength": 1,
|
18182
|
+
"maxLength": 32767
|
18183
|
+
},
|
18184
|
+
"cloudOnly": {
|
18185
|
+
"type": "boolean",
|
18186
|
+
"default": false
|
18187
|
+
},
|
18188
|
+
"description": {
|
18189
|
+
"type": "string",
|
18190
|
+
"maxLength": 1024
|
18191
|
+
}
|
18192
|
+
},
|
18193
|
+
"additionalProperties": false,
|
18194
|
+
"required": [
|
18195
|
+
"key",
|
18196
|
+
"json"
|
18197
|
+
]
|
18198
|
+
}
|
18199
|
+
},
|
18200
|
+
"blobUrlTTL": {
|
18201
|
+
"type": "number",
|
18202
|
+
"minimum": 3600,
|
18203
|
+
"maximum": 604800
|
18204
|
+
},
|
18205
|
+
"summary": {
|
18206
|
+
"type": "object",
|
18207
|
+
"properties": {
|
18208
|
+
"apiTokenCount": {
|
18209
|
+
"type": "integer"
|
18210
|
+
},
|
18211
|
+
"dataTableCount": {
|
18212
|
+
"type": "integer"
|
18213
|
+
},
|
18214
|
+
"deviceCount": {
|
18215
|
+
"type": "integer"
|
18216
|
+
},
|
18217
|
+
"deviceRecipeCount": {
|
18218
|
+
"type": "integer"
|
18219
|
+
},
|
18220
|
+
"eventCount": {
|
18221
|
+
"type": "integer"
|
18222
|
+
},
|
18223
|
+
"experienceDomainCount": {
|
18224
|
+
"type": "integer"
|
18225
|
+
},
|
18226
|
+
"experienceEndpointCount": {
|
18227
|
+
"type": "integer"
|
18228
|
+
},
|
18229
|
+
"experienceGroupCount": {
|
18230
|
+
"type": "integer"
|
18231
|
+
},
|
18232
|
+
"experienceSlugCount": {
|
18233
|
+
"type": "integer"
|
18234
|
+
},
|
18235
|
+
"experienceUserCount": {
|
18236
|
+
"type": "integer"
|
18237
|
+
},
|
18238
|
+
"experienceVersionCount": {
|
18239
|
+
"type": "integer"
|
18240
|
+
},
|
18241
|
+
"experienceViewCount": {
|
18242
|
+
"type": "integer"
|
18243
|
+
},
|
18244
|
+
"fileCount": {
|
18245
|
+
"type": "integer"
|
18246
|
+
},
|
18247
|
+
"flowCount": {
|
18248
|
+
"type": "integer"
|
18249
|
+
},
|
18250
|
+
"integrationCount": {
|
18251
|
+
"type": "integer"
|
18252
|
+
},
|
18253
|
+
"keyCount": {
|
18254
|
+
"type": "integer"
|
18255
|
+
},
|
18256
|
+
"storageStats": {
|
18257
|
+
"type": "object",
|
18258
|
+
"properties": {
|
18259
|
+
"count": {
|
18260
|
+
"type": "integer"
|
18261
|
+
},
|
18262
|
+
"size": {
|
18263
|
+
"type": "integer"
|
18264
|
+
}
|
18265
|
+
}
|
18266
|
+
},
|
18267
|
+
"webhookCount": {
|
18268
|
+
"type": "integer"
|
18269
|
+
}
|
18270
|
+
}
|
18271
|
+
},
|
18272
|
+
"ftueTracking": {
|
18273
|
+
"type": "array",
|
18274
|
+
"items": {
|
18275
|
+
"type": "object",
|
18276
|
+
"properties": {
|
18277
|
+
"name": {
|
18278
|
+
"type": "string",
|
18279
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
18280
|
+
},
|
18281
|
+
"version": {
|
18282
|
+
"type": "number"
|
18283
|
+
},
|
18284
|
+
"status": {
|
18285
|
+
"type": "string",
|
18286
|
+
"enum": [
|
18287
|
+
"skipped",
|
18288
|
+
"completed"
|
18289
|
+
]
|
18290
|
+
}
|
18291
|
+
},
|
18292
|
+
"required": [
|
18293
|
+
"name",
|
18294
|
+
"version",
|
18295
|
+
"status"
|
18296
|
+
],
|
18297
|
+
"additionalProperties": false
|
18298
|
+
},
|
18299
|
+
"maxItems": 100
|
18300
|
+
},
|
18301
|
+
"archiveConfig": {
|
18302
|
+
"type": "object",
|
18303
|
+
"properties": {
|
18304
|
+
"directory": {
|
18305
|
+
"type": "string",
|
18306
|
+
"maxLength": 255
|
18307
|
+
},
|
18308
|
+
"mode": {
|
18309
|
+
"type": "string",
|
18310
|
+
"enum": [
|
18311
|
+
"all",
|
18312
|
+
"whitelist",
|
18313
|
+
"blacklist"
|
18314
|
+
]
|
18315
|
+
},
|
18316
|
+
"deviceIds": {
|
18317
|
+
"type": "array",
|
18318
|
+
"items": {
|
18319
|
+
"type": "string",
|
18320
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18321
|
+
},
|
18322
|
+
"maxItems": 1000
|
18323
|
+
},
|
18324
|
+
"deviceTags": {
|
18325
|
+
"type": "array",
|
18326
|
+
"items": {
|
18327
|
+
"type": "object",
|
18328
|
+
"properties": {
|
18329
|
+
"key": {
|
18330
|
+
"type": "string",
|
18331
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
18332
|
+
},
|
18333
|
+
"value": {
|
18334
|
+
"type": "string",
|
18335
|
+
"minLength": 1,
|
18336
|
+
"maxLength": 255
|
18337
|
+
}
|
18338
|
+
},
|
18339
|
+
"additionalProperties": false
|
18340
|
+
},
|
18341
|
+
"maxItems": 100
|
18342
|
+
},
|
18343
|
+
"includeDevices": {
|
18344
|
+
"type": "boolean",
|
18345
|
+
"default": true
|
18346
|
+
},
|
18347
|
+
"includeEvents": {
|
18348
|
+
"type": "boolean",
|
18349
|
+
"default": false
|
18350
|
+
},
|
18351
|
+
"includeDataTables": {
|
18352
|
+
"type": "boolean",
|
18353
|
+
"default": false
|
18354
|
+
},
|
18355
|
+
"dataTablesMode": {
|
18356
|
+
"type": "string",
|
18357
|
+
"enum": [
|
18358
|
+
"all",
|
18359
|
+
"whitelist",
|
18360
|
+
"blacklist"
|
18361
|
+
]
|
18362
|
+
},
|
18363
|
+
"dataTableIds": {
|
18364
|
+
"type": "array",
|
18365
|
+
"items": {
|
18366
|
+
"type": "string",
|
18367
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
18368
|
+
},
|
18369
|
+
"maxItems": 1000
|
18370
|
+
},
|
18371
|
+
"s3": {
|
18372
|
+
"type": "object",
|
18373
|
+
"properties": {
|
18374
|
+
"bucket": {
|
18375
|
+
"type": "string",
|
18376
|
+
"maxLength": 255
|
18377
|
+
},
|
18378
|
+
"accessKeyId": {
|
18379
|
+
"type": "string",
|
18380
|
+
"minLength": 4,
|
18381
|
+
"maxLength": 128
|
18382
|
+
},
|
18383
|
+
"secretAccessKey": {
|
18384
|
+
"type": "string",
|
18385
|
+
"minLength": 4,
|
18386
|
+
"maxLength": 128
|
18387
|
+
},
|
18388
|
+
"region": {
|
18389
|
+
"type": "string",
|
18390
|
+
"maxLength": 128
|
18391
|
+
}
|
18392
|
+
},
|
18393
|
+
"required": [
|
18394
|
+
"bucket",
|
18395
|
+
"accessKeyId",
|
18396
|
+
"secretAccessKey",
|
18397
|
+
"region"
|
18398
|
+
],
|
18399
|
+
"additionalProperties": false
|
18400
|
+
},
|
18401
|
+
"gcs": {
|
18402
|
+
"type": "object",
|
18403
|
+
"properties": {
|
18404
|
+
"projectId": {
|
18405
|
+
"type": "string",
|
18406
|
+
"minLength": 1,
|
18407
|
+
"maxLength": 1024
|
18408
|
+
},
|
18409
|
+
"keyJson": {
|
18410
|
+
"type": "string",
|
18411
|
+
"maxLength": 32767,
|
18412
|
+
"minLength": 4
|
18413
|
+
},
|
18414
|
+
"bucket": {
|
18415
|
+
"type": "string",
|
18416
|
+
"maxLength": 255
|
18417
|
+
}
|
18418
|
+
},
|
18419
|
+
"required": [
|
18420
|
+
"projectId",
|
18421
|
+
"keyJson",
|
18422
|
+
"bucket"
|
18423
|
+
],
|
18424
|
+
"additionalProperties": false
|
18425
|
+
},
|
18426
|
+
"azure": {
|
18427
|
+
"type": "object",
|
18428
|
+
"properties": {
|
18429
|
+
"account": {
|
18430
|
+
"type": "string",
|
18431
|
+
"minLength": 3,
|
18432
|
+
"maxLength": 24
|
18433
|
+
},
|
18434
|
+
"accountKey": {
|
18435
|
+
"type": "string",
|
18436
|
+
"maxLength": 255
|
18437
|
+
},
|
18438
|
+
"bucket": {
|
18439
|
+
"type": "string",
|
18440
|
+
"minLength": 3,
|
18441
|
+
"maxLength": 63
|
18442
|
+
}
|
18443
|
+
},
|
18444
|
+
"required": [
|
18445
|
+
"account",
|
18446
|
+
"accountKey",
|
18447
|
+
"bucket"
|
18448
|
+
],
|
18449
|
+
"additionalProperties": false
|
18450
|
+
}
|
18451
|
+
},
|
18452
|
+
"additionalProperties": false
|
18432
18453
|
}
|
18433
18454
|
}
|
18434
18455
|
}
|
@@ -18493,7 +18514,7 @@ Schema for a collection of Applications
|
|
18493
18514
|
"s3": {
|
18494
18515
|
"bucket": "bucketName",
|
18495
18516
|
"accessKeyId": "awsAccessKey",
|
18496
|
-
"
|
18517
|
+
"secretAccessKey": "awsSecretKey",
|
18497
18518
|
"region": "us-west-1"
|
18498
18519
|
},
|
18499
18520
|
"mode": "all",
|
@@ -18621,7 +18642,8 @@ Schema for a single Audit Log entry
|
|
18621
18642
|
"Flow",
|
18622
18643
|
"Integration",
|
18623
18644
|
"Notebook",
|
18624
|
-
"Webhook"
|
18645
|
+
"Webhook",
|
18646
|
+
"ResourceJob"
|
18625
18647
|
]
|
18626
18648
|
},
|
18627
18649
|
"secondaryTargetName": {
|
@@ -18772,7 +18794,8 @@ Schema for the filter of an audit log query
|
|
18772
18794
|
"Flow",
|
18773
18795
|
"Integration",
|
18774
18796
|
"Notebook",
|
18775
|
-
"Webhook"
|
18797
|
+
"Webhook",
|
18798
|
+
"ResourceJob"
|
18776
18799
|
]
|
18777
18800
|
},
|
18778
18801
|
"name": {
|
@@ -18940,7 +18963,8 @@ Schema for a collection of Audit Logs
|
|
18940
18963
|
"Flow",
|
18941
18964
|
"Integration",
|
18942
18965
|
"Notebook",
|
18943
|
-
"Webhook"
|
18966
|
+
"Webhook",
|
18967
|
+
"ResourceJob"
|
18944
18968
|
]
|
18945
18969
|
},
|
18946
18970
|
"secondaryTargetName": {
|
@@ -19287,7 +19311,7 @@ Schema for the body of a request to change the current user's password
|
|
19287
19311
|
|
19288
19312
|
```json
|
19289
19313
|
{
|
19290
|
-
"newPassword": "
|
19314
|
+
"newPassword": "yourNewPassword1!",
|
19291
19315
|
"password": "yourCurrentPassword",
|
19292
19316
|
"invalidateExistingTokens": true
|
19293
19317
|
}
|
@@ -44833,7 +44857,8 @@ Schema for a the result of a single or multiple row insert
|
|
44833
44857
|
},
|
44834
44858
|
"maxItems": 1000
|
44835
44859
|
}
|
44836
|
-
}
|
44860
|
+
},
|
44861
|
+
"additionalProperties": false
|
44837
44862
|
}
|
44838
44863
|
]
|
44839
44864
|
}
|
@@ -44843,8 +44868,8 @@ Schema for a the result of a single or multiple row insert
|
|
44843
44868
|
```json
|
44844
44869
|
{
|
44845
44870
|
"id": "596fbb703fc088453872e609",
|
44846
|
-
"
|
44847
|
-
"
|
44871
|
+
"createdAt": "2016-06-13T04:00:00.000Z",
|
44872
|
+
"updatedAt": "2016-06-13T04:00:00.000Z",
|
44848
44873
|
"myColumn1": "myValue",
|
44849
44874
|
"myColumn2": 5
|
44850
44875
|
}
|
@@ -58869,7 +58894,7 @@ Schema for the body of a compiled embedded deployment files request
|
|
58869
58894
|
|
58870
58895
|
```json
|
58871
58896
|
{
|
58872
|
-
"email": "email
|
58897
|
+
"email": "email@example.com",
|
58873
58898
|
"deviceId": "575ecf887ae143cd83dc4aa2"
|
58874
58899
|
}
|
58875
58900
|
```
|
@@ -59628,6 +59653,205 @@ Schema for the body of an Event modification request
|
|
59628
59653
|
|
59629
59654
|
<br/>
|
59630
59655
|
|
59656
|
+
## Event Plus New Count
|
59657
|
+
|
59658
|
+
Schema for an event plus a count of new events
|
59659
|
+
|
59660
|
+
### <a name="event-plus-new-count-schema"></a> Schema
|
59661
|
+
|
59662
|
+
```json
|
59663
|
+
{
|
59664
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
59665
|
+
"type": "object",
|
59666
|
+
"properties": {
|
59667
|
+
"event": {
|
59668
|
+
"title": "Event",
|
59669
|
+
"description": "Schema for a single Event",
|
59670
|
+
"type": "object",
|
59671
|
+
"properties": {
|
59672
|
+
"id": {
|
59673
|
+
"type": "string",
|
59674
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
59675
|
+
},
|
59676
|
+
"eventId": {
|
59677
|
+
"type": "string",
|
59678
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
59679
|
+
},
|
59680
|
+
"applicationId": {
|
59681
|
+
"type": "string",
|
59682
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
59683
|
+
},
|
59684
|
+
"creationDate": {
|
59685
|
+
"type": "string",
|
59686
|
+
"format": "date-time"
|
59687
|
+
},
|
59688
|
+
"lastUpdated": {
|
59689
|
+
"type": "string",
|
59690
|
+
"format": "date-time"
|
59691
|
+
},
|
59692
|
+
"sourceType": {
|
59693
|
+
"type": "string",
|
59694
|
+
"enum": [
|
59695
|
+
"flow",
|
59696
|
+
"user",
|
59697
|
+
"device",
|
59698
|
+
"apiToken",
|
59699
|
+
"experienceUser",
|
59700
|
+
"public"
|
59701
|
+
]
|
59702
|
+
},
|
59703
|
+
"sourceId": {
|
59704
|
+
"type": "string",
|
59705
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
59706
|
+
},
|
59707
|
+
"sourceName": {
|
59708
|
+
"type": "string",
|
59709
|
+
"minLength": 1,
|
59710
|
+
"maxLength": 255
|
59711
|
+
},
|
59712
|
+
"level": {
|
59713
|
+
"type": "string",
|
59714
|
+
"enum": [
|
59715
|
+
"info",
|
59716
|
+
"warning",
|
59717
|
+
"error",
|
59718
|
+
"critical"
|
59719
|
+
]
|
59720
|
+
},
|
59721
|
+
"state": {
|
59722
|
+
"type": "string",
|
59723
|
+
"enum": [
|
59724
|
+
"new",
|
59725
|
+
"acknowledged",
|
59726
|
+
"resolved"
|
59727
|
+
]
|
59728
|
+
},
|
59729
|
+
"subject": {
|
59730
|
+
"type": "string",
|
59731
|
+
"minLength": 1,
|
59732
|
+
"maxLength": 255
|
59733
|
+
},
|
59734
|
+
"message": {
|
59735
|
+
"type": "string",
|
59736
|
+
"maxLength": 32767
|
59737
|
+
},
|
59738
|
+
"data": {},
|
59739
|
+
"deviceId": {
|
59740
|
+
"type": "string",
|
59741
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
59742
|
+
},
|
59743
|
+
"deviceName": {
|
59744
|
+
"type": "string",
|
59745
|
+
"minLength": 1,
|
59746
|
+
"maxLength": 255
|
59747
|
+
},
|
59748
|
+
"eventTags": {
|
59749
|
+
"type": "object",
|
59750
|
+
"patternProperties": {
|
59751
|
+
"^[0-9a-zA-Z_-]{1,255}$": {
|
59752
|
+
"type": "string",
|
59753
|
+
"minLength": 1,
|
59754
|
+
"maxLength": 255
|
59755
|
+
}
|
59756
|
+
},
|
59757
|
+
"additionalProperties": false
|
59758
|
+
},
|
59759
|
+
"updates": {
|
59760
|
+
"type": "array",
|
59761
|
+
"items": {
|
59762
|
+
"type": "object",
|
59763
|
+
"properties": {
|
59764
|
+
"sourceType": {
|
59765
|
+
"type": "string",
|
59766
|
+
"enum": [
|
59767
|
+
"flow",
|
59768
|
+
"user",
|
59769
|
+
"device",
|
59770
|
+
"apiToken",
|
59771
|
+
"experienceUser",
|
59772
|
+
"public"
|
59773
|
+
]
|
59774
|
+
},
|
59775
|
+
"sourceId": {
|
59776
|
+
"type": "string",
|
59777
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
59778
|
+
},
|
59779
|
+
"sourceName": {
|
59780
|
+
"type": "string",
|
59781
|
+
"minLength": 1,
|
59782
|
+
"maxLength": 255
|
59783
|
+
},
|
59784
|
+
"creationDate": {
|
59785
|
+
"type": "string",
|
59786
|
+
"format": "date-time"
|
59787
|
+
},
|
59788
|
+
"comment": {
|
59789
|
+
"type": "string",
|
59790
|
+
"maxLength": 32767
|
59791
|
+
},
|
59792
|
+
"data": {},
|
59793
|
+
"stateChange": {
|
59794
|
+
"type": "object",
|
59795
|
+
"properties": {
|
59796
|
+
"old": {
|
59797
|
+
"type": "string",
|
59798
|
+
"enum": [
|
59799
|
+
"new",
|
59800
|
+
"acknowledged",
|
59801
|
+
"resolved"
|
59802
|
+
]
|
59803
|
+
},
|
59804
|
+
"new": {
|
59805
|
+
"type": "string",
|
59806
|
+
"enum": [
|
59807
|
+
"new",
|
59808
|
+
"acknowledged",
|
59809
|
+
"resolved"
|
59810
|
+
]
|
59811
|
+
}
|
59812
|
+
}
|
59813
|
+
}
|
59814
|
+
}
|
59815
|
+
}
|
59816
|
+
}
|
59817
|
+
}
|
59818
|
+
},
|
59819
|
+
"newCount": {
|
59820
|
+
"type": "integer"
|
59821
|
+
}
|
59822
|
+
}
|
59823
|
+
}
|
59824
|
+
```
|
59825
|
+
### <a name="event-plus-new-count-example"></a> Example
|
59826
|
+
|
59827
|
+
```json
|
59828
|
+
{
|
59829
|
+
"event": {
|
59830
|
+
"id": "575ed0de7ae143cd83dc4aa5",
|
59831
|
+
"eventId": "575ed0de7ae143cd83dc4aa5",
|
59832
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
59833
|
+
"creationDate": "2016-06-13T04:00:00.000Z",
|
59834
|
+
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
59835
|
+
"sourceType": "user",
|
59836
|
+
"sourceId": "575ed70c7ae143cd83dc4aa9",
|
59837
|
+
"sourceName": "hello@example.com",
|
59838
|
+
"level": "info",
|
59839
|
+
"state": "new",
|
59840
|
+
"subject": "Power levels critical",
|
59841
|
+
"message": "Power levels on device 432 have surpassed critical thresholds",
|
59842
|
+
"updates": [],
|
59843
|
+
"deviceId": "575ecf887ae143cd83dc4aa2",
|
59844
|
+
"deviceName": "My Device",
|
59845
|
+
"eventTags": {
|
59846
|
+
"customKey": "customValue"
|
59847
|
+
}
|
59848
|
+
},
|
59849
|
+
"newCount": 2
|
59850
|
+
}
|
59851
|
+
```
|
59852
|
+
|
59853
|
+
<br/>
|
59854
|
+
|
59631
59855
|
## Event Post
|
59632
59856
|
|
59633
59857
|
Schema for the body of an Event creation request
|
@@ -61454,9 +61678,9 @@ The result of an experience bootstrap request
|
|
61454
61678
|
|
61455
61679
|
```json
|
61456
61680
|
{
|
61457
|
-
"homePath": "/",
|
61458
61681
|
"password": "examplePass",
|
61459
|
-
"email": "example.user@example.com"
|
61682
|
+
"email": "example.user@example.com",
|
61683
|
+
"resourceSuffix": ""
|
61460
61684
|
}
|
61461
61685
|
```
|
61462
61686
|
|
@@ -61605,8 +61829,8 @@ Schema for the body of an Experience Domain modification request
|
|
61605
61829
|
```json
|
61606
61830
|
{
|
61607
61831
|
"domainName": "my.domain.example.com",
|
61608
|
-
"sslCert": "
|
61609
|
-
"sslKey": "
|
61832
|
+
"sslCert": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
|
61833
|
+
"sslKey": "-----BEGIN PRIVATE KEY-----\nMY_SSL_KEY\n-----END PRIVATE KEY-----",
|
61610
61834
|
"version": "develop"
|
61611
61835
|
}
|
61612
61836
|
```
|
@@ -61668,8 +61892,8 @@ Schema for the body of an Experience Domain creation request
|
|
61668
61892
|
```json
|
61669
61893
|
{
|
61670
61894
|
"domainName": "my.domain.example.com",
|
61671
|
-
"sslCert": "
|
61672
|
-
"sslKey": "
|
61895
|
+
"sslCert": "-----BEGIN CERTIFICATE-----\nMY_SSL_CERTIFICATE\n-----END CERTIFICATE-----",
|
61896
|
+
"sslKey": "-----BEGIN PRIVATE KEY-----\nMY_SSL_KEY\n-----END PRIVATE KEY-----",
|
61673
61897
|
"version": "develop"
|
61674
61898
|
}
|
61675
61899
|
```
|
@@ -62971,7 +63195,7 @@ Schema for the body of an Experience Group creation request
|
|
62971
63195
|
"deviceTags": [
|
62972
63196
|
{
|
62973
63197
|
"key": "floor",
|
62974
|
-
"value": 8
|
63198
|
+
"value": "8"
|
62975
63199
|
}
|
62976
63200
|
],
|
62977
63201
|
"parentId": "58b9d743cbfafe1be675744e"
|
@@ -63670,7 +63894,10 @@ The body of an experience linked resources response
|
|
63670
63894
|
"onConnect",
|
63671
63895
|
"onDisconnect",
|
63672
63896
|
"udp",
|
63673
|
-
"webhook"
|
63897
|
+
"webhook",
|
63898
|
+
"resourceJobIteration",
|
63899
|
+
"resourceJobIterationTimeout",
|
63900
|
+
"resourceJobComplete"
|
63674
63901
|
]
|
63675
63902
|
},
|
63676
63903
|
"config": {
|
@@ -63706,7 +63933,10 @@ The body of an experience linked resources response
|
|
63706
63933
|
"particle",
|
63707
63934
|
"sqs",
|
63708
63935
|
"udp",
|
63709
|
-
"webhook"
|
63936
|
+
"webhook",
|
63937
|
+
"resourceJobIteration",
|
63938
|
+
"resourceJobIterationTimeout",
|
63939
|
+
"resourceJobComplete"
|
63710
63940
|
]
|
63711
63941
|
},
|
63712
63942
|
"label": {
|
@@ -66278,6 +66508,15 @@ The body of an experience linked resources response
|
|
66278
66508
|
"minLength": 1,
|
66279
66509
|
"maxLength": 255
|
66280
66510
|
},
|
66511
|
+
"flowClass": {
|
66512
|
+
"type": "string",
|
66513
|
+
"enum": [
|
66514
|
+
"cloud",
|
66515
|
+
"edge",
|
66516
|
+
"embedded",
|
66517
|
+
"customNode"
|
66518
|
+
]
|
66519
|
+
},
|
66281
66520
|
"notes": {
|
66282
66521
|
"type": "string",
|
66283
66522
|
"maxLength": 32767
|
@@ -66311,7 +66550,10 @@ The body of an experience linked resources response
|
|
66311
66550
|
"onConnect",
|
66312
66551
|
"onDisconnect",
|
66313
66552
|
"udp",
|
66314
|
-
"webhook"
|
66553
|
+
"webhook",
|
66554
|
+
"resourceJobIteration",
|
66555
|
+
"resourceJobIterationTimeout",
|
66556
|
+
"resourceJobComplete"
|
66315
66557
|
]
|
66316
66558
|
},
|
66317
66559
|
"config": {
|
@@ -66347,7 +66589,10 @@ The body of an experience linked resources response
|
|
66347
66589
|
"particle",
|
66348
66590
|
"sqs",
|
66349
66591
|
"udp",
|
66350
|
-
"webhook"
|
66592
|
+
"webhook",
|
66593
|
+
"resourceJobIteration",
|
66594
|
+
"resourceJobIterationTimeout",
|
66595
|
+
"resourceJobComplete"
|
66351
66596
|
]
|
66352
66597
|
},
|
66353
66598
|
"label": {
|
@@ -68896,7 +69141,10 @@ The body of an experience linked resources response
|
|
68896
69141
|
"onConnect",
|
68897
69142
|
"onDisconnect",
|
68898
69143
|
"udp",
|
68899
|
-
"webhook"
|
69144
|
+
"webhook",
|
69145
|
+
"resourceJobIteration",
|
69146
|
+
"resourceJobIterationTimeout",
|
69147
|
+
"resourceJobComplete"
|
68900
69148
|
]
|
68901
69149
|
},
|
68902
69150
|
"config": {
|
@@ -68932,7 +69180,10 @@ The body of an experience linked resources response
|
|
68932
69180
|
"particle",
|
68933
69181
|
"sqs",
|
68934
69182
|
"udp",
|
68935
|
-
"webhook"
|
69183
|
+
"webhook",
|
69184
|
+
"resourceJobIteration",
|
69185
|
+
"resourceJobIterationTimeout",
|
69186
|
+
"resourceJobComplete"
|
68936
69187
|
]
|
68937
69188
|
},
|
68938
69189
|
"label": {
|
@@ -71225,8 +71476,11 @@ The body of an experience linked resources response
|
|
71225
71476
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
71226
71477
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
71227
71478
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
71228
|
-
"
|
71229
|
-
"
|
71479
|
+
"description": "Description of my workflow version",
|
71480
|
+
"flowClass": "experience",
|
71481
|
+
"versions": [
|
71482
|
+
"v1.2.3"
|
71483
|
+
],
|
71230
71484
|
"enabled": true,
|
71231
71485
|
"triggers": [],
|
71232
71486
|
"nodes": [],
|
@@ -73566,7 +73820,10 @@ Schema for a single Workflow
|
|
73566
73820
|
"onConnect",
|
73567
73821
|
"onDisconnect",
|
73568
73822
|
"udp",
|
73569
|
-
"webhook"
|
73823
|
+
"webhook",
|
73824
|
+
"resourceJobIteration",
|
73825
|
+
"resourceJobIterationTimeout",
|
73826
|
+
"resourceJobComplete"
|
73570
73827
|
]
|
73571
73828
|
},
|
73572
73829
|
"config": {
|
@@ -73602,7 +73859,10 @@ Schema for a single Workflow
|
|
73602
73859
|
"particle",
|
73603
73860
|
"sqs",
|
73604
73861
|
"udp",
|
73605
|
-
"webhook"
|
73862
|
+
"webhook",
|
73863
|
+
"resourceJobIteration",
|
73864
|
+
"resourceJobIterationTimeout",
|
73865
|
+
"resourceJobComplete"
|
73606
73866
|
]
|
73607
73867
|
},
|
73608
73868
|
"label": {
|
@@ -76382,7 +76642,10 @@ Schema for the body of a Workflow modification request
|
|
76382
76642
|
"onConnect",
|
76383
76643
|
"onDisconnect",
|
76384
76644
|
"udp",
|
76385
|
-
"webhook"
|
76645
|
+
"webhook",
|
76646
|
+
"resourceJobIteration",
|
76647
|
+
"resourceJobIterationTimeout",
|
76648
|
+
"resourceJobComplete"
|
76386
76649
|
]
|
76387
76650
|
},
|
76388
76651
|
"config": {
|
@@ -76418,7 +76681,10 @@ Schema for the body of a Workflow modification request
|
|
76418
76681
|
"particle",
|
76419
76682
|
"sqs",
|
76420
76683
|
"udp",
|
76421
|
-
"webhook"
|
76684
|
+
"webhook",
|
76685
|
+
"resourceJobIteration",
|
76686
|
+
"resourceJobIterationTimeout",
|
76687
|
+
"resourceJobComplete"
|
76422
76688
|
]
|
76423
76689
|
},
|
76424
76690
|
"label": {
|
@@ -78953,7 +79219,10 @@ Schema for the body of a Workflow creation request
|
|
78953
79219
|
"onConnect",
|
78954
79220
|
"onDisconnect",
|
78955
79221
|
"udp",
|
78956
|
-
"webhook"
|
79222
|
+
"webhook",
|
79223
|
+
"resourceJobIteration",
|
79224
|
+
"resourceJobIterationTimeout",
|
79225
|
+
"resourceJobComplete"
|
78957
79226
|
]
|
78958
79227
|
},
|
78959
79228
|
"config": {
|
@@ -78989,7 +79258,10 @@ Schema for the body of a Workflow creation request
|
|
78989
79258
|
"particle",
|
78990
79259
|
"sqs",
|
78991
79260
|
"udp",
|
78992
|
-
"webhook"
|
79261
|
+
"webhook",
|
79262
|
+
"resourceJobIteration",
|
79263
|
+
"resourceJobIterationTimeout",
|
79264
|
+
"resourceJobComplete"
|
78993
79265
|
]
|
78994
79266
|
},
|
78995
79267
|
"label": {
|
@@ -81639,8 +81911,8 @@ Schema for the result of get storage metadata request
|
|
81639
81911
|
|
81640
81912
|
```json
|
81641
81913
|
{
|
81642
|
-
"
|
81643
|
-
"
|
81914
|
+
"memoryUsed": 610,
|
81915
|
+
"keysCount": 2
|
81644
81916
|
}
|
81645
81917
|
```
|
81646
81918
|
|
@@ -81729,6 +82001,15 @@ Schema for a single Workflow Version
|
|
81729
82001
|
"minLength": 1,
|
81730
82002
|
"maxLength": 255
|
81731
82003
|
},
|
82004
|
+
"flowClass": {
|
82005
|
+
"type": "string",
|
82006
|
+
"enum": [
|
82007
|
+
"cloud",
|
82008
|
+
"edge",
|
82009
|
+
"embedded",
|
82010
|
+
"customNode"
|
82011
|
+
]
|
82012
|
+
},
|
81732
82013
|
"notes": {
|
81733
82014
|
"type": "string",
|
81734
82015
|
"maxLength": 32767
|
@@ -81762,7 +82043,10 @@ Schema for a single Workflow Version
|
|
81762
82043
|
"onConnect",
|
81763
82044
|
"onDisconnect",
|
81764
82045
|
"udp",
|
81765
|
-
"webhook"
|
82046
|
+
"webhook",
|
82047
|
+
"resourceJobIteration",
|
82048
|
+
"resourceJobIterationTimeout",
|
82049
|
+
"resourceJobComplete"
|
81766
82050
|
]
|
81767
82051
|
},
|
81768
82052
|
"config": {
|
@@ -81798,7 +82082,10 @@ Schema for a single Workflow Version
|
|
81798
82082
|
"particle",
|
81799
82083
|
"sqs",
|
81800
82084
|
"udp",
|
81801
|
-
"webhook"
|
82085
|
+
"webhook",
|
82086
|
+
"resourceJobIteration",
|
82087
|
+
"resourceJobIterationTimeout",
|
82088
|
+
"resourceJobComplete"
|
81802
82089
|
]
|
81803
82090
|
},
|
81804
82091
|
"label": {
|
@@ -84347,7 +84634,10 @@ Schema for a single Workflow Version
|
|
84347
84634
|
"onConnect",
|
84348
84635
|
"onDisconnect",
|
84349
84636
|
"udp",
|
84350
|
-
"webhook"
|
84637
|
+
"webhook",
|
84638
|
+
"resourceJobIteration",
|
84639
|
+
"resourceJobIterationTimeout",
|
84640
|
+
"resourceJobComplete"
|
84351
84641
|
]
|
84352
84642
|
},
|
84353
84643
|
"config": {
|
@@ -84383,7 +84673,10 @@ Schema for a single Workflow Version
|
|
84383
84673
|
"particle",
|
84384
84674
|
"sqs",
|
84385
84675
|
"udp",
|
84386
|
-
"webhook"
|
84676
|
+
"webhook",
|
84677
|
+
"resourceJobIteration",
|
84678
|
+
"resourceJobIterationTimeout",
|
84679
|
+
"resourceJobComplete"
|
84387
84680
|
]
|
84388
84681
|
},
|
84389
84682
|
"label": {
|
@@ -86547,8 +86840,11 @@ Schema for a single Workflow Version
|
|
86547
86840
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
86548
86841
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
86549
86842
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
86550
|
-
"
|
86551
|
-
"
|
86843
|
+
"description": "Description of my workflow version",
|
86844
|
+
"flowClass": "experience",
|
86845
|
+
"versions": [
|
86846
|
+
"v1.2.3"
|
86847
|
+
],
|
86552
86848
|
"enabled": true,
|
86553
86849
|
"triggers": [],
|
86554
86850
|
"nodes": [],
|
@@ -86640,7 +86936,10 @@ Schema for the body of a Workflow Version creation request
|
|
86640
86936
|
"onConnect",
|
86641
86937
|
"onDisconnect",
|
86642
86938
|
"udp",
|
86643
|
-
"webhook"
|
86939
|
+
"webhook",
|
86940
|
+
"resourceJobIteration",
|
86941
|
+
"resourceJobIterationTimeout",
|
86942
|
+
"resourceJobComplete"
|
86644
86943
|
]
|
86645
86944
|
},
|
86646
86945
|
"config": {
|
@@ -86676,7 +86975,10 @@ Schema for the body of a Workflow Version creation request
|
|
86676
86975
|
"particle",
|
86677
86976
|
"sqs",
|
86678
86977
|
"udp",
|
86679
|
-
"webhook"
|
86978
|
+
"webhook",
|
86979
|
+
"resourceJobIteration",
|
86980
|
+
"resourceJobIterationTimeout",
|
86981
|
+
"resourceJobComplete"
|
86680
86982
|
]
|
86681
86983
|
},
|
86682
86984
|
"label": {
|
@@ -89185,6 +89487,15 @@ Schema for a collection of Workflow Versions
|
|
89185
89487
|
"minLength": 1,
|
89186
89488
|
"maxLength": 255
|
89187
89489
|
},
|
89490
|
+
"flowClass": {
|
89491
|
+
"type": "string",
|
89492
|
+
"enum": [
|
89493
|
+
"cloud",
|
89494
|
+
"edge",
|
89495
|
+
"embedded",
|
89496
|
+
"customNode"
|
89497
|
+
]
|
89498
|
+
},
|
89188
89499
|
"notes": {
|
89189
89500
|
"type": "string",
|
89190
89501
|
"maxLength": 32767
|
@@ -89218,7 +89529,10 @@ Schema for a collection of Workflow Versions
|
|
89218
89529
|
"onConnect",
|
89219
89530
|
"onDisconnect",
|
89220
89531
|
"udp",
|
89221
|
-
"webhook"
|
89532
|
+
"webhook",
|
89533
|
+
"resourceJobIteration",
|
89534
|
+
"resourceJobIterationTimeout",
|
89535
|
+
"resourceJobComplete"
|
89222
89536
|
]
|
89223
89537
|
},
|
89224
89538
|
"config": {
|
@@ -89254,7 +89568,10 @@ Schema for a collection of Workflow Versions
|
|
89254
89568
|
"particle",
|
89255
89569
|
"sqs",
|
89256
89570
|
"udp",
|
89257
|
-
"webhook"
|
89571
|
+
"webhook",
|
89572
|
+
"resourceJobIteration",
|
89573
|
+
"resourceJobIterationTimeout",
|
89574
|
+
"resourceJobComplete"
|
89258
89575
|
]
|
89259
89576
|
},
|
89260
89577
|
"label": {
|
@@ -91803,7 +92120,10 @@ Schema for a collection of Workflow Versions
|
|
91803
92120
|
"onConnect",
|
91804
92121
|
"onDisconnect",
|
91805
92122
|
"udp",
|
91806
|
-
"webhook"
|
92123
|
+
"webhook",
|
92124
|
+
"resourceJobIteration",
|
92125
|
+
"resourceJobIterationTimeout",
|
92126
|
+
"resourceJobComplete"
|
91807
92127
|
]
|
91808
92128
|
},
|
91809
92129
|
"config": {
|
@@ -91839,7 +92159,10 @@ Schema for a collection of Workflow Versions
|
|
91839
92159
|
"particle",
|
91840
92160
|
"sqs",
|
91841
92161
|
"udp",
|
91842
|
-
"webhook"
|
92162
|
+
"webhook",
|
92163
|
+
"resourceJobIteration",
|
92164
|
+
"resourceJobIterationTimeout",
|
92165
|
+
"resourceJobComplete"
|
91843
92166
|
]
|
91844
92167
|
},
|
91845
92168
|
"label": {
|
@@ -94047,8 +94370,11 @@ Schema for a collection of Workflow Versions
|
|
94047
94370
|
"applicationId": "575ec8687ae143cd83dc4a97",
|
94048
94371
|
"creationDate": "2016-06-13T04:00:00.000Z",
|
94049
94372
|
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
94050
|
-
"
|
94051
|
-
"
|
94373
|
+
"description": "Description of my workflow version",
|
94374
|
+
"flowClass": "experience",
|
94375
|
+
"versions": [
|
94376
|
+
"v1.2.3"
|
94377
|
+
],
|
94052
94378
|
"enabled": true,
|
94053
94379
|
"triggers": [],
|
94054
94380
|
"nodes": [],
|
@@ -95197,7 +95523,10 @@ Schema for a collection of Workflows
|
|
95197
95523
|
"onConnect",
|
95198
95524
|
"onDisconnect",
|
95199
95525
|
"udp",
|
95200
|
-
"webhook"
|
95526
|
+
"webhook",
|
95527
|
+
"resourceJobIteration",
|
95528
|
+
"resourceJobIterationTimeout",
|
95529
|
+
"resourceJobComplete"
|
95201
95530
|
]
|
95202
95531
|
},
|
95203
95532
|
"config": {
|
@@ -95233,7 +95562,10 @@ Schema for a collection of Workflows
|
|
95233
95562
|
"particle",
|
95234
95563
|
"sqs",
|
95235
95564
|
"udp",
|
95236
|
-
"webhook"
|
95565
|
+
"webhook",
|
95566
|
+
"resourceJobIteration",
|
95567
|
+
"resourceJobIterationTimeout",
|
95568
|
+
"resourceJobComplete"
|
95237
95569
|
]
|
95238
95570
|
},
|
95239
95571
|
"label": {
|
@@ -97890,7 +98222,10 @@ Schema for the body of a workflow import request
|
|
97890
98222
|
"onConnect",
|
97891
98223
|
"onDisconnect",
|
97892
98224
|
"udp",
|
97893
|
-
"webhook"
|
98225
|
+
"webhook",
|
98226
|
+
"resourceJobIteration",
|
98227
|
+
"resourceJobIterationTimeout",
|
98228
|
+
"resourceJobComplete"
|
97894
98229
|
]
|
97895
98230
|
},
|
97896
98231
|
"config": {
|
@@ -97926,7 +98261,10 @@ Schema for the body of a workflow import request
|
|
97926
98261
|
"particle",
|
97927
98262
|
"sqs",
|
97928
98263
|
"udp",
|
97929
|
-
"webhook"
|
98264
|
+
"webhook",
|
98265
|
+
"resourceJobIteration",
|
98266
|
+
"resourceJobIterationTimeout",
|
98267
|
+
"resourceJobComplete"
|
97930
98268
|
]
|
97931
98269
|
},
|
97932
98270
|
"label": {
|
@@ -100462,7 +100800,10 @@ Schema for the body of a workflow import request
|
|
100462
100800
|
"onConnect",
|
100463
100801
|
"onDisconnect",
|
100464
100802
|
"udp",
|
100465
|
-
"webhook"
|
100803
|
+
"webhook",
|
100804
|
+
"resourceJobIteration",
|
100805
|
+
"resourceJobIterationTimeout",
|
100806
|
+
"resourceJobComplete"
|
100466
100807
|
]
|
100467
100808
|
},
|
100468
100809
|
"config": {
|
@@ -100498,7 +100839,10 @@ Schema for the body of a workflow import request
|
|
100498
100839
|
"particle",
|
100499
100840
|
"sqs",
|
100500
100841
|
"udp",
|
100501
|
-
"webhook"
|
100842
|
+
"webhook",
|
100843
|
+
"resourceJobIteration",
|
100844
|
+
"resourceJobIterationTimeout",
|
100845
|
+
"resourceJobComplete"
|
100502
100846
|
]
|
100503
100847
|
},
|
100504
100848
|
"label": {
|
@@ -102958,21 +103302,8 @@ Schema for the body of a workflow import request
|
|
102958
103302
|
{
|
102959
103303
|
"flows": [
|
102960
103304
|
{
|
102961
|
-
"
|
102962
|
-
"
|
102963
|
-
"applicationId": "575ec8687ae143cd83dc4a97",
|
102964
|
-
"creationDate": "2016-06-13T04:00:00.000Z",
|
102965
|
-
"lastUpdated": "2016-06-13T04:00:00.000Z",
|
102966
|
-
"name": "My Workflow",
|
102967
|
-
"description": "Description of my empty workflow",
|
102968
|
-
"enabled": true,
|
102969
|
-
"triggers": [],
|
102970
|
-
"nodes": [],
|
102971
|
-
"globals": [],
|
102972
|
-
"stats": {
|
102973
|
-
"runCount": 0,
|
102974
|
-
"errorCount": 0
|
102975
|
-
}
|
103305
|
+
"name": "My New Workflow",
|
103306
|
+
"description": "Description of my new workflow"
|
102976
103307
|
}
|
102977
103308
|
],
|
102978
103309
|
"flowVersions": []
|
@@ -103098,7 +103429,10 @@ Schema for the result of a workflow import request
|
|
103098
103429
|
"onConnect",
|
103099
103430
|
"onDisconnect",
|
103100
103431
|
"udp",
|
103101
|
-
"webhook"
|
103432
|
+
"webhook",
|
103433
|
+
"resourceJobIteration",
|
103434
|
+
"resourceJobIterationTimeout",
|
103435
|
+
"resourceJobComplete"
|
103102
103436
|
]
|
103103
103437
|
},
|
103104
103438
|
"config": {
|
@@ -103134,7 +103468,10 @@ Schema for the result of a workflow import request
|
|
103134
103468
|
"particle",
|
103135
103469
|
"sqs",
|
103136
103470
|
"udp",
|
103137
|
-
"webhook"
|
103471
|
+
"webhook",
|
103472
|
+
"resourceJobIteration",
|
103473
|
+
"resourceJobIterationTimeout",
|
103474
|
+
"resourceJobComplete"
|
103138
103475
|
]
|
103139
103476
|
},
|
103140
103477
|
"label": {
|
@@ -105655,6 +105992,15 @@ Schema for the result of a workflow import request
|
|
105655
105992
|
"minLength": 1,
|
105656
105993
|
"maxLength": 255
|
105657
105994
|
},
|
105995
|
+
"flowClass": {
|
105996
|
+
"type": "string",
|
105997
|
+
"enum": [
|
105998
|
+
"cloud",
|
105999
|
+
"edge",
|
106000
|
+
"embedded",
|
106001
|
+
"customNode"
|
106002
|
+
]
|
106003
|
+
},
|
105658
106004
|
"notes": {
|
105659
106005
|
"type": "string",
|
105660
106006
|
"maxLength": 32767
|
@@ -105688,7 +106034,10 @@ Schema for the result of a workflow import request
|
|
105688
106034
|
"onConnect",
|
105689
106035
|
"onDisconnect",
|
105690
106036
|
"udp",
|
105691
|
-
"webhook"
|
106037
|
+
"webhook",
|
106038
|
+
"resourceJobIteration",
|
106039
|
+
"resourceJobIterationTimeout",
|
106040
|
+
"resourceJobComplete"
|
105692
106041
|
]
|
105693
106042
|
},
|
105694
106043
|
"config": {
|
@@ -105724,7 +106073,10 @@ Schema for the result of a workflow import request
|
|
105724
106073
|
"particle",
|
105725
106074
|
"sqs",
|
105726
106075
|
"udp",
|
105727
|
-
"webhook"
|
106076
|
+
"webhook",
|
106077
|
+
"resourceJobIteration",
|
106078
|
+
"resourceJobIterationTimeout",
|
106079
|
+
"resourceJobComplete"
|
105728
106080
|
]
|
105729
106081
|
},
|
105730
106082
|
"label": {
|
@@ -108273,7 +108625,10 @@ Schema for the result of a workflow import request
|
|
108273
108625
|
"onConnect",
|
108274
108626
|
"onDisconnect",
|
108275
108627
|
"udp",
|
108276
|
-
"webhook"
|
108628
|
+
"webhook",
|
108629
|
+
"resourceJobIteration",
|
108630
|
+
"resourceJobIterationTimeout",
|
108631
|
+
"resourceJobComplete"
|
108277
108632
|
]
|
108278
108633
|
},
|
108279
108634
|
"config": {
|
@@ -108309,7 +108664,10 @@ Schema for the result of a workflow import request
|
|
108309
108664
|
"particle",
|
108310
108665
|
"sqs",
|
108311
108666
|
"udp",
|
108312
|
-
"webhook"
|
108667
|
+
"webhook",
|
108668
|
+
"resourceJobIteration",
|
108669
|
+
"resourceJobIterationTimeout",
|
108670
|
+
"resourceJobComplete"
|
108313
108671
|
]
|
108314
108672
|
},
|
108315
108673
|
"label": {
|
@@ -110597,6 +110955,8 @@ Schema for the body of a Github login request
|
|
110597
110955
|
"flows.*",
|
110598
110956
|
"flowVersion.*",
|
110599
110957
|
"flowVersions.*",
|
110958
|
+
"resourceJobs.*",
|
110959
|
+
"resourceJob.*",
|
110600
110960
|
"notebook.*",
|
110601
110961
|
"notebooks.*",
|
110602
110962
|
"webhook.*",
|
@@ -110809,6 +111169,14 @@ Schema for the body of a Github login request
|
|
110809
111169
|
"notebook.upload",
|
110810
111170
|
"notebooks.get",
|
110811
111171
|
"notebooks.post",
|
111172
|
+
"resourceJob.get",
|
111173
|
+
"resourceJob.logs",
|
111174
|
+
"resourceJob.patch",
|
111175
|
+
"resourceJob.delete",
|
111176
|
+
"resourceJob.execute",
|
111177
|
+
"resourceJob.cancelExecution",
|
111178
|
+
"resourceJobs.get",
|
111179
|
+
"resourceJobs.post",
|
110812
111180
|
"webhook.delete",
|
110813
111181
|
"webhook.get",
|
110814
111182
|
"webhook.patch",
|
@@ -110996,7 +111364,530 @@ Schema for a collection of Historical Summaries
|
|
110996
111364
|
"items": {
|
110997
111365
|
"type": "array",
|
110998
111366
|
"items": {
|
110999
|
-
"
|
111367
|
+
"title": "Historical Summary",
|
111368
|
+
"description": "Schema for a historical summary report",
|
111369
|
+
"type": "object",
|
111370
|
+
"properties": {
|
111371
|
+
"resourceType": {
|
111372
|
+
"type": "string",
|
111373
|
+
"enum": [
|
111374
|
+
"application",
|
111375
|
+
"organization",
|
111376
|
+
"whitelabel"
|
111377
|
+
]
|
111378
|
+
},
|
111379
|
+
"resourceId": {
|
111380
|
+
"type": "string",
|
111381
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
111382
|
+
},
|
111383
|
+
"resourceName": {
|
111384
|
+
"type": "string",
|
111385
|
+
"minLength": 1,
|
111386
|
+
"maxLength": 255
|
111387
|
+
},
|
111388
|
+
"resourceProration": {
|
111389
|
+
"type": "number"
|
111390
|
+
},
|
111391
|
+
"ownerType": {
|
111392
|
+
"type": "string",
|
111393
|
+
"enum": [
|
111394
|
+
"organization",
|
111395
|
+
"user"
|
111396
|
+
]
|
111397
|
+
},
|
111398
|
+
"ownerId": {
|
111399
|
+
"type": "string",
|
111400
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
111401
|
+
},
|
111402
|
+
"ownerName": {
|
111403
|
+
"type": "string",
|
111404
|
+
"minLength": 1,
|
111405
|
+
"maxLength": 255
|
111406
|
+
},
|
111407
|
+
"limits": {
|
111408
|
+
"type": "object",
|
111409
|
+
"properties": {
|
111410
|
+
"apitoken": {
|
111411
|
+
"type": "integer"
|
111412
|
+
},
|
111413
|
+
"application": {
|
111414
|
+
"type": "integer"
|
111415
|
+
},
|
111416
|
+
"applicationkey": {
|
111417
|
+
"type": "integer"
|
111418
|
+
},
|
111419
|
+
"dashboard": {
|
111420
|
+
"type": "integer"
|
111421
|
+
},
|
111422
|
+
"datatable": {
|
111423
|
+
"type": "integer"
|
111424
|
+
},
|
111425
|
+
"device": {
|
111426
|
+
"type": "integer"
|
111427
|
+
},
|
111428
|
+
"devicerecipe": {
|
111429
|
+
"type": "integer"
|
111430
|
+
},
|
111431
|
+
"experiencedomain": {
|
111432
|
+
"type": "integer"
|
111433
|
+
},
|
111434
|
+
"experienceendpoint": {
|
111435
|
+
"type": "integer"
|
111436
|
+
},
|
111437
|
+
"experiencegroup": {
|
111438
|
+
"type": "integer"
|
111439
|
+
},
|
111440
|
+
"experienceslug": {
|
111441
|
+
"type": "integer"
|
111442
|
+
},
|
111443
|
+
"experienceuser": {
|
111444
|
+
"type": "integer"
|
111445
|
+
},
|
111446
|
+
"experienceversion": {
|
111447
|
+
"type": "integer"
|
111448
|
+
},
|
111449
|
+
"experienceview": {
|
111450
|
+
"type": "integer"
|
111451
|
+
},
|
111452
|
+
"file": {
|
111453
|
+
"type": "integer"
|
111454
|
+
},
|
111455
|
+
"flow": {
|
111456
|
+
"type": "integer"
|
111457
|
+
},
|
111458
|
+
"integration": {
|
111459
|
+
"type": "integer"
|
111460
|
+
},
|
111461
|
+
"notebook": {
|
111462
|
+
"type": "integer"
|
111463
|
+
},
|
111464
|
+
"resourcejob": {
|
111465
|
+
"type": "integer"
|
111466
|
+
},
|
111467
|
+
"webhook": {
|
111468
|
+
"type": "integer"
|
111469
|
+
},
|
111470
|
+
"dataTTL": {
|
111471
|
+
"type": "integer"
|
111472
|
+
},
|
111473
|
+
"member": {
|
111474
|
+
"type": "integer"
|
111475
|
+
},
|
111476
|
+
"payload": {
|
111477
|
+
"type": "integer"
|
111478
|
+
},
|
111479
|
+
"storage": {
|
111480
|
+
"type": "integer"
|
111481
|
+
},
|
111482
|
+
"notebookMinutesPerRun": {
|
111483
|
+
"type": "integer"
|
111484
|
+
},
|
111485
|
+
"notebookMinutesPerMonth": {
|
111486
|
+
"type": "integer"
|
111487
|
+
},
|
111488
|
+
"notebookInParallel": {
|
111489
|
+
"type": "integer"
|
111490
|
+
},
|
111491
|
+
"experienceFlowSlots": {
|
111492
|
+
"type": "integer"
|
111493
|
+
},
|
111494
|
+
"applicationFlowSlots": {
|
111495
|
+
"type": "integer"
|
111496
|
+
}
|
111497
|
+
},
|
111498
|
+
"additionalProperties": false
|
111499
|
+
},
|
111500
|
+
"currentPeriodStart": {
|
111501
|
+
"type": "string",
|
111502
|
+
"format": "date-time"
|
111503
|
+
},
|
111504
|
+
"currentPeriodEnd": {
|
111505
|
+
"type": "string",
|
111506
|
+
"format": "date-time"
|
111507
|
+
},
|
111508
|
+
"applicationCount": {
|
111509
|
+
"type": "number"
|
111510
|
+
},
|
111511
|
+
"applicationCountProrated": {
|
111512
|
+
"type": "number"
|
111513
|
+
},
|
111514
|
+
"userCount": {
|
111515
|
+
"type": "number"
|
111516
|
+
},
|
111517
|
+
"userCountProrated": {
|
111518
|
+
"type": "number"
|
111519
|
+
},
|
111520
|
+
"apiTokenCount": {
|
111521
|
+
"type": "number"
|
111522
|
+
},
|
111523
|
+
"applicationKeyCount": {
|
111524
|
+
"type": "number"
|
111525
|
+
},
|
111526
|
+
"certificateAuthorityCount": {
|
111527
|
+
"type": "number"
|
111528
|
+
},
|
111529
|
+
"certificateCount": {
|
111530
|
+
"type": "number"
|
111531
|
+
},
|
111532
|
+
"dashboardCount": {
|
111533
|
+
"type": "number"
|
111534
|
+
},
|
111535
|
+
"dashboardCountProrated": {
|
111536
|
+
"type": "number"
|
111537
|
+
},
|
111538
|
+
"dataTableCount": {
|
111539
|
+
"type": "number"
|
111540
|
+
},
|
111541
|
+
"dataTableRowCount": {
|
111542
|
+
"type": "number"
|
111543
|
+
},
|
111544
|
+
"dataTableTotalSizeMb": {
|
111545
|
+
"type": "number"
|
111546
|
+
},
|
111547
|
+
"deviceCount": {
|
111548
|
+
"type": "number"
|
111549
|
+
},
|
111550
|
+
"deviceCountProrated": {
|
111551
|
+
"type": "number"
|
111552
|
+
},
|
111553
|
+
"deviceRecipeCount": {
|
111554
|
+
"type": "number"
|
111555
|
+
},
|
111556
|
+
"eventCount": {
|
111557
|
+
"type": "number"
|
111558
|
+
},
|
111559
|
+
"experienceDomainCount": {
|
111560
|
+
"type": "number"
|
111561
|
+
},
|
111562
|
+
"experienceEndpointCount": {
|
111563
|
+
"type": "number"
|
111564
|
+
},
|
111565
|
+
"experienceGroupCount": {
|
111566
|
+
"type": "number"
|
111567
|
+
},
|
111568
|
+
"experienceSlugCount": {
|
111569
|
+
"type": "number"
|
111570
|
+
},
|
111571
|
+
"experienceUserCount": {
|
111572
|
+
"type": "number"
|
111573
|
+
},
|
111574
|
+
"experienceVersionCount": {
|
111575
|
+
"type": "number"
|
111576
|
+
},
|
111577
|
+
"experienceViewCount": {
|
111578
|
+
"type": "number"
|
111579
|
+
},
|
111580
|
+
"fileCount": {
|
111581
|
+
"type": "number"
|
111582
|
+
},
|
111583
|
+
"fileTotalSizeMb": {
|
111584
|
+
"type": "number"
|
111585
|
+
},
|
111586
|
+
"integrationCount": {
|
111587
|
+
"type": "number"
|
111588
|
+
},
|
111589
|
+
"notebookCount": {
|
111590
|
+
"type": "number"
|
111591
|
+
},
|
111592
|
+
"resourceJobCount": {
|
111593
|
+
"type": "integer"
|
111594
|
+
},
|
111595
|
+
"notebookRunCount": {
|
111596
|
+
"type": "number"
|
111597
|
+
},
|
111598
|
+
"notebookMinutesCount": {
|
111599
|
+
"type": "number"
|
111600
|
+
},
|
111601
|
+
"webhookCount": {
|
111602
|
+
"type": "number"
|
111603
|
+
},
|
111604
|
+
"workflowCount": {
|
111605
|
+
"type": "number"
|
111606
|
+
},
|
111607
|
+
"payloadBillableCount": {
|
111608
|
+
"type": "number"
|
111609
|
+
},
|
111610
|
+
"payloadNonbillableCount": {
|
111611
|
+
"type": "number"
|
111612
|
+
},
|
111613
|
+
"payloadBillableSizeMb": {
|
111614
|
+
"type": "number"
|
111615
|
+
},
|
111616
|
+
"payloadNonbillableSizeMb": {
|
111617
|
+
"type": "number"
|
111618
|
+
},
|
111619
|
+
"payloadCountDetails": {
|
111620
|
+
"title": "Payload Stats",
|
111621
|
+
"description": "Schema for the result of a payload stats request",
|
111622
|
+
"type": "object",
|
111623
|
+
"properties": {
|
111624
|
+
"dataTable": {
|
111625
|
+
"type": "object",
|
111626
|
+
"patternProperties": {
|
111627
|
+
".*": {
|
111628
|
+
"type": "number"
|
111629
|
+
}
|
111630
|
+
}
|
111631
|
+
},
|
111632
|
+
"deviceCommand": {
|
111633
|
+
"type": "object",
|
111634
|
+
"patternProperties": {
|
111635
|
+
".*": {
|
111636
|
+
"type": "number"
|
111637
|
+
}
|
111638
|
+
}
|
111639
|
+
},
|
111640
|
+
"deviceConnect": {
|
111641
|
+
"type": "object",
|
111642
|
+
"patternProperties": {
|
111643
|
+
".*": {
|
111644
|
+
"type": "number"
|
111645
|
+
}
|
111646
|
+
}
|
111647
|
+
},
|
111648
|
+
"deviceDisconnect": {
|
111649
|
+
"type": "object",
|
111650
|
+
"patternProperties": {
|
111651
|
+
".*": {
|
111652
|
+
"type": "number"
|
111653
|
+
}
|
111654
|
+
}
|
111655
|
+
},
|
111656
|
+
"deviceState": {
|
111657
|
+
"type": "object",
|
111658
|
+
"patternProperties": {
|
111659
|
+
".*": {
|
111660
|
+
"type": "number"
|
111661
|
+
}
|
111662
|
+
}
|
111663
|
+
},
|
111664
|
+
"endpoint": {
|
111665
|
+
"type": "object",
|
111666
|
+
"patternProperties": {
|
111667
|
+
".*": {
|
111668
|
+
"type": "number"
|
111669
|
+
}
|
111670
|
+
}
|
111671
|
+
},
|
111672
|
+
"event": {
|
111673
|
+
"type": "object",
|
111674
|
+
"patternProperties": {
|
111675
|
+
".*": {
|
111676
|
+
"type": "number"
|
111677
|
+
}
|
111678
|
+
}
|
111679
|
+
},
|
111680
|
+
"flowError": {
|
111681
|
+
"type": "object",
|
111682
|
+
"patternProperties": {
|
111683
|
+
".*": {
|
111684
|
+
"type": "number"
|
111685
|
+
}
|
111686
|
+
}
|
111687
|
+
},
|
111688
|
+
"integration": {
|
111689
|
+
"type": "object",
|
111690
|
+
"patternProperties": {
|
111691
|
+
".*": {
|
111692
|
+
"type": "number"
|
111693
|
+
}
|
111694
|
+
}
|
111695
|
+
},
|
111696
|
+
"mqttIn": {
|
111697
|
+
"type": "object",
|
111698
|
+
"patternProperties": {
|
111699
|
+
".*": {
|
111700
|
+
"type": "number"
|
111701
|
+
}
|
111702
|
+
}
|
111703
|
+
},
|
111704
|
+
"mqttOut": {
|
111705
|
+
"type": "object",
|
111706
|
+
"patternProperties": {
|
111707
|
+
".*": {
|
111708
|
+
"type": "number"
|
111709
|
+
}
|
111710
|
+
}
|
111711
|
+
},
|
111712
|
+
"notebook": {
|
111713
|
+
"type": "object",
|
111714
|
+
"patternProperties": {
|
111715
|
+
".*": {
|
111716
|
+
"type": "number"
|
111717
|
+
}
|
111718
|
+
}
|
111719
|
+
},
|
111720
|
+
"timer": {
|
111721
|
+
"type": "object",
|
111722
|
+
"patternProperties": {
|
111723
|
+
".*": {
|
111724
|
+
"type": "number"
|
111725
|
+
}
|
111726
|
+
}
|
111727
|
+
},
|
111728
|
+
"virtualButton": {
|
111729
|
+
"type": "object",
|
111730
|
+
"patternProperties": {
|
111731
|
+
".*": {
|
111732
|
+
"type": "number"
|
111733
|
+
}
|
111734
|
+
}
|
111735
|
+
},
|
111736
|
+
"webhook": {
|
111737
|
+
"type": "object",
|
111738
|
+
"patternProperties": {
|
111739
|
+
".*": {
|
111740
|
+
"type": "number"
|
111741
|
+
}
|
111742
|
+
}
|
111743
|
+
},
|
111744
|
+
"resourceJob": {
|
111745
|
+
"type": "object",
|
111746
|
+
"patternProperties": {
|
111747
|
+
".*": {
|
111748
|
+
"type": "number"
|
111749
|
+
}
|
111750
|
+
}
|
111751
|
+
}
|
111752
|
+
}
|
111753
|
+
},
|
111754
|
+
"payloadSizeDetails": {
|
111755
|
+
"title": "Payload Stats",
|
111756
|
+
"description": "Schema for the result of a payload stats request",
|
111757
|
+
"type": "object",
|
111758
|
+
"properties": {
|
111759
|
+
"dataTable": {
|
111760
|
+
"type": "object",
|
111761
|
+
"patternProperties": {
|
111762
|
+
".*": {
|
111763
|
+
"type": "number"
|
111764
|
+
}
|
111765
|
+
}
|
111766
|
+
},
|
111767
|
+
"deviceCommand": {
|
111768
|
+
"type": "object",
|
111769
|
+
"patternProperties": {
|
111770
|
+
".*": {
|
111771
|
+
"type": "number"
|
111772
|
+
}
|
111773
|
+
}
|
111774
|
+
},
|
111775
|
+
"deviceConnect": {
|
111776
|
+
"type": "object",
|
111777
|
+
"patternProperties": {
|
111778
|
+
".*": {
|
111779
|
+
"type": "number"
|
111780
|
+
}
|
111781
|
+
}
|
111782
|
+
},
|
111783
|
+
"deviceDisconnect": {
|
111784
|
+
"type": "object",
|
111785
|
+
"patternProperties": {
|
111786
|
+
".*": {
|
111787
|
+
"type": "number"
|
111788
|
+
}
|
111789
|
+
}
|
111790
|
+
},
|
111791
|
+
"deviceState": {
|
111792
|
+
"type": "object",
|
111793
|
+
"patternProperties": {
|
111794
|
+
".*": {
|
111795
|
+
"type": "number"
|
111796
|
+
}
|
111797
|
+
}
|
111798
|
+
},
|
111799
|
+
"endpoint": {
|
111800
|
+
"type": "object",
|
111801
|
+
"patternProperties": {
|
111802
|
+
".*": {
|
111803
|
+
"type": "number"
|
111804
|
+
}
|
111805
|
+
}
|
111806
|
+
},
|
111807
|
+
"event": {
|
111808
|
+
"type": "object",
|
111809
|
+
"patternProperties": {
|
111810
|
+
".*": {
|
111811
|
+
"type": "number"
|
111812
|
+
}
|
111813
|
+
}
|
111814
|
+
},
|
111815
|
+
"flowError": {
|
111816
|
+
"type": "object",
|
111817
|
+
"patternProperties": {
|
111818
|
+
".*": {
|
111819
|
+
"type": "number"
|
111820
|
+
}
|
111821
|
+
}
|
111822
|
+
},
|
111823
|
+
"integration": {
|
111824
|
+
"type": "object",
|
111825
|
+
"patternProperties": {
|
111826
|
+
".*": {
|
111827
|
+
"type": "number"
|
111828
|
+
}
|
111829
|
+
}
|
111830
|
+
},
|
111831
|
+
"mqttIn": {
|
111832
|
+
"type": "object",
|
111833
|
+
"patternProperties": {
|
111834
|
+
".*": {
|
111835
|
+
"type": "number"
|
111836
|
+
}
|
111837
|
+
}
|
111838
|
+
},
|
111839
|
+
"mqttOut": {
|
111840
|
+
"type": "object",
|
111841
|
+
"patternProperties": {
|
111842
|
+
".*": {
|
111843
|
+
"type": "number"
|
111844
|
+
}
|
111845
|
+
}
|
111846
|
+
},
|
111847
|
+
"notebook": {
|
111848
|
+
"type": "object",
|
111849
|
+
"patternProperties": {
|
111850
|
+
".*": {
|
111851
|
+
"type": "number"
|
111852
|
+
}
|
111853
|
+
}
|
111854
|
+
},
|
111855
|
+
"timer": {
|
111856
|
+
"type": "object",
|
111857
|
+
"patternProperties": {
|
111858
|
+
".*": {
|
111859
|
+
"type": "number"
|
111860
|
+
}
|
111861
|
+
}
|
111862
|
+
},
|
111863
|
+
"virtualButton": {
|
111864
|
+
"type": "object",
|
111865
|
+
"patternProperties": {
|
111866
|
+
".*": {
|
111867
|
+
"type": "number"
|
111868
|
+
}
|
111869
|
+
}
|
111870
|
+
},
|
111871
|
+
"webhook": {
|
111872
|
+
"type": "object",
|
111873
|
+
"patternProperties": {
|
111874
|
+
".*": {
|
111875
|
+
"type": "number"
|
111876
|
+
}
|
111877
|
+
}
|
111878
|
+
},
|
111879
|
+
"resourceJob": {
|
111880
|
+
"type": "object",
|
111881
|
+
"patternProperties": {
|
111882
|
+
".*": {
|
111883
|
+
"type": "number"
|
111884
|
+
}
|
111885
|
+
}
|
111886
|
+
}
|
111887
|
+
}
|
111888
|
+
}
|
111889
|
+
},
|
111890
|
+
"additionalProperties": false
|
111000
111891
|
}
|
111001
111892
|
},
|
111002
111893
|
"count": {
|
@@ -111071,6 +111962,7 @@ Schema for a collection of Historical Summaries
|
|
111071
111962
|
"fileTotalSizeMb": 0,
|
111072
111963
|
"integrationCount": 0,
|
111073
111964
|
"notebookCount": 0,
|
111965
|
+
"resourceJobCount": 0,
|
111074
111966
|
"notebookRunCount": 0,
|
111075
111967
|
"notebookMinutesCount": 0,
|
111076
111968
|
"webhookCount": 2,
|
@@ -111212,6 +112104,9 @@ Schema for a historical summary report
|
|
111212
112104
|
"notebook": {
|
111213
112105
|
"type": "integer"
|
111214
112106
|
},
|
112107
|
+
"resourcejob": {
|
112108
|
+
"type": "integer"
|
112109
|
+
},
|
111215
112110
|
"webhook": {
|
111216
112111
|
"type": "integer"
|
111217
112112
|
},
|
@@ -111337,6 +112232,9 @@ Schema for a historical summary report
|
|
111337
112232
|
"notebookCount": {
|
111338
112233
|
"type": "number"
|
111339
112234
|
},
|
112235
|
+
"resourceJobCount": {
|
112236
|
+
"type": "integer"
|
112237
|
+
},
|
111340
112238
|
"notebookRunCount": {
|
111341
112239
|
"type": "number"
|
111342
112240
|
},
|
@@ -111485,6 +112383,14 @@ Schema for a historical summary report
|
|
111485
112383
|
"type": "number"
|
111486
112384
|
}
|
111487
112385
|
}
|
112386
|
+
},
|
112387
|
+
"resourceJob": {
|
112388
|
+
"type": "object",
|
112389
|
+
"patternProperties": {
|
112390
|
+
".*": {
|
112391
|
+
"type": "number"
|
112392
|
+
}
|
112393
|
+
}
|
111488
112394
|
}
|
111489
112395
|
}
|
111490
112396
|
},
|
@@ -111612,6 +112518,14 @@ Schema for a historical summary report
|
|
111612
112518
|
"type": "number"
|
111613
112519
|
}
|
111614
112520
|
}
|
112521
|
+
},
|
112522
|
+
"resourceJob": {
|
112523
|
+
"type": "object",
|
112524
|
+
"patternProperties": {
|
112525
|
+
".*": {
|
112526
|
+
"type": "number"
|
112527
|
+
}
|
112528
|
+
}
|
111615
112529
|
}
|
111616
112530
|
}
|
111617
112531
|
}
|
@@ -111655,6 +112569,7 @@ Schema for a historical summary report
|
|
111655
112569
|
"fileTotalSizeMb": 0,
|
111656
112570
|
"integrationCount": 0,
|
111657
112571
|
"notebookCount": 0,
|
112572
|
+
"resourceJobCount": 0,
|
111658
112573
|
"notebookRunCount": 0,
|
111659
112574
|
"notebookMinutesCount": 0,
|
111660
112575
|
"webhookCount": 2,
|
@@ -111719,6 +112634,10 @@ Schema for additional application import options
|
|
111719
112634
|
"type": "boolean",
|
111720
112635
|
"default": false
|
111721
112636
|
},
|
112637
|
+
"forceJob": {
|
112638
|
+
"type": "boolean",
|
112639
|
+
"default": false
|
112640
|
+
},
|
111722
112641
|
"include": {
|
111723
112642
|
"type": "array",
|
111724
112643
|
"items": {
|
@@ -111742,7 +112661,8 @@ Schema for additional application import options
|
|
111742
112661
|
"Global",
|
111743
112662
|
"Integration",
|
111744
112663
|
"Notebook",
|
111745
|
-
"Webhook"
|
112664
|
+
"Webhook",
|
112665
|
+
"ResourceJob"
|
111746
112666
|
]
|
111747
112667
|
},
|
111748
112668
|
"uniqueItems": true
|
@@ -111809,10 +112729,15 @@ Schema for additional application import options (new application)
|
|
111809
112729
|
"Global",
|
111810
112730
|
"Integration",
|
111811
112731
|
"Notebook",
|
111812
|
-
"Webhook"
|
112732
|
+
"Webhook",
|
112733
|
+
"ResourceJob"
|
111813
112734
|
]
|
111814
112735
|
},
|
111815
112736
|
"uniqueItems": true
|
112737
|
+
},
|
112738
|
+
"forceJob": {
|
112739
|
+
"type": "boolean",
|
112740
|
+
"default": false
|
111816
112741
|
}
|
111817
112742
|
},
|
111818
112743
|
"additionalProperties": false
|
@@ -111940,6 +112865,12 @@ Schema for a single Instance
|
|
111940
112865
|
"application": {
|
111941
112866
|
"type": "integer"
|
111942
112867
|
},
|
112868
|
+
"applicationcertificate": {
|
112869
|
+
"type": "integer"
|
112870
|
+
},
|
112871
|
+
"applicationcertificateauthority": {
|
112872
|
+
"type": "integer"
|
112873
|
+
},
|
111943
112874
|
"applicationkey": {
|
111944
112875
|
"type": "integer"
|
111945
112876
|
},
|
@@ -111988,6 +112919,9 @@ Schema for a single Instance
|
|
111988
112919
|
"notebook": {
|
111989
112920
|
"type": "integer"
|
111990
112921
|
},
|
112922
|
+
"resourcejob": {
|
112923
|
+
"type": "integer"
|
112924
|
+
},
|
111991
112925
|
"webhook": {
|
111992
112926
|
"type": "integer"
|
111993
112927
|
},
|
@@ -112017,6 +112951,9 @@ Schema for a single Instance
|
|
112017
112951
|
},
|
112018
112952
|
"applicationFlowSlots": {
|
112019
112953
|
"type": "integer"
|
112954
|
+
},
|
112955
|
+
"systemInterval": {
|
112956
|
+
"type": "integer"
|
112020
112957
|
}
|
112021
112958
|
},
|
112022
112959
|
"additionalProperties": false
|
@@ -112073,6 +113010,7 @@ Schema for a single Instance
|
|
112073
113010
|
"flow": 1000,
|
112074
113011
|
"integration": 50,
|
112075
113012
|
"notebook": 100,
|
113013
|
+
"resourcejob": 10,
|
112076
113014
|
"webhook": 1000,
|
112077
113015
|
"dataTTL": 15552000,
|
112078
113016
|
"member": 100,
|
@@ -112820,7 +113758,10 @@ Schema for the body of a Instance Custom Node modification request
|
|
112820
113758
|
"onConnect",
|
112821
113759
|
"onDisconnect",
|
112822
113760
|
"udp",
|
112823
|
-
"webhook"
|
113761
|
+
"webhook",
|
113762
|
+
"resourceJobIteration",
|
113763
|
+
"resourceJobIterationTimeout",
|
113764
|
+
"resourceJobComplete"
|
112824
113765
|
]
|
112825
113766
|
},
|
112826
113767
|
"config": {
|
@@ -112856,7 +113797,10 @@ Schema for the body of a Instance Custom Node modification request
|
|
112856
113797
|
"particle",
|
112857
113798
|
"sqs",
|
112858
113799
|
"udp",
|
112859
|
-
"webhook"
|
113800
|
+
"webhook",
|
113801
|
+
"resourceJobIteration",
|
113802
|
+
"resourceJobIterationTimeout",
|
113803
|
+
"resourceJobComplete"
|
112860
113804
|
]
|
112861
113805
|
},
|
112862
113806
|
"label": {
|
@@ -113514,7 +114458,10 @@ Schema for the body of a Instance Custom Node creation request
|
|
113514
114458
|
"onConnect",
|
113515
114459
|
"onDisconnect",
|
113516
114460
|
"udp",
|
113517
|
-
"webhook"
|
114461
|
+
"webhook",
|
114462
|
+
"resourceJobIteration",
|
114463
|
+
"resourceJobIterationTimeout",
|
114464
|
+
"resourceJobComplete"
|
113518
114465
|
]
|
113519
114466
|
},
|
113520
114467
|
"config": {
|
@@ -113550,7 +114497,10 @@ Schema for the body of a Instance Custom Node creation request
|
|
113550
114497
|
"particle",
|
113551
114498
|
"sqs",
|
113552
114499
|
"udp",
|
113553
|
-
"webhook"
|
114500
|
+
"webhook",
|
114501
|
+
"resourceJobIteration",
|
114502
|
+
"resourceJobIterationTimeout",
|
114503
|
+
"resourceJobComplete"
|
113554
114504
|
]
|
113555
114505
|
},
|
113556
114506
|
"label": {
|
@@ -115195,6 +116145,9 @@ Schema for the body of an Organization owned by an instance
|
|
115195
116145
|
"notebook": {
|
115196
116146
|
"type": "integer"
|
115197
116147
|
},
|
116148
|
+
"resourcejob": {
|
116149
|
+
"type": "integer"
|
116150
|
+
},
|
115198
116151
|
"webhook": {
|
115199
116152
|
"type": "integer"
|
115200
116153
|
},
|
@@ -115298,7 +116251,7 @@ Schema for the body of an Organization owned by an instance
|
|
115298
116251
|
"id": "60106426dc03c6aad06540bb",
|
115299
116252
|
"instanceId": "60106426dc03c6aad06560ba",
|
115300
116253
|
"limits": {
|
115301
|
-
"
|
116254
|
+
"member": 500
|
115302
116255
|
},
|
115303
116256
|
"auditLogEnabled": true
|
115304
116257
|
}
|
@@ -115370,14 +116323,7 @@ Schema for an Instance Organization member
|
|
115370
116323
|
```json
|
115371
116324
|
{
|
115372
116325
|
"userId": "575ef90f7ae143cd83dc4aad",
|
115373
|
-
"role": "view"
|
115374
|
-
"applicationRoles": [
|
115375
|
-
{
|
115376
|
-
"resourceId": "575ef90f7ae143cd83dc4a4f",
|
115377
|
-
"role": "none"
|
115378
|
-
}
|
115379
|
-
],
|
115380
|
-
"dashboardRoles": []
|
116326
|
+
"role": "view"
|
115381
116327
|
}
|
115382
116328
|
```
|
115383
116329
|
|
@@ -115713,14 +116659,7 @@ Schema for a collection of Organization members within an instance
|
|
115713
116659
|
"items": [
|
115714
116660
|
{
|
115715
116661
|
"userId": "575ef90f7ae143cd83dc4aad",
|
115716
|
-
"role": "view"
|
115717
|
-
"applicationRoles": [
|
115718
|
-
{
|
115719
|
-
"resourceId": "575ef90f7ae143cd83dc4a4f",
|
115720
|
-
"role": "none"
|
115721
|
-
}
|
115722
|
-
],
|
115723
|
-
"dashboardRoles": []
|
116662
|
+
"role": "view"
|
115724
116663
|
}
|
115725
116664
|
],
|
115726
116665
|
"count": 8,
|
@@ -115830,6 +116769,10 @@ Schema for the body of an Organization modification request within an instance
|
|
115830
116769
|
"type": "integer",
|
115831
116770
|
"minimum": 0
|
115832
116771
|
},
|
116772
|
+
"resourcejob": {
|
116773
|
+
"type": "integer",
|
116774
|
+
"minimum": 0
|
116775
|
+
},
|
115833
116776
|
"webhook": {
|
115834
116777
|
"type": "integer",
|
115835
116778
|
"minimum": 0
|
@@ -115935,7 +116878,7 @@ Schema for the body of an Organization modification request within an instance
|
|
115935
116878
|
{
|
115936
116879
|
"name": "My Org",
|
115937
116880
|
"limits": {
|
115938
|
-
"
|
116881
|
+
"member": 500
|
115939
116882
|
},
|
115940
116883
|
"auditLogEnabled": true
|
115941
116884
|
}
|
@@ -116042,6 +116985,10 @@ Schema for the body of an Organization creation request within an instance
|
|
116042
116985
|
"type": "integer",
|
116043
116986
|
"minimum": 0
|
116044
116987
|
},
|
116988
|
+
"resourcejob": {
|
116989
|
+
"type": "integer",
|
116990
|
+
"minimum": 0
|
116991
|
+
},
|
116045
116992
|
"webhook": {
|
116046
116993
|
"type": "integer",
|
116047
116994
|
"minimum": 0
|
@@ -116428,6 +117375,9 @@ Schema for a collection of Organizations within an instance
|
|
116428
117375
|
"notebook": {
|
116429
117376
|
"type": "integer"
|
116430
117377
|
},
|
117378
|
+
"resourcejob": {
|
117379
|
+
"type": "integer"
|
117380
|
+
},
|
116431
117381
|
"webhook": {
|
116432
117382
|
"type": "integer"
|
116433
117383
|
},
|
@@ -116571,7 +117521,7 @@ Schema for a collection of Organizations within an instance
|
|
116571
117521
|
"id": "60106426dc03c6aad06540bb",
|
116572
117522
|
"instanceId": "60106426dc03c6aad06560ba",
|
116573
117523
|
"limits": {
|
116574
|
-
"
|
117524
|
+
"member": 500
|
116575
117525
|
},
|
116576
117526
|
"auditLogEnabled": true
|
116577
117527
|
}
|
@@ -116669,14 +117619,15 @@ Schema for instance patch request
|
|
116669
117619
|
{
|
116670
117620
|
"reportConfigs": [
|
116671
117621
|
{
|
116672
|
-
"
|
117622
|
+
"emails": [
|
116673
117623
|
"email@example.com"
|
116674
117624
|
],
|
116675
117625
|
"callbackUrl": "https://example.com/callback",
|
116676
117626
|
"resourceGroupBy": "organization",
|
116677
117627
|
"dateGroupBy": "month",
|
116678
117628
|
"includeSandbox": false,
|
116679
|
-
"periods": 3
|
117629
|
+
"periods": 3,
|
117630
|
+
"cron": "0 4 1 * *"
|
116680
117631
|
},
|
116681
117632
|
{
|
116682
117633
|
"emails": [
|
@@ -116685,7 +117636,8 @@ Schema for instance patch request
|
|
116685
117636
|
],
|
116686
117637
|
"resourceGroupBy": "application",
|
116687
117638
|
"dateGroupBy": "month",
|
116688
|
-
"includeSandbox": true
|
117639
|
+
"includeSandbox": true,
|
117640
|
+
"cron": "0 4 1 * *"
|
116689
117641
|
}
|
116690
117642
|
]
|
116691
117643
|
}
|
@@ -116928,6 +117880,9 @@ Schema for information about a sandbox user within an instance domain
|
|
116928
117880
|
"notebook": {
|
116929
117881
|
"type": "integer"
|
116930
117882
|
},
|
117883
|
+
"resourcejob": {
|
117884
|
+
"type": "integer"
|
117885
|
+
},
|
116931
117886
|
"webhook": {
|
116932
117887
|
"type": "integer"
|
116933
117888
|
},
|
@@ -117136,6 +118091,14 @@ Schema for information about a sandbox user within an instance domain
|
|
117136
118091
|
"type": "number"
|
117137
118092
|
}
|
117138
118093
|
}
|
118094
|
+
},
|
118095
|
+
"resourceJob": {
|
118096
|
+
"type": "object",
|
118097
|
+
"patternProperties": {
|
118098
|
+
".*": {
|
118099
|
+
"type": "number"
|
118100
|
+
}
|
118101
|
+
}
|
117139
118102
|
}
|
117140
118103
|
}
|
117141
118104
|
},
|
@@ -117246,7 +118209,439 @@ Schema for a collection of instance associated sandboxes
|
|
117246
118209
|
"items": {
|
117247
118210
|
"type": "array",
|
117248
118211
|
"items": {
|
117249
|
-
"
|
118212
|
+
"title": "Instance Sandbox User",
|
118213
|
+
"description": "Schema for information about a sandbox user within an instance domain",
|
118214
|
+
"type": "object",
|
118215
|
+
"properties": {
|
118216
|
+
"id": {
|
118217
|
+
"type": "string",
|
118218
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118219
|
+
},
|
118220
|
+
"instanceSandboxId": {
|
118221
|
+
"type": "string",
|
118222
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118223
|
+
},
|
118224
|
+
"instanceId": {
|
118225
|
+
"type": "string",
|
118226
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118227
|
+
},
|
118228
|
+
"creationDate": {
|
118229
|
+
"type": "string",
|
118230
|
+
"format": "date-time"
|
118231
|
+
},
|
118232
|
+
"permanentDeletion": {
|
118233
|
+
"type": "string",
|
118234
|
+
"format": "date-time"
|
118235
|
+
},
|
118236
|
+
"dataDeletion": {
|
118237
|
+
"type": "string",
|
118238
|
+
"format": "date-time"
|
118239
|
+
},
|
118240
|
+
"lastUpdated": {
|
118241
|
+
"type": "string",
|
118242
|
+
"format": "date-time"
|
118243
|
+
},
|
118244
|
+
"lastSuccessfulLogin": {
|
118245
|
+
"type": "string",
|
118246
|
+
"format": "date-time"
|
118247
|
+
},
|
118248
|
+
"lastFailedLogin": {
|
118249
|
+
"type": "string",
|
118250
|
+
"format": "date-time"
|
118251
|
+
},
|
118252
|
+
"failedLoginCount": {
|
118253
|
+
"type": "number"
|
118254
|
+
},
|
118255
|
+
"passwordLastUpdated": {
|
118256
|
+
"type": "string",
|
118257
|
+
"format": "date-time"
|
118258
|
+
},
|
118259
|
+
"email": {
|
118260
|
+
"type": "string",
|
118261
|
+
"format": "email",
|
118262
|
+
"maxLength": 1024
|
118263
|
+
},
|
118264
|
+
"firstName": {
|
118265
|
+
"type": "string",
|
118266
|
+
"minLength": 1,
|
118267
|
+
"maxLength": 1024
|
118268
|
+
},
|
118269
|
+
"lastName": {
|
118270
|
+
"type": "string",
|
118271
|
+
"maxLength": 1024
|
118272
|
+
},
|
118273
|
+
"companyName": {
|
118274
|
+
"type": "string",
|
118275
|
+
"maxLength": 1024
|
118276
|
+
},
|
118277
|
+
"title": {
|
118278
|
+
"type": "string",
|
118279
|
+
"maxLength": 1024
|
118280
|
+
},
|
118281
|
+
"phoneNumber": {
|
118282
|
+
"type": "string",
|
118283
|
+
"maxLength": 1024
|
118284
|
+
},
|
118285
|
+
"location": {
|
118286
|
+
"type": "string",
|
118287
|
+
"maxLength": 1024
|
118288
|
+
},
|
118289
|
+
"url": {
|
118290
|
+
"type": "string",
|
118291
|
+
"maxLength": 1024
|
118292
|
+
},
|
118293
|
+
"tokenCutoff": {
|
118294
|
+
"type": "string",
|
118295
|
+
"format": "date-time"
|
118296
|
+
},
|
118297
|
+
"emailVerified": {
|
118298
|
+
"type": "boolean"
|
118299
|
+
},
|
118300
|
+
"needsToVerifyEmail": {
|
118301
|
+
"type": "boolean"
|
118302
|
+
},
|
118303
|
+
"twoFactorAuthEnabled": {
|
118304
|
+
"type": "boolean"
|
118305
|
+
},
|
118306
|
+
"fullName": {
|
118307
|
+
"type": "string"
|
118308
|
+
},
|
118309
|
+
"githubName": {
|
118310
|
+
"type": "string"
|
118311
|
+
},
|
118312
|
+
"avatarUrl": {
|
118313
|
+
"type": "string",
|
118314
|
+
"format": "uri",
|
118315
|
+
"maxLength": 1024
|
118316
|
+
},
|
118317
|
+
"limits": {
|
118318
|
+
"type": "object",
|
118319
|
+
"properties": {
|
118320
|
+
"apitoken": {
|
118321
|
+
"type": "integer"
|
118322
|
+
},
|
118323
|
+
"application": {
|
118324
|
+
"type": "integer"
|
118325
|
+
},
|
118326
|
+
"applicationkey": {
|
118327
|
+
"type": "integer"
|
118328
|
+
},
|
118329
|
+
"dashboard": {
|
118330
|
+
"type": "integer"
|
118331
|
+
},
|
118332
|
+
"datatable": {
|
118333
|
+
"type": "integer"
|
118334
|
+
},
|
118335
|
+
"device": {
|
118336
|
+
"type": "integer"
|
118337
|
+
},
|
118338
|
+
"devicerecipe": {
|
118339
|
+
"type": "integer"
|
118340
|
+
},
|
118341
|
+
"experiencedomain": {
|
118342
|
+
"type": "integer"
|
118343
|
+
},
|
118344
|
+
"experienceendpoint": {
|
118345
|
+
"type": "integer"
|
118346
|
+
},
|
118347
|
+
"experiencegroup": {
|
118348
|
+
"type": "integer"
|
118349
|
+
},
|
118350
|
+
"experienceslug": {
|
118351
|
+
"type": "integer"
|
118352
|
+
},
|
118353
|
+
"experienceuser": {
|
118354
|
+
"type": "integer"
|
118355
|
+
},
|
118356
|
+
"experienceversion": {
|
118357
|
+
"type": "integer"
|
118358
|
+
},
|
118359
|
+
"experienceview": {
|
118360
|
+
"type": "integer"
|
118361
|
+
},
|
118362
|
+
"file": {
|
118363
|
+
"type": "integer"
|
118364
|
+
},
|
118365
|
+
"flow": {
|
118366
|
+
"type": "integer"
|
118367
|
+
},
|
118368
|
+
"integration": {
|
118369
|
+
"type": "integer"
|
118370
|
+
},
|
118371
|
+
"notebook": {
|
118372
|
+
"type": "integer"
|
118373
|
+
},
|
118374
|
+
"resourcejob": {
|
118375
|
+
"type": "integer"
|
118376
|
+
},
|
118377
|
+
"webhook": {
|
118378
|
+
"type": "integer"
|
118379
|
+
},
|
118380
|
+
"dataTTL": {
|
118381
|
+
"type": "integer"
|
118382
|
+
},
|
118383
|
+
"payload": {
|
118384
|
+
"type": "integer"
|
118385
|
+
},
|
118386
|
+
"storage": {
|
118387
|
+
"type": "integer"
|
118388
|
+
},
|
118389
|
+
"notebookMinutesPerRun": {
|
118390
|
+
"type": "integer"
|
118391
|
+
},
|
118392
|
+
"notebookMinutesPerMonth": {
|
118393
|
+
"type": "integer"
|
118394
|
+
},
|
118395
|
+
"notebookInParallel": {
|
118396
|
+
"type": "integer"
|
118397
|
+
},
|
118398
|
+
"experienceFlowSlots": {
|
118399
|
+
"type": "integer"
|
118400
|
+
},
|
118401
|
+
"applicationFlowSlots": {
|
118402
|
+
"type": "integer"
|
118403
|
+
}
|
118404
|
+
},
|
118405
|
+
"additionalProperties": false
|
118406
|
+
},
|
118407
|
+
"summary": {
|
118408
|
+
"type": "object",
|
118409
|
+
"properties": {
|
118410
|
+
"apiTokenCount": {
|
118411
|
+
"type": "integer"
|
118412
|
+
},
|
118413
|
+
"appCount": {
|
118414
|
+
"type": "integer"
|
118415
|
+
},
|
118416
|
+
"dashCount": {
|
118417
|
+
"type": "integer"
|
118418
|
+
},
|
118419
|
+
"dataTableCount": {
|
118420
|
+
"type": "integer"
|
118421
|
+
},
|
118422
|
+
"deviceCount": {
|
118423
|
+
"type": "integer"
|
118424
|
+
},
|
118425
|
+
"deviceRecipeCount": {
|
118426
|
+
"type": "integer"
|
118427
|
+
},
|
118428
|
+
"experienceEndpointCount": {
|
118429
|
+
"type": "integer"
|
118430
|
+
},
|
118431
|
+
"experienceGroupCount": {
|
118432
|
+
"type": "integer"
|
118433
|
+
},
|
118434
|
+
"experienceSlugCount": {
|
118435
|
+
"type": "integer"
|
118436
|
+
},
|
118437
|
+
"experienceUserCount": {
|
118438
|
+
"type": "integer"
|
118439
|
+
},
|
118440
|
+
"experienceVersionCount": {
|
118441
|
+
"type": "integer"
|
118442
|
+
},
|
118443
|
+
"experienceViewCount": {
|
118444
|
+
"type": "integer"
|
118445
|
+
},
|
118446
|
+
"fileCount": {
|
118447
|
+
"type": "integer"
|
118448
|
+
},
|
118449
|
+
"flowCount": {
|
118450
|
+
"type": "integer"
|
118451
|
+
},
|
118452
|
+
"integrationCount": {
|
118453
|
+
"type": "integer"
|
118454
|
+
},
|
118455
|
+
"keyCount": {
|
118456
|
+
"type": "integer"
|
118457
|
+
},
|
118458
|
+
"orgCount": {
|
118459
|
+
"type": "integer"
|
118460
|
+
},
|
118461
|
+
"payloadCount": {
|
118462
|
+
"title": "Payload Stats",
|
118463
|
+
"description": "Schema for the result of a payload stats request",
|
118464
|
+
"type": "object",
|
118465
|
+
"properties": {
|
118466
|
+
"dataTable": {
|
118467
|
+
"type": "object",
|
118468
|
+
"patternProperties": {
|
118469
|
+
".*": {
|
118470
|
+
"type": "number"
|
118471
|
+
}
|
118472
|
+
}
|
118473
|
+
},
|
118474
|
+
"deviceCommand": {
|
118475
|
+
"type": "object",
|
118476
|
+
"patternProperties": {
|
118477
|
+
".*": {
|
118478
|
+
"type": "number"
|
118479
|
+
}
|
118480
|
+
}
|
118481
|
+
},
|
118482
|
+
"deviceConnect": {
|
118483
|
+
"type": "object",
|
118484
|
+
"patternProperties": {
|
118485
|
+
".*": {
|
118486
|
+
"type": "number"
|
118487
|
+
}
|
118488
|
+
}
|
118489
|
+
},
|
118490
|
+
"deviceDisconnect": {
|
118491
|
+
"type": "object",
|
118492
|
+
"patternProperties": {
|
118493
|
+
".*": {
|
118494
|
+
"type": "number"
|
118495
|
+
}
|
118496
|
+
}
|
118497
|
+
},
|
118498
|
+
"deviceState": {
|
118499
|
+
"type": "object",
|
118500
|
+
"patternProperties": {
|
118501
|
+
".*": {
|
118502
|
+
"type": "number"
|
118503
|
+
}
|
118504
|
+
}
|
118505
|
+
},
|
118506
|
+
"endpoint": {
|
118507
|
+
"type": "object",
|
118508
|
+
"patternProperties": {
|
118509
|
+
".*": {
|
118510
|
+
"type": "number"
|
118511
|
+
}
|
118512
|
+
}
|
118513
|
+
},
|
118514
|
+
"event": {
|
118515
|
+
"type": "object",
|
118516
|
+
"patternProperties": {
|
118517
|
+
".*": {
|
118518
|
+
"type": "number"
|
118519
|
+
}
|
118520
|
+
}
|
118521
|
+
},
|
118522
|
+
"flowError": {
|
118523
|
+
"type": "object",
|
118524
|
+
"patternProperties": {
|
118525
|
+
".*": {
|
118526
|
+
"type": "number"
|
118527
|
+
}
|
118528
|
+
}
|
118529
|
+
},
|
118530
|
+
"integration": {
|
118531
|
+
"type": "object",
|
118532
|
+
"patternProperties": {
|
118533
|
+
".*": {
|
118534
|
+
"type": "number"
|
118535
|
+
}
|
118536
|
+
}
|
118537
|
+
},
|
118538
|
+
"mqttIn": {
|
118539
|
+
"type": "object",
|
118540
|
+
"patternProperties": {
|
118541
|
+
".*": {
|
118542
|
+
"type": "number"
|
118543
|
+
}
|
118544
|
+
}
|
118545
|
+
},
|
118546
|
+
"mqttOut": {
|
118547
|
+
"type": "object",
|
118548
|
+
"patternProperties": {
|
118549
|
+
".*": {
|
118550
|
+
"type": "number"
|
118551
|
+
}
|
118552
|
+
}
|
118553
|
+
},
|
118554
|
+
"notebook": {
|
118555
|
+
"type": "object",
|
118556
|
+
"patternProperties": {
|
118557
|
+
".*": {
|
118558
|
+
"type": "number"
|
118559
|
+
}
|
118560
|
+
}
|
118561
|
+
},
|
118562
|
+
"timer": {
|
118563
|
+
"type": "object",
|
118564
|
+
"patternProperties": {
|
118565
|
+
".*": {
|
118566
|
+
"type": "number"
|
118567
|
+
}
|
118568
|
+
}
|
118569
|
+
},
|
118570
|
+
"virtualButton": {
|
118571
|
+
"type": "object",
|
118572
|
+
"patternProperties": {
|
118573
|
+
".*": {
|
118574
|
+
"type": "number"
|
118575
|
+
}
|
118576
|
+
}
|
118577
|
+
},
|
118578
|
+
"webhook": {
|
118579
|
+
"type": "object",
|
118580
|
+
"patternProperties": {
|
118581
|
+
".*": {
|
118582
|
+
"type": "number"
|
118583
|
+
}
|
118584
|
+
}
|
118585
|
+
},
|
118586
|
+
"resourceJob": {
|
118587
|
+
"type": "object",
|
118588
|
+
"patternProperties": {
|
118589
|
+
".*": {
|
118590
|
+
"type": "number"
|
118591
|
+
}
|
118592
|
+
}
|
118593
|
+
}
|
118594
|
+
}
|
118595
|
+
},
|
118596
|
+
"storageStats": {
|
118597
|
+
"type": "object",
|
118598
|
+
"properties": {
|
118599
|
+
"count": {
|
118600
|
+
"type": "integer"
|
118601
|
+
},
|
118602
|
+
"size": {
|
118603
|
+
"type": "integer"
|
118604
|
+
}
|
118605
|
+
}
|
118606
|
+
},
|
118607
|
+
"webhookCount": {
|
118608
|
+
"type": "integer"
|
118609
|
+
}
|
118610
|
+
}
|
118611
|
+
},
|
118612
|
+
"currentPeriodStart": {
|
118613
|
+
"type": "string",
|
118614
|
+
"format": "date-time"
|
118615
|
+
},
|
118616
|
+
"currentPeriodEnd": {
|
118617
|
+
"type": "string",
|
118618
|
+
"format": "date-time"
|
118619
|
+
},
|
118620
|
+
"ssoLinked": {
|
118621
|
+
"type": "boolean"
|
118622
|
+
},
|
118623
|
+
"orgs": {
|
118624
|
+
"type": "array",
|
118625
|
+
"items": {
|
118626
|
+
"type": "object",
|
118627
|
+
"properties": {
|
118628
|
+
"id": {
|
118629
|
+
"type": "string",
|
118630
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118631
|
+
},
|
118632
|
+
"iconColor": {
|
118633
|
+
"type": "string",
|
118634
|
+
"maxLength": 64
|
118635
|
+
},
|
118636
|
+
"name": {
|
118637
|
+
"type": "string",
|
118638
|
+
"minLength": 1,
|
118639
|
+
"maxLength": 255
|
118640
|
+
}
|
118641
|
+
}
|
118642
|
+
}
|
118643
|
+
}
|
118644
|
+
}
|
117250
118645
|
}
|
117251
118646
|
},
|
117252
118647
|
"count": {
|
@@ -117389,7 +118784,223 @@ Schema for a collection of Instances
|
|
117389
118784
|
"items": {
|
117390
118785
|
"type": "array",
|
117391
118786
|
"items": {
|
117392
|
-
"
|
118787
|
+
"title": "Instance",
|
118788
|
+
"description": "Schema for a single Instance",
|
118789
|
+
"type": "object",
|
118790
|
+
"properties": {
|
118791
|
+
"name": {
|
118792
|
+
"type": "string",
|
118793
|
+
"minLength": 1,
|
118794
|
+
"maxLength": 255
|
118795
|
+
},
|
118796
|
+
"id": {
|
118797
|
+
"type": "string",
|
118798
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118799
|
+
},
|
118800
|
+
"instanceId": {
|
118801
|
+
"type": "string",
|
118802
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118803
|
+
},
|
118804
|
+
"creationDate": {
|
118805
|
+
"type": "string",
|
118806
|
+
"format": "date-time"
|
118807
|
+
},
|
118808
|
+
"lastUpdated": {
|
118809
|
+
"type": "string",
|
118810
|
+
"format": "date-time"
|
118811
|
+
},
|
118812
|
+
"allowAuditLogging": {
|
118813
|
+
"type": "boolean"
|
118814
|
+
},
|
118815
|
+
"reportConfigs": {
|
118816
|
+
"type": "array",
|
118817
|
+
"maxItems": 10,
|
118818
|
+
"items": {
|
118819
|
+
"type": "object",
|
118820
|
+
"properties": {
|
118821
|
+
"id": {
|
118822
|
+
"type": "string",
|
118823
|
+
"maxLength": 48
|
118824
|
+
},
|
118825
|
+
"cron": {
|
118826
|
+
"type": "string",
|
118827
|
+
"maxLength": 255
|
118828
|
+
},
|
118829
|
+
"timezone": {
|
118830
|
+
"type": "string",
|
118831
|
+
"maxLength": 255
|
118832
|
+
},
|
118833
|
+
"emails": {
|
118834
|
+
"type": "array",
|
118835
|
+
"maxItems": 10,
|
118836
|
+
"items": {
|
118837
|
+
"type": "string",
|
118838
|
+
"format": "email",
|
118839
|
+
"maxLength": 1024
|
118840
|
+
}
|
118841
|
+
},
|
118842
|
+
"callbackUrl": {
|
118843
|
+
"type": "string",
|
118844
|
+
"format": "uri",
|
118845
|
+
"maxLength": 1024
|
118846
|
+
},
|
118847
|
+
"resourceGroupBy": {
|
118848
|
+
"type": "string",
|
118849
|
+
"enum": [
|
118850
|
+
"application",
|
118851
|
+
"organization"
|
118852
|
+
]
|
118853
|
+
},
|
118854
|
+
"dateGroupBy": {
|
118855
|
+
"type": "string",
|
118856
|
+
"enum": [
|
118857
|
+
"day",
|
118858
|
+
"month"
|
118859
|
+
]
|
118860
|
+
},
|
118861
|
+
"periods": {
|
118862
|
+
"type": "integer",
|
118863
|
+
"minimum": 1,
|
118864
|
+
"maximum": 90
|
118865
|
+
},
|
118866
|
+
"includeSandbox": {
|
118867
|
+
"type": "boolean"
|
118868
|
+
}
|
118869
|
+
},
|
118870
|
+
"required": [
|
118871
|
+
"cron"
|
118872
|
+
],
|
118873
|
+
"additionalProperties": false
|
118874
|
+
}
|
118875
|
+
},
|
118876
|
+
"limits": {
|
118877
|
+
"type": "object",
|
118878
|
+
"properties": {
|
118879
|
+
"organization": {
|
118880
|
+
"type": "integer"
|
118881
|
+
},
|
118882
|
+
"apitoken": {
|
118883
|
+
"type": "integer"
|
118884
|
+
},
|
118885
|
+
"application": {
|
118886
|
+
"type": "integer"
|
118887
|
+
},
|
118888
|
+
"applicationcertificate": {
|
118889
|
+
"type": "integer"
|
118890
|
+
},
|
118891
|
+
"applicationcertificateauthority": {
|
118892
|
+
"type": "integer"
|
118893
|
+
},
|
118894
|
+
"applicationkey": {
|
118895
|
+
"type": "integer"
|
118896
|
+
},
|
118897
|
+
"dashboard": {
|
118898
|
+
"type": "integer"
|
118899
|
+
},
|
118900
|
+
"datatable": {
|
118901
|
+
"type": "integer"
|
118902
|
+
},
|
118903
|
+
"device": {
|
118904
|
+
"type": "integer"
|
118905
|
+
},
|
118906
|
+
"devicerecipe": {
|
118907
|
+
"type": "integer"
|
118908
|
+
},
|
118909
|
+
"experiencedomain": {
|
118910
|
+
"type": "integer"
|
118911
|
+
},
|
118912
|
+
"experienceendpoint": {
|
118913
|
+
"type": "integer"
|
118914
|
+
},
|
118915
|
+
"experiencegroup": {
|
118916
|
+
"type": "integer"
|
118917
|
+
},
|
118918
|
+
"experienceslug": {
|
118919
|
+
"type": "integer"
|
118920
|
+
},
|
118921
|
+
"experienceuser": {
|
118922
|
+
"type": "integer"
|
118923
|
+
},
|
118924
|
+
"experienceversion": {
|
118925
|
+
"type": "integer"
|
118926
|
+
},
|
118927
|
+
"experienceview": {
|
118928
|
+
"type": "integer"
|
118929
|
+
},
|
118930
|
+
"file": {
|
118931
|
+
"type": "integer"
|
118932
|
+
},
|
118933
|
+
"flow": {
|
118934
|
+
"type": "integer"
|
118935
|
+
},
|
118936
|
+
"integration": {
|
118937
|
+
"type": "integer"
|
118938
|
+
},
|
118939
|
+
"notebook": {
|
118940
|
+
"type": "integer"
|
118941
|
+
},
|
118942
|
+
"resourcejob": {
|
118943
|
+
"type": "integer"
|
118944
|
+
},
|
118945
|
+
"webhook": {
|
118946
|
+
"type": "integer"
|
118947
|
+
},
|
118948
|
+
"dataTTL": {
|
118949
|
+
"type": "integer"
|
118950
|
+
},
|
118951
|
+
"member": {
|
118952
|
+
"type": "integer"
|
118953
|
+
},
|
118954
|
+
"payload": {
|
118955
|
+
"type": "integer"
|
118956
|
+
},
|
118957
|
+
"storage": {
|
118958
|
+
"type": "integer"
|
118959
|
+
},
|
118960
|
+
"notebookMinutesPerRun": {
|
118961
|
+
"type": "integer"
|
118962
|
+
},
|
118963
|
+
"notebookMinutesPerMonth": {
|
118964
|
+
"type": "integer"
|
118965
|
+
},
|
118966
|
+
"notebookInParallel": {
|
118967
|
+
"type": "integer"
|
118968
|
+
},
|
118969
|
+
"experienceFlowSlots": {
|
118970
|
+
"type": "integer"
|
118971
|
+
},
|
118972
|
+
"applicationFlowSlots": {
|
118973
|
+
"type": "integer"
|
118974
|
+
},
|
118975
|
+
"systemInterval": {
|
118976
|
+
"type": "integer"
|
118977
|
+
}
|
118978
|
+
},
|
118979
|
+
"additionalProperties": false
|
118980
|
+
},
|
118981
|
+
"members": {
|
118982
|
+
"type": "array",
|
118983
|
+
"items": {
|
118984
|
+
"type": "object",
|
118985
|
+
"properties": {
|
118986
|
+
"userId": {
|
118987
|
+
"type": "string",
|
118988
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
118989
|
+
},
|
118990
|
+
"role": {
|
118991
|
+
"type": "string",
|
118992
|
+
"enum": [
|
118993
|
+
"admin",
|
118994
|
+
"edit",
|
118995
|
+
"collaborate",
|
118996
|
+
"view",
|
118997
|
+
"none"
|
118998
|
+
]
|
118999
|
+
}
|
119000
|
+
}
|
119001
|
+
}
|
119002
|
+
}
|
119003
|
+
}
|
117393
119004
|
}
|
117394
119005
|
},
|
117395
119006
|
"count": {
|
@@ -117456,6 +119067,7 @@ Schema for a collection of Instances
|
|
117456
119067
|
"flow": 1000,
|
117457
119068
|
"integration": 50,
|
117458
119069
|
"notebook": 100,
|
119070
|
+
"resourcejob": 10,
|
117459
119071
|
"webhook": 1000,
|
117460
119072
|
"dataTTL": 15552000,
|
117461
119073
|
"member": 100,
|
@@ -119047,6 +120659,9 @@ Schema for information about the currently authenticated user
|
|
119047
120659
|
"notebook": {
|
119048
120660
|
"type": "integer"
|
119049
120661
|
},
|
120662
|
+
"resourcejob": {
|
120663
|
+
"type": "integer"
|
120664
|
+
},
|
119050
120665
|
"webhook": {
|
119051
120666
|
"type": "integer"
|
119052
120667
|
},
|
@@ -119369,6 +120984,14 @@ Schema for information about the currently authenticated user
|
|
119369
120984
|
"type": "number"
|
119370
120985
|
}
|
119371
120986
|
}
|
120987
|
+
},
|
120988
|
+
"resourceJob": {
|
120989
|
+
"type": "object",
|
120990
|
+
"patternProperties": {
|
120991
|
+
".*": {
|
120992
|
+
"type": "number"
|
120993
|
+
}
|
120994
|
+
}
|
119372
120995
|
}
|
119373
120996
|
}
|
119374
120997
|
},
|
@@ -119504,7 +121127,7 @@ Schema for the body of request to modify the current user
|
|
119504
121127
|
"lastName": "Name",
|
119505
121128
|
"companyName": "Example, Inc.",
|
119506
121129
|
"url": "https://example.com",
|
119507
|
-
"password": "
|
121130
|
+
"password": "My new password!!1"
|
119508
121131
|
}
|
119509
121132
|
```
|
119510
121133
|
|
@@ -121230,7 +122853,7 @@ Schema for the body of a request to send a command to multiple Devices
|
|
121230
122853
|
"deviceTags": [
|
121231
122854
|
{
|
121232
122855
|
"key": "floor",
|
121233
|
-
"value": 8
|
122856
|
+
"value": "8"
|
121234
122857
|
}
|
121235
122858
|
]
|
121236
122859
|
}
|
@@ -122144,7 +123767,9 @@ Schema for a set of Notebook execution logs
|
|
122144
123767
|
"inProgress",
|
122145
123768
|
"completed",
|
122146
123769
|
"errored",
|
122147
|
-
"timeout"
|
123770
|
+
"timeout",
|
123771
|
+
"canceling",
|
123772
|
+
"canceled"
|
122148
123773
|
]
|
122149
123774
|
},
|
122150
123775
|
"executionRelativeTo": {
|
@@ -124648,6 +126273,9 @@ Schema for a single Organization
|
|
124648
126273
|
"notebook": {
|
124649
126274
|
"type": "integer"
|
124650
126275
|
},
|
126276
|
+
"resourcejob": {
|
126277
|
+
"type": "integer"
|
126278
|
+
},
|
124651
126279
|
"webhook": {
|
124652
126280
|
"type": "integer"
|
124653
126281
|
},
|
@@ -124862,6 +126490,14 @@ Schema for a single Organization
|
|
124862
126490
|
"type": "number"
|
124863
126491
|
}
|
124864
126492
|
}
|
126493
|
+
},
|
126494
|
+
"resourceJob": {
|
126495
|
+
"type": "object",
|
126496
|
+
"patternProperties": {
|
126497
|
+
".*": {
|
126498
|
+
"type": "number"
|
126499
|
+
}
|
126500
|
+
}
|
124865
126501
|
}
|
124866
126502
|
}
|
124867
126503
|
},
|
@@ -126144,6 +127780,9 @@ Schema for a collection of Organizations
|
|
126144
127780
|
"notebook": {
|
126145
127781
|
"type": "integer"
|
126146
127782
|
},
|
127783
|
+
"resourcejob": {
|
127784
|
+
"type": "integer"
|
127785
|
+
},
|
126147
127786
|
"webhook": {
|
126148
127787
|
"type": "integer"
|
126149
127788
|
},
|
@@ -126358,6 +127997,14 @@ Schema for a collection of Organizations
|
|
126358
127997
|
"type": "number"
|
126359
127998
|
}
|
126360
127999
|
}
|
128000
|
+
},
|
128001
|
+
"resourceJob": {
|
128002
|
+
"type": "object",
|
128003
|
+
"patternProperties": {
|
128004
|
+
".*": {
|
128005
|
+
"type": "number"
|
128006
|
+
}
|
128007
|
+
}
|
126361
128008
|
}
|
126362
128009
|
}
|
126363
128010
|
},
|
@@ -127401,7 +129048,7 @@ Schema for the body of a request to complete the reset password flow
|
|
127401
129048
|
{
|
127402
129049
|
"token": "the_password_reset_token",
|
127403
129050
|
"email": "email@example.com",
|
127404
|
-
"password": "
|
129051
|
+
"password": "The new password!1"
|
127405
129052
|
}
|
127406
129053
|
```
|
127407
129054
|
|
@@ -127608,6 +129255,14 @@ Schema for the result of a payload stats request
|
|
127608
129255
|
"type": "number"
|
127609
129256
|
}
|
127610
129257
|
}
|
129258
|
+
},
|
129259
|
+
"resourceJob": {
|
129260
|
+
"type": "object",
|
129261
|
+
"patternProperties": {
|
129262
|
+
".*": {
|
129263
|
+
"type": "number"
|
129264
|
+
}
|
129265
|
+
}
|
127611
129266
|
}
|
127612
129267
|
}
|
127613
129268
|
}
|
@@ -127753,6 +129408,643 @@ Schema for an array of recent items
|
|
127753
129408
|
|
127754
129409
|
<br/>
|
127755
129410
|
|
129411
|
+
## Resource Job
|
129412
|
+
|
129413
|
+
Schema for a single resource job
|
129414
|
+
|
129415
|
+
### <a name="resource-job-schema"></a> Schema
|
129416
|
+
|
129417
|
+
```json
|
129418
|
+
{
|
129419
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
129420
|
+
"type": "object",
|
129421
|
+
"properties": {
|
129422
|
+
"id": {
|
129423
|
+
"type": "string",
|
129424
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129425
|
+
},
|
129426
|
+
"resourceJobId": {
|
129427
|
+
"type": "string",
|
129428
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129429
|
+
},
|
129430
|
+
"name": {
|
129431
|
+
"type": "string",
|
129432
|
+
"minLength": 1,
|
129433
|
+
"maxLength": 255
|
129434
|
+
},
|
129435
|
+
"description": {
|
129436
|
+
"type": "string",
|
129437
|
+
"maxLength": 32767
|
129438
|
+
},
|
129439
|
+
"applicationId": {
|
129440
|
+
"type": "string",
|
129441
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129442
|
+
},
|
129443
|
+
"dataTableId": {
|
129444
|
+
"oneOf": [
|
129445
|
+
{
|
129446
|
+
"type": "string",
|
129447
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129448
|
+
},
|
129449
|
+
{
|
129450
|
+
"type": "string",
|
129451
|
+
"minLength": 4,
|
129452
|
+
"maxLength": 255,
|
129453
|
+
"pattern": ".*{{.+}}.*"
|
129454
|
+
}
|
129455
|
+
]
|
129456
|
+
},
|
129457
|
+
"queryJson": {
|
129458
|
+
"type": "string",
|
129459
|
+
"maxLength": 8192
|
129460
|
+
},
|
129461
|
+
"resourceType": {
|
129462
|
+
"type": "string",
|
129463
|
+
"enum": [
|
129464
|
+
"dataTableRow",
|
129465
|
+
"device"
|
129466
|
+
]
|
129467
|
+
},
|
129468
|
+
"maxIterationConcurrency": {
|
129469
|
+
"type": "number",
|
129470
|
+
"enum": [
|
129471
|
+
1,
|
129472
|
+
10
|
129473
|
+
]
|
129474
|
+
},
|
129475
|
+
"iterationDelay": {
|
129476
|
+
"type": "number",
|
129477
|
+
"min": 0,
|
129478
|
+
"max": 60000
|
129479
|
+
},
|
129480
|
+
"iterationTimeout": {
|
129481
|
+
"type": "number",
|
129482
|
+
"min": 60000,
|
129483
|
+
"max": 900000
|
129484
|
+
},
|
129485
|
+
"creationDate": {
|
129486
|
+
"type": "string",
|
129487
|
+
"format": "date-time"
|
129488
|
+
},
|
129489
|
+
"lastUpdated": {
|
129490
|
+
"type": "string",
|
129491
|
+
"format": "date-time"
|
129492
|
+
},
|
129493
|
+
"lastExecutionRequested": {
|
129494
|
+
"type": "string",
|
129495
|
+
"format": "date-time"
|
129496
|
+
},
|
129497
|
+
"defaultContext": {
|
129498
|
+
"type": "string",
|
129499
|
+
"maxLength": 32767
|
129500
|
+
}
|
129501
|
+
},
|
129502
|
+
"additionalProperties": false
|
129503
|
+
}
|
129504
|
+
```
|
129505
|
+
### <a name="resource-job-example"></a> Example
|
129506
|
+
|
129507
|
+
```json
|
129508
|
+
{
|
129509
|
+
"name": "Example Resource Job",
|
129510
|
+
"iterationDelay": 60,
|
129511
|
+
"iterationTimeout": 60000,
|
129512
|
+
"defaultContext": "{}",
|
129513
|
+
"applicationId": "6328c6c026517badf9142116",
|
129514
|
+
"maxIterationConcurrency": 1,
|
129515
|
+
"creationDate": "2022-09-19T19:45:04.453Z",
|
129516
|
+
"lastUpdated": "2022-09-19T19:45:04.453Z",
|
129517
|
+
"resourceJobId": "6328c6c026517badf914211a",
|
129518
|
+
"resourceType": "device",
|
129519
|
+
"queryJson": "{ \"name\": \"my device\"}"
|
129520
|
+
}
|
129521
|
+
```
|
129522
|
+
|
129523
|
+
<br/>
|
129524
|
+
|
129525
|
+
## Resource Job Execution Logs
|
129526
|
+
|
129527
|
+
Schema for a set of Resource Job execution logs
|
129528
|
+
|
129529
|
+
### <a name="resource-job-execution-logs-schema"></a> Schema
|
129530
|
+
|
129531
|
+
```json
|
129532
|
+
{
|
129533
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
129534
|
+
"type": "array",
|
129535
|
+
"items": {
|
129536
|
+
"type": "object",
|
129537
|
+
"properties": {
|
129538
|
+
"id": {
|
129539
|
+
"type": "string",
|
129540
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129541
|
+
},
|
129542
|
+
"applicationId": {
|
129543
|
+
"type": "string",
|
129544
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129545
|
+
},
|
129546
|
+
"resourceJobExecutionId": {
|
129547
|
+
"type": "string",
|
129548
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129549
|
+
},
|
129550
|
+
"resourceJobId": {
|
129551
|
+
"type": "string",
|
129552
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129553
|
+
},
|
129554
|
+
"status": {
|
129555
|
+
"type": "string",
|
129556
|
+
"enum": [
|
129557
|
+
"inProgress",
|
129558
|
+
"completed",
|
129559
|
+
"erroring",
|
129560
|
+
"errored",
|
129561
|
+
"canceling",
|
129562
|
+
"canceled"
|
129563
|
+
]
|
129564
|
+
},
|
129565
|
+
"queryJson": {
|
129566
|
+
"type": "string",
|
129567
|
+
"maxLength": 8192
|
129568
|
+
},
|
129569
|
+
"resourceType": {
|
129570
|
+
"type": "string",
|
129571
|
+
"enum": [
|
129572
|
+
"dataTableRow",
|
129573
|
+
"device"
|
129574
|
+
]
|
129575
|
+
},
|
129576
|
+
"sourceType": {
|
129577
|
+
"type": "string",
|
129578
|
+
"enum": [
|
129579
|
+
"flow",
|
129580
|
+
"user",
|
129581
|
+
"device",
|
129582
|
+
"apiToken",
|
129583
|
+
"notebook"
|
129584
|
+
]
|
129585
|
+
},
|
129586
|
+
"sourceId": {
|
129587
|
+
"type": "string",
|
129588
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129589
|
+
},
|
129590
|
+
"cancelSourceType": {
|
129591
|
+
"type": "string",
|
129592
|
+
"enum": [
|
129593
|
+
"flow",
|
129594
|
+
"user",
|
129595
|
+
"device",
|
129596
|
+
"apiToken",
|
129597
|
+
"notebook"
|
129598
|
+
]
|
129599
|
+
},
|
129600
|
+
"cancelSourceId": {
|
129601
|
+
"type": "string",
|
129602
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129603
|
+
},
|
129604
|
+
"runStartedAt": {
|
129605
|
+
"type": "string",
|
129606
|
+
"format": "date-time"
|
129607
|
+
},
|
129608
|
+
"runCompletedAt": {
|
129609
|
+
"type": "string",
|
129610
|
+
"format": "date-time"
|
129611
|
+
},
|
129612
|
+
"executionReportUrl": {
|
129613
|
+
"type": "string"
|
129614
|
+
},
|
129615
|
+
"templateContext": {
|
129616
|
+
"type": "string",
|
129617
|
+
"maxLength": 32767
|
129618
|
+
},
|
129619
|
+
"iterationDelay": {
|
129620
|
+
"type": "number",
|
129621
|
+
"min": 0,
|
129622
|
+
"max": 60000
|
129623
|
+
},
|
129624
|
+
"iterationTimeout": {
|
129625
|
+
"type": "number",
|
129626
|
+
"min": 60000,
|
129627
|
+
"max": 900000
|
129628
|
+
},
|
129629
|
+
"maxIterationConcurrency": {
|
129630
|
+
"type": "number",
|
129631
|
+
"enum": [
|
129632
|
+
1,
|
129633
|
+
10
|
129634
|
+
]
|
129635
|
+
},
|
129636
|
+
"executionSummary": {
|
129637
|
+
"type": "object",
|
129638
|
+
"properties": {
|
129639
|
+
"succeeded": {
|
129640
|
+
"type": "number"
|
129641
|
+
},
|
129642
|
+
"failed": {
|
129643
|
+
"type": "number"
|
129644
|
+
},
|
129645
|
+
"timedOut": {
|
129646
|
+
"type": "number"
|
129647
|
+
},
|
129648
|
+
"inProgress": {
|
129649
|
+
"type": "number"
|
129650
|
+
},
|
129651
|
+
"remaining": {
|
129652
|
+
"type": "number"
|
129653
|
+
}
|
129654
|
+
}
|
129655
|
+
}
|
129656
|
+
}
|
129657
|
+
}
|
129658
|
+
}
|
129659
|
+
```
|
129660
|
+
### <a name="resource-job-execution-logs-example"></a> Example
|
129661
|
+
|
129662
|
+
```json
|
129663
|
+
[
|
129664
|
+
{
|
129665
|
+
"id": "5c7d3f9cd32c87a49f04c260",
|
129666
|
+
"resourceJobExecutionId": "5c7d3f9cd32c87a49f04c260",
|
129667
|
+
"resourceJobId": "5c782b8d4f3a8e51c1db42e4",
|
129668
|
+
"applicationId": "575ec8687ae143cd83dc4a97",
|
129669
|
+
"runStartedAt": "2016-06-13T03:59:00.000Z",
|
129670
|
+
"sourceId": "575ed70c7ae143cd83dc4aa9",
|
129671
|
+
"sourceType": "user",
|
129672
|
+
"status": "inProgress",
|
129673
|
+
"queryJson": "{ \"deviceClass\": \"standalone\"}",
|
129674
|
+
"templateContext": "{ \"monarchs\": [\"lizzy\", \"vicky\", \"chuck\"] }",
|
129675
|
+
"iterationDelay": 60,
|
129676
|
+
"iterationTimeout": 60000,
|
129677
|
+
"maxIterationConcurrency": 1,
|
129678
|
+
"executionSummary": {
|
129679
|
+
"succeeded": 5,
|
129680
|
+
"failed": 3,
|
129681
|
+
"timedOut": 0,
|
129682
|
+
"inProgress": 22,
|
129683
|
+
"remaining": 15
|
129684
|
+
}
|
129685
|
+
}
|
129686
|
+
]
|
129687
|
+
```
|
129688
|
+
|
129689
|
+
<br/>
|
129690
|
+
|
129691
|
+
## Resource Job Execution Options
|
129692
|
+
|
129693
|
+
Schema for a resource job execution configuration
|
129694
|
+
|
129695
|
+
### <a name="resource-job-execution-options-schema"></a> Schema
|
129696
|
+
|
129697
|
+
```json
|
129698
|
+
{
|
129699
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
129700
|
+
"type": "object",
|
129701
|
+
"properties": {
|
129702
|
+
"templateContext": {
|
129703
|
+
"type": "string",
|
129704
|
+
"maxLength": 32767
|
129705
|
+
}
|
129706
|
+
},
|
129707
|
+
"additionalProperties": false
|
129708
|
+
}
|
129709
|
+
```
|
129710
|
+
### <a name="resource-job-execution-options-example"></a> Example
|
129711
|
+
|
129712
|
+
```json
|
129713
|
+
{
|
129714
|
+
"templateContext": "{ \"myData\": 123 }"
|
129715
|
+
}
|
129716
|
+
```
|
129717
|
+
|
129718
|
+
<br/>
|
129719
|
+
|
129720
|
+
## Resource Job Patch
|
129721
|
+
|
129722
|
+
Schema for a resource job update
|
129723
|
+
|
129724
|
+
### <a name="resource-job-patch-schema"></a> Schema
|
129725
|
+
|
129726
|
+
```json
|
129727
|
+
{
|
129728
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
129729
|
+
"type": "object",
|
129730
|
+
"properties": {
|
129731
|
+
"name": {
|
129732
|
+
"type": "string",
|
129733
|
+
"minLength": 1,
|
129734
|
+
"maxLength": 255
|
129735
|
+
},
|
129736
|
+
"description": {
|
129737
|
+
"type": "string",
|
129738
|
+
"maxLength": 32767
|
129739
|
+
},
|
129740
|
+
"dataTableId": {
|
129741
|
+
"oneOf": [
|
129742
|
+
{
|
129743
|
+
"type": "string",
|
129744
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129745
|
+
},
|
129746
|
+
{
|
129747
|
+
"type": "string",
|
129748
|
+
"minLength": 4,
|
129749
|
+
"maxLength": 255,
|
129750
|
+
"pattern": ".*{{.+}}.*"
|
129751
|
+
}
|
129752
|
+
]
|
129753
|
+
},
|
129754
|
+
"queryJson": {
|
129755
|
+
"type": "string",
|
129756
|
+
"maxLength": 8192
|
129757
|
+
},
|
129758
|
+
"maxIterationConcurrency": {
|
129759
|
+
"type": "number",
|
129760
|
+
"enum": [
|
129761
|
+
1,
|
129762
|
+
10
|
129763
|
+
]
|
129764
|
+
},
|
129765
|
+
"iterationDelay": {
|
129766
|
+
"type": "number",
|
129767
|
+
"min": 0,
|
129768
|
+
"max": 60000
|
129769
|
+
},
|
129770
|
+
"iterationTimeout": {
|
129771
|
+
"type": "number",
|
129772
|
+
"min": 60000,
|
129773
|
+
"max": 900000
|
129774
|
+
},
|
129775
|
+
"defaultContext": {
|
129776
|
+
"type": "string",
|
129777
|
+
"maxLength": 32767
|
129778
|
+
}
|
129779
|
+
},
|
129780
|
+
"additionalProperties": false
|
129781
|
+
}
|
129782
|
+
```
|
129783
|
+
### <a name="resource-job-patch-example"></a> Example
|
129784
|
+
|
129785
|
+
```json
|
129786
|
+
{
|
129787
|
+
"name": "Example Resource Job",
|
129788
|
+
"queryJson": "{ \"name\": \"my device\"}"
|
129789
|
+
}
|
129790
|
+
```
|
129791
|
+
|
129792
|
+
<br/>
|
129793
|
+
|
129794
|
+
## Resource Job Post
|
129795
|
+
|
129796
|
+
Schema for a resource job creation
|
129797
|
+
|
129798
|
+
### <a name="resource-job-post-schema"></a> Schema
|
129799
|
+
|
129800
|
+
```json
|
129801
|
+
{
|
129802
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
129803
|
+
"type": "object",
|
129804
|
+
"properties": {
|
129805
|
+
"name": {
|
129806
|
+
"type": "string",
|
129807
|
+
"minLength": 1,
|
129808
|
+
"maxLength": 255
|
129809
|
+
},
|
129810
|
+
"description": {
|
129811
|
+
"type": "string",
|
129812
|
+
"maxLength": 32767
|
129813
|
+
},
|
129814
|
+
"dataTableId": {
|
129815
|
+
"oneOf": [
|
129816
|
+
{
|
129817
|
+
"type": "string",
|
129818
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129819
|
+
},
|
129820
|
+
{
|
129821
|
+
"type": "string",
|
129822
|
+
"minLength": 4,
|
129823
|
+
"maxLength": 255,
|
129824
|
+
"pattern": ".*{{.+}}.*"
|
129825
|
+
}
|
129826
|
+
]
|
129827
|
+
},
|
129828
|
+
"queryJson": {
|
129829
|
+
"type": "string",
|
129830
|
+
"maxLength": 8192
|
129831
|
+
},
|
129832
|
+
"resourceType": {
|
129833
|
+
"type": "string",
|
129834
|
+
"enum": [
|
129835
|
+
"dataTableRow",
|
129836
|
+
"device"
|
129837
|
+
]
|
129838
|
+
},
|
129839
|
+
"maxIterationConcurrency": {
|
129840
|
+
"type": "number",
|
129841
|
+
"enum": [
|
129842
|
+
1,
|
129843
|
+
10
|
129844
|
+
]
|
129845
|
+
},
|
129846
|
+
"iterationDelay": {
|
129847
|
+
"type": "number",
|
129848
|
+
"min": 0,
|
129849
|
+
"max": 60000
|
129850
|
+
},
|
129851
|
+
"iterationTimeout": {
|
129852
|
+
"type": "number",
|
129853
|
+
"min": 60000,
|
129854
|
+
"max": 900000
|
129855
|
+
},
|
129856
|
+
"defaultContext": {
|
129857
|
+
"type": "string",
|
129858
|
+
"maxLength": 32767
|
129859
|
+
}
|
129860
|
+
},
|
129861
|
+
"additionalProperties": false,
|
129862
|
+
"required": [
|
129863
|
+
"name",
|
129864
|
+
"resourceType"
|
129865
|
+
]
|
129866
|
+
}
|
129867
|
+
```
|
129868
|
+
### <a name="resource-job-post-example"></a> Example
|
129869
|
+
|
129870
|
+
```json
|
129871
|
+
{
|
129872
|
+
"name": "Example Resource Job",
|
129873
|
+
"resourceType": "device",
|
129874
|
+
"queryJson": "{ \"name\": \"my device\"}"
|
129875
|
+
}
|
129876
|
+
```
|
129877
|
+
|
129878
|
+
<br/>
|
129879
|
+
|
129880
|
+
## Resource Jobs
|
129881
|
+
|
129882
|
+
Schema for a collection of Resource Jobs
|
129883
|
+
|
129884
|
+
### <a name="resource-jobs-schema"></a> Schema
|
129885
|
+
|
129886
|
+
```json
|
129887
|
+
{
|
129888
|
+
"$schema": "http://json-schema.org/draft-07/schema#",
|
129889
|
+
"type": "object",
|
129890
|
+
"properties": {
|
129891
|
+
"items": {
|
129892
|
+
"type": "array",
|
129893
|
+
"items": {
|
129894
|
+
"title": "Resource Job",
|
129895
|
+
"description": "Schema for a single resource job",
|
129896
|
+
"type": "object",
|
129897
|
+
"properties": {
|
129898
|
+
"id": {
|
129899
|
+
"type": "string",
|
129900
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129901
|
+
},
|
129902
|
+
"resourceJobId": {
|
129903
|
+
"type": "string",
|
129904
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129905
|
+
},
|
129906
|
+
"name": {
|
129907
|
+
"type": "string",
|
129908
|
+
"minLength": 1,
|
129909
|
+
"maxLength": 255
|
129910
|
+
},
|
129911
|
+
"description": {
|
129912
|
+
"type": "string",
|
129913
|
+
"maxLength": 32767
|
129914
|
+
},
|
129915
|
+
"applicationId": {
|
129916
|
+
"type": "string",
|
129917
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129918
|
+
},
|
129919
|
+
"dataTableId": {
|
129920
|
+
"oneOf": [
|
129921
|
+
{
|
129922
|
+
"type": "string",
|
129923
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
129924
|
+
},
|
129925
|
+
{
|
129926
|
+
"type": "string",
|
129927
|
+
"minLength": 4,
|
129928
|
+
"maxLength": 255,
|
129929
|
+
"pattern": ".*{{.+}}.*"
|
129930
|
+
}
|
129931
|
+
]
|
129932
|
+
},
|
129933
|
+
"queryJson": {
|
129934
|
+
"type": "string",
|
129935
|
+
"maxLength": 8192
|
129936
|
+
},
|
129937
|
+
"resourceType": {
|
129938
|
+
"type": "string",
|
129939
|
+
"enum": [
|
129940
|
+
"dataTableRow",
|
129941
|
+
"device"
|
129942
|
+
]
|
129943
|
+
},
|
129944
|
+
"maxIterationConcurrency": {
|
129945
|
+
"type": "number",
|
129946
|
+
"enum": [
|
129947
|
+
1,
|
129948
|
+
10
|
129949
|
+
]
|
129950
|
+
},
|
129951
|
+
"iterationDelay": {
|
129952
|
+
"type": "number",
|
129953
|
+
"min": 0,
|
129954
|
+
"max": 60000
|
129955
|
+
},
|
129956
|
+
"iterationTimeout": {
|
129957
|
+
"type": "number",
|
129958
|
+
"min": 60000,
|
129959
|
+
"max": 900000
|
129960
|
+
},
|
129961
|
+
"creationDate": {
|
129962
|
+
"type": "string",
|
129963
|
+
"format": "date-time"
|
129964
|
+
},
|
129965
|
+
"lastUpdated": {
|
129966
|
+
"type": "string",
|
129967
|
+
"format": "date-time"
|
129968
|
+
},
|
129969
|
+
"lastExecutionRequested": {
|
129970
|
+
"type": "string",
|
129971
|
+
"format": "date-time"
|
129972
|
+
},
|
129973
|
+
"defaultContext": {
|
129974
|
+
"type": "string",
|
129975
|
+
"maxLength": 32767
|
129976
|
+
}
|
129977
|
+
},
|
129978
|
+
"additionalProperties": false
|
129979
|
+
}
|
129980
|
+
},
|
129981
|
+
"count": {
|
129982
|
+
"type": "integer"
|
129983
|
+
},
|
129984
|
+
"totalCount": {
|
129985
|
+
"type": "integer"
|
129986
|
+
},
|
129987
|
+
"perPage": {
|
129988
|
+
"type": "integer"
|
129989
|
+
},
|
129990
|
+
"page": {
|
129991
|
+
"type": "integer"
|
129992
|
+
},
|
129993
|
+
"filter": {
|
129994
|
+
"type": "string"
|
129995
|
+
},
|
129996
|
+
"filterField": {
|
129997
|
+
"type": "string"
|
129998
|
+
},
|
129999
|
+
"sortField": {
|
130000
|
+
"type": "string"
|
130001
|
+
},
|
130002
|
+
"sortDirection": {
|
130003
|
+
"type": "string",
|
130004
|
+
"enum": [
|
130005
|
+
"asc",
|
130006
|
+
"desc",
|
130007
|
+
"ASC",
|
130008
|
+
"DESC",
|
130009
|
+
""
|
130010
|
+
]
|
130011
|
+
},
|
130012
|
+
"applicationId": {
|
130013
|
+
"type": "string",
|
130014
|
+
"pattern": "^[A-Fa-f\\d]{24}$"
|
130015
|
+
}
|
130016
|
+
}
|
130017
|
+
}
|
130018
|
+
```
|
130019
|
+
### <a name="resource-jobs-example"></a> Example
|
130020
|
+
|
130021
|
+
```json
|
130022
|
+
{
|
130023
|
+
"items": [
|
130024
|
+
{
|
130025
|
+
"name": "Example Resource Job",
|
130026
|
+
"iterationDelay": 60,
|
130027
|
+
"iterationTimeout": 60000,
|
130028
|
+
"defaultContext": "{}",
|
130029
|
+
"applicationId": "6328c6c026517badf9142116",
|
130030
|
+
"maxIterationConcurrency": 1,
|
130031
|
+
"creationDate": "2022-09-19T19:45:04.453Z",
|
130032
|
+
"lastUpdated": "2022-09-19T19:45:04.453Z",
|
130033
|
+
"resourceJobId": "6328c6c026517badf914211a",
|
130034
|
+
"resourceType": "device",
|
130035
|
+
"queryJson": "{ \"name\": \"my device\"}"
|
130036
|
+
}
|
130037
|
+
],
|
130038
|
+
"count": 1,
|
130039
|
+
"totalCount": 4,
|
130040
|
+
"sortField": "name",
|
130041
|
+
"sortDirection": "asc",
|
130042
|
+
"applicationId": "575ec8687ae143cd83dc4a97"
|
130043
|
+
}
|
130044
|
+
```
|
130045
|
+
|
130046
|
+
<br/>
|
130047
|
+
|
127756
130048
|
## Resource Transfer
|
127757
130049
|
|
127758
130050
|
Schema for the body of a resource transfer request
|
@@ -127901,6 +130193,8 @@ SAML Response body for login
|
|
127901
130193
|
"flows.*",
|
127902
130194
|
"flowVersion.*",
|
127903
130195
|
"flowVersions.*",
|
130196
|
+
"resourceJobs.*",
|
130197
|
+
"resourceJob.*",
|
127904
130198
|
"notebook.*",
|
127905
130199
|
"notebooks.*",
|
127906
130200
|
"webhook.*",
|
@@ -128113,6 +130407,14 @@ SAML Response body for login
|
|
128113
130407
|
"notebook.upload",
|
128114
130408
|
"notebooks.get",
|
128115
130409
|
"notebooks.post",
|
130410
|
+
"resourceJob.get",
|
130411
|
+
"resourceJob.logs",
|
130412
|
+
"resourceJob.patch",
|
130413
|
+
"resourceJob.delete",
|
130414
|
+
"resourceJob.execute",
|
130415
|
+
"resourceJob.cancelExecution",
|
130416
|
+
"resourceJobs.get",
|
130417
|
+
"resourceJobs.post",
|
128116
130418
|
"webhook.delete",
|
128117
130419
|
"webhook.get",
|
128118
130420
|
"webhook.patch",
|
@@ -128386,7 +130688,7 @@ Schema for reporting a successful operation with a corresponding execution ID
|
|
128386
130688
|
```json
|
128387
130689
|
{
|
128388
130690
|
"success": true,
|
128389
|
-
"executionId": "
|
130691
|
+
"executionId": "575ed78e7ae143cd83dc4aab"
|
128390
130692
|
}
|
128391
130693
|
```
|
128392
130694
|
|
@@ -129098,6 +131400,8 @@ Schema for the body of a User authentication request
|
|
129098
131400
|
"flows.*",
|
129099
131401
|
"flowVersion.*",
|
129100
131402
|
"flowVersions.*",
|
131403
|
+
"resourceJobs.*",
|
131404
|
+
"resourceJob.*",
|
129101
131405
|
"notebook.*",
|
129102
131406
|
"notebooks.*",
|
129103
131407
|
"webhook.*",
|
@@ -129310,6 +131614,14 @@ Schema for the body of a User authentication request
|
|
129310
131614
|
"notebook.upload",
|
129311
131615
|
"notebooks.get",
|
129312
131616
|
"notebooks.post",
|
131617
|
+
"resourceJob.get",
|
131618
|
+
"resourceJob.logs",
|
131619
|
+
"resourceJob.patch",
|
131620
|
+
"resourceJob.delete",
|
131621
|
+
"resourceJob.execute",
|
131622
|
+
"resourceJob.cancelExecution",
|
131623
|
+
"resourceJobs.get",
|
131624
|
+
"resourceJobs.post",
|
129313
131625
|
"webhook.delete",
|
129314
131626
|
"webhook.get",
|
129315
131627
|
"webhook.patch",
|
@@ -129632,6 +131944,8 @@ Schema for the body of a User creation request
|
|
129632
131944
|
"flows.*",
|
129633
131945
|
"flowVersion.*",
|
129634
131946
|
"flowVersions.*",
|
131947
|
+
"resourceJobs.*",
|
131948
|
+
"resourceJob.*",
|
129635
131949
|
"notebook.*",
|
129636
131950
|
"notebooks.*",
|
129637
131951
|
"webhook.*",
|
@@ -129844,6 +132158,14 @@ Schema for the body of a User creation request
|
|
129844
132158
|
"notebook.upload",
|
129845
132159
|
"notebooks.get",
|
129846
132160
|
"notebooks.post",
|
132161
|
+
"resourceJob.get",
|
132162
|
+
"resourceJob.logs",
|
132163
|
+
"resourceJob.patch",
|
132164
|
+
"resourceJob.delete",
|
132165
|
+
"resourceJob.execute",
|
132166
|
+
"resourceJob.cancelExecution",
|
132167
|
+
"resourceJobs.get",
|
132168
|
+
"resourceJobs.post",
|
129847
132169
|
"webhook.delete",
|
129848
132170
|
"webhook.get",
|
129849
132171
|
"webhook.patch",
|
@@ -130032,7 +132354,7 @@ Schema for the body of a User creation request
|
|
130032
132354
|
"lastName": "Name",
|
130033
132355
|
"companyName": "Example, Inc.",
|
130034
132356
|
"url": "https://example.com",
|
130035
|
-
"password": "
|
132357
|
+
"password": "The new password1!",
|
130036
132358
|
"acceptTerms": "on"
|
130037
132359
|
}
|
130038
132360
|
```
|
@@ -130056,6 +132378,10 @@ Schema for the result of a validateContext call when invalid context is passed
|
|
130056
132378
|
"message": {
|
130057
132379
|
"type": "string"
|
130058
132380
|
},
|
132381
|
+
"invalidCtxName": {
|
132382
|
+
"type": "string",
|
132383
|
+
"pattern": "^[0-9a-zA-Z_-]{1,255}$"
|
132384
|
+
},
|
130059
132385
|
"ctx": {
|
130060
132386
|
"type": "object",
|
130061
132387
|
"patternProperties": {
|
@@ -130468,15 +132794,7 @@ Schema for validation errors returned by the API
|
|
130468
132794
|
"type": "string"
|
130469
132795
|
},
|
130470
132796
|
"id": {
|
130471
|
-
"
|
130472
|
-
{
|
130473
|
-
"type": "string",
|
130474
|
-
"pattern": "^[A-Fa-f\\d]{24}$"
|
130475
|
-
},
|
130476
|
-
{
|
130477
|
-
"type": "string"
|
130478
|
-
}
|
130479
|
-
]
|
132797
|
+
"type": "string"
|
130480
132798
|
},
|
130481
132799
|
"message": {
|
130482
132800
|
"type": "string"
|