Work item links

Manage work item links

GET /links/{id} - Get a link by ID

GET /links - Get all links for the work items to which the user has access to.

GET /workitems/{workItemId}/links - Get all links for a work item

POST /links - Create a link

DELETE /links/{id} - Delete a link

The object representing a link has the following properties:

id: integer (Read-only) - ID of the link.

workItemId: integer (Required, Read-only) - ID of the work item to which the link belongs to.

projectId: integer (Required, Read-only) - ID of the project to which the associated work item belongs to.

displayText: string (Required) - Link text.

url: string (Required) - Link URL.

createdBy: string - The name of the user who created the link

createdAt: DateTime - The date when the link is created

lastModifiedBy: string - The name of the user who last modified the link

lastModifiedAt: DateTime - The date when the link is last modified

Resource Url

To make API requests use the URL [teampulse]/api/v1 where [teampulse] is the URL to the TeamPulse instance which you want to manage via the API.

Example:
[teampulse]/api/v1/links

GET /links/{id}

Response

HTTP/1.1 200

{
  "id": 1,
  "projectId": 1,
  "workItemId": 1,
  "displayText": "Link label 1",
  "url": "http://www.telerik.com/agile-project-management-tools/",
  "createdBy": "Paul Smith",
  "createdAt": "2013-06-20T10:10:00",
  "lastModifiedBy": "Paul Smith",
  "lastModifiedAt": "2013-06-20T11:45:00"
}

GET /links : Get all links for the work items to which the user has access to.

GET /workitems/{workItemId}/links : Get all links for a specific work item

OData $filter and $orderby options can be supplied to filter and order the results. $top and $skip to get top N items and skip the top M. Read more how to use the OData options

Response

HTTP/1.1 200

{
  "totalResults": 3,
  "top": 3,
  "results": [
    {
      "id": 1,
      "projectId": 1,
      "workItemId": 1,
      "displayText": "Link label 1",
      "url": "http://www.telerik.com/agile-project-management-tools/",
      "createdBy": "Paul Smith",
      "createdAt": "2013-06-20T10:10:00",
      "lastModifiedBy": "Paul Smith",
      "lastModifiedAt": "2013-06-20T11:45:00"       
    },
    {
      "id": 2,
      "projectId": 1,
      "workItemId": 1,
      "displayText": "Link label 2",
      "url": "http://www.telerik.com/agile-project-management-tools/",
      "createdBy": "Paul Smith",
      "createdAt": "2013-06-20T10:10:00",
      "lastModifiedBy": "Paul Smith",
      "lastModifiedAt": "2013-06-20T11:45:00"       
    },
    {
      "id": 3,
      "projectId": 1,
      "workItemId": 1,
      "displayText": "Link label 3",
      "url": "http://www.telerik.com/agile-project-management-tools/",
      "createdBy": "Paul Smith",
      "createdAt": "2013-06-20T10:10:00",
      "lastModifiedBy": "Paul Smith",
      "lastModifiedAt": "2013-06-20T11:45:00"       
    }
  ]
}

POST /links

Request

{
  "workItemId": 1,
  "displayText": "Link label 1",
  "url": "http://www.telerik.com/agile-project-management-tools/",
  "createdBy": "Paul Smith"
}

Response

HTTP/1.1 201

{
  "id": 1,
  "projectId": 1,
  "workItemId": 1,
  "displayText": "Link label 1",
  "url": "http://www.telerik.com/agile-project-management-tools/",
  "createdBy": "Paul Smith",
  "createdAt": "2013-06-20T10:10:00",
  "lastModifiedBy": "Paul Smith",
  "lastModifiedAt": "2013-06-20T10:10:00"       
}

PUT /links/{id}

Request

{
  "displayText": "Link label 1",
  "url": "http://www.telerik.com/agile-project-management-tools/"
}

Response

HTTP/1.1 200

{
  "id": 1,
  "projectId": 1,
  "workItemId": 1,
  "displayText": "Link label 1",
  "url": "http://www.telerik.com/agile-project-management-tools/",
  "createdBy": "Paul Smith",
  "createdAt": "2013-06-20T10:10:00",
  "lastModifiedBy": "Paul Smith",
  "lastModifiedAt": "2013-06-20T11:45:00"       
}

DELETE /links/{id}

Response

HTTP/1.1 200