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:

  1. Choose Issues > Search for Issues.
  2. Refine your search, as described in Searching for Issues, then choose the Export menu.
  3. Choose XML from the dropdown menu.
  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

<title>[TEST-4] This is a test</title>

link

<link>https://extranet.atlassian.com:443/jira/browse/TEST-4</link>

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

project (or pid)

<project id="10330" key="TST">Test</project>

description

<description>This is a detailed description of the issue.<description>

environment

<environment>Sydney network<environment>

key

<key id="22574">TEST-4</key>

summary

<summary>This is a test<summary>

type (or issuetype)

<type id="3" iconUrl="https://extranet.atlassian.com:443/jira/images/icons/task.gif">Task</type>

parent

<parent id="22620">TEST-5</parent>

Only relevant if the issue is a sub-task.

priority

<priority id="4" iconUrl="https://extranet.atlassian.com:443/jira/images/icons/priority_minor.gif">Minor<priority>

status

<status id="5" iconUrl="https://extranet.atlassian.com:443/jira/images/icons/status_resolved.gif">Resolved</status>

resolution

<resolution id="1">Fixed</resolution>

labels

<labels>
<label>focus</label>
<labels>

assignee

<assignee username="jsmith">John Smith</assignee>

reporter

<assignee username="jsmith">John Smith</assignee>

security

<security id="10021">Private</security>

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

created

<created>Mon, 1 Sep 2008 17:30:03 -0500 (CDT)>/created>

updated

<updated>Mon, 1 Sep 2008 17:30:03 -0500 (CDT)>/updated>

resolved (or resolutiondate)

<resolved>Mon, 1 Sep 2008 17:30:03 -0500 (CDT)>/resolved>

due (or duedate)

<due>Mon, 1 Sep 2008 17:30:03 -0500 (CDT)>/due>

version (or versions)

<version>2.4.7</version>

fixfor (or fixVersions)

<fixVersion>2.6</fixVersion>

component (or components)

<component>Documentation</component>

votes

<votes>1</votes>

comments (or comment)

<comments>
    <comment id="39270" author="jsmith" created="Tue, 24 Feb 2009 16:45:02 -0600 (CST)">this looks familiar</comment>
    <comment id="39273" author="jbrown" created="Tue, 24 Feb 2009 16:48:16 -0600 (CST)">to me too</comment>
</comments>

attachments (or attachment)

<attachments>
   <attachment id="30318" name="Issue Navigator - Atlassian JIRA-2.png" size="16161" author="yoz" created="Mon, 9 Feb 2009 13:32:58 -0600 (CST)"/>
   <attachment id="30323" name="Windows XP (with Firefox 3.0).jpg" size="5802" author="vbharara" created="Tue, 10 Feb 2009 00:30:11 -0600 (CST)"/>
</attachments>

Only available if your administrator has enabled attachments.

timeoriginalestimate

<timeoriginalestimate seconds="600">10 minutes</timeoriginalestimate>

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

timeestimate

<timeestimate seconds="300">5 minutes</timeestimate>

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

timespent

<timespent seconds="300">5 minutes</timespent>

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

aggregatetimeoriginalestimate

<aggregatetimeoriginalestimate seconds="36000">10 hours</aggregatetimeoriginalestimate>

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

aggregatetimeestimate

<aggregatetimeremainingestimate seconds="18000">5 hours</aggregatetimeremainingestimate>

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

aggregatetimespent

<aggregatetimespent seconds="18000">5 hours</aggregatetimespent>

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

timetracking

<timeoriginalestimate seconds="600">10 minutes</timeoriginalestimate>
<timeestimate seconds="300">5 minutes</timeestimate>
<timespent seconds="300">5 minutes</timespent>
<aggregatetimeoriginalestimate seconds="36000">10 hours</aggregatetimeoriginalestimate>
<aggregatetimeremainingestimate seconds="18000">5 hours</aggregatetimeremainingestimate>
<aggregatetimespent seconds="18000">5 hours</aggregatetimespent>

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

<issuelinks>
    <issuelinktype id="10020">
        <name>Duplicate</name>
        <inwardlinks description="is duplicated by">
            <issuelink>
                <issuekey id="22477">INTSYS-1009</issuekey>
            </issuelink>
        </inwardlinks>
    </issuelinktype>
</issuelinks>

subtasks (or subtask)

<subtasks>
    <subtask id="22623">TEST-8</subtask>
</subtasks>

customfield_xxxxx

<customfields>
    <customfield id="customfield_10112" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
        <customfieldname>Department</customfieldname>
        <customfieldvalues>
            <customfieldvalue>Adminstration</customfieldvalue>
        </customfieldvalues>
    </customfield>
</customfields>

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

allcustom

<customfields>
    <customfield id="customfield_10112" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
        <customfieldname>Department</customfieldname>
        <customfieldvalues>
            <customfieldvalue>Adminstration</customfieldvalue>
        </customfieldvalues>
    </customfield>
    <customfield id="customfield_10111" key="com.atlassian.jira.plugin.system.customfieldtypes:select">
        <customfieldname>Expenditure Type</customfieldname>
        <customfieldvalues>
            <customfieldvalue>Operating</customfieldvalue>
        </customfieldvalues>
    </customfield>
</customfields>

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.

Viewing a Chart

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport