Class: Vidispine::API::Client::Requests::ItemsSearch

Inherits:
BaseRequest
  • Object
show all
Defined in:
lib/vidispine/api/client/requests/items_search.rb

Overview

See Also:

Constant Summary collapse

HTTP_METHOD = 
:put
HTTP_PATH = 
'/item'
DEFAULT_PARAMETER_SEND_IN_VALUE = 
:matrix
PARAMETERS = 
[
    { :name => :result, :send_in => :query },
    { :name => :content, :send_in => :query },


    :library,
    :first,
    :number,
    :libraryId,
    :autoRefresh,
    :updateMode,
    :updateFrequency,

    { :name => :ItemSearchDocument, :send_in => :body }
]

Constants inherited from BaseRequest

BaseRequest::HTTP_BASE_PATH, BaseRequest::HTTP_SUCCESS_CODE

Instance Attribute Summary

Attributes inherited from BaseRequest

#arguments, #client, #default_parameter_send_in_value, #initial_arguments, #missing_required_arguments, #options, #parameters, #path, #processed_parameters, #query

Instance Method Summary collapse

Methods inherited from BaseRequest

#after_initialize, #after_process_parameters, #base_path, #before_process_parameters, #body_arguments, #eval_http_path?, #http_method, #http_path, #http_success_code, #initialize, #matrix, #matrix_arguments, normalize_argument_hash_keys, normalize_parameter_name, #path_arguments, #path_only, process_parameter, #process_parameters, process_parameters, #query_arguments, #reset_attributes, #success?, #uri_request_path

Constructor Details

This class inherits a constructor from Vidispine::API::Client::Requests::BaseRequest

Instance Method Details

#body ⇒ Object 



26
27
28
 
# File 'lib/vidispine/api/client/requests/items_search.rb', line 26

def body
  @body ||= arguments[:ItemSearchDocument]
end

#body_as_xml ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/vidispine/api/client/requests/items_search.rb', line 30

def body_as_xml
  "<ItemSearchDocument xmlns=\"http://xml.vidispine.com/schema/vidispine\">\n</ItemSearchDocument>\n  XML\nend\n"