class EmassClient::ControlsApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Get control information in a system for one or many controls Returns system control information for matching ‘systemId` path parameter @param system_id **System Id**: The unique system record identifier. @param [Hash] opts the optional parameters @option opts [String] :acronyms Acronym: The system acronym(s) being queried (single value or comma delimited values). (default to PM-6) @return [ControlsResponseGet]

# File lib/emass_client/api/controls_api.rb, line 25
def get_system_controls(system_id, opts = {})
  data, _status_code, _headers = get_system_controls_with_http_info(system_id, opts)
  data
end
get_system_controls_with_http_info(system_id, opts = {}) click to toggle source

Get control information in a system for one or many controls Returns system control information for matching &#x60;systemId&#x60; path parameter @param system_id **System Id**: The unique system record identifier. @param [Hash] opts the optional parameters @option opts [String] :acronyms Acronym: The system acronym(s) being queried (single value or comma delimited values). @return [Array<(ControlsResponseGet, Integer, Hash)>] ControlsResponseGet data, response status code and response headers

# File lib/emass_client/api/controls_api.rb, line 36
def get_system_controls_with_http_info(system_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ControlsApi.get_system_controls ...'
  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 ControlsApi.get_system_controls"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/controls'.sub('{' + 'systemId' + '}', system_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'acronyms'] = opts[:'acronyms'] if !opts[:'acronyms'].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] || 'ControlsResponseGet' 

  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: ControlsApi#get_system_controls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_control_by_system_id(body, system_id, opts = {}) click to toggle source

Update control information in a system for one or many controls

Update a Control for given `systemId`<br>  **Request Body Required Fields** - `acronym` - `responsibleEntities` - `controlDesignation` - `estimatedCompletionDate` - `implementationNarrative`  The following optional fields are required based on the Implementation Status `implementationStatus` value<br> | Value                    | Required Fields |--------------------------|--------------------------------------------------- | Planned  or Implemented  | `estimatedCompletionDate`, `responsibleEntities`, `slcmCriticality`, `slcmFrequency`, `slcmMethod`, `slcmReporting`, `slcmTracking`, `slcmComments` | Not Applicable           | `naJustification`, `responsibleEntities` | Manually Inherited       | `commonControlProvider`, `estimatedCompletionDate`, `responsibleEntities`, `slcmCriticality`, `slcmFrequency`, `slcmMethod`, `slcmReporting`, `slcmTracking`, `slcmComments`  If the Implementation Status `implementationStatus` value is \"Inherited\", only the following fields can be updated:   - `controlDesignation`   - `commonnControlProvider`

@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 [ControlsResponsePut]

# File lib/emass_client/api/controls_api.rb, line 84
def update_control_by_system_id(body, system_id, opts = {})
  data, _status_code, _headers = update_control_by_system_id_with_http_info(body, system_id, opts)
  data
end
update_control_by_system_id_with_http_info(body, system_id, opts = {}) click to toggle source

Update control information in a system for one or many controls

Update a Control for given &#x60;systemId&#x60;&lt;br&gt;  **Request Body Required Fields** - &#x60;acronym&#x60; - &#x60;responsibleEntities&#x60; - &#x60;controlDesignation&#x60; - &#x60;estimatedCompletionDate&#x60; - &#x60;implementationNarrative&#x60;  The following optional fields are required based on the Implementation Status &#x60;implementationStatus&#x60; value&lt;br&gt; | Value                    | Required Fields |--------------------------|--------------------------------------------------- | Planned  or Implemented  | &#x60;estimatedCompletionDate&#x60;, &#x60;responsibleEntities&#x60;, &#x60;slcmCriticality&#x60;, &#x60;slcmFrequency&#x60;, &#x60;slcmMethod&#x60;, &#x60;slcmReporting&#x60;, &#x60;slcmTracking&#x60;, &#x60;slcmComments&#x60; | Not Applicable           | &#x60;naJustification&#x60;, &#x60;responsibleEntities&#x60; | Manually Inherited       | &#x60;commonControlProvider&#x60;, &#x60;estimatedCompletionDate&#x60;, &#x60;responsibleEntities&#x60;, &#x60;slcmCriticality&#x60;, &#x60;slcmFrequency&#x60;, &#x60;slcmMethod&#x60;, &#x60;slcmReporting&#x60;, &#x60;slcmTracking&#x60;, &#x60;slcmComments&#x60;  If the Implementation Status &#x60;implementationStatus&#x60; value is \&quot;Inherited\&quot;, only the following fields can be updated:   - &#x60;controlDesignation&#x60;   - &#x60;commonnControlProvider&#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<(ControlsResponsePut, Integer, Hash)>] ControlsResponsePut data, response status code and response headers

# File lib/emass_client/api/controls_api.rb, line 95
def update_control_by_system_id_with_http_info(body, system_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ControlsApi.update_control_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 ControlsApi.update_control_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 ControlsApi.update_control_by_system_id"
  end
  # resource path
  local_var_path = '/api/systems/{systemId}/controls'.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] || 'ControlsResponsePut' 

  auth_names = opts[:auth_names] || ['apikey', 'mockType', 'userid']
  data, status_code, headers = @api_client.call_api(:PUT, 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: ControlsApi#update_control_by_system_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end