Click or drag to resize

IssueSearch.ashx

The IssueSearch.ashx resource provides access to lists of issues that match a specified search criteria.

Operations

The following HTTP operations are supported by IssueSearch.ashx:

HTTP Operation

Description

GET

Returns an IssueList response containing issues that match the specified search 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.

IncludeClosed

If "True" then all issues including ones that are closed are returned. If "False" then only open issues are returned.

Fields

A comma separated list of fields to be returned.

Criteria

The search criteria. Maximum of 50 characters.

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

Issues List Response