Backlogs - Get Backlog
Get a backlog level
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogs/{id}?api-version=6.0-preview.1
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
id
|
path | True |
string |
The id of the backlog level |
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
project
|
path | True |
string |
Project ID or project name |
team
|
path | True |
string |
Team ID or team name |
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0-preview.1' to use this version of the api. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
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 backlog
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/{team}/_apis/work/backlogs/{id}?api-version=6.0-preview.1
Sample Response
{
"id": "Microsoft.FeatureCategory",
"name": "Features",
"rank": 3,
"workItemCountLimit": 1000,
"addPanelFields": [
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
}
],
"columnFields": [
{
"columnFieldReference": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
},
"width": 400
},
{
"columnFieldReference": {
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Scheduling.Effort",
"name": "Effort",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.Effort"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.BusinessValue",
"name": "Business Value",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.BusinessValue"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.ValueArea",
"name": "Value Area",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.ValueArea"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
},
"width": 200
}
],
"workItemTypes": [
{
"name": "Feature",
"url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
}
],
"defaultWorkItemType": {
"name": "Feature",
"url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Feature"
},
"color": "773B93",
"isHidden": false,
"type": "portfolio"
}
Definitions
Name | Description |
---|---|
Backlog |
|
Backlog |
|
Backlog |
The type of this backlog level |
Work |
Reference to a field in a work item |
Work |
Reference to a work item type. |
BacklogColumn
Name | Type | Description |
---|---|---|
columnFieldReference |
Reference to a field in a work item |
|
width |
integer |
BacklogLevelConfiguration
Name | Type | Description |
---|---|---|
addPanelFields |
List of fields to include in Add Panel |
|
color |
string |
Color for the backlog level |
columnFields |
Default list of columns for the backlog |
|
defaultWorkItemType |
Default Work Item Type for the backlog |
|
id |
string |
Backlog Id (for Legacy Backlog Level from process config it can be categoryref name) |
isHidden |
boolean |
Indicates whether the backlog level is hidden |
name |
string |
Backlog Name |
rank |
integer |
Backlog Rank (Taskbacklog is 0) |
type |
The type of this backlog level |
|
workItemCountLimit |
integer |
Max number of work items to show in the given backlog |
workItemTypes |
Work Item types participating in this backlog as known by the project/Process, can be overridden by team settings for bugs |
BacklogType
The type of this backlog level
Name | Type | Description |
---|---|---|
portfolio |
string |
Portfolio backlog level |
requirement |
string |
Requirement backlog level |
task |
string |
Task backlog level |
WorkItemFieldReference
Reference to a field in a work item
Name | Type | Description |
---|---|---|
name |
string |
The friendly name of the field. |
referenceName |
string |
The reference name of the field. |
url |
string |
The REST URL of the resource. |
WorkItemTypeReference
Reference to a work item type.
Name | Type | Description |
---|---|---|
name |
string |
Name of the work item type. |
url |
string |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for