Advanced

Advanced topics

Servlet: ObjectExplorer

com.pageseeder.tree.ObjectExplorer

Description

Load an object or a collection of objects form the database.

HTTP Method: GET

Returns the requested objects.

All of the parameters are optional but one of groupid, groupname, guriid, guripath, uriid, uripath, memberid, xlinkid, collection is required.

HTTP Parameters

NameDescriptionRequiredTypeDefault
groupidThe id of the group to loadnolong
groupnameThe name of the group to loadnoString
guriidThe id of group URI to loadnolong
guriportThe port of group URI to loadnoportrequest port
guripathThe path of group URI to loadnoString
gurischemeThe scheme of group URI to loadnoschemerequest scheme
uriidThe URI to loadnolong
uriportThe port of URI to loadnoportrequest port
uripathThe path of URI to loadnoString
urischemeThe scheme of URI to loadnoschemerequest scheme
memberidThe member to loadnolong
xlinkidThe XLink to loadnolong
collectionOne of "groups", "xlinks", "members", "uris", "groupuris", "hosts"; for each of them, a predicate can be added (i.e.: "groups[$1]")noString
xpathThe XPath to load from the main objectnoString
predicate[Nb]NameA predicate going with the XPath or collection parameternoString
predicate[Nb]Param[Nb]A predicate parameter going with the XPath or collection parameternoString
archivedGroupsIf true, archivedGroups are included in the responsenoboolean
archiveIf "show" archived XLinks are included in the responsenoString
getAllif true and the user is an Admin, the default predicate (filtering data by the member's groups) is not used.noboolean
getEmailsif true and the user is an Admin, members' emails are included.noboolean
treeMaxObjectsThe max number of results; Must be a number, if not specified, the default value is the property treeMaxObjects found in the global properties, if none is found, 1000 is used.nolongproperty or 1000

 

HTTP Method: POST

Invoking this Servlet using method is the same as using the HTTP GET method.

Created on , last edited on