...
Allows the retrieval of details for a single external system link (Incident, Requirement, UseCase link etc.).
This resource supports the following methods: DELETE, GET, PATCH
Methods
DELETE
...
Deletes the external system link and optionally removes all associated references and events.
...
Example - Get External System Link
An example of retrieving an external system link by its identifier.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| 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
| Code Block | ||
|---|---|---|
| ||
{
"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": [],
"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 - Enable External System Link
An example of changing the enabled state of a link by its ID.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| {id} | a01fc7ed-3492-4792-9a0b-e2b52fa10913 |
Request Body
| Code Block | ||
|---|---|---|
| ||
{ "Enabled": true }
|
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",
"ProjectName": null,
"Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"Type": "Incident",
"TypeForDisplay": null,
"ExternalSystemName": "Jira PROD",
"ExternalSystemImplementationType": "Jira",
"ExternalSystemConnectionType": null,
"Name": "Project X",
"Enabled": true,
"LastSynchronizedAt": "2012-01-01T14:04:07Z",
"LastDestinationToSourceSynchronizationAt": "2012-01-01T14:04:05Z",
"LastSourceToDestinationSynchronizationAt": "2012-01-01T14:04:06Z",
"ConfigurationComplete": true,
"ConfigurationProblems": [],
"Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"Links": [
{
"Title": "Configuration Editor",
"Href": "http://localhost/api",
"Rel": "Edit"
}
]
}
|
Status Code
200 - OK
...