Page Comparison

query

Represents the search criteria.
All documents containing this value will be retrieved. Search is not key sensitive. Leave it blank to retrieve all documents. The parameter has to be URL encoded.

projectKey

The key of the project that you want to search into.

fields

The field(s) to be used for search. It can be either "all" which will include most of the data fields associated with a document or one or more of the following values: "key","title", "description", "revision". The items in the list can be separated with a comma.

folderID

The key of the folder to be searched. See "scope" parameter for more info. This parameter will be used only if the scope parameter has one of the following values: "folderAndSubFolders" or "folder"

scope

The scope of the search. By default the scope is the entire project.
This parameter can have one of the following values:

• "folderAndSubFolders" - the search will be restricted to the folder with the key specified through the "folderID" parameter and all its sub-folders

• "folder" - the search result will include only documents from the folder with the key specified through the "folderID" parameter

If the "folderID" parameter is not provided, then the scope parameter is ignored and the entire project is searched.