Newer Version Available

This content describes an older version of this product. View Latest

Annotation Resource

An asset's annotations.
Resource URL
1/wave/annotations/<annotationId>
Formats
JSON
Available Version
37.0
HTTP Methods
GET PATCH
GET Response Body
AnnotationRepresentation
Property Name Type Description Filter Group and Version Available Version
anchor String The anchor key. Small, 37.0 37.0
asset Asset​Reference​Representation The referenced asset. Small, 37.0 37.0
feed​Element Asset​Reference​Representation The referenced feed element. Small, 37.0 37.0
id String The 18 character annotation ID. Small, 37.0 37.0
resolved Boolean Indicates whether the state of the annotation is resolved or not. Small, 37.0 37.0
url String The URL to get this annotation. Small, 37.0 37.0
PATCH Request Body
AnnotationInputRepresentation
Property Name Type Description Required or Optional Available Version
anchor String The anchor of the annotation. Optional 37.0
asset Asset​Reference​Input​Representation The referenced asset of the annotation. Required 37.0
feed​Element Asset​Reference​Input​Representation The referenced feed element of the annotation. Required 37.0
resolved Boolean Indicates whether the state of the annotation is resolved or not. Optional 37.0
PATCH Response Body
Property Name Type Description Filter Group and Version Available Version
anchor String The anchor key. Small, 37.0 37.0
asset Asset​Reference​Representation The referenced asset. Small, 37.0 37.0
feed​Element Asset​Reference​Representation The referenced feed element. Small, 37.0 37.0
id String The 18 character annotation ID. Small, 37.0 37.0
resolved Boolean Indicates whether the state of the annotation is resolved or not. Small, 37.0 37.0
url String The URL to get this annotation. Small, 37.0 37.0