losant_rest 1.10.2 → 1.12.0
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 +21561 -8561
- data/docs/application.md +83 -0
- data/docs/applicationApiTokens.md +2 -2
- data/docs/applicationCertificateAuthorities.md +1 -1
- data/docs/applicationCertificates.md +1 -1
- data/docs/applicationDashboard.md +133 -0
- data/docs/applicationDashboards.md +93 -0
- data/docs/applicationKeys.md +4 -3
- 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 +130 -4
- data/docs/edgeDeployments.md +1 -1
- data/docs/events.md +1 -1
- data/docs/experienceEndpoint.md +1 -0
- 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 +5 -2
- data/docs/integration.md +1 -0
- 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/webhook.md +1 -0
- data/docs/webhooks.md +1 -1
- data/lib/losant_rest.rb +3 -0
- data/lib/losant_rest/application.rb +95 -0
- data/lib/losant_rest/application_api_tokens.rb +1 -1
- data/lib/losant_rest/application_dashboard.rb +176 -0
- data/lib/losant_rest/application_dashboards.rb +138 -0
- data/lib/losant_rest/application_keys.rb +3 -0
- data/lib/losant_rest/application_template.rb +79 -0
- data/lib/losant_rest/application_templates.rb +89 -1
- data/lib/losant_rest/client.rb +14 -2
- data/lib/losant_rest/device.rb +9 -3
- data/lib/losant_rest/devices.rb +154 -1
- data/lib/losant_rest/experience_endpoint.rb +2 -0
- 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 +8 -0
- data/lib/losant_rest/integration.rb +2 -0
- data/lib/losant_rest/me.rb +0 -41
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest/webhook.rb +2 -0
- data/schemas/advancedApplicationKeyQuery.json +1082 -0
- data/schemas/advancedFlowByVersionQuery.json +665 -0
- data/schemas/advancedFlowQuery.json +883 -0
- data/schemas/advancedFlowVersionQuery.json +925 -0
- data/schemas/application.json +8 -0
- data/schemas/applicationApiTokenPost.json +16 -1
- data/schemas/applicationApplyTemplatePatch.json +19 -0
- data/schemas/applicationCreationByTemplateResult.json +8 -0
- data/schemas/applicationDashboardPost.json +5665 -0
- data/schemas/applicationGlobalPatch.json +33 -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 +195 -26
- data/schemas/dashboardPatch.json +195 -26
- data/schemas/dashboardPost.json +195 -26
- data/schemas/dashboards.json +195 -26
- data/schemas/dataExport.json +132 -1
- data/schemas/deviceAttributeDataTypeFilter.json +29 -0
- data/schemas/deviceClassFilter.json +1 -2
- data/schemas/eventPost.json +22 -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/files.json +3 -0
- 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 +33 -4
- data/schemas/instance.json +132 -0
- data/schemas/instanceOrg.json +119 -0
- data/schemas/instanceOrgPatch.json +103 -0
- data/schemas/instanceOrgPost.json +114 -0
- data/schemas/instanceOrgs.json +160 -0
- data/schemas/instances.json +43 -0
- 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/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 +31 -3
- data/schemas/userPost.json +39 -7
- metadata +34 -6
data/docs/applications.md
CHANGED
@@ -34,7 +34,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, applications.*
|
|
34
34
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, 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 * app |
|
40
40
|
| orgId | string | N | If not provided, return all applications. If provided but blank, only return applications belonging to the current user. If provided and an id, only return applications belonging to the given organization id. | | 575ecdf07ae143cd83dc4a9a |
|
data/docs/auditLogs.md
CHANGED
@@ -33,7 +33,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, auditLogs.*, o
|
|
33
33
|
| sortField | string | N | Field to sort the results by. Accepted values are: creationDate, responseStatus, actorName | creationDate | creationDate |
|
34
34
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | desc | asc |
|
35
35
|
| page | string | N | Which page of results to return | 0 | 0 |
|
36
|
-
| perPage | string | N | How many items to return per page |
|
36
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
37
37
|
| start | string | N | Start of time range for audit log query | | 1465790400000 |
|
38
38
|
| end | string | N | End of time range for audit log query | | 1465790400000 |
|
39
39
|
| auditLogFilter | [Audit Log Filter](_schemas.md#audit-log-filter) | N | Filters for the audit log query | | [Audit Log Filter Example](_schemas.md#audit-log-filter-example) |
|
data/docs/dashboards.md
CHANGED
@@ -33,7 +33,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, dashboards.*,
|
|
33
33
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, ownerId, applicationId | name | name |
|
34
34
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
35
35
|
| page | string | N | Which page of results to return | 0 | 0 |
|
36
|
-
| perPage | string | N | How many items to return per page |
|
36
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
37
37
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
38
38
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * dashboard |
|
39
39
|
| applicationId | string | N | If not provided, return all dashboards. If provided but blank, only return dashboards that are not linked to applications. If provided and an id, only return dashboards linked to the given application id. | | 575ec8687ae143cd83dc4a97 |
|
data/docs/dataTables.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*table |
|
40
40
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
data/docs/device.md
CHANGED
@@ -170,8 +170,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
170
170
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
171
171
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
172
172
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
173
|
-
| limit | string | N |
|
173
|
+
| limit | string | N | Maximum number of command entries to return | 1 | 10 |
|
174
174
|
| since | string | N | Look for command entries since this time (ms since epoch) | | 1465790400000 |
|
175
|
+
| sortDirection | string | N | Direction to sort the command entries (by time). Accepted values are: asc, desc | desc | desc |
|
175
176
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
176
177
|
|
177
178
|
#### Successful Responses
|
@@ -255,8 +256,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
255
256
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
256
257
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
257
258
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
258
|
-
| limit | string | N |
|
259
|
+
| limit | string | N | Maximum number of log entries to return | 1 | 10 |
|
259
260
|
| since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
|
261
|
+
| sortDirection | string | N | Direction to sort the log entries (by time). Accepted values are: asc, desc | desc | desc |
|
260
262
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
261
263
|
|
262
264
|
#### Successful Responses
|
@@ -297,8 +299,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
297
299
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
298
300
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
299
301
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
300
|
-
| limit | string | N |
|
302
|
+
| limit | string | N | Maximum number of state entries to return | 1 | 10 |
|
301
303
|
| since | string | N | Look for state entries since this time (ms since epoch) | | 1465790400000 |
|
304
|
+
| sortDirection | string | N | Direction to sort the state entries (by time). Accepted values are: asc, desc | desc | desc |
|
302
305
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
303
306
|
|
304
307
|
#### Successful Responses
|
data/docs/deviceRecipes.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 * recipe |
|
40
40
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
data/docs/devices.md
CHANGED
@@ -6,6 +6,7 @@ parameters and the potential responses.
|
|
6
6
|
|
7
7
|
##### Contents
|
8
8
|
|
9
|
+
* [Attribute Names](#attribute-names)
|
9
10
|
* [Delete](#delete)
|
10
11
|
* [Export](#export)
|
11
12
|
* [Get](#get)
|
@@ -13,6 +14,48 @@ parameters and the potential responses.
|
|
13
14
|
* [Post](#post)
|
14
15
|
* [Remove Data](#remove-data)
|
15
16
|
* [Send Command](#send-command)
|
17
|
+
* [Tag Keys](#tag-keys)
|
18
|
+
* [Tag Values](#tag-values)
|
19
|
+
|
20
|
+
<br/>
|
21
|
+
|
22
|
+
## Attribute Names
|
23
|
+
|
24
|
+
Gets the attribute names that match the given query. Maximum 1K returned.
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
result = client.devices.attribute_names(applicationId: my_application_id)
|
28
|
+
|
29
|
+
puts result
|
30
|
+
```
|
31
|
+
|
32
|
+
#### Authentication
|
33
|
+
The client must be configured with a valid api access token to call this
|
34
|
+
action. The token must include at least one of the following scopes:
|
35
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.attributeNames.
|
36
|
+
|
37
|
+
#### Available Parameters
|
38
|
+
|
39
|
+
| Name | Type | Required | Description | Default | Example |
|
40
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
41
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
42
|
+
| query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
|
43
|
+
| dataType | [Device Attribute Data Type Filter](_schemas.md#device-attribute-data-type-filter) | N | Filter the devices by the given attribute data type or types | | [Device Attribute Data Type Filter Example](_schemas.md#device-attribute-data-type-filter-example) |
|
44
|
+
| startsWith | string | N | Filter attributes down to those that have names starting with the given string. Case insensitive. | | temper |
|
45
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
46
|
+
|
47
|
+
#### Successful Responses
|
48
|
+
|
49
|
+
| Code | Type | Description |
|
50
|
+
| ---- | ---- | ----------- |
|
51
|
+
| 200 | [Attribute Names Response](_schemas.md#attribute-names-response) | The matching attribute names |
|
52
|
+
|
53
|
+
#### Error Responses
|
54
|
+
|
55
|
+
| Code | Type | Description |
|
56
|
+
| ---- | ---- | ----------- |
|
57
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
58
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
16
59
|
|
17
60
|
<br/>
|
18
61
|
|
@@ -120,7 +163,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
120
163
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
121
164
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
122
165
|
| page | string | N | Which page of results to return | 0 | 0 |
|
123
|
-
| perPage | string | N | How many items to return per page |
|
166
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
124
167
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
125
168
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * device |
|
126
169
|
| deviceClass | [Device Class Filter](_schemas.md#device-class-filter) | N | Filter the devices by the given device class or classes | | [Device Class Filter Example](_schemas.md#device-class-filter-example) |
|
@@ -150,7 +193,9 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
150
193
|
Update the fields of one or more devices
|
151
194
|
|
152
195
|
```ruby
|
153
|
-
result = client.devices.patch(
|
196
|
+
result = client.devices.patch(
|
197
|
+
applicationId: my_application_id,
|
198
|
+
patchInfo: my_patch_info)
|
154
199
|
|
155
200
|
puts result
|
156
201
|
```
|
@@ -165,7 +210,7 @@ all.Application, all.Organization, all.User, devices.*, or devices.patch.
|
|
165
210
|
| Name | Type | Required | Description | Default | Example |
|
166
211
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
167
212
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
168
|
-
| patchInfo | [Devices Patch](_schemas.md#devices-patch) |
|
213
|
+
| patchInfo | [Devices Patch](_schemas.md#devices-patch) | Y | Object containing device query or IDs and update operations | | [Devices Patch Example](_schemas.md#devices-patch-example) |
|
169
214
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
170
215
|
|
171
216
|
#### Successful Responses
|
@@ -261,7 +306,7 @@ all.Application, all.Organization, all.User, devices.*, or devices.removeData.
|
|
261
306
|
| Code | Type | Description |
|
262
307
|
| ---- | ---- | ----------- |
|
263
308
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
264
|
-
| 404 | [Error](_schemas.md#error) | Error if
|
309
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
265
310
|
|
266
311
|
<br/>
|
267
312
|
|
@@ -302,3 +347,84 @@ all.Application, all.Device, all.Organization, all.User, devices.*, or devices.s
|
|
302
347
|
| ---- | ---- | ----------- |
|
303
348
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
304
349
|
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
350
|
+
|
351
|
+
<br/>
|
352
|
+
|
353
|
+
## Tag Keys
|
354
|
+
|
355
|
+
Gets the unique tag keys for devices that match the given query. Maximum 1K returned.
|
356
|
+
|
357
|
+
```ruby
|
358
|
+
result = client.devices.tag_keys(applicationId: my_application_id)
|
359
|
+
|
360
|
+
puts result
|
361
|
+
```
|
362
|
+
|
363
|
+
#### Authentication
|
364
|
+
The client must be configured with a valid api access token to call this
|
365
|
+
action. The token must include at least one of the following scopes:
|
366
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.tagKeys.
|
367
|
+
|
368
|
+
#### Available Parameters
|
369
|
+
|
370
|
+
| Name | Type | Required | Description | Default | Example |
|
371
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
372
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
373
|
+
| query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
|
374
|
+
| startsWith | string | N | Filter keys down to those that start with the given string. Case insensitive. | | temper |
|
375
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
376
|
+
|
377
|
+
#### Successful Responses
|
378
|
+
|
379
|
+
| Code | Type | Description |
|
380
|
+
| ---- | ---- | ----------- |
|
381
|
+
| 200 | [Tag Keys Response](_schemas.md#tag-keys-response) | The matching tag keys |
|
382
|
+
|
383
|
+
#### Error Responses
|
384
|
+
|
385
|
+
| Code | Type | Description |
|
386
|
+
| ---- | ---- | ----------- |
|
387
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
388
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
389
|
+
|
390
|
+
<br/>
|
391
|
+
|
392
|
+
## Tag Values
|
393
|
+
|
394
|
+
Gets the unique tag values for the given key for devices that match the given query. Maximum 1K returned.
|
395
|
+
|
396
|
+
```ruby
|
397
|
+
result = client.devices.tag_values(
|
398
|
+
applicationId: my_application_id,
|
399
|
+
key: my_key)
|
400
|
+
|
401
|
+
puts result
|
402
|
+
```
|
403
|
+
|
404
|
+
#### Authentication
|
405
|
+
The client must be configured with a valid api access token to call this
|
406
|
+
action. The token must include at least one of the following scopes:
|
407
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, devices.*, or devices.tagValues.
|
408
|
+
|
409
|
+
#### Available Parameters
|
410
|
+
|
411
|
+
| Name | Type | Required | Description | Default | Example |
|
412
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
413
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
414
|
+
| query | [Advanced Device Query](_schemas.md#advanced-device-query) | N | Device filter JSON object | | [Advanced Device Query Example](_schemas.md#advanced-device-query-example) |
|
415
|
+
| key | string | Y | The tag key to get the values for | | myKey |
|
416
|
+
| startsWith | string | N | Filter values down to those that start with the given string. Case insensitive. | | temper |
|
417
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
418
|
+
|
419
|
+
#### Successful Responses
|
420
|
+
|
421
|
+
| Code | Type | Description |
|
422
|
+
| ---- | ---- | ----------- |
|
423
|
+
| 200 | [Tag Values Response](_schemas.md#tag-values-response) | The matching tag values |
|
424
|
+
|
425
|
+
#### Error Responses
|
426
|
+
|
427
|
+
| Code | Type | Description |
|
428
|
+
| ---- | ---- | ----------- |
|
429
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
430
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
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/experienceEndpoint.md
CHANGED
@@ -36,6 +36,7 @@ all.Application, all.Organization, all.User, experienceEndpoint.*, or experience
|
|
36
36
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
37
37
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
38
38
|
| experienceEndpointId | string | Y | ID associated with the experience endpoint | | 575ed78e7ae143cd83dc4aab |
|
39
|
+
| includeWorkflows | string | N | If the workflows that utilize this experience endpoint should also be deleted. | | true |
|
39
40
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
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 |
|