Resource: External System Link Ticket ( /api/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId} )

Allows the retrieval of a single project ticket.

This resource supports the following methods: GET

Methods

GET

Retrieves a single ticket by its unique identifier.

Required Permissions

  • TestManagement/ManageIncidents/View
  • TestManagement/ManageRequirements/View
  • TestManagement/ManageScripts/View

Supported Expansions

  • ExternalSystem

For more details on expansions, please see the Expand help topic.

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.
404 - NotFoundReturned if external system does not exist.

Example - Get ticket

Example of Retrieving a ticket by its Id and the external system link its associated with.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{ticketId}18759
{externalSystemLinkId}c63e805c-e5d3-4919-9d10-a0a500e0754a

Response Headers

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

Response Body

{
  "Key": "TST-4629",
  "Summary": "Test windows title clips text on bottom",
  "Url": "https://mycompany.atlassian.net/browse/TST-4629",
  "Id": "18759",
  "Type": "Bug",
  "ExternalSystemId": "c63e805c-e5d3-4919-9d10-a0a500e0754a",
  "ExternalSystemName": "testing",
  "IncidentId": null,
  "Status": "Open",
  "InternalKey": null,
  "Self": "http://localhost/api/externalsystemlink/c63e805c-e5d3-4919-9d10-a0a500e0754a/ticket/18759",
  "Links": [
    {
      "Href": "http://localhost/api/externalsystemlink/c63e805c-e5d3-4919-9d10-a0a500e0754a/ticket/18759/link",
      "Rel": "StartCreateIncident"
    },
    {
      "Href": "http://localhost/api/externalsystemlink/c63e805c-e5d3-4919-9d10-a0a500e0754a",
      "Rel": "ExternalSystemLink"
    }
  ]
}

Status Code

200 - OK

  • No labels