Class: CtdDocumentation::ActivitiesController

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

Overview

ActivitiesController

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_activities(page: nil, per_page: nil, alert_id__exact: nil, asset_reference__exact: nil, baseline__exact: nil, site__exact: nil, asset__exact: nil, message__exact: nil, comment__exact: nil, id__exact: nil, site_id__exact: nil, type__exact: nil, timestamp__exact: nil, user_id__exact: nil, sort: nil) ⇒ ActivitiesResponse

Get Activities descending order

Parameters:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Example:

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

    Optional parameter: Sort order: add - for

Returns:



27
28
29
30
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
66
67
 
# File 'lib/ctd_documentation/controllers/activities_controller.rb', line 27

def get_activities(page: nil,
                   per_page: nil,
                   alert_id__exact: nil,
                   asset_reference__exact: nil,
                   baseline__exact: nil,
                   site__exact: nil,
                   asset__exact: nil,
                   message__exact: nil,
                   comment__exact: nil,
                   id__exact: nil,
                   site_id__exact: nil,
                   type__exact: nil,
                   timestamp__exact: nil,
                   user_id__exact: nil,
                   sort: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/ranger/activities',
                                 Server::DEFAULT)
               .query_param(new_parameter(page, key: 'page'))
               .query_param(new_parameter(per_page, key: 'per_page'))
               .query_param(new_parameter(alert_id__exact, key: 'alert_id__exact'))
               .query_param(new_parameter(asset_reference__exact, key: 'asset_reference__exact'))
               .query_param(new_parameter(baseline__exact, key: 'baseline__exact'))
               .query_param(new_parameter(site__exact, key: 'site__exact'))
               .query_param(new_parameter(asset__exact, key: 'asset__exact'))
               .query_param(new_parameter(message__exact, key: 'message__exact'))
               .query_param(new_parameter(comment__exact, key: 'comment__exact'))
               .query_param(new_parameter(id__exact, key: 'id__exact'))
               .query_param(new_parameter(site_id__exact, key: 'site_id__exact'))
               .query_param(new_parameter(type__exact, key: 'type__exact'))
               .query_param(new_parameter(timestamp__exact, key: 'timestamp__exact'))
               .query_param(new_parameter(user_id__exact, key: 'user_id__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(ActivitiesResponse.method(:from_hash)))
    .execute
end