Resource: External System's Links ( /api/externalsystem/{systemId}/links )

Allows the search and retrieval of external system links for an external system (Defect Trackers and Enterprise Architect connections)

Methods

GET

Retrieves all (or a subset) of external systems links for an external system

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

Supported Expansions

Configuration
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).

Status	Description
200 - OK	Returned if the request was completed successfully.

Example - Get all external system links

An example of fetching all external system links

Request Headers

Key	Value	Description
Accept	application/json

Request Parameters

Key	Value	Description
{systemId}	b5ee119f-bc44-4b3c-befe-919f2fe3f4f7

Response Headers

Key	Value	Description
Content-Type	application/json; charset=utf-8

Response Body

[
  {
    "ExternalSystemId": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
    "ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281",
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Type": "Incident",
    "Name": "Project X",
    "Enabled": false,
    "LastSynchronizedAt": "2012-01-01T14:04:07Z",
    "LastDestinationToSourceSynchronizationAt": "2012-01-01T14:04:05Z",
    "LastSourceToDestinationSynchronizationAt": "2012-01-01T14:04:06Z",
    "Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913"
  },
  {
    "ExternalSystemId": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
    "ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281",
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Type": "Requirement",
    "Name": "Project X",
    "Enabled": false,
    "LastSynchronizedAt": "2012-01-01T14:04:07Z",
    "LastDestinationToSourceSynchronizationAt": "2012-01-01T14:04:05Z",
    "LastSourceToDestinationSynchronizationAt": "2012-01-01T14:04:06Z",
    "Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913"
  }
]

Status Code

200 - OK

Example - Get all external system links filtered by type

An example of fetching a set of external system links by type and project Id, by using the ODATA $filter query parameter.