losant_rest 1.10.1 → 1.11.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/docs/_schemas.md +26941 -15658
- data/docs/application.md +42 -0
- data/docs/applicationApiTokens.md +2 -2
- data/docs/applicationCertificateAuthorities.md +1 -1
- data/docs/applicationCertificates.md +1 -1
- data/docs/applicationKeys.md +1 -1
- data/docs/applicationTemplate.md +46 -0
- data/docs/applicationTemplates.md +77 -2
- data/docs/applications.md +1 -1
- data/docs/auditLogs.md +1 -1
- data/docs/dashboards.md +1 -1
- data/docs/dataTables.md +1 -1
- data/docs/device.md +6 -3
- data/docs/deviceRecipes.md +1 -1
- data/docs/devices.md +217 -5
- data/docs/edgeDeployments.md +1 -1
- data/docs/events.md +1 -1
- data/docs/experienceEndpoints.md +1 -0
- data/docs/experienceGroups.md +1 -1
- data/docs/experienceUsers.md +1 -1
- data/docs/experienceVersions.md +1 -1
- data/docs/experienceViews.md +1 -1
- data/docs/file.md +4 -4
- data/docs/files.md +1 -1
- data/docs/flow.md +94 -1
- data/docs/flowVersion.md +96 -1
- data/docs/flowVersions.md +2 -1
- data/docs/flows.md +4 -2
- data/docs/integrations.md +1 -1
- data/docs/me.md +0 -36
- data/docs/notebooks.md +1 -1
- data/docs/orgs.md +1 -1
- data/docs/webhooks.md +1 -1
- data/lib/losant_rest.rb +1 -0
- data/lib/losant_rest/application.rb +48 -0
- data/lib/losant_rest/application_api_tokens.rb +1 -1
- data/lib/losant_rest/application_template.rb +79 -0
- data/lib/losant_rest/application_templates.rb +89 -1
- data/lib/losant_rest/client.rb +6 -2
- data/lib/losant_rest/device.rb +9 -3
- data/lib/losant_rest/devices.rb +255 -3
- data/lib/losant_rest/experience_endpoints.rb +2 -0
- data/lib/losant_rest/file.rb +3 -3
- data/lib/losant_rest/flow.rb +115 -1
- data/lib/losant_rest/flow_version.rb +115 -1
- data/lib/losant_rest/flow_versions.rb +3 -0
- data/lib/losant_rest/flows.rb +6 -0
- data/lib/losant_rest/me.rb +0 -41
- data/lib/losant_rest/version.rb +1 -1
- data/schemas/advancedDeviceQuery.json +110 -0
- data/schemas/advancedEventQuery.json +198 -0
- data/schemas/advancedFlowByVersionQuery.json +665 -0
- data/schemas/advancedFlowQuery.json +665 -0
- data/schemas/advancedFlowVersionQuery.json +707 -0
- data/schemas/advancedQuery.json +22 -0
- data/schemas/application.json +8 -0
- data/schemas/applicationApiTokenPost.json +11 -1
- data/schemas/applicationApplyTemplatePatch.json +19 -0
- data/schemas/applicationCreationByTemplateResult.json +8 -0
- data/schemas/applicationPost.json +8 -0
- data/schemas/applicationTemplate.json +20 -0
- data/schemas/applicationTemplateCategories.json +43 -0
- data/schemas/applicationTemplateCategory.json +23 -0
- data/schemas/applicationTemplates.json +32 -0
- data/schemas/applications.json +8 -0
- data/schemas/attributeNamesResponse.json +14 -0
- data/schemas/authedUser.json +3 -0
- data/schemas/changePassword.json +2 -2
- data/schemas/dashboard.json +175 -25
- data/schemas/dashboardPatch.json +175 -25
- data/schemas/dashboardPost.json +175 -25
- data/schemas/dashboards.json +175 -25
- data/schemas/dataExport.json +142 -0
- data/schemas/dataTableRowsExport.json +22 -0
- data/schemas/deviceAttributeDataTypeFilter.json +29 -0
- data/schemas/deviceClassFilter.json +1 -2
- data/schemas/devicesDataRemoved.json +12 -0
- data/schemas/devicesDeletePost.json +1034 -0
- data/schemas/devicesDeleted.json +12 -0
- data/schemas/devicesExportPost.json +1035 -0
- data/schemas/devicesPatch.json +1757 -4
- data/schemas/devicesRemoveDataPost.json +1056 -0
- data/schemas/devicesUpdated.json +18 -0
- data/schemas/eventPost.json +22 -0
- data/schemas/eventsExport.json +198 -0
- data/schemas/experienceDomain.json +1 -1
- data/schemas/experienceDomainPatch.json +1 -1
- data/schemas/experienceDomainPost.json +1 -1
- data/schemas/experienceDomains.json +1 -1
- data/schemas/experienceLinkedResources.json +96 -0
- data/schemas/experienceVersion.json +10 -1
- data/schemas/experienceVersionPatch.json +9 -0
- data/schemas/experienceVersions.json +10 -1
- data/schemas/flow.json +32 -0
- data/schemas/flowErrors.json +87 -0
- data/schemas/flowPatch.json +32 -0
- data/schemas/flowPost.json +32 -0
- data/schemas/flowStats.json +54 -0
- data/schemas/flowVersion.json +64 -0
- data/schemas/flowVersionPost.json +32 -0
- data/schemas/flowVersions.json +64 -0
- data/schemas/flows.json +32 -0
- data/schemas/flowsImportPost.json +64 -0
- data/schemas/flowsImportResult.json +96 -0
- data/schemas/githubLogin.json +17 -4
- data/schemas/integration.json +3 -0
- data/schemas/integrationPatch.json +3 -0
- data/schemas/integrationPost.json +3 -0
- data/schemas/integrations.json +3 -0
- data/schemas/me.json +3 -3
- data/schemas/mePatch.json +2 -2
- data/schemas/multiDeviceCommand.json +1019 -0
- data/schemas/notebook.json +96 -0
- data/schemas/notebookExecutionLogs.json +7 -0
- data/schemas/notebookPatch.json +96 -0
- data/schemas/notebookPost.json +96 -0
- data/schemas/notebooks.json +96 -0
- data/schemas/org.json +1 -1
- data/schemas/orgInviteInfo.json +3 -0
- data/schemas/orgInvitePost.json +3 -0
- data/schemas/orgInvites.json +3 -0
- data/schemas/orgPatch.json +1 -1
- data/schemas/orgs.json +1 -1
- data/schemas/passwordResetFinish.json +2 -2
- data/schemas/samlResponse.json +1 -1
- data/schemas/tagKeysResponse.json +14 -0
- data/schemas/tagValuesResponse.json +19 -0
- data/schemas/templateKeywords.json +14 -0
- data/schemas/timeSeriesData.json +12 -2
- data/schemas/timeSeriesQuery.json +94 -14
- data/schemas/userCredentials.json +15 -3
- data/schemas/userPost.json +23 -7
- metadata +27 -6
data/docs/edgeDeployments.md
CHANGED
@@ -36,7 +36,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
36
36
|
| sortField | string | N | Field to sort the results by. Accepted values are: id, deviceId, flowId, desiredVersion, currentVersion, creationDate, lastUpdated | lastUpdated | creationDate |
|
37
37
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
38
38
|
| page | string | N | Which page of results to return | 0 | 0 |
|
39
|
-
| perPage | string | N | How many items to return per page |
|
39
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
40
40
|
| deviceId | string | N | Filter deployments to the given Device ID | | 575ecf887ae143cd83dc4aa2 |
|
41
41
|
| version | string | N | Filter deployments to the given Workflow Version (matches against both current and desired) | | myFlowVersion |
|
42
42
|
| filterEmpty | undefined | N | Filter out deployments where both the current and desired version are null. | | true |
|
data/docs/events.md
CHANGED
@@ -114,7 +114,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
114
114
|
| sortField | string | N | Field to sort the results by. Accepted values are: subject, id, creationDate, lastUpdated, level, state, deviceId | creationDate | subject |
|
115
115
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
|
116
116
|
| page | string | N | Which page of results to return | 0 | 0 |
|
117
|
-
| perPage | string | N | How many items to return per page |
|
117
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
118
118
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: subject | | subject |
|
119
119
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
120
120
|
| state | string | N | If provided, return events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
|
data/docs/experienceEndpoints.md
CHANGED
@@ -118,6 +118,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
118
118
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
119
119
|
| statGrouping | string | N | Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain | statusCode | statusCode |
|
120
120
|
| duration | string | N | Duration in milliseconds | 86400000 | 86400000 |
|
121
|
+
| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
|
121
122
|
| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
|
122
123
|
| versionFilter | string | N | Filters the stats to a particular experience version | | myVersion |
|
123
124
|
| domainFilter | string | N | Filters the stats to a particular experience domain or slug | | mycustomdomain.com |
|
data/docs/experienceGroups.md
CHANGED
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
-
| perPage | string | N | How many items to return per page |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*group |
|
40
40
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
data/docs/experienceUsers.md
CHANGED
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: firstName, lastName, email, id, creationDate, lastLogin, lastUpdated | email | email |
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
-
| perPage | string | N | How many items to return per page |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: firstName, lastName, email | | email |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*user |
|
40
40
|
| experienceGroupId | string | N | Filter users to those only in the specified group, special experienceGroupIds of 'any' which will give users who are in at least one group and 'none' will give you users who are not in any groups. | | 575ec8687ae143cd83dc4a97 |
|
data/docs/experienceVersions.md
CHANGED
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated | version | version |
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
-
| perPage | string | N | How many items to return per page |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version | | email |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*version |
|
40
40
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
data/docs/experienceViews.md
CHANGED
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: id, creationDate, name, lastUpdated | name | name |
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
-
| perPage | string | N | How many items to return per page |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*view |
|
40
40
|
| viewType | string | N | Filter views to those only of the given type. Accepted values are: page, layout, component | | page |
|
data/docs/file.md
CHANGED
@@ -50,7 +50,7 @@ all.Application, all.Organization, all.User, file.*, or file.delete.
|
|
50
50
|
| Code | Type | Description |
|
51
51
|
| ---- | ---- | ----------- |
|
52
52
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
53
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
53
|
+
| 404 | [Error](_schemas.md#error) | Error if file was not found |
|
54
54
|
|
55
55
|
<br/>
|
56
56
|
|
@@ -132,7 +132,7 @@ all.Application, all.Organization, all.User, file.*, or file.move.
|
|
132
132
|
| Code | Type | Description |
|
133
133
|
| ---- | ---- | ----------- |
|
134
134
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
135
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
135
|
+
| 404 | [Error](_schemas.md#error) | Error if file was not found |
|
136
136
|
|
137
137
|
<br/>
|
138
138
|
|
@@ -174,7 +174,7 @@ all.Application, all.Organization, all.User, file.*, or file.patch.
|
|
174
174
|
| Code | Type | Description |
|
175
175
|
| ---- | ---- | ----------- |
|
176
176
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
177
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
177
|
+
| 404 | [Error](_schemas.md#error) | Error if file was not found |
|
178
178
|
|
179
179
|
<br/>
|
180
180
|
|
@@ -216,4 +216,4 @@ all.Application, all.Organization, all.User, file.*, or file.upload.
|
|
216
216
|
| Code | Type | Description |
|
217
217
|
| ---- | ---- | ----------- |
|
218
218
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
219
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
219
|
+
| 404 | [Error](_schemas.md#error) | Error if file was not found |
|
data/docs/files.md
CHANGED
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: lastUpdated, type, name, creationDate | lastUpdated | subject |
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
-
| perPage | string | N | How many items to return per page |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | myFile |
|
40
40
|
| type | string | N | Limit by the type (file or directory) of the file | | file |
|
data/docs/flow.md
CHANGED
@@ -8,12 +8,14 @@ parameters and the potential responses.
|
|
8
8
|
|
9
9
|
* [Clear Storage Entries](#clear-storage-entries)
|
10
10
|
* [Delete](#delete)
|
11
|
+
* [Errors](#errors)
|
11
12
|
* [Get](#get)
|
12
13
|
* [Get Log Entries](#get-log-entries)
|
13
14
|
* [Get Storage Entries](#get-storage-entries)
|
14
15
|
* [Patch](#patch)
|
15
16
|
* [Press Virtual Button](#press-virtual-button)
|
16
17
|
* [Set Storage Entry](#set-storage-entry)
|
18
|
+
* [Stats](#stats)
|
17
19
|
|
18
20
|
<br/>
|
19
21
|
|
@@ -97,6 +99,52 @@ all.Application, all.Organization, all.User, flow.*, or flow.delete.
|
|
97
99
|
|
98
100
|
<br/>
|
99
101
|
|
102
|
+
## Errors
|
103
|
+
|
104
|
+
Get information about errors that occurred during runs of this workflow
|
105
|
+
|
106
|
+
```ruby
|
107
|
+
result = client.flow.errors(
|
108
|
+
applicationId: my_application_id,
|
109
|
+
flowId: my_flow_id)
|
110
|
+
|
111
|
+
puts result
|
112
|
+
```
|
113
|
+
|
114
|
+
#### Authentication
|
115
|
+
The client must be configured with a valid api access token to call this
|
116
|
+
action. The token must include at least one of the following scopes:
|
117
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.errors.
|
118
|
+
|
119
|
+
#### Available Parameters
|
120
|
+
|
121
|
+
| Name | Type | Required | Description | Default | Example |
|
122
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
123
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
124
|
+
| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
|
125
|
+
| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
|
126
|
+
| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
|
127
|
+
| limit | string | N | Maximum number of errors to return | 25 | 25 |
|
128
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
|
129
|
+
| flowVersion | string | N | Flow version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. | | develop |
|
130
|
+
| deviceId | string | N | For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
131
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
132
|
+
|
133
|
+
#### Successful Responses
|
134
|
+
|
135
|
+
| Code | Type | Description |
|
136
|
+
| ---- | ---- | ----------- |
|
137
|
+
| 200 | [Workflow Errors](_schemas.md#workflow-errors) | Workflow error information |
|
138
|
+
|
139
|
+
#### Error Responses
|
140
|
+
|
141
|
+
| Code | Type | Description |
|
142
|
+
| ---- | ---- | ----------- |
|
143
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
144
|
+
| 404 | [Error](_schemas.md#error) | Error if flow was not found |
|
145
|
+
|
146
|
+
<br/>
|
147
|
+
|
100
148
|
## Get
|
101
149
|
|
102
150
|
Retrieves information on a flow
|
@@ -176,7 +224,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
176
224
|
| Code | Type | Description |
|
177
225
|
| ---- | ---- | ----------- |
|
178
226
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
179
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
227
|
+
| 404 | [Error](_schemas.md#error) | Error if flow was not found |
|
180
228
|
|
181
229
|
<br/>
|
182
230
|
|
@@ -344,3 +392,48 @@ all.Application, all.Organization, all.User, flow.*, or flow.setStorageEntry.
|
|
344
392
|
| ---- | ---- | ----------- |
|
345
393
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
346
394
|
| 404 | [Error](_schemas.md#error) | Error if flow was not found |
|
395
|
+
|
396
|
+
<br/>
|
397
|
+
|
398
|
+
## Stats
|
399
|
+
|
400
|
+
Get statistics about workflow runs for this workflow
|
401
|
+
|
402
|
+
```ruby
|
403
|
+
result = client.flow.stats(
|
404
|
+
applicationId: my_application_id,
|
405
|
+
flowId: my_flow_id)
|
406
|
+
|
407
|
+
puts result
|
408
|
+
```
|
409
|
+
|
410
|
+
#### Authentication
|
411
|
+
The client must be configured with a valid api access token to call this
|
412
|
+
action. The token must include at least one of the following scopes:
|
413
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flow.*, or flow.stats.
|
414
|
+
|
415
|
+
#### Available Parameters
|
416
|
+
|
417
|
+
| Name | Type | Required | Description | Default | Example |
|
418
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
419
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
420
|
+
| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
|
421
|
+
| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
|
422
|
+
| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
|
423
|
+
| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
|
424
|
+
| flowVersion | string | N | Flow version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version. | | develop |
|
425
|
+
| deviceId | string | N | For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
426
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
427
|
+
|
428
|
+
#### Successful Responses
|
429
|
+
|
430
|
+
| Code | Type | Description |
|
431
|
+
| ---- | ---- | ----------- |
|
432
|
+
| 200 | [Workflow Statistics](_schemas.md#workflow-statistics) | Statistics for workflow runs |
|
433
|
+
|
434
|
+
#### Error Responses
|
435
|
+
|
436
|
+
| Code | Type | Description |
|
437
|
+
| ---- | ---- | ----------- |
|
438
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
439
|
+
| 404 | [Error](_schemas.md#error) | Error if flow was not found |
|
data/docs/flowVersion.md
CHANGED
@@ -7,9 +7,11 @@ parameters and the potential responses.
|
|
7
7
|
##### Contents
|
8
8
|
|
9
9
|
* [Delete](#delete)
|
10
|
+
* [Errors](#errors)
|
10
11
|
* [Get](#get)
|
11
12
|
* [Get Log Entries](#get-log-entries)
|
12
13
|
* [Patch](#patch)
|
14
|
+
* [Stats](#stats)
|
13
15
|
|
14
16
|
<br/>
|
15
17
|
|
@@ -55,6 +57,53 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.delet
|
|
55
57
|
|
56
58
|
<br/>
|
57
59
|
|
60
|
+
## Errors
|
61
|
+
|
62
|
+
Get information about errors that occurred during runs of this workflow version
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
result = client.flow_version.errors(
|
66
|
+
applicationId: my_application_id,
|
67
|
+
flowId: my_flow_id,
|
68
|
+
flowVersionId: my_flow_version_id)
|
69
|
+
|
70
|
+
puts result
|
71
|
+
```
|
72
|
+
|
73
|
+
#### Authentication
|
74
|
+
The client must be configured with a valid api access token to call this
|
75
|
+
action. The token must include at least one of the following scopes:
|
76
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.errors.
|
77
|
+
|
78
|
+
#### Available Parameters
|
79
|
+
|
80
|
+
| Name | Type | Required | Description | Default | Example |
|
81
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
82
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
83
|
+
| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
|
84
|
+
| flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
|
85
|
+
| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
|
86
|
+
| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
|
87
|
+
| limit | string | N | Maximum number of errors to return | 25 | 25 |
|
88
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | desc |
|
89
|
+
| deviceId | string | N | For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
90
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
91
|
+
|
92
|
+
#### Successful Responses
|
93
|
+
|
94
|
+
| Code | Type | Description |
|
95
|
+
| ---- | ---- | ----------- |
|
96
|
+
| 200 | [Workflow Errors](_schemas.md#workflow-errors) | Workflow error information |
|
97
|
+
|
98
|
+
#### Error Responses
|
99
|
+
|
100
|
+
| Code | Type | Description |
|
101
|
+
| ---- | ---- | ----------- |
|
102
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
103
|
+
| 404 | [Error](_schemas.md#error) | Error if flow version was not found |
|
104
|
+
|
105
|
+
<br/>
|
106
|
+
|
58
107
|
## Get
|
59
108
|
|
60
109
|
Retrieves information on a flow version
|
@@ -138,7 +187,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
138
187
|
| Code | Type | Description |
|
139
188
|
| ---- | ---- | ----------- |
|
140
189
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
141
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
190
|
+
| 404 | [Error](_schemas.md#error) | Error if flow version was not found |
|
142
191
|
|
143
192
|
<br/>
|
144
193
|
|
@@ -184,3 +233,49 @@ all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.patch
|
|
184
233
|
| ---- | ---- | ----------- |
|
185
234
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
186
235
|
| 404 | [Error](_schemas.md#error) | Error if flow version was not found |
|
236
|
+
|
237
|
+
<br/>
|
238
|
+
|
239
|
+
## Stats
|
240
|
+
|
241
|
+
Get statistics about workflow runs for this workflow version
|
242
|
+
|
243
|
+
```ruby
|
244
|
+
result = client.flow_version.stats(
|
245
|
+
applicationId: my_application_id,
|
246
|
+
flowId: my_flow_id,
|
247
|
+
flowVersionId: my_flow_version_id)
|
248
|
+
|
249
|
+
puts result
|
250
|
+
```
|
251
|
+
|
252
|
+
#### Authentication
|
253
|
+
The client must be configured with a valid api access token to call this
|
254
|
+
action. The token must include at least one of the following scopes:
|
255
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.stats.
|
256
|
+
|
257
|
+
#### Available Parameters
|
258
|
+
|
259
|
+
| Name | Type | Required | Description | Default | Example |
|
260
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
261
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
262
|
+
| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
|
263
|
+
| flowVersionId | string | Y | Version ID or version name associated with the flow version | | 675ed18f7ae143cd83dc4bb7 |
|
264
|
+
| duration | string | N | Duration of time range in milliseconds | 86400000 | 86400000 |
|
265
|
+
| end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
|
266
|
+
| resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
|
267
|
+
| deviceId | string | N | For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs. | | 575ed18f7ae143cd83dc4bb6 |
|
268
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
269
|
+
|
270
|
+
#### Successful Responses
|
271
|
+
|
272
|
+
| Code | Type | Description |
|
273
|
+
| ---- | ---- | ----------- |
|
274
|
+
| 200 | [Workflow Statistics](_schemas.md#workflow-statistics) | Statistics for workflow runs |
|
275
|
+
|
276
|
+
#### Error Responses
|
277
|
+
|
278
|
+
| Code | Type | Description |
|
279
|
+
| ---- | ---- | ----------- |
|
280
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
281
|
+
| 404 | [Error](_schemas.md#error) | Error if flow version was not found |
|
data/docs/flowVersions.md
CHANGED
@@ -37,10 +37,11 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
37
37
|
| sortField | string | N | Field to sort the results by. Accepted values are: version, id, creationDate, lastUpdated | version | version |
|
38
38
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
39
39
|
| page | string | N | Which page of results to return | 0 | 0 |
|
40
|
-
| perPage | string | N | How many items to return per page |
|
40
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
41
41
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: version | | version |
|
42
42
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*version |
|
43
43
|
| includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
|
44
|
+
| query | [Advanced Workflow Version Query](_schemas.md#advanced-workflow-version-query) | N | Workflow filter JSON object which overrides the filterField and filter parameters. | | [Advanced Workflow Version Query Example](_schemas.md#advanced-workflow-version-query-example) |
|
44
45
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
45
46
|
|
46
47
|
#### Successful Responses
|
data/docs/flows.md
CHANGED
@@ -36,12 +36,13 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
36
36
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
37
37
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
38
38
|
| page | string | N | Which page of results to return | 0 | 0 |
|
39
|
-
| perPage | string | N | How many items to return per page |
|
39
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
40
40
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
41
41
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
|
42
42
|
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
|
43
43
|
| triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. | | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
|
44
44
|
| includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
|
45
|
+
| query | [Advanced Workflow Query](_schemas.md#advanced-workflow-query) | N | Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. | | [Advanced Workflow Query Example](_schemas.md#advanced-workflow-query-example) |
|
45
46
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
46
47
|
|
47
48
|
#### Successful Responses
|
@@ -84,13 +85,14 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
84
85
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
85
86
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
86
87
|
| page | string | N | Which page of results to return | 0 | 0 |
|
87
|
-
| perPage | string | N | How many items to return per page |
|
88
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
88
89
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
89
90
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
|
90
91
|
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
|
91
92
|
| version | string | Y | Return the workflow versions for the given version. | | myVersion |
|
92
93
|
| triggerFilter | [Workflow Trigger Filter](_schemas.md#workflow-trigger-filter) | N | Array of triggers to filter by - always filters against default flow version. | | [Workflow Trigger Filter Example](_schemas.md#workflow-trigger-filter-example) |
|
93
94
|
| includeCustomNodes | string | N | If the result of the request should also include the details of any custom nodes referenced by the returned workflows | false | true |
|
95
|
+
| query | [Advanced Workflow By Version Query](_schemas.md#advanced-workflow-by-version-query) | N | Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. | | [Advanced Workflow By Version Query Example](_schemas.md#advanced-workflow-by-version-query-example) |
|
94
96
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
95
97
|
|
96
98
|
#### Successful Responses
|
data/docs/integrations.md
CHANGED
@@ -34,7 +34,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, integrationType, lastUpdated | name | name |
|
35
35
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
36
|
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
-
| perPage | string | N | How many items to return per page |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, integrationType | | integrationType |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*integration |
|
40
40
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
data/docs/me.md
CHANGED
@@ -11,7 +11,6 @@ parameters and the potential responses.
|
|
11
11
|
* [Delete](#delete)
|
12
12
|
* [Disable Two Factor Auth](#disable-two-factor-auth)
|
13
13
|
* [Disconnect Github](#disconnect-github)
|
14
|
-
* [Disconnect Twitter](#disconnect-twitter)
|
15
14
|
* [Enable Two Factor Auth](#enable-two-factor-auth)
|
16
15
|
* [Fetch Recent Items](#fetch-recent-items)
|
17
16
|
* [Get](#get)
|
@@ -202,41 +201,6 @@ all.User, me.*, or me.disconnectGithub.
|
|
202
201
|
|
203
202
|
<br/>
|
204
203
|
|
205
|
-
## Disconnect Twitter
|
206
|
-
|
207
|
-
Disconnects the user from Twitter
|
208
|
-
|
209
|
-
```ruby
|
210
|
-
result = client.me.disconnect_twitter(optional_params)
|
211
|
-
|
212
|
-
puts result
|
213
|
-
```
|
214
|
-
|
215
|
-
#### Authentication
|
216
|
-
The client must be configured with a valid api access token to call this
|
217
|
-
action. The token must include at least one of the following scopes:
|
218
|
-
all.User, me.*, or me.disconnectTwitter.
|
219
|
-
|
220
|
-
#### Available Parameters
|
221
|
-
|
222
|
-
| Name | Type | Required | Description | Default | Example |
|
223
|
-
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
224
|
-
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
225
|
-
|
226
|
-
#### Successful Responses
|
227
|
-
|
228
|
-
| Code | Type | Description |
|
229
|
-
| ---- | ---- | ----------- |
|
230
|
-
| 200 | [Me](_schemas.md#me) | Updated user information |
|
231
|
-
|
232
|
-
#### Error Responses
|
233
|
-
|
234
|
-
| Code | Type | Description |
|
235
|
-
| ---- | ---- | ----------- |
|
236
|
-
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
237
|
-
|
238
|
-
<br/>
|
239
|
-
|
240
204
|
## Enable Two Factor Auth
|
241
205
|
|
242
206
|
Enables two factor auth for the current user
|