Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ReportDefinition

Description of report definition.

Properties

Optional category

category: Category

Specifies the name of the category that this report belongs to.

Optional columnFilters

columnFilters: Array<ColumnFilter>

An array of columnFilter objects. A columnFilter 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.

Optional 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).

Optional 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 complianceStandards

complianceStandards: Array<string>

The list of the data protection regulations/standards used in the report that will help demonstrate compliance.

Optional dataSource

dataSource: model.ReportDefinitionDataSource

Specifies the name of a resource that provides data for the report. For example alerts, events.

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

A description of the report definition.

displayName

displayName: string

Name of the report definition.

Optional displayOrder

displayOrder: undefined | number

Specifies how the report definitions are ordered in the display. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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\"}}

id

id: string

The OCID of the report definition.

Optional isSeeded

isSeeded: undefined | false | true

Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.

lifecycleState

The current state of the report.

Optional parentId

parentId: undefined | string

The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.

Optional recordTimeSpan

recordTimeSpan: undefined | string

The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced:

  1. period = H (The allowed range for period-value is [1, 23])
  2. period = D (The allowed range for period-value is [1, 30])
  3. period = M (The allowed range for period-value is [1, 11])
  4. period = Y (The minimum period-value is 1)

Optional schedule

schedule: undefined | string

The schedule to generate the report periodically in the specified format: ;

Allowed version strings - \"v1\" v1's version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) 4. can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is '*'. When not, day of week must equal the given value 5. can be either '*' (without quotes or a number between 1 and 28) No constraint introduced when it is '*'. When not, day of month must equal the given value

Optional scheduledReportCompartmentId

scheduledReportCompartmentId: undefined | string

The OCID of the compartment in which the scheduled resource will be created.

Optional scheduledReportMimeType

scheduledReportMimeType: ScheduledReportMimeType

Specifies the format of the report ( either .xls or .pdf )

Optional scheduledReportName

scheduledReportName: undefined | string

The name of the report to be scheduled.

Optional scheduledReportRowLimit

scheduledReportRowLimit: undefined | number

Specifies the limit on the number of rows in the report. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional scimFilter

scimFilter: undefined | string

Additional SCIM filters used to define the report.

Optional 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).

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

Specifies the date and time the report definition was created.

Optional timeUpdated

timeUpdated: Date

The date and time the report definition was updated.

Functions

getDeserializedJsonObj

getJsonObj