Class: EmassClient::WorkflowDefinitionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/emass_client/api/workflow_definitions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowDefinitionsApi

Returns a new instance of WorkflowDefinitionsApi.



19
20
21
 
# File 'lib/emass_client/api/workflow_definitions_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/emass_client/api/workflow_definitions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_workflow_definitions(opts = {}) ⇒ WorkflowDefinitionResponseGet

Get workflow definitions in a site View all workflow schemas available on the eMASS instance filtered by status ‘includeInactive` and registration type `registrationType`.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_inactive (Boolean) —

    **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. (default to true)

  • :registration_type (String) —

    **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’)

Returns:



28
29
30
31
 
# File 'lib/emass_client/api/workflow_definitions_api.rb', line 28

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 = {}) ⇒ Array<(WorkflowDefinitionResponseGet, Integer, Hash)>

Get workflow definitions in a site View all workflow schemas available on the eMASS instance filtered by status &#x60;includeInactive&#x60; and registration type &#x60;registrationType&#x60;.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_inactive (Boolean) —

    **Include Inactive**: If no value is specified, the default returns false to not include outdated workflow definitions. (default to true)

  • :registration_type (String) —

    **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’)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/emass_client/api/workflow_definitions_api.rb', line 39

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/workflows/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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKey', 'mockType', 'userId']

  new_options = opts.merge(
    :operation => :"WorkflowDefinitionsApi.get_workflow_definitions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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