Annotations

Update or replace an existing annotation

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

put/annotations/{annotationId}

Request

Base URL: http://example.com/annotations
URL: http://example.com/annotations/annotations/{annotationId}
Auth: none declared

Path parameters

annotationIdstring required

The annotation ID.

Headers

If-Matchstring

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

Request body

versionnumber

The version of the resource.

idstring

The unique ID, which the system assigns.

domainstring

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

namestring

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

labelstring

The display label for the annotation.

descriptionstring

The description of the annotation.

createdBystring

The user who created this annotation member.

modifiedBystring

The last user to modify this annotation member.

creationTimeStampstring

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

modifiedTimeStampstring

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

Response

The annotation was updated.