class LosantRest::Flow
Class containing all the actions for the Flow
Resource
Public Class Methods
# File lib/losant_rest/flow.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Clear all storage entries
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, flow.*, or flow.clearStorageEntries.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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:
-
200 - The current storage entries (api.losant.com/#/definitions/flowStorageEntries)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 56 def clear_storage_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) 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]}/storage" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Deletes a flow
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, flow.*, or flow.delete.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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:
-
200 - If flow was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 102 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) 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]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end
Get information about errors that occurred during runs of this workflow
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, flow.*, or flow.errors.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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} flowVersion -
Flow
version name or ID. When not included, will be errors for all versions. Pass develop for just the develop version. -
{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:
-
200 - Workflow error information (api.losant.com/#/definitions/flowErrors)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 154 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) 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[:flowVersion] = params[:flowVersion] if params.has_key?(:flowVersion) 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]}/errors" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieves information on a flow
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, flow.*, or flow.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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:
-
200 -
Flow
information (api.losant.com/#/definitions/flow)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 207 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) 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]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Retrieve the recent log entries about runs of this workflow
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, flow.*, or flow.log.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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:
-
200 - Recent log entries (api.losant.com/#/definitions/flowLog)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 256 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) 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]}/logs" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Gets the current values in persistent storage
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, flow.*, or flow.getStorageEntries.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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:
-
200 - The current storage entries (api.losant.com/#/definitions/flowStorageEntries)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 304 def get_storage_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) 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]}/storage" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Gets metadata about storage for this flow
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, flow.*, or flow.getStorageEntriesMetadata.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{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:
-
200 - The meta data for the current storage entries (api.losant.com/#/definitions/flowStorageMetadata)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 350 def get_storage_entries_metadata(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) 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]}/storage-metadata" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Updates information about a flow
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, flow.*, or flow.patch.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
-
{hash} flow - Object containing new properties of the flow (api.losant.com/#/definitions/flowPatch)
-
{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:
-
200 - Updated flow information (api.losant.com/#/definitions/flow)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow is not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 398 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("flow is required") unless params.has_key?(:flow) query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes) body = params[:flow] if params.has_key?(:flow) 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]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end
Sets a storage value
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, flow.*, or flow.setStorageEntry.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{hash} entry - Object containing storage entry (api.losant.com/#/definitions/flowStorageEntry)
-
{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:
-
200 - Value was successfully stored (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 497 def set_storage_entry(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("entry is required") unless params.has_key?(:entry) body = params[:entry] if params.has_key?(:entry) 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]}/storage" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end
Get statistics about workflow runs for this workflow
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, flow.*, or flow.stats.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} flowId - ID associated with the flow
-
{string} duration - Duration of time range in milliseconds
-
{string} end - End of time range in milliseconds since epoch
-
{string} resolution - Resolution in milliseconds
-
{string} flowVersion -
Flow
version name or ID. When not included, will be aggregate for all versions. Pass develop for just the develop version. -
{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:
-
200 - Statistics for workflow runs (api.losant.com/#/definitions/flowStats)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if flow was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flow.rb, line 550 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) 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[:flowVersion] = params[:flowVersion] if params.has_key?(:flowVersion) 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]}/stats" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end