...
You can search and retrieve documents by their title 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-doc-titles?query=QUERY&projectKey=PROJECT_KEY
Replace "https:/ /MY_JIRA_BASE_URL" with the base URL of your Jira server.
Parameters
You have to specify the following parameters:
...
https:/ /myjiraserver:2990/jira/plugins/servlet/stonikbyte/projectdocs/search-doc-titles?query=plan&projectKey=DEMO&matchingCriteria=contains
In this example, all the documents from project DEMO with title “plan” or “Plan” are returned. The search is not case sensitive.
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:
...