Obtains information needed to construct the Vibe workspace and folder tree.


public String search_getWorkspaceTreeAsXML( String accessToken, long binderId, int levels, String page );


The search_getWorkspaceTreeAsXML operation obtains information needed to construct the Vibe workspace and folder tree.

Parameters and Return Value


Either the security token passed to your application by Vibe as part of implementing a remote application, or the null value.


The identifier of the binder whose descendants you want to include in the workspace and folder tree information.

The top workspace in the Vibe tree has a binder identifier of 1.


The number of hierarchical levels down from the node specified by binderId that you want to include in the returned information. The value -1 indicates that you want all subsequent levels.


A parameter used to expand pages of binders. When you specify a valid page identifier, Vibe expands the page by the number of levels indicated in the levels parameter.

If you do not want to use this call expand pages, pass null as this parameter.

See Section 5.6.6, Binder Pages and search_getWorkspaceTreeAsXML for more detailed information about working with pages.


A string containing XML elements needed to construct each node within the requested levels of the workspace hierarchy.

See Also