Class: EmassClient::ControlsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ControlsApi

Returns a new instance of ControlsApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_system_controls(system_id, opts = {}) ⇒ ControlsResponseGet

Get control information in a system for one or many controls Returns system control information for matching ‘systemId` path parameter

Parameters:

  • system_id (Integer) —

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

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

    the optional parameters

Options Hash (opts):

  • :acronyms (String) —

    Acronym: The system acronym(s) being queried (single value or comma delimited values). (default to ‘PM-6’)

Returns:



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

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

Get control information in a system for one or many controls Returns system control information for matching &#x60;systemId&#x60; path parameter

Parameters:

  • system_id (Integer) —

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

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

    the optional parameters

Options Hash (opts):

  • :acronyms (String) —

    Acronym: The system acronym(s) being queried (single value or comma delimited values). (default to ‘PM-6’)

Returns:

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

    ControlsResponseGet 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
 
# File 'lib/emass_client/api/controls_api.rb', line 39

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' + '}', CGI.escape(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[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"ControlsApi.get_system_controls",
    :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: 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(system_id, request_body, opts = {}) ⇒ ControlsResponsePut

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`

Parameters:

  • system_id (Integer) —

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

  • request_body (Array<Object>) —

    Update an existing control by Id

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/emass_client/api/controls_api.rb', line 94

def update_control_by_system_id(system_id, request_body, opts = {})
  data, _status_code, _headers = update_control_by_system_id_with_http_info(system_id, request_body, opts)
  data
end

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

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 &#x60;Inherited&#x60;, only the following fields can be updated:   - &#x60;controlDesignation&#x60;   - &#x60;commonnControlProvider&#x60;

Parameters:

  • system_id (Integer) —

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

  • request_body (Array<Object>) —

    Update an existing control by Id

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

    the optional parameters

Returns:

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

    ControlsResponsePut data, response status code and response headers



105
106
107
108
109
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
157
158
159
160
 
# File 'lib/emass_client/api/controls_api.rb', line 105

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

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

  new_options = opts.merge(
    :operation => :"ControlsApi.update_control_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(:PUT, local_var_path, new_options)
  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