Web service API

How to use PageSeeder's Web service API

list externaluri externaluris

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

com.pageseeder.uri.GetExternalURIsForURI

Description

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

Parameters

NameDescriptionRequiredTypeDefault value
archived include archived URIs no boolean false
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 URI, can be "children", "descendants", "ancestors" no enum children
type the type of URIs to return, can be "folder" no string

 

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