Apache CloudStack 4.20.0.0 Root Admin API Reference

listAnnotations

Lists annotations.

Request parameters

Parameter NameDescriptionRequired
annotationfilterpossible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can accessfalse
entityidthe id of the entity for which to show annotationsfalse
entitytypethe entity typefalse
idthe id of the annotationfalse
keywordList by keywordfalse
pagefalse
pagesizefalse
useridoptional: the id of the user of the annotationfalse

Response Tags

Response NameDescription
idthe (uu)id of the annotation
adminsonlyTrue if the annotation is available for admins only
annotationthe contents of the annotation
createdthe creation timestamp for this annotation
entityidthe (uu)id of the entity to which this annotation pertains
entitynamethe name of the entity to which this annotation pertains
entitytypethe type of the annotated entity
removedthe removal timestamp for this annotation
useridThe (uu)id of the user that entered the annotation
usernameThe username of the user that entered the annotation