Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AnnotationSummary

An annotation summary is the representation returned in list views. It is usually a subset of the full annotation entity and should not contain any potentially sensitive information.

Properties

compartmentId

compartmentId: string

The OCID of the compartment for the annotation.

Optional definedTags

definedTags: undefined | object

The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the annotation.

lifecycleState

lifecycleState: string

Describes the lifecycle state.

recordId

recordId: string

The OCID of the record annotated.

timeCreated

timeCreated: Date

The date and time the annotation was created, in the timestamp format defined by RFC3339.

timeUpdated

timeUpdated: Date

The date and time the resource was updated, in the timestamp format defined by RFC3339.

Functions

getDeserializedJsonObj

getJsonObj