Help Contents

 

External Source Metadata

Resource: External Source Metadata ( /api/externalsourcemetadata )

Allows the retrieval of an external source's metadata. Metadata provides identifying information and additional field metadata which can be used when creating a new link by POSTing to the /api/externalsystemlink resource.

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 in 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 returned from these resources allows you to identify compatible source and destination ends via the property 'CompatibleWithSourceKeys'.

This resource supports the following methods: GET

Methods

GET


Retrieves an external resource identified by its attributes.

Supported Expansions

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).

StatusDescription
200 - OKReturned if the request was completed successfully.

Example - Retrieve an external source's metadata identified by end and key

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

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
endSourceThe end the source belongs to
keyRequirementThe key of the source

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "End": "Source",
  "Name": "Requirements",
  "Id": null,
  "Key": "Requirement",
  "CompatibleWithSourceKeys": null,
  "Expands": [
    "Widgets",
    "InitialFieldValues"
  ],
  "Self": "http://localhost/api/externalsourcemetadata?key=Requirement&end=Source"
}

Status Code

200 - OK

Example - Retrieve an external source's metadata identified by end, key and external system ID

An example of retrieving an external source's metadata identified by end, key and external system.

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
endDestinationThe end the source belongs to.
keySynchronizationThe key of the source.
id0a1e8d7a-0078-4941-92e7-a17a00ed142fThe unique identifier for the the external system.

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-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=0a1e8d7a-0078-4941-92e7-a17a00ed142f&key=Synchronization&end=Destination"
}

Status Code

200 - OK