Single Exportation API
Overview
Xporter for JIRA provides a REST API to enable single exportations outside of the JIRA context.
Base URL
The base URL to call the Single Export endpoint is: /plugins/servlet/jiraxporter
Required Parameters
This is a list that shows the required parameters.
| Parameter | Explanation |
|---|---|
| issueKey | This is the key from the issue that is being exported. |
| outputType | This is the output type of the document being exported. Word templates can be exported to the following output types: docx, docm, dotx, dotm, odt, rtf, png, svg and pdf. Excel template can be exported to the following output types: xlsx, xlsm and pdf. |
| template | This is the name of the template being exported. |
An example of usage is:
Optional Parameters
This is a list that shows the optional parameters.
| Parameter | Explanation | Example |
|---|---|---|
| filename | This is used if you wish to name your output document in a custom way. You can also use the default Xporter mappings to customize your filename.* | http://<JIRA-URL>/plugins/servlet/jiraxporter?issueKey=TEST1-3&outputType=docx&template=Basic%20Release%20Notes&filename=Test-filename |
* The way this can be achieved is similiar to naming the output document in the Xporter for JIRA Workflow Post-Functions. The usage is as follows: ${<Field>}. Example: ...&filename=Test-${Key} (where ${Key} will be replace by the Issue Key).