Resource: External System Links ( /api/externalsystemlinks )
Allows the search and retrieval of external system links (Defect Trackers and Enterprise Architect connections)
Root Relation: ExternalSystemLinks
Methods
GET
Retrieves all (or a subset) of external systems links
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. |
An example of fetching all external system links
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"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
An example of fetching a set of external system links by type and project Id, by using the ODATA $filter query parameter.
Request Headers
| Key | Value | Description |
|---|---|---|
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| $filter | Type eq 'Incident' AND ProjectId eq '3AFBE0DD-55CA-419E-B75D-D21C821D7281' | The ODATA $filter parameter, this query parameter should be url encoded i.e. $filter=Type%20eq%20'Incident'%20AND%20Project%20eq%20'3AFBE0DD-55CA-419E-B75D-D21C821D7281' |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
[
{
"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"
}
]
|
Status Code
200 - OK