Updated Oct 16, 2009 by artdent

IssueTrackerAPIReference

Issue Tracker Data API Reference Guide

This document provides detailed reference documentation for the raw protocol (XML and HTTP) for the Issue Tracker Data API.

This document doesn't contain information about the programming-language client libraries. For client-library reference information, see the links from the programming-language-specific sections of the developer's guide.

Audience

This document is intended for programmers who want to write client applications that can interact with Project Hosting on Google Code's Issue Tracker.

It's a reference document; it assumes that you understand the concepts presented in the developer's guide, and the general ideas behind the Google Data APIs protocol.

Issue Tracker Data API feed types

Issue Tracker Data API provides a variety of representations of issue data. The Issue Tracker Data API provides two types of feeds: the Issues and IssueComments feed.

The Issues feed allows you to get a list of issues that match a certain criteria. To get all the issue for in an issue tracker, replace the PROJECT_NAME with your project's name in the url below:

http://code.google.com/feeds/issues/p/PROJECT_NAME/issues/full

The IssueComments feed allows you to get the issue comments for a specified issue. To get the issue comments for an issue, replace PROJECT_NAME with your project name and ISSUE_ID with a valid issue id number in the url below.

http://code.google.com/feeds/issues/p/PROJECT_NAME/issues/ISSUE_ID/comments/full

Project Hosting on Google Code query parameters reference

The Issue Tracker Data API supports the following standard Google Data API query parameters for the Issue feed:

If the info here is very simple/straightforward, then delete the table and just describe the parameter support in text.

Name	Support
max-results	Issues, IssueComments
prettyprint	Issues, IssueComments
start-index	Issues, IssueComments
published-max	Issues
published-min	Issues
updated-max	Issues
updated-min	Issues
q	Issues
alt	Issues

Issue Tracker Data API does not support the category, author, and strict parameters.

In addition to the standard Google Data API query parameters, the Issue Tracker Data API supports the following parameters:

Name	Description	Notes
author	Return issues based on who reported the issue. For Gmail users, this will be part of the email preceding the '@' sign.
can	Return issues based on a canned query identifier.	'All issues' all 'Open issues' open 'Open and owned by me' owned 'Open and reported by me' reported 'Open and starred by me'starred 'New issues' new 'Issues to verify' to-verify
id	The issue to return based on the issue id.
label	The type of issues to return based on the label set on the issue
owner	Return issues based on the owner of the issue. For Gmail users, this will be the part of the email preceding the '@' sign.
status	Return issues based on the status of the issue.

Issue Tracker elements reference

In addition to the standard Data API elements, the Issue Tacker Data API uses the following elements in the issues namespace.

For information about the standard Google Data API elements, see the Atom specification and the Kinds document.

issues namespace element reference

cc

Entry in the issue cc list.

The cc element can appear only as a child of IssuesEntry.

Properties

Property	Type	Description
Uri? (zero or one)	issues:uri	uri
Username (one)	issues:username	username

Example

<issues:cc>
	<issues:uri>/u/fitzwilliam.darcy/</issues:uri>
	<issues:username>fitzwilliam.darcy</issues:username>
</issues:cc>

ccUpdate

Issue cc update

The ccUpdate element can appear only as a child of Updates.

Properties

Property	Type	Description
string? (zero or one)	text()	value

Example

<issues:ccUpdate>fitzwilliam.darcy</issues:ccUpdate>

label

Issue label.

The label element can appear only as a child of IssuesEntry and Updates.

Properties

Property	Type	Description
string (one)	text()	value

Example

<issues:label>ThisIsFun</issues:label>

owner

Issue owner.

The owner element can appear only as a child of IssuesEntry.

Properties

Property	Type	Description
Uri? (zero or one)	issues:uri	uri
Username (one)	issues:username	username

Example

<issues:owner>
	<issues:uri>/u/fitzwilliam.darcy/</issues:uri>
	<issues:username>fitzwilliam.darcy</issues:username>
</issues:owner>

ownerUpdate

Issue owner update.

The ownerUpdate element can appear only as a child of Updates.

Properties

Property	Type	Description
string? (zero or one)	text()	value

Example

<issues:ownerUpdate>fitzwilliam.darcy</issues:ownerUpdate>

stars

Issue star count.

The stars element can appear only as a child of IssuesEntry.

Properties

Property	Type	Description
non-negative integer (one)	text()	value

Example

<issues:stars>0</issues:stars>

state

Whether the issue is open or closed.

The state element can appear only as a child of IssuesEntry.

Properties

Property	Type	Description
enum string (one)	text()	value

Example

<issues:state>open</issues:state>

status

Issue status

The status element can appear only as a child of IssuesEntry and Updates.

Properties

Property	Type	Description
string (one)	text()	value

Example

<issues:status>Accepted</issues:status>

summary

Issue summary.

The summary element can appear only as a child of Updates.

Properties

Property	Type	Description
string (one)	text()	value

Example

<issues:summary>Summary of issue</issues:summary>

Updates

List of metadata updates.

The updates element can appear only as a child of IssueCommentsEntry.

Properties

Property	Type	Description
ccUpdate (zero or more)	issues:ccUpdate	cc updates
Label (zero or more)	issues:label	labels
OwnerUpdate? (zero or one)	issues:ownerUpdate	owner updates
Status? (zero or one)	issues:status	status
Summary? (zero or one)	issues:summary	summary

Example

<issues:updates>
	<issues:ccUpdate>fitzwilliam.darcy</issues:ccUpdate>
	<issues:label>-Type-Defect</issues:label>
	<issues:label>-Priority-High</issues:label>
	<issues:label>Type-Task</issues:label>
	<issues:label>Priority-Medium</issues:label>
	<issues:ownerUpdate>elizabeth.bennet</issues:ownerUpdate>
	<issues:status>Accepted</issues:status>
	<issues:summary>anothersmoketest</issues:summary>
</issues:updates>

uri

Describes the URI associated with a user.

The uri element can appear only as a child of Cc and Owner.

Properties

Property	Type	Description
string? (zero or one)	text()	value

Example

<issues:uri>/u/fitzwilliam.darcy/</issues:uri>

username

Username of a user.

The username element can appear only as a child of Cc and Owner.

Properties

Property	Type	Description
string? (zero or one)	text()	value

Example

<issues:username>fitzwilliam.darcy</issues:username>