Shelvesets - Get Shelveset Work Items

Service:: Tfvc

API Version:: 7.1

Get work items associated with a shelveset.

GET https://dev.azure.com/{organization}/_apis/tfvc/shelvesets/workitems?shelvesetId={shelvesetId}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.
shelvesetId	query	True	string	Shelveset's unique ID

Responses

Name	Type	Description
200 OK	AssociatedWorkItem[]	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.code	Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Examples

GET a list of workitems for a ShelvesetId.

Sample request

HTTP

GET https://dev.azure.com/fabrikam/_apis/tfvc/shelvesets/workitems?shelvesetId=My first shelveset;d6245f20-2af8-44f4-9451-8107cb2767db&api-version=7.1

Sample response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "webUrl": "https://dev.azure.com/fabrikam/web/wi.aspx?pcguid=d81542e4-cdfa-4333-b082-1ae2d6c3ad16&id=22",
      "id": 22,
      "title": "Wrong output",
      "workItemType": "Bug",
      "state": "Done"
    }
  ]
}

Definitions

AssociatedWorkItem

Object

Name	Type	Description
assignedTo	string
id	integer (int32)	Id of associated the work item.
state	string
title	string
url	string	REST Url of the work item.
webUrl	string
workItemType	string

Share via