Boards - Get

服务:

Work

API 版本:

7.1

获取板

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

URI 参数

名称	在	必需	类型	说明
id	path	True	string	板的标识符，板的积压工作级别名称（例如：“故事”）或 ID
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
team	path		string	团队 ID 或团队名称
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	Board	成功作

安全性

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	授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。

定义

名称	说明
Board
BoardColumn
BoardColumnType
BoardFields
BoardRow
FieldReference	对字段的抽象引用
ReferenceLinks	表示 REST 引用链接集合的类。

Board

Object

名称	类型	说明
_links	ReferenceLinks	表示 REST 引用链接集合的类。
allowedMappings	object
canEdit	boolean
columns	BoardColumn[]
fields	BoardFields
id	string (uuid)	资源的 ID
isValid	boolean
name	string	资源的名称
revision	integer (int32)
rows	BoardRow[]
url	string	指向资源的完整 http 链接

BoardColumn

Object

名称	类型	说明
columnType	BoardColumnType
description	string
id	string (uuid)
isSplit	boolean
itemLimit	integer (int32)
name	string
stateMappings	object

BoardColumnType

枚举

值	说明
inProgress
incoming
outgoing

BoardFields

Object

名称	类型	说明
columnField	FieldReference	对字段的抽象引用
doneField	FieldReference	对字段的抽象引用
rowField	FieldReference	对字段的抽象引用

BoardRow

Object

名称	类型	说明
color	string
id	string (uuid)
name	string

FieldReference

Object

对字段的抽象引用

名称	类型	说明
referenceName	string	字段的 fieldRefName
url	string	指向有关字段的详细信息的完整 http 链接

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。