ReportRun

No description

type ReportRun {
  asOf: DateTimeISO!
  bom: Boolean!
  cancelRequested: Boolean!
  columns: [String!]
  completedAt: DateTimeISO
  createdAt: DateTimeISO!
  csvExport: ReportCsvExport
  error: ReportRunError
  fileExpiresAt: DateTimeISO
  fileId: ID
  format: ReportFormat!
  id: ID!
  manifest: JSONObject
  manifestSha256: String
  params: JSONObject!
  reportId: String!
  reportVersion: Int!
  requestedBy: Identity
  rowCount: Int!
  signoffs: [ReportSignoff!]
  sortKey: String
  startedAt: DateTimeISO
  status: ReportRunStatus!
  timeZone: String!
  truncated: Boolean!
  truncatedBy: ReportTruncation
}

Fields

ReportRun.asOf ● DateTimeISO! non-null scalar

ReportRun.bom ● Boolean! non-null scalar

Whether the stored file starts with a UTF-8 byte-order mark: false for NDJSON.

ReportRun.cancelRequested ● Boolean! non-null scalar

ReportRun.columns ● [String!] list scalar

The exported columns; all of the version's when null.

ReportRun.completedAt ● DateTimeISO scalar

ReportRun.createdAt ● DateTimeISO! non-null scalar

ReportRun.csvExport ● ReportCsvExport object

How the run's CSV is exported, once it succeeded.

ReportRun.error ● ReportRunError object

ReportRun.fileExpiresAt ● DateTimeISO scalar

When the run's file is deleted (a sign-off in progress keeps it longer). Null when it has no file.

ReportRun.fileId ● ID scalar

The run's file, once it succeeded: its rows as NDJSON. Download it at /api/files/{fileId}, or as CSV at /api/files/{fileId}?format=csv when csvExport.mode is STREAM. It expires with the tenant's file retention (see fileExpiresAt).

ReportRun.format ● ReportFormat! non-null enum

The stored file's format: NDJSON for every run since runs stopped storing CSV.

ReportRun.id ● ID! non-null scalar

ReportRun.manifest ● JSONObject scalar

The evidence manifest (ids, parameters, digests), once the run succeeded.

ReportRun.manifestSha256 ● String scalar

ReportRun.params ● JSONObject! non-null scalar

ReportRun.reportId ● String! non-null scalar

ReportRun.reportVersion ● Int! non-null scalar

ReportRun.requestedBy ● Identity object

ReportRun.rowCount ● Int! non-null scalar

ReportRun.signoffs ● [ReportSignoff!] list object

The run's sign-offs, oldest first (null when the viewer can't see them).

ReportRun.sortKey ● String scalar

The declared sort; the report's default order when null.

ReportRun.startedAt ● DateTimeISO scalar

ReportRun.status ● ReportRunStatus! non-null enum

ReportRun.timeZone ● String! non-null scalar

ReportRun.truncated ● Boolean! non-null scalar

ReportRun.truncatedBy ● ReportTruncation enum

What cut a truncated run short.

Returned By

cancelReportRun mutation ● prepareReportCsv mutation ● reportRun query ● runReport mutation ● runSavedReport mutation

Member Of

ReportRunConnection object