Displaying Search Results in XML
The JIRA Issue Navigator enables you to display your search results in XML format, suitable for use with the Confluence Jira Issues Macro, for example. (Also suitable for use as an RSS 0.9.2 feed. Note: for an RSS 2.0 feed, please see 'Receiving Search Results via RSS'.)
You can choose which fields to include in the XML output, as described below.
Exporting to XML
To display your search results in XML format:
- Choose Issues > Search for Issues.
- Refine your search, as described in Searching for Issues, then choose the Export menu.
- Choose XML from the dropdown menu.
- Your search results will be displayed in XML format. Note:
- If you wish to restrict which fields are included in the XML output, use the
field
parameter as described below. - To choose how many issues are included in the XML output, change the value of the
tempMax
parameter. The default is 1,000 issues (i.e.tempMax=1000
).
- If you wish to restrict which fields are included in the XML output, use the
- Copy the URL that is currently displayed on your screen.
- If you are using the Confluence JIRA Issues Macro, paste the URL into your Confluence document as described in the Confluence documentation.
On this page:
Choosing which fields to include
To restrict which issue fields are returned in the XML export, specify the field
parameter in your URL. For example, to include only the Issue key and Summary, add &field=key&field=summary
to the URL.
Note:
- If the
field
parameter is not specified, the XML output will include all the issue fields. - If one or more
field
parameters are specified, the XML output will contain only the Issue key plus your chosen field(s).
The complete list of available values for the field
parameter is as follows:
Value | Sample XML output | Notes |
---|---|---|
|
|
|
|
| This is a 'permalink' to the issue. For links between issues, see * |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Only relevant if the issue is a sub-task. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Only relevant if a security level has been applied to the issue. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Only available if your administrator has enabled attachments. |
|
| Only available if your administrator has enabled 'time-tracking'. |
|
| Only available if your administrator has enabled 'time-tracking'. |
|
| Only available if your administrator has enabled 'time-tracking'. |
|
| (ie. aggregate time for the issue plus all of its sub-tasks.) Only available if your administrator has enabled 'time-tracking'. |
|
| (ie. aggregate time for the issue plus all of its sub-tasks.) Only available if your administrator has enabled 'time-tracking'. |
|
| (ie. aggregate time for the issue plus all of its sub-tasks.) Only available if your administrator has enabled 'time-tracking'. |
|
| This is a convenient shorthand way of specifying all of the above six time-tracking fields. (Only available if your administrator has enabled 'time-tracking'. ) |
|
|
|
|
|
|
|
| (where "xxxxx" is the id of a given custom field. E.g. this output is the result of specifying |
|
|
|
Accessing protected data
When accessing data generated from JIRA, you may find that access to some resources requires user authentication (i.e. requires you to login). There are three options for this:
- To enable access to data without logging in, your JIRA administrator may specify the 'Browse' permission for Anyone.
- You can provide the parameters os_username and os_password in the request URL (e.g.
http://jira.atlassian.com/browse/TST-1?os_username=tester&os_password=tstpassword
). The problem with this method is that it transmits your username and password across the wire in clear text, which may not be an option for some users. - You can provide the request parameter os_authType=basic (e.g.
http://mycompany.com/anypage?os_authType=basic
). This will force the server to issue a challenge for user credentials (i.e. a login prompt) via the basic http authentication protocol. If you are running over SSL, you still need to specify the os_authType=basic parameter if you require the user to authenticate.