Class: Vidispine::API::Client::Requests::ItemExport

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

Overview

See Also:

Constant Summary collapse

HTTP_METHOD = 
:post
HTTP_PATH = 
'/item/#{path_arguments[:item_id]}/export'
DEFAULT_PARAMETER_SEND_IN_VALUE = 
:query
PARAMETERS = 
[
  { :name => :item_id, :send_in => :path },

  :uri,
  :locationName,
  :tag,
  :metadata,
  :projection,
  :start,
  :end,
  :notification,
  :notificationData,
  :priority,
  :jobmetadata,
  :useOriginalFilename,
  :template,
  :allowMissing,

  { :name => :body, :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 



31
32
33
 
# File 'lib/vidispine/api/client/requests/item_export.rb', line 31

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

#body_as_xml ⇒ Object 



35
36
37
38
39
 
# File 'lib/vidispine/api/client/requests/item_export.rb', line 35

def body_as_xml
  <<-XML
<empty/>
  XML
end