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.

 

Parameters

NameDescriptionRequiredTypeDefault value
url the parent URL (required if no URI on the request) maybe url
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

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