Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RecordAnalyticsAggregation

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize record information for a given dataset and are used to populate UI elements. Aggregations need to have the fields that identify the exact scope that they're summarizing. Any filters applied to the list API, have to show up in the aggregation.

Properties

compartmentId

compartmentId: string

ocid of the compartment the records

count

count: number

the count of the matching results Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

datasetId

datasetId: string

ocid of the dataset the annotation belongs to

Optional dimensions

dimensions: model.RecordAggregationDimensions

Optional lifecycleState

lifecycleState: undefined | string

Describes the lifecycle state.

Functions

getDeserializedJsonObj

getJsonObj