Apache CloudStack 4.23.0.0 Root Admin API Reference

listAnnotations

Lists annotations.

Request parameters

Parameter Name	Description	Required
annotationfilter	Possible values are "self" and "all". self : annotations that have been created by the calling user. * all : all the annotations the calling user can access*	false
entityid	The ID of the entity for which to show annotations	false
entitytype	The entity type	false
id	The ID of the annotation	false
keyword	List by keyword	false
page		false
pagesize		false
userid	Optional: The ID of the user of the annotation	false

Response Tags

Response Name	Description
id	The UUID of the annotation
adminsonly	True if the annotation is available for admins only
annotation	The contents of the annotation
created	The creation timestamp for this annotation
entityid	The UUID of the entity to which this annotation pertains
entityname	The name of the entity to which this annotation pertains
entitytype	The type of the annotated entity
removed	The removal timestamp for this annotation
userid	The UUID of the User that entered the annotation
username	The username of the User that entered the annotation

Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0.
Apache, CloudStack, Apache CloudStack, the Apache CloudStack logo, the CloudMonkey logo and the Apache feather logo are trademarks of The Apache Software Foundation.