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

A collection resource which allows the search and retrieval of external system links for a specific external system (Defect Trackers and Enterprise Architect connections).

This resource supports the following methods: GET

Methods

GET

Retrieves all (or a subset) external system links for a specific external system.

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

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 for a specific external system

An example of fetching all external system links

Request Headers

Key	Value	Description
Content-type	application/json
Accept	application/json

Request Parameters

Key	Value	Description
{systemId}	b5ee119f-bc44-4b3c-befe-919f2fe3f4f7	The unique identifier for the external system.

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",
    "ProjectName": null,
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Type": "Incident",
    "TypeForDisplay": null,
    "ExternalSystemName": "Jira PROD",
    "ExternalSystemImplementationType": "Jira",
    "ExternalSystemConnectionType": null,
    "Name": "Project X",
    "Enabled": false,
    "LastSynchronizedAt": "2012-01-01T14:04:07Z",
    "LastDestinationToSourceSynchronizationAt": "2012-01-01T14:04:05Z",
    "LastSourceToDestinationSynchronizationAt": "2012-01-01T14:04:06Z",
    "ConfigurationComplete": true,
    "ConfigurationProblems": [],
    "AutoSelect": "NotApplicable",
    "Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Links": [
      {
        "Title": "Configuration Editor",
        "Href": "http://localhost/api",
        "Rel": "Edit"
      }
    ]
  },
  {
    "ExternalSystemId": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
    "ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281",
    "ProjectName": null,
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Type": "Requirement",
    "TypeForDisplay": null,
    "ExternalSystemName": "Rally",
    "ExternalSystemImplementationType": "Rally",
    "ExternalSystemConnectionType": null,
    "Name": "Project X Requirements",
    "Enabled": false,
    "LastSynchronizedAt": "2012-01-01T14:04:07Z",
    "LastDestinationToSourceSynchronizationAt": "2012-01-01T14:04:05Z",
    "LastSourceToDestinationSynchronizationAt": "2012-01-01T14:04:06Z",
    "ConfigurationComplete": true,
    "ConfigurationProblems": [],
    "AutoSelect": "NotApplicable",
    "Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Links": [
      {
        "Title": "Configuration Editor",
        "Href": "http://localhost/api",
        "Rel": "Edit"
      }
    ]
  }
]

Status Code

200 - OK

Example - Get all external system links for a specific external system filtered by type and project Id

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