Web service API

How to use PageSeeder's Web service API

list externaluri externaluris forurl

/groups/{group}/externaluris/forurl/externaluris [GET]

com.pageseeder.uri.GetExternalURIsForURI

Description

Load all the External URIs with a particular relationship to a specified URL.

Parameters

NameDescriptionRequiredTypeDefault value
urlthe URL of the URIyesstring
archivedinclude archived URIsnobooleanfalse
archivedfoldersinclude archived folder URIsnobooleanfalse
pagethe page to loadnointeger1
pagesizethe number of results per pagenointeger200
relationshipthe relationship of returned URIs to specified URL, can be "children", "descendants", "ancestors" nostringchildren
typethe type of URIs to return, can be "folder"nostring

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<uris>
   <uri id="[id]"
        path="[crole]" ...> <!-- All URI's attribute are included -->
     <displaytitle type="text/plain">[content of version]</displaytitle>
  </uri>
 ...
</uris>

Error Handling

No specific errors expected for this service.

Created on , last edited on