Web service API

How to use PageSeeder's Web service API

list uri uris

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

com.pageseeder.uri.GetURIsForURL

Description

List all the URIs with a particular relationship to a specified URI.

If there is a URI on the request, it takes precedence over the url parameter.

Parameters

NameDescriptionRequiredTypeDefault value
pageThe page to load.nointeger1
pagesizethe number of results per page.nointeger200
relationshipThe relationship of returned URIs to specified URL, can be "children", "descendants", "ancestors", "ancestors-siblings" or "siblings".noenumchildren
typeThe type of URIs to return, can be "document", "folder" or "all".noenumall

If relationship=ancestors-siblings then ancestors and siblings of the the URI are returned including siblings of all the ancestors.

Permission

Permissions requirements to be updated.

Response

The output has the following format:

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

Error Handling

No specific errors expected for this service.

Created on , last edited on