Servlet: DocumentBrowser
| API Support | Since PageSeeder | Last updated | Documentation Date |
|---|---|---|---|
| 4.6000 | 5.7910 | 18 December 2017 |
Description
This servlet has been removed as of PageSeeder v6. Use services instead.
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
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| grp | Id of group to display (required if using parameter ‘grouppath’) | conditional | long | |
| path | The format is a complete URI path (e.g. /ps/acme/specs/folder/myfile.xml, optional) | no | string | |
| fullpath | The format is a path without the siteprefix and no starting ‘/’ (e.g. acme/specs/folder/myfile.xml, optional) | no | string | |
| grouppath | The format is a path relative to the default uri of the group with no starting ‘/’ (e.g. folder/myfile.xml, optional) | no | string | |
| uri | The uri id (optional) | no | long | |
| guri | The group uri id (optional) | no | long | |
| childpath | The path of a child URI to load if not included in the results | no | string | |
| port | The 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. | no | int | |
| astree | If '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'). | no | boolean | true |
| foldersonly | If ‘true’, URIs that are not folders are not returned | no | boolean | false |
| publishconfig | If ‘true’, the contents of the publish config file are included in the response | no | boolean | false |
| page | The page to load | no | integer | 1 |
| pagesize | The number of results per page | no | integer | 10 |
HTTP method: POST
Does Nothing.