Search the JIRA 5.0.x Beta and RCs Documentation:

Index
Downloads (PDF, HTML & XML formats)
Other versions

This documentation relates to JIRA 5.0.x Beta and RCs only.
The latest official version is JIRA 4.4.x
If you are using JIRA 4.4.x either view this page in the JIRA 4.4.x documentation or visit the JIRA 4.4.x documentation home page.
Skip to end of metadata
Comment: Corrected links that should have been relative instead of absolute.
Go to start of metadata

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,

  1. On the top navigation bar, click the 'Issues' tab.
  2. Refine your search, as described in 'Searching for Issues', until the required results are displayed in the Issue Navigator.
  3. Click the 'Views' menu, and select 'XML'.
  4. 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).
  5. Copy the URL that is currently displayed on your screen.
  6. 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

title

 

link

This is a 'permalink' to the issue. For links between issues, see * issuelinks * (below).

project (or pid)

 

description

 

environment

 

key

 

summary

 

type (or issuetype)

 

parent

Only relevant if the issue is a sub-task.

priority

 

status

 

resolution

 

labels

 

assignee

 

reporter

 

security

Only relevant if a security level has been applied to the issue.

created

 

updated

 

resolved (or resolutiondate)

 

due (or duedate)

 

version (or versions)

 

fixfor (or fixVersions)

 

component (or components)

 

votes

 

comments (or comment)

 

attachments (or attachment)

Only available if your administrator has enabled attachments.

timeoriginalestimate

Only available if your administrator has enabled 'time-tracking'.

timeestimate

Only available if your administrator has enabled 'time-tracking'.

timespent

Only available if your administrator has enabled 'time-tracking'.

aggregatetimeoriginalestimate

(ie. aggregate time for the issue plus all of its sub-tasks.) Only available if your administrator has enabled 'time-tracking'.

aggregatetimeestimate

(ie. aggregate time for the issue plus all of its sub-tasks.) Only available if your administrator has enabled 'time-tracking'.

aggregatetimespent

(ie. aggregate time for the issue plus all of its sub-tasks.) Only available if your administrator has enabled 'time-tracking'.

timetracking

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'. )

issuelinks

 

subtasks (or subtask)

 

customfield_xxxxx

(where "xxxxx" is the id of a given custom field. E.g. this output is the result of specifying &field=customfield_10112 )

allcustom

 

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:
  1. To enable access to data without logging in, your JIRA administrator may specify the 'Browse' permission for Anyone.
  2. 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.
  3. 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.

1 Comment

Hide/Show Comments

  1. Dec 19, 2011

    Bob Lane

    I am using the XML format to create a customized version for MS Word. I would like to imbed the attached objects into the word file. How do I access the attached documents? I am using VBA, but can access other libraries if necessary.