Module: BWAPI::Client::Projects::DataDownload

Included in:
BWAPI::Client::Projects
Defined in:
lib/bwapi/client/projects/data_download.rb

Overview

DataDownload module for projects/datadownload endpoints

Instance Method Summary collapse

Instance Method Details

#create_data_download(project_id, opts = {}) ⇒ Hashie::Mash

Create a new data download in project

Parameters:

  • project_id (Integer) —

    Id of project

  • opts (Hash) (defaults to: {}) —

    options hash of parameters

Options Hash (opts):

  • id (Integer) —

    Id of the data download

  • queryId (Integer) —

    Id of the query

  • userId (Integer) —

    Id of the user

  • percentComplete (Int) —

    The percentage complete of data download

  • status (String) —

    The status of the download

  • queryName (String) —

    The query name of the data download

  • endDate (Date) —

    The end date of the data download

  • requestDate (Date) —

    The request date of the data download

  • downloadLinkXLS (String) —

    The link to download the XLS format

  • downloadLinkCSV (String) —

    The link to download the CSV format

  • additionalColumns (Array) —

    The additional columns for the data download

Returns:

  • (Hashie::Mash) —

    New data download



43
44
45
 
# File 'lib/bwapi/client/projects/data_download.rb', line 43

def create_data_download(project_id, opts = {})
  post "projects/#{project_id}/datadownload", opts
end

#data_downloads(project_id, opts = {}) ⇒ Hashie::Mash

Get all data downloads in project

Parameters:

  • project_id (Integer) —

    Id of project

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • page (Integer) —

    Page of projects to retrieve

  • pageSize (Integer) —

    Results per page of results

Returns:

  • (Hashie::Mash) —

    All data downloads in project



14
15
16
 
# File 'lib/bwapi/client/projects/data_download.rb', line 14

def data_downloads(project_id, opts = {})
  get "projects/#{project_id}/datadownload", opts
end

#get_data_download(project_id, data_download_id) ⇒ Hashie::Mash

Get a specific data download in project

Parameters:

  • project_id (Integer) —

    Id of project

  • data_download_id (Integer) —

    Id of data download

Returns:

  • (Hashie::Mash) —

    Specific data download



23
24
25
 
# File 'lib/bwapi/client/projects/data_download.rb', line 23

def get_data_download(project_id, data_download_id)
  get "projects/#{project_id}/datadownload/#{data_download_id}"
end