Backlogconfiguration - Get
Gets backlog configuration for a team
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogconfiguration?api-version=5.0URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
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 '5.0' 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 configuration for a team
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/work/backlogconfiguration?api-version=5.0
Sample Response
{
"taskBacklog": {
"id": "Microsoft.TaskCategory",
"name": "Tasks",
"rank": 1,
"workItemCountLimit": 1000,
"addPanelFields": [
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
],
"columnFields": [
{
"columnFieldReference": {
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 400
},
{
"columnFieldReference": {
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.AssignedTo",
"name": "Assigned To",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
"name": "Remaining Work",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 50
}
],
"workItemTypes": [
{
"name": "Task",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Task"
}
],
"defaultWorkItemType": {
"name": "Task",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Task"
},
"color": "F2CB1D"
},
"requirementBacklog": {
"id": "Microsoft.RequirementCategory",
"name": "Stories",
"rank": 2,
"workItemCountLimit": 1000,
"addPanelFields": [
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
],
"columnFields": [
{
"columnFieldReference": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 400
},
{
"columnFieldReference": {
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
"name": "Story Points",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.ValueArea",
"name": "Value Area",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.IterationPath",
"name": "Iteration Path",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 200
},
{
"columnFieldReference": {
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 200
}
],
"workItemTypes": [
{
"name": "Ticket",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Ticket"
},
{
"name": "User Story",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/User%20Story"
}
],
"defaultWorkItemType": {
"name": "User Story",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/User%20Story"
},
"color": "009CCC"
},
"portfolioBacklogs": [
{
"id": "Microsoft.EpicCategory",
"name": "My level",
"rank": 4,
"workItemCountLimit": 1000,
"addPanelFields": [
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
],
"columnFields": [
{
"columnFieldReference": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 400
},
{
"columnFieldReference": {
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Scheduling.Effort",
"name": "Effort",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.BusinessValue",
"name": "Business Value",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.ValueArea",
"name": "Value Area",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 200
}
],
"workItemTypes": [
{
"name": "Epic",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Epic"
}
],
"defaultWorkItemType": {
"name": "Epic",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Epic"
},
"color": "60af49"
},
{
"id": "Microsoft.FeatureCategory",
"name": "Features",
"rank": 3,
"workItemCountLimit": 1000,
"addPanelFields": [
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
],
"columnFields": [
{
"columnFieldReference": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 400
},
{
"columnFieldReference": {
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Scheduling.Effort",
"name": "Effort",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.BusinessValue",
"name": "Business Value",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 50
},
{
"columnFieldReference": {
"referenceName": "Microsoft.VSTS.Common.ValueArea",
"name": "Value Area",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 100
},
{
"columnFieldReference": {
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
"width": 200
}
],
"workItemTypes": [
{
"name": "Feature",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Feature"
}
],
"defaultWorkItemType": {
"name": "Feature",
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/wit/workItemTypes/Feature"
},
"color": "773B93"
}
],
"workItemTypeMappedStates": [
{
"workItemTypeName": "User Story",
"states": {
"New": "Proposed",
"Active": "InProgress",
"Resolved": "InProgress",
"In Progress": "InProgress",
"Closed": "Completed"
}
},
{
"workItemTypeName": "Ticket",
"states": {
"New": "Proposed",
"Active": "InProgress",
"Closed": "Completed"
}
},
{
"workItemTypeName": "Feature",
"states": {
"New": "Proposed",
"Active": "InProgress",
"Resolved": "InProgress",
"Closed": "Completed"
}
},
{
"workItemTypeName": "Epic",
"states": {
"New": "Proposed",
"Active": "InProgress",
"Closed": "Completed"
}
},
{
"workItemTypeName": "Task",
"states": {
"New": "Proposed",
"Active": "InProgress",
"Closed": "Completed"
}
},
{
"workItemTypeName": "Bug",
"states": {
"Proposed": "Proposed",
"Testing": "InProgress",
"Resolved": "Resolved",
"Closed": "Completed"
}
}
],
"backlogFields": {
"typeFields": {
"Order": "Microsoft.VSTS.Common.StackRank",
"Effort": "Microsoft.VSTS.Scheduling.StoryPoints",
"RemainingWork": "Microsoft.VSTS.Scheduling.RemainingWork",
"Activity": "Microsoft.VSTS.Common.Activity"
}
},
"bugsBehavior": "asTasks",
"hiddenBacklogs": [
"Microsoft.EpicCategory"
],
"url": "https://dev.azure.com/fabrikam/c3b6da71-2b4a-497b-9137-ba8695203871/_apis/work/backlogconfiguration"
}Definitions
| Name | Description |
|---|---|
|
Backlog |
|
|
Backlog |
|
|
Backlog |
|
|
Backlog |
|
|
Backlog |
The type of this backlog level |
|
Bugs |
Bugs behavior |
|
Work |
Reference to a field in a work item |
|
Work |
Reference to a work item type. |
|
Work |
BacklogColumn
| Name | Type | Description |
|---|---|---|
| columnFieldReference |
Reference to a field in a work item |
|
| width |
integer |
BacklogConfiguration
| Name | Type | Description |
|---|---|---|
| backlogFields |
Behavior/type field mapping |
|
| bugsBehavior |
Bugs behavior |
|
| hiddenBacklogs |
string[] |
Hidden Backlog |
| portfolioBacklogs |
Portfolio backlog descriptors |
|
| requirementBacklog |
Requirement backlog |
|
| taskBacklog |
Task backlog |
|
| url |
string |
|
| workItemTypeMappedStates |
Mapped states for work item types |
BacklogFields
| Name | Type | Description |
|---|---|---|
| typeFields |
object |
Field Type (e.g. Order, Activity) to Field Reference Name map |
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 |
Defaulst 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 |
BugsBehavior
Bugs behavior
| Name | Type | Description |
|---|---|---|
| asRequirements |
string |
|
| asTasks |
string |
|
| off |
string |
WorkItemFieldReference
Reference to a field in a work item
| Name | Type | Description |
|---|---|---|
| name |
string |
The 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 |
WorkItemTypeStateInfo
| Name | Type | Description |
|---|---|---|
| states |
object |
State name to state category map |
| workItemTypeName |
string |
Work Item type name |
Feedback
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: https://aka.ms/ContentUserFeedback.
Submit and view feedback for