class LosantRest::Flows
Class containing all the actions for the Flows
Resource
Public Class Methods
# File lib/losant_rest/flows.rb, line 30 def initialize(client) @client = client end
Public Instance Methods
Returns the flows for an application
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, flows.*, or flows.get.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
-
{string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
-
{string} page - Which page of results to return
-
{string} perPage - How many items to return per page
-
{string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
-
{string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
-
{string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
-
{hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (api.losant.com/#/definitions/flowTriggerFilter)
-
{string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
-
{hash} query - Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. (api.losant.com/#/definitions/advancedFlowQuery)
-
{string} allVersions - If the request should also return flows with matching versions. Only applicable for requests with an advanced query.
-
{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 - Collection of flows (api.losant.com/#/definitions/flows)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flows.rb, line 66 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) query_params[:sortField] = params[:sortField] if params.has_key?(:sortField) query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection) query_params[:page] = params[:page] if params.has_key?(:page) query_params[:perPage] = params[:perPage] if params.has_key?(:perPage) query_params[:filterField] = params[:filterField] if params.has_key?(:filterField) query_params[:filter] = params[:filter] if params.has_key?(:filter) query_params[:flowClass] = params[:flowClass] if params.has_key?(:flowClass) query_params[:triggerFilter] = params[:triggerFilter] if params.has_key?(:triggerFilter) query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes) query_params[:query] = params[:query] if params.has_key?(:query) query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query) query_params[:allVersions] = params[:allVersions] if params.has_key?(:allVersions) 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" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Returns the flows by version for an application
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, flows.*, or flows.getByVersion.
Parameters:
-
{string} applicationId - ID associated with the application
-
{string} sortField - Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated
-
{string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
-
{string} page - Which page of results to return
-
{string} perPage - How many items to return per page
-
{string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
-
{string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
-
{string} flowClass - Filter the workflows by the given flow class. Accepted values are: edge, cloud, customNode, experience
-
{string} version - Return the workflow versions for the given version.
-
{hash} triggerFilter - Array of triggers to filter by - always filters against default flow version. (api.losant.com/#/definitions/flowTriggerFilter)
-
{string} includeCustomNodes - If the result of the request should also include the details of any custom nodes referenced by the returned workflows
-
{hash} query - Workflow filter JSON object which overrides the filterField, filter, triggerFilter, and flowClass parameters. (api.losant.com/#/definitions/advancedFlowByVersionQuery)
-
{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 - Collection of flow versions (api.losant.com/#/definitions/flowVersions)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flows.rb, line 133 def get_by_version(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("version is required") unless params.has_key?(:version) query_params[:sortField] = params[:sortField] if params.has_key?(:sortField) query_params[:sortDirection] = params[:sortDirection] if params.has_key?(:sortDirection) query_params[:page] = params[:page] if params.has_key?(:page) query_params[:perPage] = params[:perPage] if params.has_key?(:perPage) query_params[:filterField] = params[:filterField] if params.has_key?(:filterField) query_params[:filter] = params[:filter] if params.has_key?(:filter) query_params[:flowClass] = params[:flowClass] if params.has_key?(:flowClass) query_params[:version] = params[:version] if params.has_key?(:version) query_params[:triggerFilter] = params[:triggerFilter] if params.has_key?(:triggerFilter) query_params[:includeCustomNodes] = params[:includeCustomNodes] if params.has_key?(:includeCustomNodes) query_params[:query] = params[:query] if params.has_key?(:query) query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query) 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/version" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end
Import a set of flows and flow versions
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, flows.*, or flows.import.
Parameters:
-
{string} applicationId - ID associated with the application
-
{hash} importData - New flow and flow version information (api.losant.com/#/definitions/flowsImportPost)
-
{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:
-
201 - Successfully imported workflows (api.losant.com/#/definitions/flowsImportResult)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flows.rb, line 191 def import(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("importData is required") unless params.has_key?(:importData) body = params[:importData] if params.has_key?(:importData) 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/import" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end
Create a new flow for an application
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, flows.*, or flows.post.
Parameters:
-
{string} applicationId - ID associated with the application
-
{hash} flow - New flow information (api.losant.com/#/definitions/flowPost)
-
{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:
-
201 - Successfully created flow (api.losant.com/#/definitions/flow)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if application was not found (api.losant.com/#/definitions/error)
# File lib/losant_rest/flows.rb, line 239 def post(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("flow is required") unless params.has_key?(:flow) body = params[:flow] if params.has_key?(:flow) 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" @client.request( method: :post, path: path, query: query_params, headers: headers, body: body) end