ReportExecution

This is the success return type from generateReport, and it contains metadata that uniquely identifies the report generation request, as well as the current status of report generation.

type ReportExecution {
  id: ID!
  reportCode: String!
  reportParameters: JSONObject
  reportTitle: String!
  requestedColumns: [String!]
  status: ReportExecutionStatus!
}

Fields

ReportExecution.id ● ID! non-null scalar

A unique identifier for this report generation request. This value is also passed back to the report query endpoint to retrieve the results for a report.

ReportExecution.reportCode ● String! non-null scalar

The original value for the code that was passed in with the report generation request, which identifies which report was run.

ReportExecution.reportParameters ● JSONObject scalar

The original parameters, if any, passed in to this report generation request.

ReportExecution.reportTitle ● String! non-null scalar

The human-readable descriptive title of this report.

ReportExecution.requestedColumns ● [String!] list scalar

The original requested columns, if specified, for this report generation request.

ReportExecution.status ● ReportExecutionStatus! non-null enum

The current status of the report generation request.

Member Of

Report object

Implemented By

GenerateReportResponse union