Resource: External Systems ( /api/externalsystems )

Allows the search and retrieval of external systems (Defect Trackers and Enterprise Architect connections)

Root Relation: ExternalSystems

Methods

GET

Retrieves all (or a subset) of external systems.

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

Supported Expansions

Configuration
ExternalSystemLinks

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 al external systems

An example of fetching all external systems.

Request Headers

Key	Value	Description
Accept	application/json

Response Headers

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

Response Body

[
  {
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Name": "TFS",
    "ConnectionString": "http://tfs.mycompany.com:8080/tfs/Projects",
    "Type": "TFS2010",
    "Enabled": true,
    "ImplementationType": "DefectTracker",
    "UserName": "remote_tfs",
    "Self": "http://localhost/api/externalsystem/a01fc7ed-3492-4792-9a0b-e2b52fa10913"
  },
  {
    "Id": "744904d6-9612-4e87-a718-7b5d80c0060d",
    "Name": "Jira Production",
    "ConnectionString": "http://tfs.mycompany.com:8080/tfs/Projects",
    "Type": "Jira",
    "Enabled": true,
    "ImplementationType": "DefectTracker",
    "UserName": "remote",
    "Self": "http://localhost/api/externalsystem/744904d6-9612-4e87-a718-7b5d80c0060d"
  }
]

Status Code

200 - OK

Example - Get external systems filtered by type

An example of fetching a set of external systems by type, by using the ODATA $filter query parameter.