Class: Vidispine::API::Client::Requests::Search

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

Constant Summary collapse

HTTP_METHOD = 
:put
HTTP_PATH = 
'search'
PARAMETERS = 
[
    :content,
    :interval,
    :field,
    :group,
    :language,
    :samplerate,
    :track,
    :terse,
    :include,
    :type,
    :tag,
    :scheme,
    :closedFiles,
    'noauth-url',
    :defaultValue,
    :methodType,
    :version,
    :revision,

    { :name => :first, :send_in => :matrix },

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

Constants inherited from BaseRequest

BaseRequest::DEFAULT_PARAMETER_SEND_IN_VALUE, 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

{

"field": [
  {
    "name": "portal_mf48881",
    "value": [
      {
        "value": "something"
      }
    ]
  }
]

}



45
46
47
 
# File 'lib/vidispine/api/client/requests/search.rb', line 45

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

#body_as_xml ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/vidispine/api/client/requests/search.rb', line 49

def body_as_xml
  <<-XML
<ItemSearchDocument xmlns="http://xml.vidispine.com/schema/vidispine">
</ItemDocument>
  XML
end