The IssueDetails.ashx resource provides access to all the details about an individual issue (except for the raw attachment data).

Operations

The following HTTP operations are supported by IssueDetails.ashx:

HTTP Operation

Description

GET

Returns an IssueDetails response containing the details of the specified IssueId (or IssueNumber). If including the issue fields (see the Include query string parameter below) all issue fields are returned

HEAD

Returns an empty response if the specified IssueId (or IssueNumber) exists Returns a 404 - not found response if the specified IssueId does not exist.

POST

Updates or creates an issue depending upon the body of the request. Uses the Ignore query string parameter (ie. the IssueId, Include and Exclude parameters are not used).

The body of the request must be either an IssueCreate XML message or an IssueUpdate XML message

Query String Parameters

Parameter

Purpose

IssueId

Used for GET and HEAD requests to specify the IssueId or IssueNumber of the issue to return information about. Note that supplying the IssueNumber is only valid/possible if RMTrack's per-project issue numbering site option has been enabled.

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

Ignore

Used for POST requests to specify a comma separated list of validations that should be ignored. Validations that can be suppressed are: RequiredFields

Format

Used for GET and POST requests to specify whether the response should be returned formatted as XML or JSON (default is XML). Note that for POST requests the posted data's format must conform to this setting (ie. if using JSON then when POST'ing the request body must be formatted as JSON)

See Also