You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Resource: External System's Links ( /api/externalsystem/{systemId}/links )

A collection resource which allows the search and retrieval of external system links for a specific external system (Defect Trackers and Enterprise Architect connections).

This resource supports the following methods: GET

Methods


Retrieves all (or a subset) external system links for a specific external system.

This method supports the OData parameters $filter, $top, $take, $orderby and $inlinecount. See OData Topic for more details.

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 - Get all external system links for a specific external system

An example of fetching all external system links

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{systemId}b5ee119f-bc44-4b3c-befe-919f2fe3f4f7The unique identifier for the external system.

Response Headers

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

Response Body

[
  {
    "ExternalSystemId": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
    "ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281",
    "ProjectName": null,
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Type": "Incident",
    "TypeForDisplay": null,
    "ExternalSystemName": "Jira PROD",
    "ExternalSystemImplementationType": "Jira",
    "ExternalSystemConnectionType": 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": [],
    "AutoSelect": "NotApplicable",
    "Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Links": [
      {
        "Title": "Configuration Editor",
        "Href": "http://localhost/api",
        "Rel": "Edit"
      }
    ]
  },
  {
    "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": [],
    "AutoSelect": "NotApplicable",
    "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 for a specific external system filtered by type and project Id

An example of retrieving a set of external system links by type and project Id using the ODATA $filter query parameter.

Request Headers

KeyValueDescription
Content-typeapplication/json
Acceptapplication/json

Request Parameters

KeyValueDescription
{systemId}b5ee119f-bc44-4b3c-befe-919f2fe3f4f7The unique identifier for the external system.
$filterType 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

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

Response Body

[
  {
    "ExternalSystemId": "b5ee119f-bc44-4b3c-befe-919f2fe3f4f7",
    "ProjectId": "3afbe0dd-55ca-419e-b75d-d21c821d7281",
    "ProjectName": null,
    "Id": "a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Type": "Incident",
    "TypeForDisplay": null,
    "ExternalSystemName": "Jira PROD",
    "ExternalSystemImplementationType": "Jira",
    "ExternalSystemConnectionType": 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": [],
    "AutoSelect": "NotApplicable",
    "Self": "http://localhost/api/externalsystemlink/a01fc7ed-3492-4792-9a0b-e2b52fa10913",
    "Links": [
      {
        "Title": "Configuration Editor",
        "Href": "http://localhost/api",
        "Rel": "Edit"
      }
    ]
  }
]

Status Code

200 - OK

  • No labels