Method: Colrapi.name_tree

Defined in:
lib/colrapi.rb

.name_tree(dataset_id, import_attempt: nil, verbose: nil) ⇒ Object

Get a text tree of names for a dataset

Parameters:

  • dataset_id (String) —

    The dataset id

  • import_attempt (Integer) (defaults to: nil) —

    The import attempt number



429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/colrapi.rb', line 429

def self.name_tree(dataset_id, import_attempt: nil, verbose: nil)

  # get last import attempt number if none given
  if import_attempt.nil?
    import = self.importer(dataset_id: dataset_id)
    import_attempt = import['attempt']
  end

  endpoint = "dataset/#{dataset_id}/import/#{import_attempt}/tree"
  Request.new(endpoint: endpoint, verbose: verbose).perform
end