class EmassClient::WorkflowDefinitionsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/emass_client/api/workflow_definitions_api.rb, line 16
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_workflow_definitions(opts = {}) click to toggle source

Get workflow definitions in a site View all workflow schemas available on the eMASS instance filtered by status ‘includeInactive` and registration type `registrationType`. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_inactive **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. (default to true) @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider (default to regular) @return [WorkflowDefinitionResponseGet]

# File lib/emass_client/api/workflow_definitions_api.rb, line 25
def get_workflow_definitions(opts = {})
  data, _status_code, _headers = get_workflow_definitions_with_http_info(opts)
  data
end
get_workflow_definitions_with_http_info(opts = {}) click to toggle source

Get workflow definitions in a site View all workflow schemas available on the eMASS instance filtered by status `includeInactive` and registration type `registrationType`. @param [Hash] opts the optional parameters @option opts [BOOLEAN] :include_inactive **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. @option opts [String] :registration_type **Registration Type**: Filter record by selected registration type (single value or comma delimited values). *Available values:* assessAndAuthorize, assessOnly, guest, regular, functional, cloudServiceProvider, commonControlProvider

@return [Array<(WorkflowDefinitionResponseGet, Integer, Hash)>] WorkflowDefinitionResponseGet data, response status code and response headers

# File lib/emass_client/api/workflow_definitions_api.rb, line 36
def get_workflow_definitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowDefinitionsApi.get_workflow_definitions ...'
  end
  # resource path
  local_var_path = '/api/workflow-definitions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeInactive'] = opts[:'include_inactive'] if !opts[:'include_inactive'].nil?
  query_params[:'registrationType'] = opts[:'registration_type'] if !opts[:'registration_type'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'WorkflowDefinitionResponseGet' 

  auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: WorkflowDefinitionsApi#get_workflow_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end