Class: CMV4APIClient::GeneralHistorySearchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/api/general_history_search_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GeneralHistorySearchApi 



19
20
21
 
# File 'lib/cmv4-openapi-client/api/general_history_search_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/cmv4-openapi-client/api/general_history_search_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#history_search_get(search_request, opts = {}) ⇒ Action

Get History Search Data Gets the history search data based on the passed request<br/><span style="font-weight: bold;color: red">The HistorySearch feature toggle is required to use this route</span>



27
28
29
30
 
# File 'lib/cmv4-openapi-client/api/general_history_search_api.rb', line 27

def history_search_get(search_request, opts = {})
  data, _status_code, _headers = history_search_get_with_http_info(search_request, opts)
  data
end

#history_search_get_with_http_info(search_request, opts = {}) ⇒ Array<(Action, Integer, Hash)>

Get History Search Data Gets the history search data based on the passed request&lt;br/&gt;&lt;span style&#x3D;&quot;font-weight: bold;color: red&quot;&gt;The HistorySearch feature toggle is required to use this route&lt;/span&gt;



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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/cmv4-openapi-client/api/general_history_search_api.rb', line 37

def history_search_get_with_http_info(search_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GeneralHistorySearchApi.history_search_get ...'
  end
  # verify the required parameter 'search_request' is set
  if @api_client.config.client_side_validation && search_request.nil?
    fail ArgumentError, "Missing the required parameter 'search_request' when calling GeneralHistorySearchApi.history_search_get"
  end
  # resource path
  local_var_path = '/historysearch'

  # 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+action', 'application/json+correspondence', 'application/json+document', 'application/json+event', 'application/json+organisation', 'application/json+project', 'application/json+property', 'application/json+stakeholder', 'application/json+team', 'application/json+user'])
  # 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(search_request)

  # return_type
  return_type = opts[:return_type] || 'Action'

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: GeneralHistorySearchApi#history_search_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end