The IssueList.ashx resource provides access to lists of issues that match the specified criteria.

Operations

The following HTTP operations are supported by IssueList.ashx:

HTTP Operation

Description

GET

Returns an IssueList response containing issues that match the specified criteria.

Query String Parameters

Parameter

Purpose

ProjectId

Specifies the project the issues must belong to. If -1 is specified then all matching issues are returned regardless of project.

FilterCode

Specifies the filtering criteria. The following standard filters are supported:

Code

Meaning

s:all

All issues

s:allopen

All open issues

s:[userid]

All issues assigned to the specified user id (without the square brackets)

p:[userid]:[filtercode]

A user defined filter stored in RMTrack.

Fields

A comma separated list of fields to be returned.

Sort

A comma separated list of fields to sort the list of issues by before returning it. Start the field name with a minus sign, -, to indicate a descending sort direction.

Include

Used to specify a comma separated list of data elements to return. If not specified then the following data elements are included by default: Fields, Comments, Attachments, RelatedIssues, RelatedItems, Subscribers, Histories. The list of available elements includes:

  • Fields

  • Comments

  • Attachments

  • AttachmentData

  • RelatedIssues

  • RelatedItems

  • Subscribers

  • IssueHistories

  • IssueHistoryChangeDetails

Note that AttachmentData and IssueHistoryChangeDetails can be quite large.

Exclude

Used to specify a comma separated list of data elements not to return. The list of available elements includes:

  • Fields

  • Comments

  • Attachments

  • AttachmentData

  • RelatedIssues

  • RelatedItems

  • Subscribers

  • IssueHistories

  • IssueHistoryChangeDetails

Format

Used for GET requests to specify whether the response should be returned formatted as XML or JSON (default is XML).

See Also

Other Resources