Web service API

How to use PageSeeder's Web service API

list cache elements

/caches/{name}/elements [GET]

com.pageseeder.cache.GetCacheElements

Description

Return the list of elements in a specific cache.

To retrieve the list of valid cache names, use the /caches [GET] service.

Parameters

NameDescriptionRequiredTypeDefault value
pagethe page to loadnointeger1
pagesizethe number of cached elements per pagenointeger5000

This service implements paging, pages are based on the number of cached elements.

Permission

Only administrators can use this service.

Response

The output has the following format:

<cache name="xml-documents"
       guid="MY-PC/123.456.789.012-d484acdc-1040-42e9-9eae-8413ab5f9519"
       status="STATUS_ALIVE"
       disabled="false">
  <keys page="1"
        pagesize="5000"
        limitreached="false"
        count="280">
    <element key="777-25913-"
             creation-time="2015-11-10T15:54:53+11:00"
             expiration-time="292278994-08-17T17:12:55+10:00"
             last-access-time="2015-11-10T15:54:53+11:00"
             last-update-time="2015-11-10T15:54:52+11:00"
             hit-count="0"
             version="1"
             time-to-idle="0"
             time-to-live="0"
             eternal="true"
             expired="false"/>
    ...
  </keys>
</cache>

Error handling

No specific errors expected for this generator.

Created on , last edited on