Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
AggregateColumn Class
BucketField Class
BucketFieldValue Class
BucketType Enum
ColumnDataType Enum
ColumnSortOrder Enum
CrossFilter Class
CsfGroupType Enum
DateGranularity Enum
DetailColumn Class
Dimension Class
EvaluatedCondition Class
EvaluatedConditionOperator Enum
FilterOperator Class
FilterValue Class
FormulaType Enum
GroupingColumn Class
GroupingInfo Class
GroupingValue Class
NotificationAction Interface
NotificationActionContext Class
ReportCsf Class
ReportCurrency Class
ReportDataCell Class
ReportDescribeResult Class
ReportDetailRow Class
ReportDivisionInfo Class
ReportExtendedMetadata Class
ReportFact Class
ReportFactWithDetails Class
ReportFactWithSummaries Class
ReportFilter Class
ReportFormat Enum
ReportFilterType Enum
ReportInstance Class
ReportInstance Methods
ReportManager Class
ReportMetadata Class
ReportResults Class
ReportScopeInfo Class
ReportScopeValue Class
ReportType Class
ReportTypeColumn Class
ReportTypeColumnCategory Class
ReportTypeMetadata Class
SortColumn Class
StandardDateFilter Class
StandardDateFilterDuration Class
StandardDateFilterDurationGroup Class
StandardFilter Class
StandardFilterInfo Class
StandardFilterInfoPicklist Class
StandardFilterType Enum
SummaryValue Class
ThresholdInformation Class
TopRows Class
Reports Exceptions
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

ReportInstance Class

Returns an instance of a report that was run asynchronously. Retrieves the results for that instance.

Namespace

Reports

ReportInstance Methods

The following are methods for ReportInstance. All are instance methods.

getCompletionDate()

Returns the date and time when the instance of the report finished running. The completion date is available only if the report instance ran successfully or couldn’t be run because of an error. Date and time information is in ISO-8601 format.

Syntax

public Datetime getCompletionDate()

Return Value

Type: Datetime

getId()

Returns the unique ID for an instance of a report that was run asynchronously.

Syntax

public Id getId()

Return Value

Type: Id

getOwnerId()

Returns the ID of the user who created the report instance.

Syntax

public Id getOwnerId()

Return Value

Type: Id

getReportId()

Returns the unique ID of the report this instance is based on.

Syntax

public Id getReportId()

Return Value

Type: Id

getReportResults()

Retrieves results for an instance of an asynchronous report. When you request your report, you can specify whether to summarize data or include details.

Syntax

public Reports.ReportResults getReportResults()

Return Value

Type: Reports.ReportResults

getRequestDate()

Returns the date and time when an instance of the report was run. Date and time information is in ISO-8601 format.

Syntax

public Datetime getRequestDate()

Return Value

Type: Datetime

getStatus()

Returns the status of a report.

Syntax

public String getStatus()

Return Value

Type: String

Usage

  • New if the report run was recently triggered through a request.
  • Success if the report ran.
  • Running if the report is being run.
  • Error if the report run failed. The instance of a report run can return an error if, for example, your permission to access the report was removed after you requested the run.