Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Annotation

An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.

Properties

compartmentId

compartmentId: string

The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself.

createdBy

createdBy: string

The OCID of the principal which created 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"}}}

entities

entities: Array<Entity>

The entity types are validated against the dataset to ensure consistency.

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: LifecycleState

The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for labeling. INACTIVE - The annotation has been marked as inactive and should not be used for labeling. DELETED - Tha annotation been deleted and no longer available for labeling.

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.

updatedBy

updatedBy: string

The OCID of the principal which updated the annotation.

Functions

getDeserializedJsonObj

getJsonObj