losant_rest 1.7.2 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/docs/_schemas.md +7347 -4603
- data/docs/application.md +47 -0
- data/docs/applicationApiToken.md +3 -0
- data/docs/applicationApiTokens.md +2 -0
- data/docs/applicationKey.md +3 -0
- data/docs/applicationKeys.md +2 -0
- data/docs/applications.md +2 -0
- data/docs/auditLog.md +1 -0
- data/docs/auditLogs.md +1 -0
- data/docs/auth.md +4 -0
- data/docs/dashboard.md +4 -0
- data/docs/dashboards.md +2 -0
- data/docs/data.md +2 -0
- data/docs/dataTable.md +5 -0
- data/docs/dataTableRow.md +3 -0
- data/docs/dataTableRows.md +9 -3
- data/docs/dataTables.md +2 -0
- data/docs/device.md +12 -0
- data/docs/deviceRecipe.md +4 -0
- data/docs/deviceRecipes.md +2 -0
- data/docs/devices.md +4 -0
- data/docs/edgeDeployments.md +4 -0
- data/docs/event.md +3 -0
- data/docs/events.md +4 -0
- data/docs/experience.md +52 -8
- data/docs/experienceDomain.md +3 -0
- data/docs/experienceDomains.md +2 -0
- data/docs/experienceEndpoint.md +4 -0
- data/docs/experienceEndpoints.md +9 -1
- data/docs/experienceGroup.md +3 -0
- data/docs/experienceGroups.md +2 -0
- data/docs/experienceSlug.md +133 -0
- data/docs/experienceSlugs.md +87 -0
- data/docs/experienceUser.md +3 -0
- data/docs/experienceUsers.md +2 -0
- data/docs/experienceVersion.md +133 -0
- data/docs/experienceVersions.md +93 -0
- data/docs/experienceView.md +4 -0
- data/docs/experienceViews.md +3 -0
- data/docs/file.md +4 -0
- data/docs/files.md +2 -0
- data/docs/flow.md +8 -0
- data/docs/flowVersion.md +4 -0
- data/docs/flowVersions.md +2 -0
- data/docs/flows.md +54 -1
- data/docs/integration.md +3 -0
- data/docs/integrations.md +2 -0
- data/docs/me.md +19 -3
- data/docs/org.md +10 -0
- data/docs/orgInvites.md +2 -0
- data/docs/orgs.md +2 -0
- data/docs/solution.md +3 -0
- data/docs/solutionUser.md +3 -0
- data/docs/solutionUsers.md +2 -0
- data/docs/solutions.md +2 -0
- data/docs/webhook.md +3 -0
- data/docs/webhooks.md +2 -0
- data/lib/losant_rest/application.rb +47 -0
- data/lib/losant_rest/client.rb +18 -2
- data/lib/losant_rest/data_table_rows.rb +3 -3
- data/lib/losant_rest/experience.rb +62 -11
- data/lib/losant_rest/experience_endpoint.rb +2 -0
- data/lib/losant_rest/experience_endpoints.rb +11 -1
- data/lib/losant_rest/experience_slug.rb +174 -0
- data/lib/losant_rest/experience_slugs.rb +124 -0
- data/lib/losant_rest/experience_version.rb +174 -0
- data/lib/losant_rest/experience_versions.rb +136 -0
- data/lib/losant_rest/experience_view.rb +2 -0
- data/lib/losant_rest/experience_views.rb +2 -0
- data/lib/losant_rest/flows.rb +66 -1
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest.rb +4 -0
- data/schemas/apiTokens.json +128 -0
- data/schemas/application.json +6 -0
- data/schemas/applicationApiTokenPost.json +18 -0
- data/schemas/applications.json +6 -0
- data/schemas/dataTableRowInMultiple.json +20 -0
- data/schemas/dataTableRowInsert.json +42 -0
- data/schemas/dataTableRowInsertResult.json +54 -0
- data/schemas/edgeDeployment.json +119 -0
- data/schemas/emailVerificationVerify.json +20 -0
- data/schemas/experienceBootstrapOptions.json +25 -0
- data/schemas/experienceBootstrapResult.json +16 -0
- data/schemas/experienceDomain.json +5 -0
- data/schemas/experienceDomainPatch.json +12 -0
- data/schemas/experienceDomainPost.json +12 -0
- data/schemas/experienceDomains.json +5 -0
- data/schemas/experienceSlug.json +37 -0
- data/schemas/experienceSlugPatch.json +25 -0
- data/schemas/experienceSlugPost.json +28 -0
- data/schemas/experienceSlugs.json +57 -0
- data/schemas/experienceVersion.json +82 -0
- data/schemas/experienceVersionPatch.json +19 -0
- data/schemas/experienceVersionPost.json +35 -0
- data/schemas/experienceVersions.json +102 -0
- data/schemas/file.json +3 -0
- data/schemas/files.json +3 -0
- data/schemas/flow.json +5 -0
- data/schemas/flowPatch.json +1 -0
- data/schemas/flowPost.json +2 -0
- data/schemas/flowVersion.json +622 -433
- data/schemas/flowVersionPost.json +1 -0
- data/schemas/flowVersions.json +622 -433
- data/schemas/flows.json +6 -0
- data/schemas/flowsImportPost.json +3 -0
- data/schemas/flowsImportResult.json +628 -434
- data/schemas/githubLogin.json +18 -0
- data/schemas/me.json +12 -0
- data/schemas/mqttPublishBody.json +20 -0
- data/schemas/org.json +12 -0
- data/schemas/orgs.json +12 -0
- data/schemas/passwordResetFinish.json +31 -0
- data/schemas/passwordResetInput.json +19 -0
- data/schemas/passwordResetResponse.json +18 -0
- data/schemas/solutionMe.json +150 -0
- data/schemas/userCredentials.json +18 -0
- data/schemas/userPost.json +388 -0
- metadata +32 -2
data/docs/application.md
CHANGED
@@ -10,6 +10,7 @@ parameters and the potential responses.
|
|
10
10
|
* [Backfill Archive Data](#backfill-archive-data)
|
11
11
|
* [Delete](#delete)
|
12
12
|
* [Get](#get)
|
13
|
+
* [Mqtt Publish Message](#mqtt-publish-message)
|
13
14
|
* [Patch](#patch)
|
14
15
|
* [Payload Counts](#payload-counts)
|
15
16
|
|
@@ -38,6 +39,7 @@ all.Application, all.Organization, all.User, application.*, or application.archi
|
|
38
39
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
39
40
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
40
41
|
| date | string | Y | The date to archive data (ms since epoch), it must be within the archive time range older than 31 days and newer than the organizations dataTTL | | 1518556791829 |
|
42
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
43
|
|
42
44
|
#### Successful Responses
|
43
45
|
|
@@ -74,6 +76,7 @@ all.Application, all.Organization, all.User, application.*, or application.backf
|
|
74
76
|
| Name | Type | Required | Description | Default | Example |
|
75
77
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
76
78
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
79
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
77
80
|
|
78
81
|
#### Successful Responses
|
79
82
|
|
@@ -110,6 +113,7 @@ all.Application, all.Organization, all.User, application.*, or application.delet
|
|
110
113
|
| Name | Type | Required | Description | Default | Example |
|
111
114
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
112
115
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
116
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
113
117
|
|
114
118
|
#### Successful Responses
|
115
119
|
|
@@ -146,6 +150,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
146
150
|
| Name | Type | Required | Description | Default | Example |
|
147
151
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
148
152
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
153
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
149
154
|
|
150
155
|
#### Successful Responses
|
151
156
|
|
@@ -162,6 +167,46 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
162
167
|
|
163
168
|
<br/>
|
164
169
|
|
170
|
+
## Mqtt Publish Message
|
171
|
+
|
172
|
+
Publishes the given message to the given MQTT topic
|
173
|
+
|
174
|
+
```ruby
|
175
|
+
result = client.application.mqtt_publish_message(
|
176
|
+
applicationId: my_application_id,
|
177
|
+
payload: my_payload)
|
178
|
+
|
179
|
+
puts result
|
180
|
+
```
|
181
|
+
|
182
|
+
#### Authentication
|
183
|
+
The client must be configured with a valid api access token to call this
|
184
|
+
action. The token must include at least one of the following scopes:
|
185
|
+
all.Application, all.Organization, all.User, application.*, or application.mqttPublishMessage.
|
186
|
+
|
187
|
+
#### Available Parameters
|
188
|
+
|
189
|
+
| Name | Type | Required | Description | Default | Example |
|
190
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
191
|
+
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
192
|
+
| payload | [MQTT Publish Body](_schemas.md#mqtt-publish-body) | Y | Object containing topic and message | | [MQTT Publish Body Example](_schemas.md#mqtt-publish-body-example) |
|
193
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
194
|
+
|
195
|
+
#### Successful Responses
|
196
|
+
|
197
|
+
| Code | Type | Description |
|
198
|
+
| ---- | ---- | ----------- |
|
199
|
+
| 200 | [Success](_schemas.md#success) | Message successfully published |
|
200
|
+
|
201
|
+
#### Error Responses
|
202
|
+
|
203
|
+
| Code | Type | Description |
|
204
|
+
| ---- | ---- | ----------- |
|
205
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
206
|
+
| 404 | [Error](_schemas.md#error) | Error if application was not found |
|
207
|
+
|
208
|
+
<br/>
|
209
|
+
|
165
210
|
## Patch
|
166
211
|
|
167
212
|
Updates information about an application
|
@@ -185,6 +230,7 @@ all.Application, all.Organization, all.User, application.*, or application.patch
|
|
185
230
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
186
231
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
187
232
|
| application | [Application Patch](_schemas.md#application-patch) | Y | Object containing new application properties | | [Application Patch Example](_schemas.md#application-patch-example) |
|
233
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
188
234
|
|
189
235
|
#### Successful Responses
|
190
236
|
|
@@ -223,6 +269,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
223
269
|
| applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
|
224
270
|
| start | string | N | Start of range for payload count query (ms since epoch) | -2592000000 | 0 |
|
225
271
|
| end | string | N | End of range for payload count query (ms since epoch) | 0 | 1465790400000 |
|
272
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
226
273
|
|
227
274
|
#### Successful Responses
|
228
275
|
|
data/docs/applicationApiToken.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, applicationApiToken.*, or applicati
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
38
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
38
39
|
|
39
40
|
#### Successful Responses
|
40
41
|
|
@@ -74,6 +75,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
74
75
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
75
76
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
76
77
|
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
78
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
77
79
|
|
78
80
|
#### Successful Responses
|
79
81
|
|
@@ -115,6 +117,7 @@ all.Application, all.Organization, all.User, applicationApiToken.*, or applicati
|
|
115
117
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
118
|
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
117
119
|
| apiToken | [API Token Patch](_schemas.md#api-token-patch) | Y | Object containing new properties of the API token | | [API Token Patch Example](_schemas.md#api-token-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
121
|
|
119
122
|
#### Successful Responses
|
120
123
|
|
@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
37
37
|
| perPage | string | N | How many items to return per page | 1000 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, status | | key |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*token |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -75,6 +76,7 @@ all.Application, all.Organization, all.User, applicationApiTokens.*, or applicat
|
|
75
76
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
76
77
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
77
78
|
| apiToken | [Application API Token Post](_schemas.md#application-api-token-post) | Y | API token information | | [Application API Token Post Example](_schemas.md#application-api-token-post-example) |
|
79
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
78
80
|
|
79
81
|
#### Successful Responses
|
80
82
|
|
data/docs/applicationKey.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, applicationKey.*, or applicationKey
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| applicationKeyId | string | Y | ID associated with the applicationKey | | 575ec76c7ae143cd83dc4a96 |
|
38
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
38
39
|
|
39
40
|
#### Successful Responses
|
40
41
|
|
@@ -74,6 +75,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
74
75
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
75
76
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
76
77
|
| applicationKeyId | string | Y | ID associated with the applicationKey | | 575ec76c7ae143cd83dc4a96 |
|
78
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
77
79
|
|
78
80
|
#### Successful Responses
|
79
81
|
|
@@ -115,6 +117,7 @@ all.Application, all.Organization, all.User, applicationKey.*, or applicationKey
|
|
115
117
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
116
118
|
| applicationKeyId | string | Y | ID associated with the applicationKey | | 575ec76c7ae143cd83dc4a96 |
|
117
119
|
| applicationKey | [Application Key Patch](_schemas.md#application-key-patch) | Y | Object containing new properties of the applicationKey | | [Application Key Patch Example](_schemas.md#application-key-patch-example) |
|
120
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
118
121
|
|
119
122
|
#### Successful Responses
|
120
123
|
|
data/docs/applicationKeys.md
CHANGED
@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
37
37
|
| perPage | string | N | How many items to return per page | 1000 | 10 |
|
38
38
|
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: key, status | | key |
|
39
39
|
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | the*key |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -76,6 +77,7 @@ all.Application, all.Organization, all.User, applicationKeys.*, or applicationKe
|
|
76
77
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
77
78
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
78
79
|
| applicationKey | [Application Key Post](_schemas.md#application-key-post) | Y | ApplicationKey information | | [Application Key Post Example](_schemas.md#application-key-post-example) |
|
80
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
79
81
|
|
80
82
|
#### Successful Responses
|
81
83
|
|
data/docs/applications.md
CHANGED
@@ -37,6 +37,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, applications.*
|
|
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 * app |
|
39
39
|
| 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 |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -72,6 +73,7 @@ all.Organization, all.User, applications.*, or applications.post.
|
|
72
73
|
| Name | Type | Required | Description | Default | Example |
|
73
74
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
74
75
|
| application | [Application Post](_schemas.md#application-post) | Y | New application information | | [Application Post Example](_schemas.md#application-post-example) |
|
76
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
75
77
|
|
76
78
|
#### Successful Responses
|
77
79
|
|
data/docs/auditLog.md
CHANGED
@@ -33,6 +33,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, auditLog.*, or
|
|
33
33
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
34
34
|
| orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
|
35
35
|
| auditLogId | string | Y | ID associated with the audit log | | 57955788124b37010084c053 |
|
36
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
36
37
|
|
37
38
|
#### Successful Responses
|
38
39
|
|
data/docs/auditLogs.md
CHANGED
@@ -37,6 +37,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, auditLogs.*, o
|
|
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) |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
data/docs/auth.md
CHANGED
@@ -31,6 +31,7 @@ No api access token is required to call this action.
|
|
31
31
|
| Name | Type | Required | Description | Default | Example |
|
32
32
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
33
33
|
| credentials | [Device Credentials](_schemas.md#device-credentials) | Y | Device authentication credentials | | [Device Credentials Example](_schemas.md#device-credentials-example) |
|
34
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
34
35
|
|
35
36
|
#### Successful Responses
|
36
37
|
|
@@ -65,6 +66,7 @@ No api access token is required to call this action.
|
|
65
66
|
| Name | Type | Required | Description | Default | Example |
|
66
67
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
67
68
|
| credentials | [Solution User Credentials](_schemas.md#solution-user-credentials) | Y | Solution user authentication credentials. The included api access token has the scope 'all.SolutionUser'. | | [Solution User Credentials Example](_schemas.md#solution-user-credentials-example) |
|
69
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
68
70
|
|
69
71
|
#### Successful Responses
|
70
72
|
|
@@ -99,6 +101,7 @@ No api access token is required to call this action.
|
|
99
101
|
| Name | Type | Required | Description | Default | Example |
|
100
102
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
101
103
|
| credentials | [User Credentials](_schemas.md#user-credentials) | Y | User authentication credentials | | [User Credentials Example](_schemas.md#user-credentials-example) |
|
104
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
102
105
|
|
103
106
|
#### Successful Responses
|
104
107
|
|
@@ -133,6 +136,7 @@ No api access token is required to call this action.
|
|
133
136
|
| Name | Type | Required | Description | Default | Example |
|
134
137
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
135
138
|
| oauth | [Github Login](_schemas.md#github-login) | Y | User authentication credentials (access token) | | [Github Login Example](_schemas.md#github-login-example) |
|
139
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
136
140
|
|
137
141
|
#### Successful Responses
|
138
142
|
|
data/docs/dashboard.md
CHANGED
@@ -33,6 +33,7 @@ all.Organization, all.User, dashboard.*, or dashboard.delete.
|
|
33
33
|
| Name | Type | Required | Description | Default | Example |
|
34
34
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
35
35
|
| dashboardId | string | Y | ID of the associated dashboard | | 575ece2b7ae143cd83dc4a9b |
|
36
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
36
37
|
|
37
38
|
#### Successful Responses
|
38
39
|
|
@@ -68,6 +69,7 @@ No api access token is required to call this action.
|
|
68
69
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
69
70
|
| dashboardId | string | Y | ID of the associated dashboard | | 575ece2b7ae143cd83dc4a9b |
|
70
71
|
| password | string | N | Password for password-protected dashboards | | myPassword |
|
72
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
71
73
|
|
72
74
|
#### Successful Responses
|
73
75
|
|
@@ -107,6 +109,7 @@ all.Organization, all.User, dashboard.*, or dashboard.patch.
|
|
107
109
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
108
110
|
| dashboardId | string | Y | ID of the associated dashboard | | 575ece2b7ae143cd83dc4a9b |
|
109
111
|
| dashboard | [Dashboard Patch](_schemas.md#dashboard-patch) | Y | Object containing new dashboard properties | | [Dashboard Patch Example](_schemas.md#dashboard-patch-example) |
|
112
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
110
113
|
|
111
114
|
#### Successful Responses
|
112
115
|
|
@@ -145,6 +148,7 @@ No api access token is required to call this action.
|
|
145
148
|
| dashboardId | string | Y | ID of the associated dashboard | | 575ece2b7ae143cd83dc4a9b |
|
146
149
|
| ctx | [Dashboard Context Instance](_schemas.md#dashboard-context-instance) | Y | The context object to validate | | [Dashboard Context Instance Example](_schemas.md#dashboard-context-instance-example) |
|
147
150
|
| password | string | N | Password for password-protected dashboards | | myPassword |
|
151
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
148
152
|
|
149
153
|
#### Successful Responses
|
150
154
|
|
data/docs/dashboards.md
CHANGED
@@ -37,6 +37,7 @@ all.Organization, all.Organization.read, all.SolutionUser, all.SolutionUser.read
|
|
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
|
| orgId | string | N | If not provided, return all dashboards. If provided but blank, only return dashboards belonging to the current user. If provided and an id, only return dashboards belonging to the given organization id. | | 575ece7e7ae143cd83dc4a9c |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -72,6 +73,7 @@ all.Organization, all.User, dashboards.*, or dashboards.post.
|
|
72
73
|
| Name | Type | Required | Description | Default | Example |
|
73
74
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
74
75
|
| dashboard | [Dashboard Post](_schemas.md#dashboard-post) | Y | New dashboard information | | [Dashboard Post Example](_schemas.md#dashboard-post-example) |
|
76
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
75
77
|
|
76
78
|
#### Successful Responses
|
77
79
|
|
data/docs/data.md
CHANGED
@@ -34,6 +34,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
34
34
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
35
35
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
36
36
|
| query | [Last Value Query](_schemas.md#last-value-query) | Y | The query parameters | | [Last Value Query Example](_schemas.md#last-value-query-example) |
|
37
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
37
38
|
|
38
39
|
#### Successful Responses
|
39
40
|
|
@@ -73,6 +74,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
73
74
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
74
75
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
75
76
|
| query | [Time Series Query](_schemas.md#time-series-query) | Y | The query parameters | | [Time Series Query Example](_schemas.md#time-series-query-example) |
|
77
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
76
78
|
|
77
79
|
#### Successful Responses
|
78
80
|
|
data/docs/dataTable.md
CHANGED
@@ -39,6 +39,7 @@ all.Application, all.Organization, all.User, dataTable.*, or dataTable.addColumn
|
|
39
39
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
40
40
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
41
41
|
| dataTableColumn | [Data Table Column](_schemas.md#data-table-column) | Y | Object containing the new column properties | | [Data Table Column Example](_schemas.md#data-table-column-example) |
|
42
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
42
43
|
|
43
44
|
#### Successful Responses
|
44
45
|
|
@@ -78,6 +79,7 @@ all.Application, all.Organization, all.User, dataTable.*, or dataTable.delete.
|
|
78
79
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
79
80
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
80
81
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
81
83
|
|
82
84
|
#### Successful Responses
|
83
85
|
|
@@ -117,6 +119,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
117
119
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
118
120
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
119
121
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
122
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
120
123
|
|
121
124
|
#### Successful Responses
|
122
125
|
|
@@ -158,6 +161,7 @@ all.Application, all.Organization, all.User, dataTable.*, or dataTable.patch.
|
|
158
161
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
159
162
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
160
163
|
| dataTable | [Data Table Patch](_schemas.md#data-table-patch) | Y | Object containing updated properties of the data table | | [Data Table Patch Example](_schemas.md#data-table-patch-example) |
|
164
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
161
165
|
|
162
166
|
#### Successful Responses
|
163
167
|
|
@@ -199,6 +203,7 @@ all.Application, all.Organization, all.User, dataTable.*, or dataTable.removeCol
|
|
199
203
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
200
204
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
201
205
|
| columnName | string | Y | Name of the column to remove | | myColumnName |
|
206
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
202
207
|
|
203
208
|
#### Successful Responses
|
204
209
|
|
data/docs/dataTableRow.md
CHANGED
@@ -37,6 +37,7 @@ all.Application, all.Organization, all.User, dataTableRow.*, or dataTableRow.del
|
|
37
37
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
38
38
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
39
39
|
| rowId | string | Y | ID associated with the data table row | | 596f832b128eda5cfe765443 |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -78,6 +79,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
78
79
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
79
80
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
80
81
|
| rowId | string | Y | ID associated with the data table row | | 596f832b128eda5cfe765443 |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
81
83
|
|
82
84
|
#### Successful Responses
|
83
85
|
|
@@ -121,6 +123,7 @@ all.Application, all.Organization, all.User, dataTableRow.*, or dataTableRow.pat
|
|
121
123
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
122
124
|
| rowId | string | Y | ID associated with the data table row | | 596f832b128eda5cfe765443 |
|
123
125
|
| dataTableRow | [Data Table Row Insert/Update](_schemas.md#data-table-row-insert/update) | Y | Object containing updated properties for the data table row | | [Data Table Row Insert/Update Example](_schemas.md#data-table-row-insert/update-example) |
|
126
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
124
127
|
|
125
128
|
#### Successful Responses
|
126
129
|
|
data/docs/dataTableRows.md
CHANGED
@@ -40,6 +40,7 @@ all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.d
|
|
40
40
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
41
41
|
| query | [Data Table Query](_schemas.md#data-table-query) | N | Query to apply to filter the data table | | [Data Table Query Example](_schemas.md#data-table-query-example) |
|
42
42
|
| limit | string | N | Limit number of rows to delete from data table | 1000 | 10 |
|
43
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
43
44
|
|
44
45
|
#### Successful Responses
|
45
46
|
|
@@ -80,6 +81,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
80
81
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
81
82
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
82
83
|
| exportData | [Data Table Export](_schemas.md#data-table-export) | N | Object containing export specifications | | [Data Table Export Example](_schemas.md#data-table-export-example) |
|
84
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
83
85
|
|
84
86
|
#### Successful Responses
|
85
87
|
|
@@ -123,6 +125,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
123
125
|
| sortDirection | string | N | Direction to sort the rows by. Accepted values are: asc, desc | asc | asc |
|
124
126
|
| limit | string | N | How many rows to return | 1000 | 0 |
|
125
127
|
| offset | string | N | How many rows to skip | 0 | 0 |
|
128
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
126
129
|
|
127
130
|
#### Successful Responses
|
128
131
|
|
@@ -141,7 +144,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
141
144
|
|
142
145
|
## Post
|
143
146
|
|
144
|
-
Inserts a new row into a data table
|
147
|
+
Inserts a new row(s) into a data table
|
145
148
|
|
146
149
|
```ruby
|
147
150
|
result = client.data_table_rows.post(
|
@@ -163,13 +166,14 @@ all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.p
|
|
163
166
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
164
167
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
165
168
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
166
|
-
| dataTableRow | [Data Table Row Insert
|
169
|
+
| dataTableRow | [Data Table Row Insert](_schemas.md#data-table-row-insert) | Y | The row(s) to insert | | [Data Table Row Insert Example](_schemas.md#data-table-row-insert-example) |
|
170
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
167
171
|
|
168
172
|
#### Successful Responses
|
169
173
|
|
170
174
|
| Code | Type | Description |
|
171
175
|
| ---- | ---- | ----------- |
|
172
|
-
| 201 | [Data Table Row](_schemas.md#data-table-row) | Successfully created data table row |
|
176
|
+
| 201 | [Data Table Row Insert Result](_schemas.md#data-table-row-insert-result) | Successfully created data table row, or bulk insert count |
|
173
177
|
|
174
178
|
#### Error Responses
|
175
179
|
|
@@ -208,6 +212,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
208
212
|
| limit | string | N | How many rows to return | 1000 | 0 |
|
209
213
|
| offset | string | N | How many rows to skip | 0 | 0 |
|
210
214
|
| query | [Data Table Query](_schemas.md#data-table-query) | N | Query to apply to filter the data table | | [Data Table Query Example](_schemas.md#data-table-query-example) |
|
215
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
211
216
|
|
212
217
|
#### Successful Responses
|
213
218
|
|
@@ -247,6 +252,7 @@ all.Application, all.Organization, all.User, dataTableRows.*, or dataTableRows.t
|
|
247
252
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
248
253
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
249
254
|
| dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
|
255
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
250
256
|
|
251
257
|
#### Successful Responses
|
252
258
|
|
data/docs/dataTables.md
CHANGED
@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
37
37
|
| perPage | string | N | How many items to return per page | 1000 | 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
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -76,6 +77,7 @@ all.Application, all.Organization, all.User, dataTables.*, or dataTables.post.
|
|
76
77
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
77
78
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
78
79
|
| dataTable | [Data Table Post](_schemas.md#data-table-post) | Y | New data table information | | [Data Table Post Example](_schemas.md#data-table-post-example) |
|
80
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
79
81
|
|
80
82
|
#### Successful Responses
|
81
83
|
|
data/docs/device.md
CHANGED
@@ -44,6 +44,7 @@ all.Application, all.Organization, all.User, device.*, or device.delete.
|
|
44
44
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
45
45
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
46
46
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
47
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
47
48
|
|
48
49
|
#### Successful Responses
|
49
50
|
|
@@ -87,6 +88,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
87
88
|
| end | string | N | End time of export (ms since epoch - 0 means now, negative is relative to now) | 0 | 1465790400000 |
|
88
89
|
| email | string | N | Email address to send export to. Defaults to current user's email. | | email@example.com |
|
89
90
|
| callbackUrl | string | N | Callback URL to call with export result. | | https://example.com/cburl |
|
91
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
90
92
|
|
91
93
|
#### Successful Responses
|
92
94
|
|
@@ -127,6 +129,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
127
129
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
128
130
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
129
131
|
| excludeConnectionInfo | string | N | If set, do not return connection info | | true |
|
132
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
130
133
|
|
131
134
|
#### Successful Responses
|
132
135
|
|
@@ -168,6 +171,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
168
171
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
169
172
|
| limit | string | N | Max command entries to return (ordered by time descending) | 1 | 10 |
|
170
173
|
| since | string | N | Look for command entries since this time (ms since epoch) | | 1465790400000 |
|
174
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
171
175
|
|
172
176
|
#### Successful Responses
|
173
177
|
|
@@ -209,6 +213,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
209
213
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
210
214
|
| start | string | N | Start of time range to look at to build composite state | 1 | 1465790400000 |
|
211
215
|
| end | string | N | End of time range to look at to build composite state | 0 | 1465790400000 |
|
216
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
212
217
|
|
213
218
|
#### Successful Responses
|
214
219
|
|
@@ -250,6 +255,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
250
255
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
251
256
|
| limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 |
|
252
257
|
| since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 |
|
258
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
253
259
|
|
254
260
|
#### Successful Responses
|
255
261
|
|
@@ -291,6 +297,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
291
297
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
292
298
|
| limit | string | N | Max state entries to return (ordered by time descending) | 1 | 10 |
|
293
299
|
| since | string | N | Look for state entries since this time (ms since epoch) | | 1465790400000 |
|
300
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
294
301
|
|
295
302
|
#### Successful Responses
|
296
303
|
|
@@ -332,6 +339,7 @@ all.Application, all.Organization, all.User, device.*, or device.patch.
|
|
332
339
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
333
340
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
334
341
|
| device | [Device Patch](_schemas.md#device-patch) | Y | Object containing new properties of the device | | [Device Patch Example](_schemas.md#device-patch-example) |
|
342
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
335
343
|
|
336
344
|
#### Successful Responses
|
337
345
|
|
@@ -373,6 +381,7 @@ all.Application, all.Organization, all.User, device.*, or device.removeData.
|
|
373
381
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
374
382
|
| start | string | N | Start time of export (ms since epoch - 0 means now, negative is relative to now) | 1 | 1465790400000 |
|
375
383
|
| end | string | N | End time of export (ms since epoch - 0 means now, negative is relative to now) | 0 | 1465790400000 |
|
384
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
376
385
|
|
377
386
|
#### Successful Responses
|
378
387
|
|
@@ -414,6 +423,7 @@ all.Application, all.Device, all.Organization, all.User, device.*, or device.sen
|
|
414
423
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
415
424
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
416
425
|
| deviceCommand | [Device Command](_schemas.md#device-command) | Y | Command to send to the device | | [Device Command Example](_schemas.md#device-command-example) |
|
426
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
417
427
|
|
418
428
|
#### Successful Responses
|
419
429
|
|
@@ -455,6 +465,7 @@ all.Application, all.Device, all.Organization, all.User, device.*, or device.sen
|
|
455
465
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
456
466
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
457
467
|
| deviceState | [Single or Multiple Device States](_schemas.md#single-or-multiple-device-states) | Y | A single device state object, or an array of device state objects | | [Single or Multiple Device States Example](_schemas.md#single-or-multiple-device-states-example) |
|
468
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
458
469
|
|
459
470
|
#### Successful Responses
|
460
471
|
|
@@ -496,6 +507,7 @@ all.Application, all.Device, all.Organization, all.User, device.*, or device.set
|
|
496
507
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
497
508
|
| deviceId | string | Y | ID associated with the device | | 575ecf887ae143cd83dc4aa2 |
|
498
509
|
| connectionStatus | [Device Connection Status](_schemas.md#device-connection-status) | Y | The current connection status of the device | | [Device Connection Status Example](_schemas.md#device-connection-status-example) |
|
510
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
499
511
|
|
500
512
|
#### Successful Responses
|
501
513
|
|
data/docs/deviceRecipe.md
CHANGED
@@ -38,6 +38,7 @@ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.bul
|
|
38
38
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
39
39
|
| deviceRecipeId | string | Y | ID associated with the device recipe | | 575ecec57ae143cd83dc4a9f |
|
40
40
|
| bulkInfo | [Device Recipe Bulk Create Post](_schemas.md#device-recipe-bulk-create-post) | Y | Object containing bulk creation info | | [Device Recipe Bulk Create Post Example](_schemas.md#device-recipe-bulk-create-post-example) |
|
41
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
42
|
|
42
43
|
#### Successful Responses
|
43
44
|
|
@@ -78,6 +79,7 @@ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.del
|
|
78
79
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
79
80
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
80
81
|
| deviceRecipeId | string | Y | ID associated with the device recipe | | 575ecec57ae143cd83dc4a9f |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
81
83
|
|
82
84
|
#### Successful Responses
|
83
85
|
|
@@ -117,6 +119,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
117
119
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
118
120
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
119
121
|
| deviceRecipeId | string | Y | ID associated with the device recipe | | 575ecec57ae143cd83dc4a9f |
|
122
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
120
123
|
|
121
124
|
#### Successful Responses
|
122
125
|
|
@@ -158,6 +161,7 @@ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.pat
|
|
158
161
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
159
162
|
| deviceRecipeId | string | Y | ID associated with the device recipe | | 575ecec57ae143cd83dc4a9f |
|
160
163
|
| deviceRecipe | [Device Recipe Patch](_schemas.md#device-recipe-patch) | Y | Object containing new properties of the device recipe | | [Device Recipe Patch Example](_schemas.md#device-recipe-patch-example) |
|
164
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
161
165
|
|
162
166
|
#### Successful Responses
|
163
167
|
|
data/docs/deviceRecipes.md
CHANGED
@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
37
37
|
| perPage | string | N | How many items to return per page | 1000 | 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
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
40
41
|
|
41
42
|
#### Successful Responses
|
42
43
|
|
@@ -76,6 +77,7 @@ all.Application, all.Organization, all.User, deviceRecipes.*, or deviceRecipes.p
|
|
76
77
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
77
78
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
78
79
|
| deviceRecipe | [Device Recipe Post](_schemas.md#device-recipe-post) | Y | New device recipe information | | [Device Recipe Post Example](_schemas.md#device-recipe-post-example) |
|
80
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
79
81
|
|
80
82
|
#### Successful Responses
|
81
83
|
|
data/docs/devices.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
|
|
35
35
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
36
36
|
| email | string | N | Email address to send export to. Defaults to current user's email. | | email@example.com |
|
37
37
|
| callbackUrl | string | N | Callback URL to call with export result. | | https://example.com/cburl |
|
38
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
38
39
|
|
39
40
|
#### Successful Responses
|
40
41
|
|
@@ -80,6 +81,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
|
|
80
81
|
| deviceClass | string | N | Filter the devices by the given device class. Accepted values are: standalone, gateway, peripheral, floating, edgeCompute | | standalone |
|
81
82
|
| tagFilter | [Device Tag Filter](_schemas.md#device-tag-filter) | N | Array of tag pairs to filter by. | | [Device Tag Filter Example](_schemas.md#device-tag-filter-example) |
|
82
83
|
| excludeConnectionInfo | string | N | If set, do not return connection info | | true |
|
84
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
83
85
|
|
84
86
|
#### Successful Responses
|
85
87
|
|
@@ -119,6 +121,7 @@ all.Application, all.Organization, all.User, devices.*, or devices.post.
|
|
119
121
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
120
122
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
121
123
|
| device | [Device Post](_schemas.md#device-post) | Y | New device information | | [Device Post Example](_schemas.md#device-post-example) |
|
124
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
122
125
|
|
123
126
|
#### Successful Responses
|
124
127
|
|
@@ -158,6 +161,7 @@ all.Application, all.Device, all.Organization, all.User, devices.*, or devices.s
|
|
158
161
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
159
162
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
160
163
|
| multiDeviceCommand | [Multi Device Command](_schemas.md#multi-device-command) | Y | Command to send to the device | | [Multi Device Command Example](_schemas.md#multi-device-command-example) |
|
164
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
161
165
|
|
162
166
|
#### Successful Responses
|
163
167
|
|