module BWAPI::Client::Projects::DataDownload
DataDownload
module for projects/datadownload endpoints
Public Instance Methods
Create a new data download in project
@param project_id [Integer] Id of project @param opts [Hash] options hash of parameters @option opts [Integer] id Id of the data download @option opts [Integer] queryId Id of the query @option opts [Integer] userId Id of the user @option opts [Int] percentComplete The percentage complete of data download @option opts [String] status The status of the download @option opts [String] queryName The query name of the data download @option opts [Date] endDate The end date of the data download @option opts [Date] requestDate The request date of the data download @option opts [String] downloadLinkXLS The link to download the XLS format @option opts [String] downloadLinkCSV The link to download the CSV format @option opts [Array] additionalColumns The additional columns for the data download @return [Hash] New data download
# File lib/bwapi/client/projects/data_download.rb, line 41 def create_data_download(project_id, opts = {}) post "projects/#{project_id}/datadownload", opts end
Get all data downloads in project
@param project_id [Integer] Id of project @option opts [Integer] page Page of projects to retrieve @option opts [Integer] pageSize Results per page of results @return [Hash] All data downloads in project
# File lib/bwapi/client/projects/data_download.rb, line 12 def data_downloads(project_id, opts = {}) get "projects/#{project_id}/datadownload", opts end
Get a specific data download in project
@param project_id [Integer] Id of project @param download_id [Integer] Id of data download @return [Hash] Specific data download
# File lib/bwapi/client/projects/data_download.rb, line 21 def get_data_download(project_id, download_id) get "projects/#{project_id}/datadownload/#{download_id}" end