Skip to main content

 Web service API

How to use PageSeeder's Web service API

list uri uris forurl

/groups/{group}/uris/forurl/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
urlThe parent URL (required if no URI on the request)maybeurl
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 allnoenumall

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

This service returns each URI as a <uri> element:

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

Error Handling

CodeCause / Description
0x1212When the supplied URL is missing or invalid.
Created on , last edited on