Create an annotation

post/annotations
Internal-Use Only

Creates an annotation from the specified request.

Request Samples

1

Response Samples

1{
2 "creationTimeStamp": "2018-03-26T19:50:09.935000Z",
3 "modifiedTimeStamp": "2018-03-26T19:50:09.935000Z",
4 "createdBy": "sasboot",
5 "modifiedBy": "sasboot",
6 "id": "2a902411-4f81-4819-9263-203cf0ff29ce",
7 "name": "newAnnotationName",
8 "domain": "newDomainLabel",
9 "version": 1,
10 "label": "newAnnotationLabel",
11 "description": "newDescriptionLabel",
12 "links": [
13 {
14 "method": "GET",
15 "rel": "self",
16 "href": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce",
17 "uri": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce",
18 "type": "application/vnd.sas.annotation"
19 },
20 {
21 "method": "PUT",
22 "rel": "update",
23 "href": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce",
24 "uri": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce",
25 "type": "application/vnd.sas.annotation",
26 "responseType": "application/vnd.sas.annotation"
27 },
28 {
29 "method": "DELETE",
30 "rel": "delete",
31 "href": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce",
32 "uri": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce"
33 },
34 {
35 "method": "GET",
36 "rel": "up",
37 "href": "/annotations/annotations",
38 "uri": "/annotations/annotations",
39 "type": "application/vnd.sas.collection",
40 "itemType": "application/vnd.sas.annotation"
41 },
42 {
43 "method": "GET",
44 "rel": "members",
45 "href": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce/members",
46 "uri": "/annotations/annotations/2a902411-4f81-4819-9263-203cf0ff29ce/members",
47 "type": "application/vnd.sas.collection",
48 "itemType": "application/vnd.sas.annotation.member"
49 }
50 ]
51}

Request Body

The annotation to create. Valid fields are name, label, domain, and description. All other fields are ignored.

Create Annotation

NameTypeRequiredDescription
domain
string
false

The domain that is associated with the annotation. The domain and name comprise a unique key.

name
string
false

The name. The domain and name comprise a unique key.

label
string
false

The display label for the annotation.

description
string
false

The description of the annotation.

Responses

StatusMeaningDescription
201CreatedThe annotation was successfully created.HeadersSchema
400Bad RequestThe request was invalid.Schema