Method: PortfolioManager::Services::Reporting::CustomReportingReportManagement::Live#get_report_status

Defined in:
lib/portfolio_manager/services/reporting.rb

#get_report_status(report_id) ⇒ PortfolioManager::Xml::ReportStatusDef, PortfolioManager::Xml::ResponseType

Get Report Status

This web service returns information on the status of the report. The report must be owned by you.

The following are valid statuses:

  • INITIALIZED - Indicates that the report was initially created or its configuration (i.e., timeframe, properties, metrics, etc.) has been updated.

  • SUBMITTED - Indicates that the report has been submitted for generation and is waiting to be generated.

  • IN_PROCESS - Indicates that the report is currently being generated.

  • FAILED - Indicates that the report encountered an unknown error during the generation step.

  • GENERATED - Indicates that report has completed generation and is available for download.

Parameters:

  • report_id (Integer)

Returns:

Raises:

See Also:



266
267
268
 
# File 'lib/portfolio_manager/services/reporting.rb', line 266

def get_report_status(report_id)
  request(Net::HTTP::Get, path_for("reports", report_id, "status"), {}, {}, nil, nil, PortfolioManager::Xml::ReportStatusDef, basic_auth: true)
end