Queries - Search Queries
搜索用户有权访问当前项目中的所有查询
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=7.1GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=7.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
project
|
path | True |
string |
项目 ID 或项目名称 |
|
$filter
|
query | True |
string |
用于筛选查询的文本。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
|
$expand
|
query | |||
|
$include
|
query |
boolean |
包括已删除的查询和文件夹 |
|
|
$top
|
query |
integer (int32) |
要返回的查询数（默认值为 50，最大值为 200）。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功作 |
安全性
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 | 授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。 |
定义
| 名称 | 说明 |
|---|---|
|
Identity |
描述对标识的引用。 |
|
Link |
链接查询模式。 |
|
Logical |
分隔条件子句的逻辑运算符 |
|
Query |
查询的展开参数。 可能的选项包括 { None、Wiql、Clauses、All、Minimal } |
|
Query |
表示工作项查询层次结构中的项。 这可以是查询或文件夹。 |
|
Query |
|
|
Query |
用于树查询的递归选项。 |
|
Query |
查询的类型。 |
|
Reference |
表示 REST 引用链接集合的类。 |
|
Work |
描述工作项字段作。 |
|
Work |
对工作项中的字段的引用 |
|
Work |
表示工作项查询中的子句。 这显示了工作项查询的结构。 |
|
Work |
排序列。 |
IdentityReference
描述对标识的引用。
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
| descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
| directoryAlias |
string |
已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索 |
| displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。 |
| id |
string (uuid) |
|
| imageUrl |
string |
已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用 |
| inactive |
boolean |
已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索 |
| isAadIdentity |
boolean |
已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType） |
| isContainer |
boolean |
已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType） |
| isDeletedInOrigin |
boolean |
|
| name |
string |
旧式后连属性。 这是常量中的 WIT 特定值。 客户端上将隐藏（但存在），除非它们以最新版本为目标 |
| profileUrl |
string |
已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用 |
| uniqueName |
string |
已弃用 - 请改用 Domain+PrincipalName |
| url |
string |
此 URL 是指向此图形主题的源资源的完整路由。 |
LinkQueryMode
链接查询模式。
| 值 | 说明 |
|---|---|
| linksOneHopDoesNotContain |
仅当没有链接的工作项满足链接和目标条件时，才返回满足源的工作项。 |
| linksOneHopMayContain |
返回满足源条件和链接条件的工作项，即使没有链接的工作项满足目标条件。 |
| linksOneHopMustContain |
返回满足源、目标和链接条件的工作项。 |
| linksRecursiveDoesNotContain | |
| linksRecursiveMayContain |
返回工作项的层次结构，这些工作项默认满足源 |
| linksRecursiveMustContain | |
| workItems |
返回工作项的平面列表。 |
LogicalOperation
分隔条件子句的逻辑运算符
| 值 | 说明 |
|---|---|
| and | |
| none | |
| or |
QueryExpand
查询的展开参数。 可能的选项包括 { None、Wiql、Clauses、All、Minimal }
| 值 | 说明 |
|---|---|
| all |
展开所有属性 |
| clauses |
展开列、链接、ChangeInfo、WIQL 文本和子句 |
| minimal |
显示最小属性和 WIQL 文本 |
| none |
展开列、链接和 ChangeInfo |
| wiql |
展开列、链接、ChangeInfo 和 WIQL 文本 |
QueryHierarchyItem
表示工作项查询层次结构中的项。 这可以是查询或文件夹。
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
链接对相关 REST 资源的引用。 |
|
| children |
查询文件夹中的子查询项。 |
|
| clauses |
平面查询的子句。 |
|
| columns |
查询的列。 |
|
| createdBy |
创建查询项的标识。 |
|
| createdDate |
string (date-time) |
创建查询项时。 |
| filterOptions |
链接查询模式。 |
|
| hasChildren |
boolean |
如果这是查询文件夹，则指示它是否包含任何子级。 |
| id |
string (uuid) |
查询项的 ID。 |
| isDeleted |
boolean |
指示是否删除此查询项。 在已删除的查询项上将其设置为 false 将取消删除。 取消删除查询或文件夹不会返回以前应用于查询或文件夹的权限更改。 |
| isFolder |
boolean |
指示这是查询文件夹还是查询。 |
| isInvalidSyntax |
boolean |
指示此查询的 WIQL 是否无效。 这可能是由于语法无效或不再有效的区域/迭代路径造成的。 |
| isPublic |
boolean |
指示此查询项是公共的还是私有的。 |
| lastExecutedBy |
上次运行查询的标识。 |
|
| lastExecutedDate |
string (date-time) |
上次运行查询时。 |
| lastModifiedBy |
上次修改查询项的标识。 |
|
| lastModifiedDate |
string (date-time) |
上次修改查询项时。 |
| linkClauses |
链接查询子句。 |
|
| name |
string |
查询项的名称。 |
| path |
string |
查询项的路径。 |
| queryRecursionOption |
用于树查询的递归选项。 |
|
| queryType |
查询的类型。 |
|
| sortColumns |
查询的排序列。 |
|
| sourceClauses |
树或单跃点链接查询中的源子句。 |
|
| targetClauses |
树或单跃点链接查询中的目标子句。 |
|
| url |
string |
|
| wiql |
string |
查询的 WIQL 文本 |
QueryHierarchyItemsResult
| 名称 | 类型 | 说明 |
|---|---|---|
| count |
integer (int32) |
项计数。 |
| hasMore |
boolean |
指示是否已达到最大返回限制，但仍存在更多项 |
| value |
项列表 |
QueryRecursionOption
用于树查询的递归选项。
| 值 | 说明 |
|---|---|
| childFirst |
返回满足目标条件的工作项，即使没有工作项满足源和链接条件。 |
| parentFirst |
返回满足源的工作项，即使没有链接的工作项满足目标和链接条件。 |
QueryType
查询的类型。
| 值 | 说明 |
|---|---|
| flat |
获取工作项的平面列表。 |
| oneHop |
获取工作项及其直接链接的列表。 |
| tree |
获取显示其链接层次结构的工作项树。 |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |
WorkItemFieldOperation
描述工作项字段作。
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
作的友好名称。 |
| referenceName |
string |
作的引用名称。 |
WorkItemFieldReference
对工作项中的字段的引用
| 名称 | 类型 | 说明 |
|---|---|---|
| name |
string |
字段的友好名称。 |
| referenceName |
string |
字段的引用名称。 |
| url |
string |
资源的 REST URL。 |
WorkItemQueryClause
表示工作项查询中的子句。 这显示了工作项查询的结构。
| 名称 | 类型 | 说明 |
|---|---|---|
| clauses |
如果当前子句是逻辑运算符，则子句 |
|
| field |
与条件关联的字段 |
|
| fieldValue |
字段到字段比较时条件的右侧 |
|
| isFieldValue |
boolean |
确定这是字段到字段比较的字段 |
| logicalOperator |
分隔条件子句的逻辑运算符 |
|
| operator |
字段运算符 |
|
| value |
string |
当字段与值比较时条件的右侧 |
WorkItemQuerySortColumn
排序列。
| 名称 | 类型 | 说明 |
|---|---|---|
| descending |
boolean |
排序依据的方向。 |
| field |
工作项字段。 |