RestApiCategories.platformAdministration.desc

platform_administration

2024.11

2024.09

2024.08

2024.10

2023.10

2024.03

2024.12

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

2023.03

Returns header information and verifies that the annotation exists.

The value of the ETag that was returned from a GET or previous PUT of this type.  This header is optional, but if provided, this MUST match exactly the current value of the etag of the object.

If-Match

annotationId

The ISO8601 date string that represents the timestamp of the last update to this annotation.

Last-Modified

A tag that identifies this revision of this object.

Etag

Check annotation availability

The annotations provides tags related lifecycle APIs.

Annotation

Create Annotation

The API exposes endpoint for updating an existing annotation.

Update Annotation

A collection of annotation objects through which you can page.

Annotation Collection

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

Member

Create Member

Update Member

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

Member Collection

Error

A link to a related operation or resource.

Link

Selection

Creating members for particular annotation

Create multiple members

Collection of AnnotationIDs to list members

Status	Meaning	Description
200	OK	The annotation exists.	Headers
404	Not Found	The annotation does not exist.

Check annotation availability

Request Samples

Response Samples

Path Parameters

Header Parameters

Responses