losant_rest 1.21.0 → 1.21.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +1 -1
- data/docs/_schemas.md +1180 -72
- data/docs/application.md +1 -0
- data/docs/devices.md +45 -2
- data/docs/instance.md +41 -0
- data/docs/instanceOrg.md +49 -5
- data/docs/instanceSandbox.md +179 -3
- data/docs/me.md +1 -0
- data/docs/org.md +1 -0
- data/lib/platform_rest/application.rb +2 -0
- data/lib/platform_rest/client.rb +2 -2
- data/lib/platform_rest/devices.rb +52 -2
- data/lib/platform_rest/instance.rb +50 -0
- data/lib/platform_rest/instance_org.rb +57 -5
- data/lib/platform_rest/instance_sandbox.rb +211 -3
- data/lib/platform_rest/me.rb +2 -0
- data/lib/platform_rest/org.rb +2 -0
- data/lib/platform_rest/version.rb +1 -1
- data/schemas/advancedDeviceQuery.json +103 -0
- data/schemas/apiTokenPost.json +7 -0
- data/schemas/bulkRestoreResponse.json +12 -0
- data/schemas/dataExport.json +103 -0
- data/schemas/device.json +4 -0
- data/schemas/devices.json +4 -0
- data/schemas/devicesDeleteOrRestorePost.json +2061 -0
- data/schemas/devicesExportPayloadCountPost.json +103 -0
- data/schemas/devicesExportPost.json +103 -0
- data/schemas/devicesPatch.json +103 -0
- data/schemas/devicesRemoveDataPost.json +103 -0
- data/schemas/githubLogin.json +7 -0
- data/schemas/lastValueQuery.json +103 -0
- data/schemas/multiDeviceCommand.json +103 -0
- data/schemas/samlResponse.json +7 -0
- data/schemas/timeSeriesQuery.json +103 -0
- data/schemas/userCredentials.json +7 -0
- data/schemas/userPost.json +7 -0
- metadata +4 -2
@@ -52,7 +52,7 @@ module PlatformRest
|
|
52
52
|
#
|
53
53
|
# Errors:
|
54
54
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
55
|
-
# * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
|
55
|
+
# * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
|
56
56
|
def delete(params = {})
|
57
57
|
params = Utils.symbolize_hash_keys(params)
|
58
58
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -149,7 +149,7 @@ module PlatformRest
|
|
149
149
|
#
|
150
150
|
# Errors:
|
151
151
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
152
|
-
# * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
|
152
|
+
# * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
|
153
153
|
def get(params = {})
|
154
154
|
params = Utils.symbolize_hash_keys(params)
|
155
155
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -198,7 +198,7 @@ module PlatformRest
|
|
198
198
|
#
|
199
199
|
# Errors:
|
200
200
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
201
|
-
# * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
|
201
|
+
# * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
|
202
202
|
def notebook_minute_counts(params = {})
|
203
203
|
params = Utils.symbolize_hash_keys(params)
|
204
204
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -248,7 +248,7 @@ module PlatformRest
|
|
248
248
|
#
|
249
249
|
# Errors:
|
250
250
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
251
|
-
# * 404 - Error if organization was not found (https://api.losant.com/#/definitions/error)
|
251
|
+
# * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
|
252
252
|
def patch(params = {})
|
253
253
|
params = Utils.symbolize_hash_keys(params)
|
254
254
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -276,6 +276,58 @@ module PlatformRest
|
|
276
276
|
body: body)
|
277
277
|
end
|
278
278
|
|
279
|
+
# Returns payload counts for the time range specified for all applications this organization owns
|
280
|
+
#
|
281
|
+
# Authentication:
|
282
|
+
# The client must be configured with a valid api
|
283
|
+
# access token to call this action. The token
|
284
|
+
# must include at least one of the following scopes:
|
285
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.payloadCounts.
|
286
|
+
#
|
287
|
+
# Parameters:
|
288
|
+
# * {string} instanceId - ID associated with the instance
|
289
|
+
# * {string} orgId - ID associated with the organization
|
290
|
+
# * {string} start - Start of range for payload count query (ms since epoch)
|
291
|
+
# * {string} end - End of range for payload count query (ms since epoch)
|
292
|
+
# * {string} asBytes - If the resulting stats should be returned as bytes
|
293
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
294
|
+
# * {boolean} _actions - Return resource actions in response
|
295
|
+
# * {boolean} _links - Return resource link in response
|
296
|
+
# * {boolean} _embedded - Return embedded resources in response
|
297
|
+
#
|
298
|
+
# Responses:
|
299
|
+
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
|
300
|
+
#
|
301
|
+
# Errors:
|
302
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
303
|
+
# * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
|
304
|
+
def payload_counts(params = {})
|
305
|
+
params = Utils.symbolize_hash_keys(params)
|
306
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
307
|
+
headers = {}
|
308
|
+
body = nil
|
309
|
+
|
310
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
311
|
+
raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId)
|
312
|
+
|
313
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
314
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
315
|
+
query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
|
316
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
317
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
318
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
319
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
320
|
+
|
321
|
+
path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/payloadCounts"
|
322
|
+
|
323
|
+
@client.request(
|
324
|
+
method: :get,
|
325
|
+
path: path,
|
326
|
+
query: query_params,
|
327
|
+
headers: headers,
|
328
|
+
body: body)
|
329
|
+
end
|
330
|
+
|
279
331
|
# Returns payload counts per resolution in the time range specified for all application this organization owns
|
280
332
|
#
|
281
333
|
# Authentication:
|
@@ -302,7 +354,7 @@ module PlatformRest
|
|
302
354
|
#
|
303
355
|
# Errors:
|
304
356
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
305
|
-
# * 404 - Error if instance was not found (https://api.losant.com/#/definitions/error)
|
357
|
+
# * 404 - Error if instance or organization was not found (https://api.losant.com/#/definitions/error)
|
306
358
|
def payload_counts_breakdown(params = {})
|
307
359
|
params = Utils.symbolize_hash_keys(params)
|
308
360
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -52,7 +52,7 @@ module PlatformRest
|
|
52
52
|
#
|
53
53
|
# Errors:
|
54
54
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
55
|
-
# * 404 - Error if
|
55
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
56
56
|
def delete(params = {})
|
57
57
|
params = Utils.symbolize_hash_keys(params)
|
58
58
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -77,6 +77,56 @@ module PlatformRest
|
|
77
77
|
body: body)
|
78
78
|
end
|
79
79
|
|
80
|
+
# Returns device counts by day for the time range specified for all applications the sandbox user owns
|
81
|
+
#
|
82
|
+
# Authentication:
|
83
|
+
# The client must be configured with a valid api
|
84
|
+
# access token to call this action. The token
|
85
|
+
# must include at least one of the following scopes:
|
86
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.deviceCounts.
|
87
|
+
#
|
88
|
+
# Parameters:
|
89
|
+
# * {string} instanceId - ID associated with the instance
|
90
|
+
# * {string} instanceSandboxId - ID associated with the sandbox user
|
91
|
+
# * {string} start - Start of range for device count query (ms since epoch)
|
92
|
+
# * {string} end - End of range for device count query (ms since epoch)
|
93
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
94
|
+
# * {boolean} _actions - Return resource actions in response
|
95
|
+
# * {boolean} _links - Return resource link in response
|
96
|
+
# * {boolean} _embedded - Return embedded resources in response
|
97
|
+
#
|
98
|
+
# Responses:
|
99
|
+
# * 200 - Device counts by day (https://api.losant.com/#/definitions/deviceCounts)
|
100
|
+
#
|
101
|
+
# Errors:
|
102
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
103
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
104
|
+
def device_counts(params = {})
|
105
|
+
params = Utils.symbolize_hash_keys(params)
|
106
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
107
|
+
headers = {}
|
108
|
+
body = nil
|
109
|
+
|
110
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
111
|
+
raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
|
112
|
+
|
113
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
114
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
115
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
116
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
117
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
118
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
119
|
+
|
120
|
+
path = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}/deviceCounts"
|
121
|
+
|
122
|
+
@client.request(
|
123
|
+
method: :get,
|
124
|
+
path: path,
|
125
|
+
query: query_params,
|
126
|
+
headers: headers,
|
127
|
+
body: body)
|
128
|
+
end
|
129
|
+
|
80
130
|
# Returns a sandbox user
|
81
131
|
#
|
82
132
|
# Authentication:
|
@@ -100,7 +150,7 @@ module PlatformRest
|
|
100
150
|
#
|
101
151
|
# Errors:
|
102
152
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
103
|
-
# * 404 - Error if sandbox was not found (https://api.losant.com/#/definitions/error)
|
153
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
104
154
|
def get(params = {})
|
105
155
|
params = Utils.symbolize_hash_keys(params)
|
106
156
|
query_params = { _actions: false, _links: true, _embedded: true }
|
@@ -127,6 +177,164 @@ module PlatformRest
|
|
127
177
|
body: body)
|
128
178
|
end
|
129
179
|
|
180
|
+
# Returns notebook execution usage by day for the time range specified for all applications the sandbox user owns
|
181
|
+
#
|
182
|
+
# Authentication:
|
183
|
+
# The client must be configured with a valid api
|
184
|
+
# access token to call this action. The token
|
185
|
+
# must include at least one of the following scopes:
|
186
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.notebookMinuteCounts.
|
187
|
+
#
|
188
|
+
# Parameters:
|
189
|
+
# * {string} instanceId - ID associated with the instance
|
190
|
+
# * {string} instanceSandboxId - ID associated with the sandbox user
|
191
|
+
# * {string} start - Start of range for notebook execution query (ms since epoch)
|
192
|
+
# * {string} end - End of range for notebook execution query (ms since epoch)
|
193
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
194
|
+
# * {boolean} _actions - Return resource actions in response
|
195
|
+
# * {boolean} _links - Return resource link in response
|
196
|
+
# * {boolean} _embedded - Return embedded resources in response
|
197
|
+
#
|
198
|
+
# Responses:
|
199
|
+
# * 200 - Notebook usage information (https://api.losant.com/#/definitions/notebookMinuteCounts)
|
200
|
+
#
|
201
|
+
# Errors:
|
202
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
203
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
204
|
+
def notebook_minute_counts(params = {})
|
205
|
+
params = Utils.symbolize_hash_keys(params)
|
206
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
207
|
+
headers = {}
|
208
|
+
body = nil
|
209
|
+
|
210
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
211
|
+
raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
|
212
|
+
|
213
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
214
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
215
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
216
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
217
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
218
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
219
|
+
|
220
|
+
path = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}/notebookMinuteCounts"
|
221
|
+
|
222
|
+
@client.request(
|
223
|
+
method: :get,
|
224
|
+
path: path,
|
225
|
+
query: query_params,
|
226
|
+
headers: headers,
|
227
|
+
body: body)
|
228
|
+
end
|
229
|
+
|
230
|
+
# Returns payload counts for the time range specified for all applications the sandbox user owns
|
231
|
+
#
|
232
|
+
# Authentication:
|
233
|
+
# The client must be configured with a valid api
|
234
|
+
# access token to call this action. The token
|
235
|
+
# must include at least one of the following scopes:
|
236
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCounts.
|
237
|
+
#
|
238
|
+
# Parameters:
|
239
|
+
# * {string} instanceId - ID associated with the instance
|
240
|
+
# * {string} instanceSandboxId - ID associated with the sandbox user
|
241
|
+
# * {string} start - Start of range for payload count query (ms since epoch)
|
242
|
+
# * {string} end - End of range for payload count query (ms since epoch)
|
243
|
+
# * {string} asBytes - If the resulting stats should be returned as bytes
|
244
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
245
|
+
# * {boolean} _actions - Return resource actions in response
|
246
|
+
# * {boolean} _links - Return resource link in response
|
247
|
+
# * {boolean} _embedded - Return embedded resources in response
|
248
|
+
#
|
249
|
+
# Responses:
|
250
|
+
# * 200 - Payload counts, by type and source (https://api.losant.com/#/definitions/payloadStats)
|
251
|
+
#
|
252
|
+
# Errors:
|
253
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
254
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
255
|
+
def payload_counts(params = {})
|
256
|
+
params = Utils.symbolize_hash_keys(params)
|
257
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
258
|
+
headers = {}
|
259
|
+
body = nil
|
260
|
+
|
261
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
262
|
+
raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
|
263
|
+
|
264
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
265
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
266
|
+
query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
|
267
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
268
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
269
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
270
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
271
|
+
|
272
|
+
path = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}/payloadCounts"
|
273
|
+
|
274
|
+
@client.request(
|
275
|
+
method: :get,
|
276
|
+
path: path,
|
277
|
+
query: query_params,
|
278
|
+
headers: headers,
|
279
|
+
body: body)
|
280
|
+
end
|
281
|
+
|
282
|
+
# Returns payload counts per resolution in the time range specified for all applications the sandbox user owns
|
283
|
+
#
|
284
|
+
# Authentication:
|
285
|
+
# The client must be configured with a valid api
|
286
|
+
# access token to call this action. The token
|
287
|
+
# must include at least one of the following scopes:
|
288
|
+
# all.Instance, all.Instance.read, all.User, all.User.read, instanceSandbox.*, or instanceSandbox.payloadCountsBreakdown.
|
289
|
+
#
|
290
|
+
# Parameters:
|
291
|
+
# * {string} instanceId - ID associated with the instance
|
292
|
+
# * {string} instanceSandboxId - ID associated with the sandbox user
|
293
|
+
# * {string} start - Start of range for payload count query (ms since epoch)
|
294
|
+
# * {string} end - End of range for payload count query (ms since epoch)
|
295
|
+
# * {string} resolution - Resolution in milliseconds. Accepted values are: 86400000, 3600000
|
296
|
+
# * {string} asBytes - If the resulting stats should be returned as bytes
|
297
|
+
# * {string} includeNonBillable - If non-billable payloads should be included in the result
|
298
|
+
# * {string} losantdomain - Domain scope of request (rarely needed)
|
299
|
+
# * {boolean} _actions - Return resource actions in response
|
300
|
+
# * {boolean} _links - Return resource link in response
|
301
|
+
# * {boolean} _embedded - Return embedded resources in response
|
302
|
+
#
|
303
|
+
# Responses:
|
304
|
+
# * 200 - Sum of payload counts by date (https://api.losant.com/#/definitions/payloadCountsBreakdown)
|
305
|
+
#
|
306
|
+
# Errors:
|
307
|
+
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
308
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
309
|
+
def payload_counts_breakdown(params = {})
|
310
|
+
params = Utils.symbolize_hash_keys(params)
|
311
|
+
query_params = { _actions: false, _links: true, _embedded: true }
|
312
|
+
headers = {}
|
313
|
+
body = nil
|
314
|
+
|
315
|
+
raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId)
|
316
|
+
raise ArgumentError.new("instanceSandboxId is required") unless params.has_key?(:instanceSandboxId)
|
317
|
+
|
318
|
+
query_params[:start] = params[:start] if params.has_key?(:start)
|
319
|
+
query_params[:end] = params[:end] if params.has_key?(:end)
|
320
|
+
query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
|
321
|
+
query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
|
322
|
+
query_params[:includeNonBillable] = params[:includeNonBillable] if params.has_key?(:includeNonBillable)
|
323
|
+
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
324
|
+
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
325
|
+
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
326
|
+
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
327
|
+
|
328
|
+
path = "/instances/#{params[:instanceId]}/sandboxes/#{params[:instanceSandboxId]}/payloadCountsBreakdown"
|
329
|
+
|
330
|
+
@client.request(
|
331
|
+
method: :get,
|
332
|
+
path: path,
|
333
|
+
query: query_params,
|
334
|
+
headers: headers,
|
335
|
+
body: body)
|
336
|
+
end
|
337
|
+
|
130
338
|
# Restores a sandbox user account
|
131
339
|
#
|
132
340
|
# Authentication:
|
@@ -150,7 +358,7 @@ module PlatformRest
|
|
150
358
|
#
|
151
359
|
# Errors:
|
152
360
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
153
|
-
# * 404 - Error if sandbox was not found (https://api.losant.com/#/definitions/error)
|
361
|
+
# * 404 - Error if sandbox or instance was not found (https://api.losant.com/#/definitions/error)
|
154
362
|
def undelete(params = {})
|
155
363
|
params = Utils.symbolize_hash_keys(params)
|
156
364
|
query_params = { _actions: false, _links: true, _embedded: true }
|
data/lib/platform_rest/me.rb
CHANGED
@@ -659,6 +659,7 @@ module PlatformRest
|
|
659
659
|
# Parameters:
|
660
660
|
# * {string} start - Start of range for payload count query (ms since epoch)
|
661
661
|
# * {string} end - End of range for payload count query (ms since epoch)
|
662
|
+
# * {string} asBytes - If the resulting stats should be returned as bytes
|
662
663
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
663
664
|
# * {boolean} _actions - Return resource actions in response
|
664
665
|
# * {boolean} _links - Return resource link in response
|
@@ -678,6 +679,7 @@ module PlatformRest
|
|
678
679
|
|
679
680
|
query_params[:start] = params[:start] if params.has_key?(:start)
|
680
681
|
query_params[:end] = params[:end] if params.has_key?(:end)
|
682
|
+
query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
|
681
683
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
682
684
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
683
685
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
data/lib/platform_rest/org.rb
CHANGED
@@ -380,6 +380,7 @@ module PlatformRest
|
|
380
380
|
# * {string} orgId - ID associated with the organization
|
381
381
|
# * {string} start - Start of range for payload count query (ms since epoch)
|
382
382
|
# * {string} end - End of range for payload count query (ms since epoch)
|
383
|
+
# * {string} asBytes - If the resulting stats should be returned as bytes
|
383
384
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
384
385
|
# * {boolean} _actions - Return resource actions in response
|
385
386
|
# * {boolean} _links - Return resource link in response
|
@@ -401,6 +402,7 @@ module PlatformRest
|
|
401
402
|
|
402
403
|
query_params[:start] = params[:start] if params.has_key?(:start)
|
403
404
|
query_params[:end] = params[:end] if params.has_key?(:end)
|
405
|
+
query_params[:asBytes] = params[:asBytes] if params.has_key?(:asBytes)
|
404
406
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
405
407
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
406
408
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
@@ -334,6 +334,109 @@
|
|
334
334
|
}
|
335
335
|
]
|
336
336
|
},
|
337
|
+
"deletedAt": {
|
338
|
+
"oneOf": [
|
339
|
+
{
|
340
|
+
"type": [
|
341
|
+
"string",
|
342
|
+
"number",
|
343
|
+
"boolean",
|
344
|
+
"null"
|
345
|
+
]
|
346
|
+
},
|
347
|
+
{
|
348
|
+
"type": "object",
|
349
|
+
"properties": {
|
350
|
+
"$eq": {
|
351
|
+
"type": [
|
352
|
+
"string",
|
353
|
+
"number",
|
354
|
+
"boolean",
|
355
|
+
"null"
|
356
|
+
]
|
357
|
+
},
|
358
|
+
"$ne": {
|
359
|
+
"type": [
|
360
|
+
"string",
|
361
|
+
"number",
|
362
|
+
"boolean",
|
363
|
+
"null"
|
364
|
+
]
|
365
|
+
},
|
366
|
+
"$gt": {
|
367
|
+
"type": [
|
368
|
+
"string",
|
369
|
+
"number",
|
370
|
+
"boolean",
|
371
|
+
"null"
|
372
|
+
]
|
373
|
+
},
|
374
|
+
"$lt": {
|
375
|
+
"type": [
|
376
|
+
"string",
|
377
|
+
"number",
|
378
|
+
"boolean",
|
379
|
+
"null"
|
380
|
+
]
|
381
|
+
},
|
382
|
+
"$gte": {
|
383
|
+
"type": [
|
384
|
+
"string",
|
385
|
+
"number",
|
386
|
+
"boolean",
|
387
|
+
"null"
|
388
|
+
]
|
389
|
+
},
|
390
|
+
"$lte": {
|
391
|
+
"type": [
|
392
|
+
"string",
|
393
|
+
"number",
|
394
|
+
"boolean",
|
395
|
+
"null"
|
396
|
+
]
|
397
|
+
},
|
398
|
+
"$startsWith": {
|
399
|
+
"type": "string",
|
400
|
+
"minLength": 1
|
401
|
+
},
|
402
|
+
"$endsWith": {
|
403
|
+
"type": "string",
|
404
|
+
"minLength": 1
|
405
|
+
},
|
406
|
+
"$contains": {
|
407
|
+
"type": "string",
|
408
|
+
"minLength": 1
|
409
|
+
},
|
410
|
+
"$ci": {
|
411
|
+
"type": "boolean"
|
412
|
+
},
|
413
|
+
"$in": {
|
414
|
+
"type": "array",
|
415
|
+
"maxItems": 100,
|
416
|
+
"items": {
|
417
|
+
"type": [
|
418
|
+
"string",
|
419
|
+
"number",
|
420
|
+
"boolean"
|
421
|
+
]
|
422
|
+
}
|
423
|
+
},
|
424
|
+
"$nin": {
|
425
|
+
"type": "array",
|
426
|
+
"maxItems": 100,
|
427
|
+
"items": {
|
428
|
+
"type": [
|
429
|
+
"string",
|
430
|
+
"number",
|
431
|
+
"boolean"
|
432
|
+
]
|
433
|
+
}
|
434
|
+
}
|
435
|
+
},
|
436
|
+
"additionalProperties": false
|
437
|
+
}
|
438
|
+
]
|
439
|
+
},
|
337
440
|
"name": {
|
338
441
|
"oneOf": [
|
339
442
|
{
|
data/schemas/apiTokenPost.json
CHANGED
@@ -185,6 +185,7 @@
|
|
185
185
|
"devices.attributeNames",
|
186
186
|
"devices.patch",
|
187
187
|
"devices.delete",
|
188
|
+
"devices.restore",
|
188
189
|
"devices.removeData",
|
189
190
|
"devices.detailedSummary",
|
190
191
|
"devices.deviceNames",
|
@@ -379,6 +380,7 @@
|
|
379
380
|
"instance.patch",
|
380
381
|
"instance.historicalSummaries",
|
381
382
|
"instance.generateReport",
|
383
|
+
"instance.payloadCounts",
|
382
384
|
"instance.payloadCountsBreakdown",
|
383
385
|
"instance.deviceCounts",
|
384
386
|
"instance.notebookMinuteCounts",
|
@@ -386,6 +388,7 @@
|
|
386
388
|
"instanceOrg.get",
|
387
389
|
"instanceOrg.patch",
|
388
390
|
"instanceOrg.delete",
|
391
|
+
"instanceOrg.payloadCounts",
|
389
392
|
"instanceOrg.payloadCountsBreakdown",
|
390
393
|
"instanceOrg.deviceCounts",
|
391
394
|
"instanceOrg.notebookMinuteCounts",
|
@@ -443,6 +446,10 @@
|
|
443
446
|
"instanceSandbox.get",
|
444
447
|
"instanceSandbox.delete",
|
445
448
|
"instanceSandbox.undelete",
|
449
|
+
"instanceSandbox.payloadCounts",
|
450
|
+
"instanceSandbox.payloadCountsBreakdown",
|
451
|
+
"instanceSandbox.deviceCounts",
|
452
|
+
"instanceSandbox.notebookMinuteCounts",
|
446
453
|
"instanceSandboxes.*",
|
447
454
|
"instanceSandboxes.get",
|
448
455
|
"instanceAuditLog.*",
|
data/schemas/dataExport.json
CHANGED
@@ -376,6 +376,109 @@
|
|
376
376
|
}
|
377
377
|
]
|
378
378
|
},
|
379
|
+
"deletedAt": {
|
380
|
+
"oneOf": [
|
381
|
+
{
|
382
|
+
"type": [
|
383
|
+
"string",
|
384
|
+
"number",
|
385
|
+
"boolean",
|
386
|
+
"null"
|
387
|
+
]
|
388
|
+
},
|
389
|
+
{
|
390
|
+
"type": "object",
|
391
|
+
"properties": {
|
392
|
+
"$eq": {
|
393
|
+
"type": [
|
394
|
+
"string",
|
395
|
+
"number",
|
396
|
+
"boolean",
|
397
|
+
"null"
|
398
|
+
]
|
399
|
+
},
|
400
|
+
"$ne": {
|
401
|
+
"type": [
|
402
|
+
"string",
|
403
|
+
"number",
|
404
|
+
"boolean",
|
405
|
+
"null"
|
406
|
+
]
|
407
|
+
},
|
408
|
+
"$gt": {
|
409
|
+
"type": [
|
410
|
+
"string",
|
411
|
+
"number",
|
412
|
+
"boolean",
|
413
|
+
"null"
|
414
|
+
]
|
415
|
+
},
|
416
|
+
"$lt": {
|
417
|
+
"type": [
|
418
|
+
"string",
|
419
|
+
"number",
|
420
|
+
"boolean",
|
421
|
+
"null"
|
422
|
+
]
|
423
|
+
},
|
424
|
+
"$gte": {
|
425
|
+
"type": [
|
426
|
+
"string",
|
427
|
+
"number",
|
428
|
+
"boolean",
|
429
|
+
"null"
|
430
|
+
]
|
431
|
+
},
|
432
|
+
"$lte": {
|
433
|
+
"type": [
|
434
|
+
"string",
|
435
|
+
"number",
|
436
|
+
"boolean",
|
437
|
+
"null"
|
438
|
+
]
|
439
|
+
},
|
440
|
+
"$startsWith": {
|
441
|
+
"type": "string",
|
442
|
+
"minLength": 1
|
443
|
+
},
|
444
|
+
"$endsWith": {
|
445
|
+
"type": "string",
|
446
|
+
"minLength": 1
|
447
|
+
},
|
448
|
+
"$contains": {
|
449
|
+
"type": "string",
|
450
|
+
"minLength": 1
|
451
|
+
},
|
452
|
+
"$ci": {
|
453
|
+
"type": "boolean"
|
454
|
+
},
|
455
|
+
"$in": {
|
456
|
+
"type": "array",
|
457
|
+
"maxItems": 100,
|
458
|
+
"items": {
|
459
|
+
"type": [
|
460
|
+
"string",
|
461
|
+
"number",
|
462
|
+
"boolean"
|
463
|
+
]
|
464
|
+
}
|
465
|
+
},
|
466
|
+
"$nin": {
|
467
|
+
"type": "array",
|
468
|
+
"maxItems": 100,
|
469
|
+
"items": {
|
470
|
+
"type": [
|
471
|
+
"string",
|
472
|
+
"number",
|
473
|
+
"boolean"
|
474
|
+
]
|
475
|
+
}
|
476
|
+
}
|
477
|
+
},
|
478
|
+
"additionalProperties": false
|
479
|
+
}
|
480
|
+
]
|
481
|
+
},
|
379
482
|
"name": {
|
380
483
|
"oneOf": [
|
381
484
|
{
|
data/schemas/device.json
CHANGED