Members

Get member objects for an annotation

Returns the member objects for an annotation. A member is an external object that uses this annotation.

get/annotations/{annotationId}/members

Request

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

Path parameters

annotationIdstring required

The annotation ID.

Query parameters

startinteger

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

limitinteger

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

filterstring filter-criteria

The filtering criteria for returned members.

sortBystring sort-criteria

The sort returned members. The sorting criteria supports the name and descriptions fields in either ascending or descending order.

Response

The annotation schema was retrieved.

namestring

The name of the collection "members" within 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.