Annotations

Get all annotations

Returns a collection of annotations. Standard paging, filtering, and sorting options are provided.

get/annotations

Request

  • Base URL: http://example.com/annotations
  • URL: http://example.com/annotations/annotations
  • Auth: none declared

Query parameters

startinteger

The starting index of the first annotation in a page. The default is 0.

limitinteger

The maximum number of annotations to return in this page of results. The actual number of returned annotations might be less if the collection has been exhausted. The default is 10.

filterstring filter-criteria

The filtering criteria for returned annotations.

sortBystring sort-criteria

The sort returned annotations. The only valid sorting option is the name field. Ascending is the default sort order on the name field. Here is a sample sort: <p> /annotations/annotations?sortBy=name:descending</li> </p>

resourceUristring

The resourceUri of the object from which annotations are to be retrieved.

Response

The collection of annotations is available.

namestring

The name of the collection "annotations" in the context of the request.

startinteger

The zero-based index of the result candidates to start returning.

limitinteger

The maximum number of results that were requested.

countinteger

The actual number of results that were returned in the collection.

acceptstring

The accept header value that was used in the initial request.

versioninteger

The collection schema version.

Changes

No recorded changes to this operation across all 1 revision of this API.