eu.ehri.extension.base

Interface ListResource

All Known Implementing Classes:

AnnotationResource, AuthoritativeSetResource, ContentTypeResource, CountryResource, CvocConceptResource, DocumentaryUnitResource, GroupResource, HistoricalAgentResource, LinkResource, RepositoryResource, UserProfileResource, VirtualUnitResource, VocabularyResource

public interface ListResource

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	list() List available resources.

Method Detail

list

javax.ws.rs.core.Response list()

List available resources. The default behaviour is to return a page of 20 items.

The default list limit can be overridden using the limit parameter, and disabled completely using a value of -1.

Item lists are paginated using the page parameter.

The page, limit, and total number of items is returned in the Content-Range response header in the form:

page=1; count=20; total=50

If the header X-Stream is set to true no count of total items will be performed. This is more efficient when returning large numbers of items or when limiting is disabled completely. Example:

      
 curl http://localhost:7474/ehri/[RESOURCE]/list?page=5&limit=10
      
 

Returns:

A list of serialized item representations