Module: Exports

Included in:
Config
Defined in:
lib/user/config/exports.rb

Instance Method Summary collapse

Instance Method Details

#get_export(id) ⇒ Object

Get export.

Get an export configuration info.

Parameters

id

(Integer) – Export configuration id.

Example

@data = @cxf_user.get_export(10)


28
29
30
 
# File 'lib/user/config/exports.rb', line 28

def get_export(id)
  @client.raw('get', "/config/export/#{id}")
end

#get_export_jobs_using_view_id(id) ⇒ Object

Get export jobs using view id.

Get a collection of export jobs using a view id.

Parameters

id

(Integer) – View id.

Example

@data = @cxf_user.get_export_jobs_using_view_id(10)


40
41
42
 
# File 'lib/user/config/exports.rb', line 40

def get_export_jobs_using_view_id(id)
  @client.raw('get', "/config/export/#{id}/jobs")
end

#get_exports(options = nil) ⇒ Object

Get export.

Get a collection of export.

Parameters

options

(Hash) – List of Resource Collection Options shown above can be used as parameter.

First Example

@data = @cxf_user.get_export

Second Example

options = { sort: 'id' }
@data = @cxf_user.get_export(options)


16
17
18
 
# File 'lib/user/config/exports.rb', line 16

def get_exports(options = nil)
  @client.raw('get', '/config/export', options)
end