Find annotations by resourceUris

post/annotations

Find all annotations that are associated with the provided resourceUris. Returns an application/vnd.sas.collection of application/vnd.sas.annotation objects.

Request Samples

Response Samples


1{
2  "version": 2,
3  "accept": "application/vnd.sas.annotation",
4  "count": 1,
5  "start": 0,
6  "limit": 2147483647,
7  "name": "annotationResourceCollection",
8  "items": [
9    {
10      "creationTimeStamp": "2025-03-06T08:57:51.425873Z",
11      "createdBy": "sasin",
12      "modifiedTimeStamp": "2025-03-06T08:57:51.425862Z",
13      "modifiedBy": "sasin",
14      "version": 1,
15      "id": "e3a58e6c-d723-4a18-b0f3-68df257ab077",
16      "name": "newAnnotationExample2",
17      "domain": "MY.DATA",
18      "label": "Annotate",
19      "description": "This is my new annotation...!!!",
20      "links": [
21        {
22          "method": "GET",
23          "rel": "self",
24          "href": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077",
25          "uri": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077",
26          "type": "application/vnd.sas.annotation"
27        },
28        {
29          "method": "PUT",
30          "rel": "update",
31          "href": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077",
32          "uri": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077",
33          "type": "application/vnd.sas.annotation",
34          "responseType": "application/vnd.sas.annotation"
35        },
36        {
37          "method": "DELETE",
38          "rel": "delete",
39          "href": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077",
40          "uri": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077"
41        },
42        {
43          "method": "GET",
44          "rel": "up",
45          "href": "/annotations/annotations",
46          "uri": "/annotations/annotations",
47          "type": "application/vnd.sas.collection",
48          "itemType": "application/vnd.sas.annotation"
49        },
50        {
51          "method": "GET",
52          "rel": "members",
53          "href": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077/members",
54          "uri": "/annotations/annotations/e3a58e6c-d723-4a18-b0f3-68df257ab077/members",
55          "type": "application/vnd.sas.collection",
56          "itemType": "application/vnd.sas.annotation.member"
57        }
58      ]
59    }
60  ],
61  "links": [
62    {
63      "method": "GET",
64      "rel": "collection",
65      "href": "/annotations/annotations",
66      "uri": "/annotations/annotations",
67      "type": "application/vnd.sas.collection",
68      "itemType": "application/vnd.sas.annotation"
69    },
70    {
71      "method": "GET",
72      "rel": "self",
73      "href": "/annotations/annotations?start=0&limit=2147483647",
74      "uri": "/annotations/annotations?start=0&limit=2147483647",
75      "type": "application/vnd.sas.collection",
76      "itemType": "application/vnd.sas.annotation"
77    },
78    {
79      "method": "POST",
80      "rel": "create",
81      "href": "/annotations/annotations",
82      "uri": "/annotations/annotations",
83      "type": "application/vnd.sas.annotation",
84      "responseType": "application/vnd.sas.annotation"
85    }
86  ]
87}

Request Body

Selects resourceUris for which associated annotations are to be found.

Identifies a set of resources.

Name	Type	Required	Description
version	integer	true	The schema version number of this media type. This representation is version 1.
template	string<uri>	false	A URI template in which the {id} parameter can be replaced with a value from the "resources" array in order to yield the URI of the identified resource.
type	string	false	Specifies whether the resources array contains IDs, URIs, or both. Allowed values: idurimixed
resources	array [string]	true	An array of resource IDs or URIs
links	array [Link]	false	An array of links to related resources and actions.

Responses

Status	Meaning	Description
200	OK	The request succeeded.	Headers	Schema
400	Bad Request	The request was invalid. This can occur when no matching annotations are found or when the user provides an invalid limit, start, sortBy, or filter.		Schema