Class: EmassClient::SystemFISMAMetricsDashboardApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SystemFISMAMetricsDashboardApi

Returns a new instance of SystemFISMAMetricsDashboardApi.



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

def api_client
  @api_client
end

Instance Method Details

#get_system_fisma_metrics(org_id, opts = {}) ⇒ GetSystemStatusDetails200Response

System FISMA Metrics Get system FISMA metrics dashboard information.

Parameters:

  • org_id (Integer) —

    **Organization Id**: The unique organization identifier.

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

    the optional parameters

Options Hash (opts):

  • :excludeinherited (Boolean) —

    **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)

  • :page_index (Integer) —

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

  • :page_size (Integer) —

    **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)

Returns:



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

def get_system_fisma_metrics(org_id, opts = {})
  data, _status_code, _headers = get_system_fisma_metrics_with_http_info(org_id, opts)
  data
end

#get_system_fisma_metrics_with_http_info(org_id, opts = {}) ⇒ Array<(GetSystemStatusDetails200Response, Integer, Hash)>

System FISMA Metrics Get system FISMA metrics dashboard information.

Parameters:

  • org_id (Integer) —

    **Organization Id**: The unique organization identifier.

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

    the optional parameters

Options Hash (opts):

  • :excludeinherited (Boolean) —

    **Exclude Inherited**: If no value is specified, the default returns false to include inherited data. (default to false)

  • :page_index (Integer) —

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

  • :page_size (Integer) —

    **Page Size**: If no value is specified, the default returns 20000 per page. (default to 20000)

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/system_fisma_metrics_dashboard_api.rb', line 43

def get_system_fisma_metrics_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemFISMAMetricsDashboardApi.get_system_fisma_metrics ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling SystemFISMAMetricsDashboardApi.get_system_fisma_metrics"
  end
  # resource path
  local_var_path = '/api/dashboards/system-fisma-metrics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'orgId'] = org_id
  query_params[:'excludeinherited'] = opts[:'excludeinherited'] if !opts[:'excludeinherited'].nil?
  query_params[:'pageIndex'] = opts[:'page_index'] if !opts[:'page_index'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

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