RestApiCategories.platformAdministration.desc

platform_administration

2024.03

2025.03

2024.09

2025.09

2025.12

2026.01

2026.02

2026.03

The Annotations API allows users to associate annotations with resources that other decoupled API manage.  An annotation augments a target resource, which is typically a column or table, with information that extends beyond its physical properties.  This information might include categorization (such as `email` and `address`), role (such as `categorical` and `primary key`), or other descriptive information.

Annotations

Viya_35

Checks whether the Annotations API is available.

Content-Type

Check API availability

The annotations provides tags related lifecycle APIs.

Annotation

A collection of annotation objects through which you can page.

Annotation Collection

Collection of AnnotationIDs to list members

Annotation Member Map Collection

Create Annotation

Information about the external object that is associated with the annotation.

Create Member

Creating members for particular annotation

Create multiple members

Error

A link to a related operation or resource.

Link

Member

A collection of annotation member objects through which you can page.

Member Collection

Selection

The API exposes endpoint for updating an existing annotation.

Check API availability

Request Samples

Responses