Class: EmassClient::WorkflowInstancesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkflowInstancesApi

Returns a new instance of WorkflowInstancesApi.



19
20
21
 
# File 'lib/emass_client/api/workflow_instances_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_instances_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_system_workflow_instances(opts = {}) ⇒ WorkflowInstancesResponseGet

Get workflow instances in a site View detailed information on all active and historical workflows filtered by provided parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_comments (Boolean) —

    **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization. (default to true)

  • :page_index (Integer) —

    **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. Note: Pages contain 1000 workflow instances. (default to 0)

  • :since_date (String) —

    Date: Filter on authorization/assessment date (Unix date format). Note: Filters off the lastEditedDate field. Note: The authorization/assessment decisions on completed workflows can be edited for up to 30 days after the initial decision is made.

  • :status (String) —

    Status: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active. (default to ‘all’)

Returns:



30
31
32
33
 
# File 'lib/emass_client/api/workflow_instances_api.rb', line 30

def get_system_workflow_instances(opts = {})
  data, _status_code, _headers = get_system_workflow_instances_with_http_info(opts)
  data
end

#get_system_workflow_instances_by_workflow_instance_id(workflow_instance_id, opts = {}) ⇒ WorkflowInstanceResponseGet

Get workflow instance by ID View detailed historical workflow information for ‘workflowInstanceId`.

Parameters:

  • workflow_instance_id (Integer) —

    **Workflow Instance Id**: The unique workflow definition identifier.

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

    the optional parameters

Returns:



100
101
102
103
 
# File 'lib/emass_client/api/workflow_instances_api.rb', line 100

def get_system_workflow_instances_by_workflow_instance_id(workflow_instance_id, opts = {})
  data, _status_code, _headers = get_system_workflow_instances_by_workflow_instance_id_with_http_info(workflow_instance_id, opts)
  data
end

#get_system_workflow_instances_by_workflow_instance_id_with_http_info(workflow_instance_id, opts = {}) ⇒ Array<(WorkflowInstanceResponseGet, Integer, Hash)>

Get workflow instance by ID View detailed historical workflow information for &#x60;workflowInstanceId&#x60;.

Parameters:

  • workflow_instance_id (Integer) —

    **Workflow Instance Id**: The unique workflow definition identifier.

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

    the optional parameters

Returns:

  • (Array<(WorkflowInstanceResponseGet, Integer, Hash)>) —

    WorkflowInstanceResponseGet data, response status code and response headers



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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/emass_client/api/workflow_instances_api.rb', line 110

def get_system_workflow_instances_by_workflow_instance_id_with_http_info(workflow_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id ...'
  end
  # verify the required parameter 'workflow_instance_id' is set
  if @api_client.config.client_side_validation && workflow_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'workflow_instance_id' when calling WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id"
  end
  # resource path
  local_var_path = '/api/workflows/instances/{workflowInstanceId}'.sub('{' + 'workflowInstanceId' + '}', CGI.escape(workflow_instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # 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] || 'WorkflowInstanceResponseGet'

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

  new_options = opts.merge(
    :operation => :"WorkflowInstancesApi.get_system_workflow_instances_by_workflow_instance_id",
    :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: WorkflowInstancesApi#get_system_workflow_instances_by_workflow_instance_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_system_workflow_instances_with_http_info(opts = {}) ⇒ Array<(WorkflowInstancesResponseGet, Integer, Hash)>

Get workflow instances in a site View detailed information on all active and historical workflows filtered by provided parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_comments (Boolean) —

    **Include Comments**: If no value is specified, the default returns true to not include transition comments. Note: Corresponds to the Comments textbox that is required at most workflow transitions. Does not include other text input fields such as Terms / Conditions for Authorization. (default to true)

  • :page_index (Integer) —

    **Page Index**: If no value is specified, the default returns results from the first page with an index of 0. Note: Pages contain 1000 workflow instances. (default to 0)

  • :since_date (String) —

    Date: Filter on authorization/assessment date (Unix date format). Note: Filters off the lastEditedDate field. Note: The authorization/assessment decisions on completed workflows can be edited for up to 30 days after the initial decision is made.

  • :status (String) —

    Status: Filter by status. If no value is specified, the default returns all to include both active and inactive workflows. Note: Any workflows at a current stage of Complete or Cancelled are inactive. Ongoing workflows currently at other stages are active. (default to ‘all’)

Returns:



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
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/emass_client/api/workflow_instances_api.rb', line 43

def get_system_workflow_instances_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkflowInstancesApi.get_system_workflow_instances ...'
  end
  allowable_values = ["active", "inactive", "all", "unknown_default_open_api"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/workflows/instances'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'includeComments'] = opts[:'include_comments'] if !opts[:'include_comments'].nil?
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'sinceDate'] = opts[:'since_date'] if !opts[:'since_date'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'WorkflowInstancesResponseGet'

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

  new_options = opts.merge(
    :operation => :"WorkflowInstancesApi.get_system_workflow_instances",
    :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: WorkflowInstancesApi#get_system_workflow_instances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end