ReportManager Class

Runs a report synchronously or asynchronously and with or without details.

Reports

Gets instances of reports and describes the metadata of Reports.

The following are methods for ReportManager. All methods are static.

Retrieves report, report type, and extended metadata for a tabular, summary, or matrix report.

public static Reports.ReportDescribeResult describeReport(Id reportId)

  • reportId:

    Type: Id

Type: Reports.ReportDescribeResult

Lists the field data types that you can use to filter the report.

public static MAP<String,LIST<Reports.FilterOperator>> getDatatypeFilterOperatorMap()

Type: Map<String, List<Reports.FilterOperator>>

Retrieves results for an instance of a report that has been run asynchronously. The settings you use when you run your asynchronous report determine whether you can retrieve summary data or detailed data.

public static Reports.ReportInstance getReportInstance(Id instanceId)

  • instanceId:

    Type: Id

Type: Reports.ReportInstance

Returns a list of instances for a report that was run asynchronously. Each item in the list represents a separate instance of the report, with metadata for the time at which the report was run.

public static LIST<Reports.ReportInstance> getReportInstances(Id reportId)

  • reportId:

    Type: Id

Type: List<Reports.ReportInstance>

Runs a report asynchronously with the report ID. Includes details if includeDetails is set to true. Filters the report based on the report metadata in reportMetadata.

public static Reports.ReportInstance runAsyncReport(Id reportId, Reports.ReportMetadata reportMetadata, Boolean includeDetails)

Type: Reports.ReportInstance

Runs a report asynchronously with the report ID. Includes details if includeDetails is set to true.

public static Reports.ReportInstance runAsyncReport(Id reportId, Boolean includeDetails)

  • reportId:

    Type: Id

  • includeDetails:

    Type: Boolean

Type: Reports.ReportInstance

Runs a report asynchronously with the report ID. Filters the results based on the report metadata in reportMetadata.

public static Reports.ReportInstance runAsyncReport(Id reportId, Reports.ReportMetadata reportMetadata)

Type: Reports.ReportInstance

Runs a report asynchronously with the report ID.

public static Reports.ReportInstance runAsyncReport(Id reportId)

  • reportId:

    Type: Id

Type: Reports.ReportInstance

Runs a report immediately with the report ID. Includes details if includeDetails is set to true. Filters the results based on the report metadata in reportMetadata.

public static Reports.ReportResults runReport(Id reportId, Reports.ReportMetadata reportMetadata, Boolean includeDetails)

Type: Reports.ReportResults

Runs a report immediately with the report ID. Includes details if includeDetails is set to true.

public static Reports.ReportResults runReport(Id reportId, Boolean includeDetails)

  • reportId:

    Type: Id

  • includeDetails:

    Type: Boolean

Type: Reports.ReportResults

Runs a report immediately with the report ID. Filters the results based on the report metadata in rmData.

public static Reports.ReportResults runReport(Id reportId, Reports.ReportMetadata reportMetadata)

Type: Reports.ReportResults

Runs a report immediately with the report ID.

public static Reports.ReportResults runReport(Id reportId)

  • reportId:

    Type: Id

Type: Reports.ReportResults