Class: EmassClient::TestResultsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TestResultsApi

Returns a new instance of TestResultsApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_test_results_by_system_id(system_id, request_body, opts = {}) ⇒ TestResultsResponsePost

Add one or many test results in a system Adds test results for given ‘systemId` **Request Body Required Fields** - `cci` - `testedBy` - `testDate` - `description` - `complianceStatus`

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • request_body (Array<Object>) —

    Add test results to a system (systemId)

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

    the optional parameters

Returns:



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

def add_test_results_by_system_id(system_id, request_body, opts = {})
  data, _status_code, _headers = add_test_results_by_system_id_with_http_info(system_id, request_body, opts)
  data
end

#add_test_results_by_system_id_with_http_info(system_id, request_body, opts = {}) ⇒ Array<(TestResultsResponsePost, Integer, Hash)>

Add one or many test results in a system Adds test results for given &#x60;systemId&#x60; **Request Body Required Fields** - &#x60;cci&#x60; - &#x60;testedBy&#x60; - &#x60;testDate&#x60; - &#x60;description&#x60; - &#x60;complianceStatus&#x60;

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

  • request_body (Array<Object>) —

    Add test results to a system (systemId)

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

    the optional parameters

Returns:

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

    TestResultsResponsePost data, response status code and response headers



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

def add_test_results_by_system_id_with_http_info(system_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TestResultsApi.add_test_results_by_system_id ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling TestResultsApi.add_test_results_by_system_id"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling TestResultsApi.add_test_results_by_system_id"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', CGI.escape(system_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'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)

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

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

  new_options = opts.merge(
    :operation => :"TestResultsApi.add_test_results_by_system_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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TestResultsApi#add_test_results_by_system_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_system_test_results(system_id, opts = {}) ⇒ TestResultsResponseGet

Get one or many test results in a system Returns system test results information for matching parameters.

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

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

    the optional parameters

Options Hash (opts):

  • :control_acronyms (String) —

    **System Acronym**: Filter query by given system acronym (single or comma separated).

  • :ccis (String) —

    **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single or comma separated).

  • :latest_only (Boolean) —

    **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). (default to true)

Returns:



104
105
106
107
 
# File 'lib/emass_client/api/test_results_api.rb', line 104

def get_system_test_results(system_id, opts = {})
  data, _status_code, _headers = get_system_test_results_with_http_info(system_id, opts)
  data
end

#get_system_test_results_with_http_info(system_id, opts = {}) ⇒ Array<(TestResultsResponseGet, Integer, Hash)>

Get one or many test results in a system Returns system test results information for matching parameters.&lt;br&gt;

Parameters:

  • system_id (Integer) —

    **System Id**: The unique system record identifier.

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

    the optional parameters

Options Hash (opts):

  • :control_acronyms (String) —

    **System Acronym**: Filter query by given system acronym (single or comma separated).

  • :ccis (String) —

    **CCI System**: Filter query by Control Correlation Identifiers (CCIs) (single or comma separated).

  • :latest_only (Boolean) —

    **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). (default to true)

Returns:

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

    TestResultsResponseGet data, response status code and response headers



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
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/emass_client/api/test_results_api.rb', line 117

def get_system_test_results_with_http_info(system_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TestResultsApi.get_system_test_results ...'
  end
  # verify the required parameter 'system_id' is set
  if @api_client.config.client_side_validation && system_id.nil?
    fail ArgumentError, "Missing the required parameter 'system_id' when calling TestResultsApi.get_system_test_results"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', CGI.escape(system_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'controlAcronyms'] = opts[:'control_acronyms'] if !opts[:'control_acronyms'].nil?
  query_params[:'ccis'] = opts[:'ccis'] if !opts[:'ccis'].nil?
  query_params[:'latestOnly'] = opts[:'latest_only'] if !opts[:'latest_only'].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] || 'TestResultsResponseGet'

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

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