losant_rest 1.10.3 → 1.13.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +2 -2
- data/docs/_schemas.md +27526 -11724
- 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 +125 -1
- data/docs/edgeDeployments.md +1 -1
- data/docs/events.md +4 -4
- data/docs/experienceEndpoint.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/files.md +1 -1
- data/docs/flow.md +41 -0
- data/docs/flowVersions.md +2 -1
- data/docs/flows.md +5 -2
- data/docs/instance.md +128 -0
- data/docs/instanceMember.md +133 -0
- data/docs/instanceMembers.md +91 -0
- data/docs/instanceOrg.md +133 -0
- data/docs/instanceOrgMember.md +139 -0
- data/docs/instanceOrgMembers.md +96 -0
- data/docs/instanceOrgs.md +91 -0
- data/docs/instances.md +50 -0
- 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 +12 -1
- data/lib/losant_rest/application.rb +97 -2
- data/lib/losant_rest/application_api_token.rb +1 -1
- data/lib/losant_rest/application_api_tokens.rb +2 -2
- data/lib/losant_rest/application_certificate.rb +1 -1
- data/lib/losant_rest/application_certificate_authorities.rb +1 -1
- data/lib/losant_rest/application_certificate_authority.rb +1 -1
- data/lib/losant_rest/application_certificates.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_key.rb +1 -1
- data/lib/losant_rest/application_keys.rb +4 -1
- data/lib/losant_rest/application_template.rb +79 -0
- data/lib/losant_rest/application_templates.rb +90 -2
- data/lib/losant_rest/applications.rb +1 -1
- data/lib/losant_rest/audit_log.rb +1 -1
- data/lib/losant_rest/audit_logs.rb +1 -1
- data/lib/losant_rest/auth.rb +1 -1
- data/lib/losant_rest/client.rb +47 -3
- data/lib/losant_rest/dashboard.rb +1 -1
- data/lib/losant_rest/dashboards.rb +1 -1
- data/lib/losant_rest/data.rb +1 -1
- data/lib/losant_rest/data_table.rb +1 -1
- data/lib/losant_rest/data_table_row.rb +1 -1
- data/lib/losant_rest/data_table_rows.rb +1 -1
- data/lib/losant_rest/data_tables.rb +1 -1
- data/lib/losant_rest/device.rb +10 -4
- data/lib/losant_rest/device_recipe.rb +1 -1
- data/lib/losant_rest/device_recipes.rb +1 -1
- data/lib/losant_rest/devices.rb +153 -1
- data/lib/losant_rest/edge_deployments.rb +1 -1
- data/lib/losant_rest/error.rb +1 -1
- data/lib/losant_rest/event.rb +1 -1
- data/lib/losant_rest/events.rb +4 -4
- data/lib/losant_rest/experience.rb +1 -1
- data/lib/losant_rest/experience_domain.rb +1 -1
- data/lib/losant_rest/experience_domains.rb +1 -1
- data/lib/losant_rest/experience_endpoint.rb +3 -1
- data/lib/losant_rest/experience_endpoints.rb +1 -1
- data/lib/losant_rest/experience_group.rb +1 -1
- data/lib/losant_rest/experience_groups.rb +1 -1
- data/lib/losant_rest/experience_slug.rb +1 -1
- data/lib/losant_rest/experience_slugs.rb +1 -1
- data/lib/losant_rest/experience_user.rb +1 -1
- data/lib/losant_rest/experience_users.rb +1 -1
- data/lib/losant_rest/experience_version.rb +1 -1
- data/lib/losant_rest/experience_versions.rb +1 -1
- data/lib/losant_rest/experience_view.rb +1 -1
- data/lib/losant_rest/experience_views.rb +1 -1
- data/lib/losant_rest/file.rb +1 -1
- data/lib/losant_rest/files.rb +1 -1
- data/lib/losant_rest/flow.rb +47 -1
- data/lib/losant_rest/flow_version.rb +1 -1
- data/lib/losant_rest/flow_versions.rb +4 -1
- data/lib/losant_rest/flows.rb +9 -1
- data/lib/losant_rest/instance.rb +181 -0
- data/lib/losant_rest/instance_member.rb +176 -0
- data/lib/losant_rest/instance_members.rb +134 -0
- data/lib/losant_rest/instance_org.rb +176 -0
- data/lib/losant_rest/instance_org_member.rb +182 -0
- data/lib/losant_rest/instance_org_members.rb +138 -0
- data/lib/losant_rest/instance_orgs.rb +139 -0
- data/lib/losant_rest/instances.rb +88 -0
- data/lib/losant_rest/integration.rb +3 -1
- data/lib/losant_rest/integrations.rb +1 -1
- data/lib/losant_rest/me.rb +2 -43
- data/lib/losant_rest/notebook.rb +1 -1
- data/lib/losant_rest/notebooks.rb +1 -1
- data/lib/losant_rest/org.rb +2 -2
- data/lib/losant_rest/org_invites.rb +1 -1
- data/lib/losant_rest/orgs.rb +1 -1
- data/lib/losant_rest/utils.rb +1 -1
- data/lib/losant_rest/version.rb +2 -2
- data/lib/losant_rest/webhook.rb +3 -1
- data/lib/losant_rest/webhooks.rb +1 -1
- data/schemas/advancedApplicationKeyQuery.json +1082 -0
- data/schemas/advancedDeviceQuery.json +309 -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 +12 -0
- data/schemas/applicationApplyTemplatePatch.json +19 -0
- data/schemas/applicationCreationByTemplateResult.json +8 -0
- data/schemas/applicationDashboardPost.json +5683 -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 +197 -26
- data/schemas/dashboardPatch.json +197 -26
- data/schemas/dashboardPost.json +197 -26
- data/schemas/dashboards.json +197 -26
- data/schemas/dataExport.json +132 -1
- data/schemas/deviceAttributeDataTypeFilter.json +29 -0
- data/schemas/deviceClassFilter.json +1 -2
- data/schemas/devicesDeletePost.json +309 -0
- data/schemas/devicesExportPost.json +309 -0
- data/schemas/devicesPatch.json +309 -0
- data/schemas/devicesRemoveDataPost.json +309 -0
- data/schemas/experienceLinkedResources.json +96 -0
- data/schemas/experienceVersion.json +9 -0
- data/schemas/experienceVersionPatch.json +9 -0
- data/schemas/experienceVersions.json +9 -0
- data/schemas/filePost.json +8 -2
- data/schemas/files.json +3 -0
- data/schemas/flow.json +32 -0
- data/schemas/flowPatch.json +32 -0
- data/schemas/flowPost.json +32 -0
- data/schemas/flowStorageMetadata.json +13 -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 +53 -4
- data/schemas/historicalSummaries.json +43 -0
- data/schemas/historicalSummary.json +455 -0
- data/schemas/instance.json +132 -0
- data/schemas/instanceMember.json +37 -0
- data/schemas/instanceMemberPatch.json +17 -0
- data/schemas/instanceMemberPost.json +22 -0
- data/schemas/instanceMembers.json +69 -0
- data/schemas/instanceOrg.json +133 -0
- data/schemas/instanceOrgMember.json +37 -0
- data/schemas/instanceOrgMemberPatch.json +69 -0
- data/schemas/instanceOrgMemberPost.json +161 -0
- data/schemas/instanceOrgMembers.json +34 -0
- data/schemas/instanceOrgPatch.json +122 -0
- data/schemas/instanceOrgPost.json +125 -0
- data/schemas/instanceOrgs.json +174 -0
- data/schemas/instanceReportOptionsPost.json +40 -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/multiDeviceCommand.json +309 -0
- data/schemas/notebook.json +7 -0
- data/schemas/notebookExecutionLogs.json +7 -0
- data/schemas/notebookPatch.json +7 -0
- data/schemas/notebookPost.json +7 -0
- data/schemas/notebooks.json +7 -0
- data/schemas/orgInviteInfo.json +3 -0
- data/schemas/orgInvitePost.json +3 -0
- data/schemas/orgInvites.json +3 -0
- data/schemas/orgPatch.json +0 -9
- data/schemas/passwordResetFinish.json +2 -2
- data/schemas/payloadStats.json +110 -0
- 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 +51 -3
- data/schemas/userPost.json +59 -7
- metadata +61 -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) |
|
@@ -304,3 +347,84 @@ all.Application, all.Device, all.Organization, all.User, devices.*, or devices.s
|
|
304
347
|
| ---- | ---- | ----------- |
|
305
348
|
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
306
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,11 +114,11 @@ 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 |
|
121
|
-
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which
|
121
|
+
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
|
122
122
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
123
123
|
|
124
124
|
#### Successful Responses
|
@@ -157,7 +157,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
157
157
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
158
158
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
159
159
|
| filter | string | N | Filter to apply against event subjects. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
160
|
-
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which
|
160
|
+
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filter parameter. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
|
161
161
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
162
162
|
|
163
163
|
#### Successful Responses
|
@@ -199,7 +199,7 @@ all.Application, all.Organization, all.User, events.*, or events.patch.
|
|
199
199
|
| filterField | string | N | Field to filter the events to act on by. Blank or not provided means no filtering. Accepted values are: subject | | subject |
|
200
200
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | abnormal power to * |
|
201
201
|
| state | string | N | If provided, act on events only in the given state. Accepted values are: new, acknowledged, resolved | | new |
|
202
|
-
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which
|
202
|
+
| query | [Advanced Event Query](_schemas.md#advanced-event-query) | N | Event filter JSON object which overrides the filterField, filter, and state parameters. | | [Advanced Event Query Example](_schemas.md#advanced-event-query-example) |
|
203
203
|
| updates | [Event Patch](_schemas.md#event-patch) | Y | Object containing updated information for the events | | [Event Patch Example](_schemas.md#event-patch-example) |
|
204
204
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
205
205
|
|
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/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/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
@@ -12,6 +12,7 @@ parameters and the potential responses.
|
|
12
12
|
* [Get](#get)
|
13
13
|
* [Get Log Entries](#get-log-entries)
|
14
14
|
* [Get Storage Entries](#get-storage-entries)
|
15
|
+
* [Get Storage Entries Metadata](#get-storage-entries-metadata)
|
15
16
|
* [Patch](#patch)
|
16
17
|
* [Press Virtual Button](#press-virtual-button)
|
17
18
|
* [Set Storage Entry](#set-storage-entry)
|
@@ -268,6 +269,46 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
268
269
|
|
269
270
|
<br/>
|
270
271
|
|
272
|
+
## Get Storage Entries Metadata
|
273
|
+
|
274
|
+
Gets metadata about storage for this flow
|
275
|
+
|
276
|
+
```ruby
|
277
|
+
result = client.flow.get_storage_entries_metadata(
|
278
|
+
applicationId: my_application_id,
|
279
|
+
flowId: my_flow_id)
|
280
|
+
|
281
|
+
puts result
|
282
|
+
```
|
283
|
+
|
284
|
+
#### Authentication
|
285
|
+
The client must be configured with a valid api access token to call this
|
286
|
+
action. The token must include at least one of the following scopes:
|
287
|
+
all.Application, all.Organization, all.User, flow.*, or flow.getStorageEntriesMetadata.
|
288
|
+
|
289
|
+
#### Available Parameters
|
290
|
+
|
291
|
+
| Name | Type | Required | Description | Default | Example |
|
292
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
293
|
+
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
294
|
+
| flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
|
295
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
296
|
+
|
297
|
+
#### Successful Responses
|
298
|
+
|
299
|
+
| Code | Type | Description |
|
300
|
+
| ---- | ---- | ----------- |
|
301
|
+
| 200 | [Get Workflow Storage Entries Metadata](_schemas.md#get-workflow-storage-entries-metadata) | The meta data for the current storage entries |
|
302
|
+
|
303
|
+
#### Error Responses
|
304
|
+
|
305
|
+
| Code | Type | Description |
|
306
|
+
| ---- | ---- | ----------- |
|
307
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
308
|
+
| 404 | [Error](_schemas.md#error) | Error if flow was not found |
|
309
|
+
|
310
|
+
<br/>
|
311
|
+
|
271
312
|
## Patch
|
272
313
|
|
273
314
|
Updates information about a flow
|
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,14 @@ 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) |
|
46
|
+
| allVersions | string | N | If the request should also return flows with matching versions. Only applicable for requests with an advanced query. | false | true |
|
45
47
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
46
48
|
|
47
49
|
#### Successful Responses
|
@@ -84,13 +86,14 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
84
86
|
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
85
87
|
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
86
88
|
| page | string | N | Which page of results to return | 0 | 0 |
|
87
|
-
| perPage | string | N | How many items to return per page |
|
89
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
88
90
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
89
91
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*flow |
|
90
92
|
| flowClass | string | N | Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience | cloud | cloud |
|
91
93
|
| version | string | Y | Return the workflow versions for the given version. | | myVersion |
|
92
94
|
| 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
95
|
| 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 |
|
96
|
+
| 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
97
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
95
98
|
|
96
99
|
#### Successful Responses
|
data/docs/instance.md
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
# Instance Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Generate Report](#generate-report)
|
10
|
+
* [Get](#get)
|
11
|
+
* [Historical Summaries](#historical-summaries)
|
12
|
+
|
13
|
+
<br/>
|
14
|
+
|
15
|
+
## Generate Report
|
16
|
+
|
17
|
+
Generates a CSV report on instance stats
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.instance.generate_report(instanceId: my_instance_id)
|
21
|
+
|
22
|
+
puts result
|
23
|
+
```
|
24
|
+
|
25
|
+
#### Authentication
|
26
|
+
The client must be configured with a valid api access token to call this
|
27
|
+
action. The token must include at least one of the following scopes:
|
28
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.generateReport.
|
29
|
+
|
30
|
+
#### Available Parameters
|
31
|
+
|
32
|
+
| Name | Type | Required | Description | Default | Example |
|
33
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
34
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
35
|
+
| options | [Instance Report Options Post](_schemas.md#instance-report-options-post) | N | Object containing report configuration | | [Instance Report Options Post Example](_schemas.md#instance-report-options-post-example) |
|
36
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
37
|
+
|
38
|
+
#### Successful Responses
|
39
|
+
|
40
|
+
| Code | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| 200 | [Success](_schemas.md#success) | If generation of report was successfully started |
|
43
|
+
|
44
|
+
#### Error Responses
|
45
|
+
|
46
|
+
| Code | Type | Description |
|
47
|
+
| ---- | ---- | ----------- |
|
48
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
49
|
+
|
50
|
+
<br/>
|
51
|
+
|
52
|
+
## Get
|
53
|
+
|
54
|
+
Returns an instance
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
result = client.instance.get(instanceId: my_instance_id)
|
58
|
+
|
59
|
+
puts result
|
60
|
+
```
|
61
|
+
|
62
|
+
#### Authentication
|
63
|
+
The client must be configured with a valid api access token to call this
|
64
|
+
action. The token must include at least one of the following scopes:
|
65
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.get.
|
66
|
+
|
67
|
+
#### Available Parameters
|
68
|
+
|
69
|
+
| Name | Type | Required | Description | Default | Example |
|
70
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
71
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
72
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
73
|
+
|
74
|
+
#### Successful Responses
|
75
|
+
|
76
|
+
| Code | Type | Description |
|
77
|
+
| ---- | ---- | ----------- |
|
78
|
+
| 200 | [Instance](_schemas.md#instance) | A single instance |
|
79
|
+
|
80
|
+
#### Error Responses
|
81
|
+
|
82
|
+
| Code | Type | Description |
|
83
|
+
| ---- | ---- | ----------- |
|
84
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
85
|
+
| 404 | [Error](_schemas.md#error) | Error if instance was not found |
|
86
|
+
|
87
|
+
<br/>
|
88
|
+
|
89
|
+
## Historical Summaries
|
90
|
+
|
91
|
+
Return historical summary entries for an instance
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
result = client.instance.historical_summaries(instanceId: my_instance_id)
|
95
|
+
|
96
|
+
puts result
|
97
|
+
```
|
98
|
+
|
99
|
+
#### Authentication
|
100
|
+
The client must be configured with a valid api access token to call this
|
101
|
+
action. The token must include at least one of the following scopes:
|
102
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instance.historicalSummaries.
|
103
|
+
|
104
|
+
#### Available Parameters
|
105
|
+
|
106
|
+
| Name | Type | Required | Description | Default | Example |
|
107
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
108
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
109
|
+
| month | string | N | Timestamp within the month to report a summary for. | now | 1609459204518 |
|
110
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: resourceId, currentPeriodStart | currentPeriodStart | resourceId |
|
111
|
+
| sortDirection | string | N | Direction to sort the results in. Accepted values are: asc, desc | asc | asc |
|
112
|
+
| page | string | N | Which page of results to return | 0 | 0 |
|
113
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
114
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: resourceType, resourceId, ownerId, ownerType | | resourceType |
|
115
|
+
| filter | string | N | Filter to apply against the filtered field. Blank or not provided means no filtering. | | organization |
|
116
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
117
|
+
|
118
|
+
#### Successful Responses
|
119
|
+
|
120
|
+
| Code | Type | Description |
|
121
|
+
| ---- | ---- | ----------- |
|
122
|
+
| 200 | [Historical Summaries](_schemas.md#historical-summaries) | Collection of historical summaries |
|
123
|
+
|
124
|
+
#### Error Responses
|
125
|
+
|
126
|
+
| Code | Type | Description |
|
127
|
+
| ---- | ---- | ----------- |
|
128
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|