...
Root Relation: ExternalSystemLinks
This resource supports the following methods: GET, POST
Methods
GET
...
Retrieves all (or a subset) of external system links.
...
Example - Get all external system links
An example of retrieving all external system links.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Top": 25,
"Total": 2,
"Items": [
{
"ExternalSystemId": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
"ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281",
"ProjectName": null,
"Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"Type": "Incident",
"NameTypeForDisplay": "Project X"null,
"EnabledExternalSystemName": "Jira falsePROD",
"LastSynchronizedAtExternalSystemImplementationType": "2012-01-01T14:04:07ZJira",
"LastDestinationToSourceSynchronizationAtExternalSystemConnectionType": "2012-01-01T14:04:05Z"null,
"LastSourceToDestinationSynchronizationAtName": "2012-01-01T14:04:06ZProject X",
"ConfigurationCompleteEnabled": truefalse,
"ConfigurationProblemsLastSynchronizedAt": []"2012-01-01T14:04:07Z",
"SelfLastDestinationToSourceSynchronizationAt": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa109132012-01-01T14:04:05Z",
"LinksLastSourceToDestinationSynchronizationAt": ["2012-01-01T14:04:06Z",
{
"ConfigurationComplete": true,
"TitleConfigurationProblems": "Configuration Editor"[],
"HrefSelf": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"Links": [
"Rel": "Edit"
{
}
]
"Title": "Configuration }Editor",
{
"ExternalSystemIdHref": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7http://localhost/api",
"ProjectIdRel": "3afbe0dd-55ca-419e-b75d-d21c821d7281","Edit"
}
]
"ProjectName": null},
{
"IdExternalSystemId": "a01fc7edb5ee119f-3492bc44-47924b3c-9a0bbefe-e2b52fa10913919f2fe3f4f7",
"TypeProjectId": "Requirement",
3afbe0dd-55ca-419e-b75d-d21c821d7281",
"NameProjectName": "Project X"null,
"EnabledId": false"a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"LastSynchronizedAtType": "2012-01-01T14:04:07ZRequirement",
"LastDestinationToSourceSynchronizationAtTypeForDisplay": "2012-01-01T14:04:05Z"null,
"LastSourceToDestinationSynchronizationAtExternalSystemName": "2012-01-01T14:04:06ZJira PROD",
"ConfigurationCompleteExternalSystemImplementationType": true"Jira",
"ConfigurationProblemsExternalSystemConnectionType": []null,
"SelfName": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913Project X",
"LinksEnabled": [false,
{"LastSynchronizedAt": "2012-01-01T14:04:07Z",
"TitleLastDestinationToSourceSynchronizationAt": "Configuration Editor2012-01-01T14:04:05Z",
"HrefLastSourceToDestinationSynchronizationAt": "http://localhost/api2012-01-01T14:04:06Z",
"ConfigurationComplete": true,
"RelConfigurationProblems": "Edit"[],
"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 filtered by type
An example of retrieving a set of external system links by type and project Id, by using the ODATA $filter query parameter.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Parameters
| Key | Value | Description |
|---|---|---|
| $filter | Type eq 'Incident' and ProjectId eq guid'3AFBE0DD-55CA-419E-B75D-D21C821D7281' | The ODATA $filter parameter, this query parameter should be url encoded i.e. $filter=Type%20eq%20'Incident'%20and%20ProjectId%20eq%20guid'3AFBE0DD-55CA-419E-B75D-D21C821D7281' |
Response Headers
| Key | Value | Description |
|---|---|---|
| Content-Type | application/json; charset=utf-8 |
Response Body
| Code Block | ||
|---|---|---|
| ||
{
"Skip": 0,
"Top": 25,
"Total": 1,
"SkipItems": 0, [
{
"TopExternalSystemId": 25"b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
"TotalProjectId": 1"3afbe0dd-55ca-419e-b75d-d21c821d7281",
"Items": [
{"ProjectName": null,
"ExternalSystemIdId": "b5ee119fa01fc7ed-bc443492-4b3c4792-befe9a0b-919f2fe3f4f7e2b52fa10913",
"ProjectIdType": "3afbe0dd-55ca-419e-b75d-d21c821d7281Incident",
"ProjectNameTypeForDisplay": null,
"IdExternalSystemName": "a01fc7ed-3492-4792-9a0b-e2b52fa10913 "Jira PROD",
"ExternalSystemImplementationType": "Jira",
"TypeExternalSystemConnectionType": "Incident"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"
}
]
}
],
"Self": "http://localhost/Enterprise/ExternalSystemLinks?$filter=Type eq 'Incident' and ProjectId eq guid'3AFBE0DD-55CA-419E-B75D-D21C821D7281'"
}
|
Status Code
200 - OK
...
Example - Create a new external system link
Create a new External System Link between a project in ET and a project in Jira, synchronizing requirements.
The ID of the project in ET is specified in the 'ProjectId' parameter of the Source FieldVaues object.
The ID of the project in Jira is specified in the 'ProjectId' parameter of the Destination FieldValues object.
Note: To determine the required FieldValues you can supply the '$expand=InitialFieldValues' query parameter when retrieving the list of External Sources from /api/externalsources, to include examples of what FieldValues are expected.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"Source": {
"Key": "Requirement",
"Id": null,
"FieldValues": {
"ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281"
}
},
"Destination": {
"Key": "Synchronization",
"Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"FieldValues": {
"ProjectId": "12345"
}
},
"Name": "Project X"
}
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Location | http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913 | |
| 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-9a0b-e2b52fa10913",
"Type": "Requirement",
"TypeForDisplay": null,
"ExternalSystemName": "Rally",
"ExternalSystemImplementationType": "Rally",
"TypeExternalSystemConnectionType": "Requirement"null,
"Name": "Project X Requirements",
"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
201 - Created
Example - Create a new external system link which is disabled
Create a new External System Link between a project in ET and a project in Jira, synchronizing requirements, and create it with the 'Enabled' state set to false.
Request Headers
| Key | Value | Description |
|---|---|---|
| Content-type | application/json | |
| Accept | application/json |
Request Body
| Code Block | ||
|---|---|---|
| ||
{
"Source": {
"Key": "Requirement",
"Id": null,
"FieldValues": {
"ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281"
}
},
"Destination": {
"Key": "Synchronization",
"Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"FieldValues": {
"ProjectId": "12345"
}
},
"Name": "Project X",
"Enabled": false
}
|
Response Headers
| Key | Value | Description |
|---|---|---|
| Location | http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913 | |
| 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": "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": [],
"Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"Links": [
{
"Title": "Configuration Editor",
"Href": "http://localhost/api",
"Rel": "Edit"
}
]
}
|
Status Code
201 - Created
...