3.10 Searching (library_entities)

The "library_entities" related link can be used to search for files and folders by keyword.  To search the entire site, use the root rest object's "library_entities" link.


[Request]
> curl -k -u dlewis:novell https://amethyst.provo.novell.com:8443/rest

[Response]
{
  "links":[...,{
    "rel":"library_entities",
    "href":"/workspaces/1/library_entities"
  },...]
}

The following query parameters are supported:

  • recursive: whether to search a single level (false) or the entire sub-tree (true).

  • binders: whether to include binders in the results.

  • folder_entries: whether to include folder entries in the results.

  • files: whether to include files in the results.

  • replies: whether to include replies in the results.

  • keyword: search term.  May include wildcards (*, ?), but not as the first character in the keyword ("Test*" is allowed but "*Test" is not).

The response is a SearchResultList of BinderBrief and FileProperties objects. 


[Request]
> curl -k -u dlewis:novell https://amethyst.provo.novell.com:8443/rest/workspaces/1/library_entities?recursive=true&keyword=H*

[Response]
{
  "first":0,
  "count":100,
  "total":514,
  "items":[...]
}

Each binder object, including the top level folders such as My Files (-100) and Shared with Me (-101), also has a "library_entities" related link that can be used to search that particular location.