...
You can search and retrieve documents by specifying the scope of the search and field(s) to be search by sending a GET HTTP request to the Jira instance running this version of Documents app. A set of attributes of the matching documents is returned in JSON format.
Request URL
The request URL takes the following form:
https:/ /MY_JIRA_BASE_URL/plugins/servlet/stonikbyte/projectdocs/search-docs?query=QUERY&projectKey=PROJECT_KEY&fields=FIELDS&folderID=FOLDER&scope=SCOPE
Replace "https:/ /MY_JIRA_BASE_URL" with the base URL of your Jira server.
Parameters
You have to specify the following parameters:
...
In this example, all the documents from the folder with the key 1 (that belongs to project DEMO) and its sub-folders that contain “chart” in their Title or Description are returned.
A successful response
An HTTP 200 status response indicates a successful request. The following data about the matching documents is returned:
Data | Description | Example |
|---|---|---|
key | The Key (unique identifier) of the document | 11 |
title | The Title of the document | Project Plan |
type | The type of the document. | 1 |
icon | The filename representing the document's icon. | pdf24.png |
Error Response
If the REST call fails, the service returns one of the following HTTP statuses:
...