Web service API

How to use PageSeeder's Web service API

list uri uris

/groups/{group}/uris/{uri}/uris [GET]

com.pageseeder.uri.GetURIsForURL

Description

List all the URIs with a particular relationship to a specified URI.

If there is a URI on the request, it takes precedence over the url parameter.

Parameters

NameDescriptionRequiredTypeDefault value
page the page to load no integer 1
pagesize the number of results per page no integer 200
relationship the relationship of returned URIs to specified URL, can be "children", "descendants", "ancestors" or "siblings" no enum children
type the type of URIs to return, can be "document", "folder" or "all no enum all

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<uris>
   <uri id="[id]"
        path="[path]" ...> <!-- All URI's attribute are included -->
      <displaytitle>[title]</displaytitle>
   </uri>
   ...
</uris>

Error handling

No specific errors expected for this service.

Created on , last edited on