Get all annotations

get/annotations
Internal-Use Only

Returns a collection of annotations. Standard paging, filtering, and sorting options are provided.

Request Samples

1

Response Samples

1{
2  "links": [
3    {
4      "method": "GET",
5      "rel": "collection",
6      "href": "/annotations/annotations",
7      "uri": "/annotations/annotations",
8      "type": "application/vnd.sas.collection"
9    },
10    {
11      "method": "GET",
12      "rel": "self",
13      "href": "/annotations/annotations?start=0&limit=10",
14      "uri": "/annotations/annotations?start=0&limit=10",
15      "type": "application/vnd.sas.collection"
16    },
17    {
18      "method": "POST",
19      "rel": "create",
20      "href": "/annotations/annotations",
21      "uri": "/annotations/annotations",
22      "type": "application/vnd.sas.annotation",
23      "responseType": "application/vnd.sas.annotation"
24    }
25  ],
26  "name": "annotations",
27  "accept": "application/vnd.sas.annotation",
28  "count": 1,
29  "items": [
30    {
31      "id": "f9bd5124-418f-4326-86cf-b6d98d57778",
32      "name": "Annotation1",
33      "domain": "Domain1",
34      "description": "One annotation.",
35      "creationTimeStamp": "2016-12-19 18:02:07.986000+00:00",
36      "modifiedTimeStamp": "2016-12-19 18:02:07.986000+00:00",
37      "createdBy": "etlguest",
38      "modifiedBy": "etlguest",
39      "links": [
40        {
41          "method": "POST",
42          "rel": "create",
43          "href": "/annotations/annotations",
44          "uri": "/annotations/annotations",
45          "type": "application/vnd.sas.annotation",
46          "responseType": "application/vnd.sas.annotation"
47        },
48        {
49          "method": "GET",
50          "rel": "self",
51          "href": "/annotations/annotations/ccc0492f-7a0a-4481-8890-ca0b127c6ed4",
52          "uri": "/annotations/annotations/ccc0492f-7a0a-4481-8890-ca0b127c6ed4",
53          "type": "application/vnd.sas.annotation"
54        },
55        {
56          "method": "PUT",
57          "rel": "update",
58          "href": "/annotations/annotations/ccc0492f-7a0a-4481-8890-ca0b127c6ed4",
59          "uri": "/annotations/annotations/ccc0492f-7a0a-4481-8890-ca0b127c6ed4",
60          "type": "application/vnd.sas.annotation"
61        },
62        {
63          "method": "DELETE",
64          "rel": "delete",
65          "href": "/annotations/annotations/ccc0492f-7a0a-4481-8890-ca0b127c6ed4",
66          "uri": "/annotations/annotations/ccc0492f-7a0a-4481-8890-ca0b127c6ed4"
67        }
68      ]
69    }
70  ],
71  "limit": 10,
72  "version": 2
73}

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

The filtering criteria for returned annotations.

limit
integer
false

The maximum number of annotations to return in this page of results. The actual number of returned annotations might be less if the collection has been exhausted. The default is 10.

resourceUri
string
false

The resourceUri of the object from which annotations are to be retrieved.

sortBy
string<sort-criteria>
false

The sort returned annotations. The only valid sorting option is the name field. Ascending is the default sort order on the name field. Here is a sample sort: /annotations/annotations?sortBy=name:descending

start
integer
false

The starting index of the first annotation in a page. The default is 0.

Responses

StatusMeaningDescription
200OKThe collection of annotations is available.HeadersSchema
400Bad RequestThe request was invalid.Schema