Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateReportDefinitionDetails

Description of a new report definition.

Properties

columnFilters

columnFilters: Array<ColumnFilter>

An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.

columnInfo

columnInfo: Array<Column>

An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).

columnSortings

columnSortings: Array<ColumnSorting>

An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.

compartmentId

compartmentId: string

The OCID of the compartment containing the report definition.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional description

description: undefined | string

The description of the report definition.

displayName

displayName: string

Specifies the name of the report definition.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {@code {\"Department\": \"Finance\"}}

parentId

parentId: string

The OCID of the parent report definition.

summary

summary: Array<Summary>

An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).

Functions

getDeserializedJsonObj

getJsonObj