Module: Agilix::Buzz::Commands::Report

Included in:
Api
Defined in:
lib/agilix/buzz/commands/report.rb

Instance Method Summary collapse

Instance Method Details

#get_report_info(options = {}) ⇒ Object

slightly more info than get_runnable_report_list api.get_report_info reportid: 123



22
23
24
25
 
# File 'lib/agilix/buzz/commands/report.rb', line 22

def get_report_info(options = {})
  options = argument_cleaner(required_params: %i( reportid ), optional_params: %i( ), options: options )
  authenticated_get cmd: "getreportinfo", **options
end

#get_report_list(options = {}) ⇒ Object

This call seems worthless, and we don’t seem to have rights api.get_report_list domainid: 1



29
30
31
32
 
# File 'lib/agilix/buzz/commands/report.rb', line 29

def get_report_list(options = {})
  options = argument_cleaner(required_params: %i( domainid ), optional_params: %i( ), options: options )
  authenticated_get cmd: "getreportlist", **options
end

#get_runnable_report_list(options = {}) ⇒ Object

Use this one to find reports you can run api.get_runnable_report_list domainid: 57025



8
9
10
11
 
# File 'lib/agilix/buzz/commands/report.rb', line 8

def get_runnable_report_list(options = {})
  options = argument_cleaner(required_params: %i( ), optional_params: %i( entityid domainid ), options: options )
  authenticated_get cmd: "getrunnablereportlist", **options
end

#run_report(options = {}) ⇒ Object

Use this one to run a report api.run_report reportid: 127, entityid: 57025



15
16
17
18
 
# File 'lib/agilix/buzz/commands/report.rb', line 15

def run_report(options = {})
  options = argument_cleaner(required_params: %i( reportid entityid ), optional_params: %i( format content_disposition nodata AsOf), options: options )
  authenticated_get cmd: "runreport", **options
end