Date: Fri, 29 Mar 2024 07:19:18 +0000 (UTC) Message-ID: <11222562.11331.1711696758980@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_11330_1993037633.1711696758969" ------=_Part_11330_1993037633.1711696758969 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Allows the retrieval of an external source's metadata. Metadata provides= identifying information and additional field metadata which can be used wh= en creating a new link by POSTing to the /api/externalsystemlink resource.<= /p>
The metadata for external sources have an associated end - the 'Source' = end is for entities within Enterprise Tester (e.g. requirement, test script= and incident).
The 'Destination' end is for entities in external systems (e.g. Issues i= n Jira, test cases in Enterprise Architect, User stories in rally etc.).
To create a suitable link between a 'Source' and 'Destination' end, the = 'Destination' end must be compatible with the 'Source' end - the metadata r= eturned from these resources allows you to identify compatible source and d= estination ends via the property 'CompatibleWithSourceKeys'.
This resource supports the following methods: GET
Retrieves an external resource identified by its attributes.
For more details on expansions, please see the Expand help topic.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
An example of retrieving an external source's metadata identified by end= and key. This is a common approach for retrieving a source for the 'Source= ' (ET) end.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
end | Source | The end the source belongs to |
key | Requirement | The key of the source |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "End": "Source", "Name": "Requirements", "Id": null, "Key": "Requirement", "CompatibleWithSourceKeys": null, "Expands": [ "Widgets", "InitialFieldValues" ], "Self": "http://localhost/api/externalsourcemetadata?key=3DRequirement&am= p;end=3DSource" }
Status Code
200 - OK
An example of retrieving an external source's metadata identified by end= , key and external system.
Request Headers
Key | Value | Description |
---|---|---|
Content-type | application/json | |
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
end | Destination | The end the source belongs to. |
key | Synchronization | The key of the source. |
id | 0a1e8d7a-0078-4941-92e7-a17a00ed142f | The unique identifier for the the external syste= m. |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "End": "Destination", "Name": "TFS2010 - TFS", "Id": "0a1e8d7a-0078-4941-92e7-a17a00ed142f", "Key": "Synchronization", "CompatibleWithSourceKeys": [ "Requirement" ], "Expands": [ "Widgets", "InitialFieldValues" ], "Self": "http://localhost/api/externalsourcemetadata?id=3D0a1e8d7a-0078-4= 941-92e7-a17a00ed142f&key=3DSynchronization&end=3DDestination" }
Status Code
200 - OK