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

Methods

GET

Retrieves an external resource identified by its attributes.

Supported Expansions

• FieldControls
• InitialFieldValues

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

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

{
  "End": "Destination",
  "Name": "TFS2010 - TFS",
  "Id": "0a1e8d7a-0078-4941-92e7-a17a00ed142f",
  "Key": "Synchronization",
  "CompatibleWithSourceKeys": [
    "Requirement"
  ],
  "Expands": [
    "FieldControls",
    "InitialFieldValues"
  ],
  "Self": "http://localhost/api/externalsourcemetadata?id=0a1e8d7a-0078-4941-92e7-a17a00ed142f&key=Synchronization&end=Destination"
}