Update or replace an existing annotation

put/annotations/{annotationId}
Internal-Use Only

Updates an existing annotation with a full replacement of the resource. This operation cannot modify the ID field.

Request Samples

1

Response Samples

1{
2  "creationTimeStamp": "2022-03-08T12:28:17.47004Z",
3  "createdBy": "sasadm",
4  "modifiedTimeStamp": "2022-03-08T12:30:03.640581Z",
5  "modifiedBy": "sasadm",
6  "version": 1,
7  "id": "b4be3b98-2643-4699-92e6-43bad70b531c",
8  "name": "Changed",
9  "domain": "Changed",
10  "label": "Changed",
11  "description": "Changed",
12  "links": [
13    {
14      "method": "GET",
15      "rel": "self",
16      "href": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c",
17      "uri": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c",
18      "type": "application/vnd.sas.annotation"
19    },
20    {
21      "method": "PUT",
22      "rel": "update",
23      "href": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c",
24      "uri": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c",
25      "type": "application/vnd.sas.annotation",
26      "responseType": "application/vnd.sas.annotation"
27    },
28    {
29      "method": "DELETE",
30      "rel": "delete",
31      "href": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c",
32      "uri": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c"
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/b4be3b98-2643-4699-92e6-43bad70b531c/members",
46      "uri": "/annotations/annotations/b4be3b98-2643-4699-92e6-43bad70b531c/members",
47      "type": "application/vnd.sas.collection",
48      "itemType": "application/vnd.sas.annotation.member"
49    }
50  ]
51}

Path Parameters

NameTypeRequiredDescription
annotationId
string
true

The annotation ID.

Header Parameters

NameTypeRequiredDescription
If-Match
string
false

The Etag that was returned from a GET, POST, or PUT of this annotation.

Request Body

The annotation to update.

The API exposes endpoint for updating an existing annotation.

NameTypeRequiredDescription
version
number
false

The version of the resource.

id
string
false

The unique ID, which the system assigns.

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.

createdBy
string
false

The user who created this annotation member.

modifiedBy
string
false

The last user to modify this annotation member.

creationTimeStamp
string
false

The formatted timestamp when the annotation member was created, shown in yyyy-mm-ddThh:mm:ssZ format.

modifiedTimeStamp
string
false

The formatted timestamp when the annotation member was last modified, shown in yyyy-mm-ddThh:mm:ssZ format.

Responses

StatusMeaningDescription
200OKThe annotation was updated.HeadersSchema
400Bad RequestThe request was invalid.Schema
412Precondition FailedThe specified Etag does not match the current version of the object or the last modified date.Schema
415Unsupported Media TypeThe specified media type is not supported.Schema
428Precondition RequiredThe Etag was not specified during update of an existing type.Schema