Class: PlatformRest::FlowVersion

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/flow_version.rb

Overview

Class containing all the actions for the Flow Version Resource

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ FlowVersion

Returns a new instance of FlowVersion.



30
31
32
 
# File 'lib/platform_rest/flow_version.rb', line 30

def initialize(client)
  @client = client
end

Instance Method Details

#delete(params = {}) ⇒ Object

Deletes a flow version

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.delete.

Parameters:

  • string applicationId - ID associated with the application

  • string flowId - ID associated with the flow

  • string flowVersionId - Version ID or version name associated with the flow version

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/platform_rest/flow_version.rb', line 57

def delete(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)

  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}"

  @client.request(
    method: :delete,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#errors(params = {}) ⇒ Object

Get information about errors that occurred during runs of this workflow version

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.errors.

Parameters:

  • string applicationId - ID associated with the application

  • string flowId - ID associated with the flow

  • string flowVersionId - Version ID or version name associated with the flow version

  • string duration - Duration of time range in milliseconds

  • string end - End of time range in milliseconds since epoch

  • string limit - Maximum number of errors to return

  • string sortDirection - Direction to sort the results by. Accepted values are: asc, desc

  • string deviceId - For edge workflows, the Device ID to return workflow errors for. When not included, will be errors for all device IDs.

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/platform_rest/flow_version.rb', line 110

def errors(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)

  query_params[:duration] = params[:duration] if params.has_key?(:duration)
  query_params[:end] = params[:end] if params.has_key?(:end)
  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection)
  query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/errors"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get(params = {}) ⇒ Object

Retrieves information on a flow version

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.get.

Parameters:

  • string applicationId - ID associated with the application

  • string flowId - ID associated with the flow

  • string flowVersionId - Version ID or version name associated with the flow version

  • string includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/platform_rest/flow_version.rb', line 164

def get(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)

  query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#get_log_entries(params = {}) ⇒ Object

Retrieve the recent log entries about runs of this workflow version

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.log.

Parameters:

  • string applicationId - ID associated with the application

  • string flowId - ID associated with the flow

  • string flowVersionId - Version ID or version name associated with the flow version

  • string limit - Max log entries to return (ordered by time descending)

  • string since - Look for log entries since this time (ms since epoch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/platform_rest/flow_version.rb', line 215

def get_log_entries(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)

  query_params[:limit] = params[:limit] if params.has_key?(:limit)
  query_params[:since] = params[:since] if params.has_key?(:since)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/logs"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#patch(params = {}) ⇒ Object

Updates information about a flow version

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, flowVersion.*, or flowVersion.patch.

Parameters:

  • string applicationId - ID associated with the application

  • string flowId - ID associated with the flow

  • string flowVersionId - Version ID or version name associated with the flow version

  • string includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows

  • hash flowVersion - Object containing new properties of the flow version (api.losant.com/#/definitions/flowVersionPatch)

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/platform_rest/flow_version.rb', line 267

def patch(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)
  raise ArgumentError.new("flowVersion is required") unless params.has_key?(:flowVersion)

  query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes)
  body = params[:flowVersion] if params.has_key?(:flowVersion)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}"

  @client.request(
    method: :patch,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end

#stats(params = {}) ⇒ Object

Get statistics about workflow runs for this workflow version

Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, flowVersion.*, or flowVersion.stats.

Parameters:

  • string applicationId - ID associated with the application

  • string flowId - ID associated with the flow

  • string flowVersionId - Version ID or version name associated with the flow version

  • string duration - Duration of time range in milliseconds

  • string end - End of time range in milliseconds since epoch

  • string resolution - Resolution in milliseconds

  • string deviceId - For edge workflows, the device ID to return workflow stats for. When not included, will be aggregate for all device IDs.

  • string losantdomain - Domain scope of request (rarely needed)

  • boolean _actions - Return resource actions in response

  • boolean _links - Return resource link in response

  • boolean _embedded - Return embedded resources in response

Responses:

Errors:

Raises:

  • (ArgumentError) 


322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/platform_rest/flow_version.rb', line 322

def stats(params = {})
  params = Utils.symbolize_hash_keys(params)
  query_params = { _actions: false, _links: true, _embedded: true }
  headers = {}
  body = nil

  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
  raise ArgumentError.new("flowId is required") unless params.has_key?(:flowId)
  raise ArgumentError.new("flowVersionId is required") unless params.has_key?(:flowVersionId)

  query_params[:duration] = params[:duration] if params.has_key?(:duration)
  query_params[:end] = params[:end] if params.has_key?(:end)
  query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
  query_params[:deviceId] = params[:deviceId] if params.has_key?(:deviceId)
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
  query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)

  path = "/applications/#{params[:applicationId]}/flows/#{params[:flowId]}/versions/#{params[:flowVersionId]}/stats"

  @client.request(
    method: :get,
    path: path,
    query: query_params,
    headers: headers,
    body: body)
end