ReportDefinition

Represents the report definition object

type ReportDefinition {
  id: UUID!
  name: String!
  description: String
  query: String!
  createdBy: UUID!
  updatedBy: UUID!
  creationDate: DateTime
  modificationDate: DateTime
  lastReportInformation: ReportInformation
  wasExecuted: Boolean!
  isDownloadable: Boolean!
  notificationRouter: NotificationRouter
  schedule: ReportSchedule
  nextRun: DateTime
}

Fields

ReportDefinition.id ● UUID! non-null scalar

The report definition unique identifier.

ReportDefinition.name ● String! non-null scalar

The report name.

ReportDefinition.description ● String scalar

The report description.

ReportDefinition.query ● String! non-null scalar

The query to be run for generating the report.

ReportDefinition.createdBy ● UUID! non-null scalar

User ID representing the user who created the report.

ReportDefinition.updatedBy ● UUID! non-null scalar

User ID representing the user who updated the report.

ReportDefinition.creationDate ● DateTime scalar

The creation date of the report definition.

ReportDefinition.modificationDate ● DateTime scalar

The date the report was last modified.

ReportDefinition.lastReportInformation ● ReportInformation object

Information regarding the report's last run if any.

ReportDefinition.wasExecuted ● Boolean! non-null scalar

Provides the necessary information to know if the report was executed at least once

ReportDefinition.isDownloadable ● Boolean! non-null scalar

Provides the necessary information to know if there is a downloadable report

ReportDefinition.notificationRouter ● NotificationRouter object

Notification router associated with the report

ReportDefinition.schedule ● ReportSchedule object

The schedule for the report

ReportDefinition.nextRun ● DateTime scalar

Next run date for the report (if scheduled)

Returned By

createReportDefinition mutation ● reportDefinition query ● updateReportDefinition mutation

Member Of

ReportDefinitionConnection object ● ReportDefinitionEdge object