Web service API

How to use PageSeeder's Web service API

list host externaluris

/groups/{group}/hosts/{host}/externaluris [GET]

com.pageseeder.uri.GetExternalURIsForHost

Description

Load all the external URIs for a specified host in the group specified in the request.

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 host, can be "children", "descendants".noenumchildren
typeThe type of URIs to return, can be "folder".nostring

Permission

Permissions requirements to be updated.

Response

The URI for the host are listed in as <uri> elements wrapped in a <uris> element:

<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