Resource: External System Link Copy ( /api/externalsystemlink/{linkId}/copy )
This is the resource which when POST'd to will create a copy of an existing external system link, targeting a new internal/remote project.
This resource supports the following methods: POST
Methods
POST
Create a a copy of an external systems link.
Required Permissions
- Resources/ExternalLinks
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 |
|---|---|
| 201 - Created | Returned if the request was completed successfully. |
Create a new External System Link between a project in ET and a project in Jira, synchronizing requirements, and copying the configuration from an existing link.
The ID of the existing external system link to copy the configuration from is identified in the 'CopyFromLinkId' parameter.
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 Parameters
| Key | Value | Description |
|---|---|---|
| {linkId} | b45599d1-d2b4-48d2-ad7e-db8d2882b7d9 | Identifier of the external system link to copy configuration from. |
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",
"CopyFromLinkId": "b45599d1-d2b4-48d2-ad7e-db8d2882b7d9"
}
|
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": true,
"LastSynchronizedAt": "2012-01-01T14:04:07Z",
"LastDestinationToSourceSynchronizationAt": "2012-01-01T14:04:05Z",
"LastSourceToDestinationSynchronizationAt": "2012-01-01T14:04:06Z",
"ConfigurationComplete": true,
"ConfigurationProblems": [],
"AutoSelect": "NotApplicable",
"Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
"Links": [
{
"Title": "Configuration Editor",
"Href": "http://localhost/api",
"Rel": "Edit"
}
]
}
|
Status Code
201 - Created