Get member objects for an annotation

get/annotations/{annotationId}/members
Internal-Use Only

Returns the member objects for an annotation. A member is an external object that uses this annotation.

Request Samples

1

Response Samples

1{
2 "name": "members",
3 "accept": "application/vnd.sas.annotation.member",
4 "start": 0,
5 "count": 1,
6 "items": [
7 {
8 "creationTimeStamp": "2018-03-26 20:11:17.132000+00:00",
9 "modifiedTimeStamp": "2018-03-26 20:11:17.132000+00:00",
10 "createdBy": "sasboot",
11 "modifiedBy": "sasboot",
12 "version": 1,
13 "id": "a7f35cb5-c72d-4fae-a5f3-af74f26cdf42",
14 "annotationId": "26e2df43-aeaf-475d-a64e-7baafb8a4eca",
15 "resourceType": "table",
16 "resourceUri": "objects/b673660283/96764860d",
17 "value": "objectValue",
18 "links": [
19 {
20 "method": "GET",
21 "rel": "annotation",
22 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca",
23 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca",
24 "type": "application/vnd.sas.annotation"
25 },
26 {
27 "method": "GET",
28 "rel": "self",
29 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members/a7f35cb5-c72d-4fae-a5f3-af74f26cdf42",
30 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members/a7f35cb5-c72d-4fae-a5f3-af74f26cdf42",
31 "type": "application/vnd.sas.annotation.member"
32 },
33 {
34 "method": "PUT",
35 "rel": "update",
36 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members/a7f35cb5-c72d-4fae-a5f3-af74f26cdf42",
37 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members/a7f35cb5-c72d-4fae-a5f3-af74f26cdf42",
38 "type": "application/vnd.sas.annotation.member"
39 },
40 {
41 "method": "DELETE",
42 "rel": "delete",
43 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members/a7f35cb5-c72d-4fae-a5f3-af74f26cdf42",
44 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members/a7f35cb5-c72d-4fae-a5f3-af74f26cdf42"
45 },
46 {
47 "method": "GET",
48 "rel": "up",
49 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members",
50 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members",
51 "type": "application/vnd.sas.annotation.member",
52 "responseType": "application/vnd.sas.annotation.member"
53 }
54 ]
55 }
56 ],
57 "links": [
58 {
59 "method": "GET",
60 "rel": "collection",
61 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members",
62 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members",
63 "type": "application/vnd.sas.collection"
64 },
65 {
66 "method": "GET",
67 "rel": "self",
68 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members?start=0&limit=10",
69 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members?start=0&limit=10",
70 "type": "application/vnd.sas.collection"
71 },
72 {
73 "method": "POST",
74 "rel": "create",
75 "href": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members",
76 "uri": "/annotations/annotations/26e2df43-aeaf-475d-a64e-7baafb8a4eca/members",
77 "type": "application/vnd.sas.annotation.member",
78 "responseType": "application/vnd.sas.annotation.member"
79 }
80 ],
81 "limit": 10,
82 "version": 2
83}

Path Parameters

NameTypeRequiredDescription
annotationId
string
true

The annotation ID.

Query Parameters

NameTypeRequiredDescription
filter
string<filter-criteria>
false

The filtering criteria for returned members.

limit
integer
false

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

sortBy
string<sort-criteria>
false

The sort returned members. The sorting criteria supports the name and descriptions fields in either ascending or descending order.

start
integer
false

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

Responses

StatusMeaningDescription
200OKThe annotation schema was retrieved.HeadersSchema
404Not FoundThe specified annotation ID does not exist.Schema