RestApiCategories.platformAdministration.desc

platform_administration

2025.03

2024.09

2025.09

2026.07

2026.03

2026.04

2026.05

2026.06

The Annotations API allows users to associate annotations with resources that other decoupled APIs 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

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.

Creates an annotation member from the provided request. The annotationId in the request body must match the annotationId in the URI.

Sample request body for creating a member

Information about the external object that is associated with the annotation. The annotationId in the request body must match the annotationId in the URI for single-member create requests.

Create Member

The member to create.  Valid fields are annotationId, value, resourceType, and resourceUri. The annotationId in the request body must match the annotationId in the URI. All other fields are ignored.

annotationId

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

Member

The annotation member was successfully created.

Location

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

Last-Modified

A tag that identifies this revision of this object.

Etag

This is an example of an error that could be returned for bad requests

Error

application/vnd.sas.error

Example of an error that might be returned on a 404 response

Create an annotation member

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

Creating members for particular annotation

Create multiple members

A link to a related operation or resource.

Link

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

Member Collection

Identifies a collection of resources for bulk queries. The resources array contains identifiers or URIs, depending on type (id, uri, mixed).

Selection

The API exposes endpoint for updating an existing annotation.

Name	Type	Required	Description
annotationId	string	false	The annotation ID that is associated with the member.
resourceUri	string	false	The URI of the object associated with this member. Example /folders/folders/{folderId} or /files/files/{fileId}.
resourceType	string	false	The object type associated with the member. Common values include folder, file and report.
value	string	false	Optional metadata value for this member. Free text (max 1000 characters).

Status	Meaning	Description
201	Created	The annotation member was successfully created.	Headers	Schema
400	Bad Request	The request was invalid.		Schema
404	Not Found	The specified annotation does not exist.		Schema

Create an annotation member

Request Samples

Response Samples

Path Parameters

Request Body

Responses