Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AnnotationAnalyticsAggregation

Aggregation entities are required by the API consistency guidelines for API Consistency Guidelines#AnalyticsAPIs. These are used to summarize annotations for a given dataset and will be 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

The OCID of the compartment containing the annotations.

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

The OCID of the dataset the annotations belong to.

Optional dimensions

dimensions: model.AnnotationAggregationDimensions

Optional lifecycleState

lifecycleState: undefined | string

Describes the lifecycle state.

Optional updatedBy

updatedBy: undefined | string

The OCID of the principal which updated the annotation.

Functions

getDeserializedJsonObj

getJsonObj