Backlogs - List

参考

服务:: Work

API 版本:: 7.1

列出所有积压工作级别

GET https://dev.azure.com/{organization}/{project}/{team}/_apis/work/backlogs?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
team	path	True	string	团队 ID 或团队名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	BacklogLevelConfiguration[]	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.work	授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Get backlogs

示例请求

HTTP

GET https://dev.azure.com/fabrikam/Fabrikam-Fiber/{team}/_apis/work/backlogs?api-version=7.1

示例响应

状态代码:: 200

{
  "count": 4,
  "value": [
    {
      "id": "Microsoft.EpicCategory",
      "name": "Epics",
      "rank": 4,
      "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": "Epic",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Epic"
        }
      ],
      "defaultWorkItemType": {
        "name": "Epic",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Epic"
      },
      "color": "FF7B00",
      "isHidden": false,
      "type": "portfolio"
    },
    {
      "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"
    },
    {
      "id": "Microsoft.RequirementCategory",
      "name": "Stories",
      "rank": 2,
      "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.StoryPoints",
            "name": "Story Points",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
          },
          "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.IterationPath",
            "name": "Iteration Path",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
          },
          "width": 200
        },
        {
          "columnFieldReference": {
            "referenceName": "System.Tags",
            "name": "Tags",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Tags"
          },
          "width": 200
        }
      ],
      "workItemTypes": [
        {
          "name": "User Story",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/User%20Story"
        },
        {
          "name": "Bug",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Bug"
        }
      ],
      "defaultWorkItemType": {
        "name": "User Story",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/User%20Story"
      },
      "color": "009CCC",
      "isHidden": false,
      "type": "requirement"
    },
    {
      "id": "Microsoft.TaskCategory",
      "name": "Tasks",
      "rank": 1,
      "workItemCountLimit": 1000,
      "addPanelFields": [
        {
          "referenceName": "System.Title",
          "name": "Title",
          "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
        }
      ],
      "columnFields": [
        {
          "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": "System.AssignedTo",
            "name": "Assigned To",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
          },
          "width": 100
        },
        {
          "columnFieldReference": {
            "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
            "name": "Remaining Work",
            "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
          },
          "width": 50
        }
      ],
      "workItemTypes": [
        {
          "name": "Task",
          "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Task"
        }
      ],
      "defaultWorkItemType": {
        "name": "Task",
        "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber/_apis/wit/workItemTypes/Task"
      },
      "color": "F2CB1D",
      "isHidden": false,
      "type": "task"
    }
  ]
}

定义

名称	说明
BacklogColumn
BacklogLevelConfiguration
BacklogType	此积压工作级别的类型
WorkItemFieldReference	对工作项中的字段的引用
WorkItemTypeReference	对工作项类型的引用。

BacklogColumn

Object

名称	类型	说明
columnFieldReference	WorkItemFieldReference	对工作项中的字段的引用
width	integer (int32)

BacklogLevelConfiguration

Object

名称	类型	说明
addPanelFields	WorkItemFieldReference[]	要包含在“添加”面板中的字段列表
color	string	积压工作级别的颜色
columnFields	BacklogColumn[]	积压工作的默认列列表
defaultWorkItemType	WorkItemTypeReference	积压工作的默认工作项类型
id	string	积压工作 ID （对于进程配置中的旧积压工作级别，它可以是类别引用名称）
isHidden	boolean	指示积压工作级别是否隐藏
name	string	积压工作名称
rank	integer (int32)	积压工作排名（任务积压工作为 0）
type	BacklogType	此积压工作级别的类型
workItemCountLimit	integer (int32)	给定积压工作中要显示的最大工作项数
workItemTypes	WorkItemTypeReference[]	参与此积压工作（项目/流程称为“工作项”类型）可由 bug 的团队设置重写

BacklogType

枚举

此积压工作级别的类型

值	说明
portfolio	项目组合积压工作级别
requirement	要求积压工作级别
task	任务积压工作级别

WorkItemFieldReference

Object

对工作项中的字段的引用

名称	类型	说明
name	string	字段的友好名称。
referenceName	string	字段的引用名称。
url	string	资源的 REST URL。

WorkItemTypeReference

Object

对工作项类型的引用。

名称	类型	说明
name	string	工作项类型的名称。
url	string

通过

Backlogs - List

URI 参数

响应

安全性

oauth2

作用域

示例

Get backlogs

示例请求

示例响应

定义

BacklogColumn

BacklogLevelConfiguration

BacklogType

WorkItemFieldReference

WorkItemTypeReference

其他资源