Resource: External System ( /api/externalsystem/{id} )
Allows the retrieval of details for a single external system (Defect Tracker of Enterprise Architect connection)
Methods
GET
Retrieves a single external system by ID.
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. |
| 404 - NotFound | Returned if external system does not exist. |
Example - Get External System
Example of fetching an external system by ID
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | a01fc7ed-3492-4792-9a0b-e2b52fa10913 |
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"
}
Status Code
200 - OK