Reporting Work Item Links - Get

Reference

Service:: Work Item Tracking

API Version:: 7.1-preview.3

Get a batch of work item links

GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemlinks?api-version=7.1-preview.3

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/reporting/workitemlinks?linkTypes={linkTypes}&types={types}&continuationToken={continuationToken}&startDateTime={startDateTime}&api-version=7.1-preview.3

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.3' to use this version of the api.
continuationToken	query		string	Specifies the continuationToken to start the batch from. Omit this parameter to get the first batch of links.
linkTypes	query		string array (string)	A list of types to filter the results to specific link types. Omit this parameter to get work item links of all link types.
startDateTime	query		string date-time	Date/time to use as a starting point for link changes. Only link changes that occurred after that date/time will be returned. Cannot be used in conjunction with 'watermark' parameter.
types	query		string array (string)	A list of types to filter the results to specific work item types. Omit this parameter to get work item links of all work item types.

Responses

Name	Type	Description
200 OK	ReportingWorkItemLinksBatch	successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.work	Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.

Examples

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/reporting/workitemlinks?api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "values": [
    {
      "rel": "System.LinkTypes.Hierarchy",
      "sourceId": 7,
      "targetId": 8,
      "changedDate": "2014-03-18T17:17:52.02Z",
      "isActive": true
    },
    {
      "rel": "System.LinkTypes.Hierarchy",
      "sourceId": 7,
      "targetId": 9,
      "changedDate": "2014-03-18T17:18:03.007Z",
      "isActive": true
    },
    {
      "rel": "System.LinkTypes.Hierarchy",
      "sourceId": 10,
      "targetId": 13,
      "changedDate": "2014-03-18T17:21:27.623Z",
      "isActive": true
    }
  ],
  "nextLink": "https://dev.azure.com/fabrikam/_apis/wit/reporting/workItemLinks?continuationToken=6281123&api-version=2.2",
  "isLastBatch": true
}

Definitions

ReportingWorkItemLinksBatch

Name	Type	Description
continuationToken	string	ContinuationToken acts as a waterMark. Used while querying large results.
isLastBatch	boolean	Returns 'true' if it's last batch, 'false' otherwise.
nextLink	string	The next link for the work item.
values	string[]	Values such as rel, sourceId, TargetId, ChangedDate, isActive.

Share via