class EmassClient::TestResultsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

add_test_results_by_system_id(body, system_id, opts = {}) click to toggle source

Add one or many test results in a system Adds test results for given ‘systemId` **Request Body Required Fields** - `cci` - `testedBy` - `testDate` - `description` - `complianceStatus` @param body Update an existing control by Id @param system_id **System Id**: The unique system record identifier. @param [Hash] opts the optional parameters @return [TestResultsResponsePost]

# File lib/emass_client/api/test_results_api.rb, line 25
def add_test_results_by_system_id(body, system_id, opts = {})
  data, _status_code, _headers = add_test_results_by_system_id_with_http_info(body, system_id, opts)
  data
end
add_test_results_by_system_id_with_http_info(body, system_id, opts = {}) click to toggle source

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; @param body Update an existing control by Id @param system_id **System Id**: The unique system record identifier. @param [Hash] opts the optional parameters @return [Array<(TestResultsResponsePost, Integer, Hash)>] TestResultsResponsePost data, response status code and response headers

# File lib/emass_client/api/test_results_api.rb, line 36
def add_test_results_by_system_id_with_http_info(body, system_id, 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 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling 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
  # resource path
  local_var_path = '/api/systems/{systemId}/test-results'.sub('{' + 'systemId' + '}', 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
  data, status_code, headers = @api_client.call_api(:POST, 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: 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 = {}) click to toggle source

Get one or many test results in a system Returns system test results information for matching parameters.
@param system_id **System Id**: The unique system record identifier. @param [Hash] opts the optional parameters @option opts [String] :control_acronyms **System Acronym**: Filter query by given system acronym (single or comma separated). @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs). @option opts [BOOLEAN] :latest_only **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). (default to true) @return [TestResultsResponseGet]

# File lib/emass_client/api/test_results_api.rb, line 91
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 = {}) click to toggle source

Get one or many test results in a system Returns system test results information for matching parameters.&lt;br&gt; @param system_id **System Id**: The unique system record identifier. @param [Hash] opts the optional parameters @option opts [String] :control_acronyms **System Acronym**: Filter query by given system acronym (single or comma separated). @option opts [String] :ccis **CCI System**: Filter query by Control Correlation Identifiers (CCIs). @option opts [BOOLEAN] :latest_only **Latest Results Only**: Indicates that only the latest test resultes are retrieved (single or comma separated). @return [Array<(TestResultsResponseGet, Integer, Hash)>] TestResultsResponseGet data, response status code and response headers

# File lib/emass_client/api/test_results_api.rb, line 104
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' + '}', 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[:body] 

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

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