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
archivedInclude archived URIs.nobooleanfalse
archivedfoldersInclude archived folder URIs.nobooleanfalse
pageThe page to load.nointeger1
pagesizeThe number of results per page.nointeger200
relationshipThe relationship of returned URIs to specified URI (can be "children", "descendants", "ancestors").noenumchildren
typeThe type of URIs to return (can be "folder").nostring

 

Permission

Permissions requirements to be updated.

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