Class: CtdDocumentation::EventsController

Inherits:
BaseController show all
Defined in:
lib/ctd_documentation/controllers/events_controller.rb

Overview

EventsController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from CtdDocumentation::BaseController

Instance Method Details

#get_events(page: nil, per_page: nil, site_id: nil, id__exact: '3-1', alert_id__exact: '56-1', timestamp__exact: nil, last_updated__exact: nil, description__contains: nil, description__icontains: nil, type__exact: nil, status__exact: nil, sort: nil) ⇒ GetEventsResponse

Get Events the latest change on the Event was made in the EMC. Format: YYYY-MM-DD**T**HH:MM:SS (in UTC) Example: 2022-11-01T16:22:05 eAssetConflict | 2: eBaselineDeviation | 3: eThreat | 4: eAssetInformationChange | 5: eProtocolSpecific 6: eBaselineDown | 8: eBaselineVolumeDeviationHigh | 9: eBaselineVolumeDeviationLow | 10: eFTPData 11: eBaselineRule | 12: eHighArpActivity | 13: eKnownThreatEvent | 14: eFalseMac | 15: eSuspiciousFileTransfer 16: ePolicyViolation | 17: ePolicyRuleMatch | 18: eHostScan | 19: ePortScan | 20: eDenialOfService

Parameters:

  • page (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • per_page (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • site_id (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • id__exact (String) (defaults to: '3-1') —

    Optional parameter: Example:3-1

  • alert_id__exact (String) (defaults to: '56-1') —

    Optional parameter: Example:56-1

  • timestamp__exact (String) (defaults to: nil) —

    Optional parameter: Example:

  • last_updated__exact (String) (defaults to: nil) —

    Optional parameter: The timestamp when

  • description__contains (String) (defaults to: nil) —

    Optional parameter: Example:

  • description__icontains (String) (defaults to: nil) —

    Optional parameter: Example:

  • type__exact (Integer) (defaults to: nil) —

    Optional parameter: 0: eNewAsset | 1:

  • status__exact (StatusExactEnum) (defaults to: nil) —

    Optional parameter: Example:

  • sort (Sort6Enum) (defaults to: nil) —

    Optional parameter: Example:

Returns:



31
32
33
34
35
36
37
38
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
 
# File 'lib/ctd_documentation/controllers/events_controller.rb', line 31

def get_events(page: nil,
               per_page: nil,
               site_id: nil,
               id__exact: '3-1',
               alert_id__exact: '56-1',
               timestamp__exact: nil,
               last_updated__exact: nil,
               description__contains: nil,
               description__icontains: nil,
               type__exact: nil,
               status__exact: nil,
               sort: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/ranger/events',
                                 Server::DEFAULT)
               .query_param(new_parameter(page, key: 'page'))
               .query_param(new_parameter(per_page, key: 'per_page'))
               .query_param(new_parameter(site_id, key: 'site_id'))
               .query_param(new_parameter(id__exact, key: 'id__exact'))
               .query_param(new_parameter(alert_id__exact, key: 'alert_id__exact'))
               .query_param(new_parameter(timestamp__exact, key: 'timestamp__exact'))
               .query_param(new_parameter(last_updated__exact, key: 'last_updated__exact'))
               .query_param(new_parameter(description__contains, key: 'description__contains'))
               .query_param(new_parameter(description__icontains, key: 'description__icontains'))
               .query_param(new_parameter(type__exact, key: 'type__exact'))
               .query_param(new_parameter(status__exact, key: 'status__exact'))
               .query_param(new_parameter(sort, key: 'sort'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('global')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(GetEventsResponse.method(:from_hash)))
    .execute
end