Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateAnnotationDetails

This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an annotation for a record.

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

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

recordId

recordId: string

The OCID of the record annotated.

Functions

getDeserializedJsonObj

getJsonObj