Skip to main content

ReportDefinition

No description

type ReportDefinition {
answers: [ReportQuestion!]!
area: ReportArea!
columns: [ReportColumn!]!
description: String!
id: String!
paramUi: JSONObject!
paramsSchema: JSONObject!
sorts: [ReportSort!]!
title: String!
version: Int!
}

Fields​

ReportDefinition.answers ● [ReportQuestion!]! non-null object​

ReportDefinition.area ● ReportArea! non-null enum​

ReportDefinition.columns ● [ReportColumn!]! non-null object​

ReportDefinition.description ● String! non-null scalar​

ReportDefinition.id ● String! non-null scalar​

ReportDefinition.paramUi ● JSONObject! non-null scalar​

How the dashboard presents each parameter, by key: a friendlier label and description, labelled choices, numeric presets, or a suggest source for reportParamSuggestions.

ReportDefinition.paramsSchema ● JSONObject! non-null scalar​

The JSON Schema of the report's parameters; the dashboard builds its form from it.

ReportDefinition.sorts ● [ReportSort!]! non-null object​

The orders an export may use; the first is the default. Empty when the report has one fixed order.

ReportDefinition.title ● String! non-null scalar​

ReportDefinition.version ● Int! non-null scalar​

Returned By​

reportCatalog query ● reportDefinition query