Iterations - Get Iteration Work Items

Reference

Service:: Work

API Version:: 7.0

Get work items for iteration

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations/{iterationId}/workitems?api-version=7.0

URI Parameters

Name	In	Required	Type	Description
iterationId	path	True	string uuid	ID of the iteration
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
team	path		string	Team ID or team name
api-version	query	True	string	Version of the API to use. This should be set to '7.0' to use this version of the api.

Responses

Name	Type	Description
200 OK	IterationWorkItems	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

Get workitems

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553/workitems?api-version=7.0

Sample Response

Status code:: 200

{
  "workItemRelations": [
    {
      "rel": null,
      "source": null,
      "target": {
        "id": 1,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
      }
    },
    {
      "rel": "System.LinkTypes.Hierarchy-Forward",
      "source": {
        "id": 1,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
      },
      "target": {
        "id": 3,
        "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/3"
      }
    }
  ],
  "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553/workitems",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553/workitems"
    },
    "iteration": {
      "href": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/teamsettings/iterations/a589a806-bf11-4d4f-a031-c19813331553"
    }
  }
}

Definitions

Name	Description
IterationWorkItems	Represents work items in an iteration backlog
ReferenceLinks	The class to represent a collection of REST reference links.
WorkItemLink	A link between two work items.
WorkItemReference	Contains reference to a work item.

IterationWorkItems

Represents work items in an iteration backlog

Name	Type	Description
_links	ReferenceLinks	Collection of links relevant to resource
url	string	Full http link to the resource
workItemRelations	WorkItemLink[]	Work item relations

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

WorkItemLink

A link between two work items.

Name	Type	Description
rel	string	The type of link.
source	WorkItemReference	The source work item.
target	WorkItemReference	The target work item.

WorkItemReference

Contains reference to a work item.

Name	Type	Description
id	integer	Work item ID.
url	string	REST API URL of the resource

Share via