| Table of Contents |
|---|
Single
...
Export API
Overview
Xporter provides a REST API to enable you to do a single export outside of the Jira context.
...
| Parameter | Explanation |
|---|---|
| issueKey | This is the key from of 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 templates can be exported to the following output types: xlsx, xlsm and pdf. |
| template | This is the name of the template being exported. |
...
| Parameter | Explanation | Example |
|---|---|---|
| filename | This is used if you want to customize the name of your output document. You can also use the default Xporter mappings.* | http://<JIRA-URL>/plugins/servlet/jiraxporter?issueKey=TEST1-3&outputType=docx&template=Basic%20Release%20Notes&filename=Test-filename |
| context |
| http://<JIRA-URL>/plugins/servlet/jiraxporter?issueKey=TEST1-3&outputType=docx&template=Basic%20Release%20Notes&context=project&filename=Test-filename |
* The way this can be achieved is similar to naming the output document in the Xporter for Jira Workflow Post-Functions. The syntax is as follows: ${<Field>}. Example: ...&filename=Test-${Key} (where ${Key} will be replace by the Issue Key).
| Info |
|---|
Please , be aware, we can have the template with the same name on different projects or on the administration section. So, if If you want to use a template defined on by a specific project where the current issues belong belongs, you should use the parameter context=project in order to ensure the correct template to useis used. Furthermore, have keep in attendancemind, if you want to use a project template ensure the issues you are exporting belongs belong only to the project where the template belongs. Otherwise, you will only will be have the possibility to use the administration or profile user templates. By default, it will assume the context administration. |
JQL
...
Export API
Overview
Xporter for Jira provides a REST API to enable you to export outside of the Jira context with a JQL clause.
Base URL
The base URL to call the Single export endpoint is: /plugins/servlet/jiraxporter
...
| Parameter | Explanation |
|---|---|
| template | This is the name of the template being exported. |
| jql | This is a JQL clause |
| project | This is the project inside the JQL clause |
| issuetype | This is the type from the issue that you want to export. |
| 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 templates can be exported to the following output types: xlsx, xlsm and pdf. |
| context |
|
An example of JQL usage is:
...
On the template, call the mapping of your parameter like this: ${parameter_name}.
Example
...