Skip to main content

 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.

This services will not work for external URIs.

Parameters

NameDescriptionRequiredTypeDefault value
pageThe page to loadnointeger1
pagesizeThe number of results per pagenointeger200
relationshipThe relationship of returned URIs to specified URL, can be children, descendants, ancestors, ancestors-siblings or siblingsnoenumchildren
typeThe type of URIs to return, can be document, folder or all.noenumall

If relationship=ancestors-siblings then ancestors and siblings of the the URI are returned including siblings of all the ancestors.

Permission

This service is restricted to guest and higher unless the group is accessible to public.

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