Class 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.

CreateAnnotationDetails

public class CreateAnnotationDetails

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Type	Description
string	The OCID of the compartment for the annotation.

Required

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Type	Description
Dictionary<string, Dictionary<string, object>>	The defined tags for this resource. Each key is predefined and scoped to a namespace. For Example: {"foo-namespace": {"bar-key": "value"}}

[Required(ErrorMessage = "Entities is required.")]
[JsonProperty(PropertyName = "entities")]
public List<Entity> Entities { get; set; }

Type	Description
List<Entity>	The entity types are validated against the dataset to ensure consistency.

Required

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Type	Description
Dictionary<string, string>	A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For Example: {"bar-key": "value"}

[Required(ErrorMessage = "RecordId is required.")]
[JsonProperty(PropertyName = "recordId")]
public string RecordId { get; set; }

Type	Description
string	The OCID of the record annotated.

Required