Resource: Requirement Comments ( /api/requirement/{id}/comments )

Allows the retrieval of external comments associated with any tickets this requirement has been synchronized with.

This resource supports the following methods: GET

Methods

GET

Retrieves all (or a subset) of external ticket comments associated with this requirement.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

Required Permissions

  • TestManagement/View

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if you do not have permission to view this requirement's comments.
404 - NotFoundReturned if requirement does not exist.

Example - Retrieve all comments for a requirement

Retrieves all the comments for a requirement.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{id}f6e5de1d-809a-4848-8630-09f5097db052ID of the Requirement to retrieve comments for

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Items": [
    {
      "CreatedAt": "2012-03-03T21:12:01Z",
      "Body": "Joe Bloggs attached file test.png to this issue",
      "CreatedBy": "joeb",
      "Id": "1234",
      "ExternalSystemLinkId": "86b6d146-28f3-47ad-ba6b-252a849f5751",
      "TicketId": "57573",
      "Self": "http://localhost/api/externalsystemlink/86b6d146-28f3-47ad-ba6b-252a849f5751/ticket/57573/comment/1234",
      "Links": [
        {
          "Href": "http://localhost/api/externalsystemlink/86b6d146-28f3-47ad-ba6b-252a849f5751/ticket/57573",
          "Rel": "Ticket"
        },
        {
          "Href": "http://localhost/api/externalsystemlink/86b6d146-28f3-47ad-ba6b-252a849f5751",
          "Rel": "ExternalSystemLink"
        }
      ]
    }
  ]
}

Status Code

200 - OK

  • No labels