Predefined Queries - List

服务:

Work

API 版本:

7.2-preview.1

检索已知查询集

GET https://dev.azure.com/{organization}/{project}/_apis/work/predefinedqueries?api-version=7.2-preview.1

URI 参数

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

响应

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

安全性

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

定义

名称	说明
PredefinedQuery	表示单个预定义查询。
ReferenceLinks	表示 REST 引用链接集合的类。
WorkItem	描述工作项。
WorkItemCommentVersionRef	表示对工作项的注释的特定版本的引用。
WorkItemRelation

PredefinedQuery

Object

表示单个预定义查询。

名称	类型	说明
hasMore	boolean	查询是否返回了完整的数据集，还是数据被截断。
id	string	查询的 ID
name	string	查询的本地化名称
results	WorkItem[]	查询的结果。 这是一组仅包含“id”集的 WorkItem 对象。 客户端负责根据需要对数据进行分页。
url	string	用于检索此查询结果的 REST API URL
webUrl	string	用于在浏览器中显示包含此查询结果的页面的 URL

ReferenceLinks

Object

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

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

WorkItem

Object

描述工作项。

名称	类型	说明
_links	ReferenceLinks	链接对相关 REST 资源的引用。
commentVersionRef	WorkItemCommentVersionRef	对此修订中添加/编辑/删除的特定批注版本的引用。
fields	object	工作项的字段和值映射。
id	integer (int32)	工作项 ID。
multilineFieldsFormat		描述最后一个编辑用户选择的多行字段的格式的字典。
relations	WorkItemRelation[]	工作项的关系。
rev	integer (int32)	工作项的修订号。
url	string	资源的 REST URL。

WorkItemCommentVersionRef

Object

表示对工作项的注释的特定版本的引用。

名称	类型	说明
commentId	integer (int32)	分配给批注的 ID。
createdInRevision	integer (int32)	[内部]最初添加此注释的工作项修订。
isDeleted	boolean	[内部]指定是否删除注释。
text	string	[内部]注释的文本。
url	string	资源的 REST URL。
version	integer (int32)	版本号。

WorkItemRelation

Object

名称	类型	说明
attributes	object	链接属性的集合。
rel	string	关系类型。
url	string	链接 URL。