Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.
Possible values are: 1 - Folder; 2 - File; 3 - URL; 4 - Wiki

1

icon

The filename representing the document's icon.
You can retrieve the icon by appending the file name to the following URL
https:/ /MY_JIRA_BASE_URL/download/resources/com.stonikbyte.jira.plugins.project-docs-plugin/images/mime-types/
Example:
https:/ /myjiraserver:2990/jira/download/resources/com.stonikbyte.jira.plugins.project-docs-plugin/images/mime-types/pdf24.png

pdf24.png

Error Response

If the REST call fails, the service returns one of the following HTTP statuses:

...