Advanced

Advanced topics

Servlet: DocumentBrowser

com.pageseeder.review.DocumentBrowser

Description

Deprecation warning!

use services or generators in com.pageseeder.uri package

Browse through the Document hierarchy of a group.

HTTP Method: GET

Optional parameters can be used to specify which folder to load (for each param, the entire tree up to this path is loaded).

One of path, fullpath, grouppath, uri, guri or grp is required

HTTP Parameters

grpId of group to display (required if using parameter 'grouppath')conditionallong
pathThe format is a complete URI path (e.g. /ps/acme/specs/folder/myfile.xml, optional)nostring
fullpathThe format is a path without the siteprefix and no starting '/' (e.g. acme/specs/folder/myfile.xml, optional).nostring
grouppathThe format is a path relative to the default uri of the group with no starting '/' (e.g. folder/myfile.xml, optional).nostring
uriThe uri id (optional). %longnostring
guriThe group uri id (optional). %longnostring
childpathThe path of a child URI to load if not included in the resultsnostring
portThe port to use when the path parameter is specified. optional, the template property documentPort is used if the request port is equals to the property apiPort, otherwise the request port is used. %intnostring
astreeif 'true', an entire tree up to the contents of the given uri requested is loaded, otherwise, only the contents of the given uri is returned (default is 'true').nobooleantrue
foldersonlyif 'true', URIs that are not folders are not returnednobooleanfalse
publishconfigif 'true', the contents of the publish config file are included in the responsenobooleanfalse
pagethe page to loadnointeger1
pagesizethe number of results per pagenointeger10

HTTP Method: POST

Does Nothing.

Created on , last edited on