Work Item Search Results - Fetch Work Item Search Results

参考

服务:: Search

API 版本:: 7.1

为搜索文本提供一组结果。

POST https://almsearch.dev.azure.com/{organization}/{project}/_apis/search/workitemsearchresults?api-version=7.1

URI 参数

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

请求正文

名称	类型	说明
$orderBy	SortOption[]	用于对搜索结果进行排序的选项。如果设置为 null，则结果将按相关性进行排序。如果提供了多个排序选项，则结果按 OrderBy 中指定的顺序进行排序。
$skip	integer (int32)	要跳过的结果数。
$top	integer (int32)	要返回的结果数。
filters	object	要应用的筛选器。如果没有要应用的筛选器，则将其设置为 null。
includeFacets	boolean	用于选择结果中的分面的标志。默认行为为 false。
searchText	string	搜索文本。

响应

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

安全性

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

示例

示例请求

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/workitemsearchresults?api-version=7.1

{
  "searchText": "Rest Api Story",
  "$skip": 0,
  "$top": 1,
  "filters": {
    "System.TeamProject": [
      "MyFirstProject"
    ],
    "System.AreaPath": [
      "MyFirstProject"
    ],
    "System.WorkItemType": [
      "Bug",
      "User Story",
      "Feature",
      "Task"
    ],
    "System.State": [
      "New",
      "Active",
      "Closed"
    ],
    "System.AssignedTo": [
      "John Doe <jodoe@microsoft.com>"
    ]
  },
  "$orderBy": [
    {
      "field": "system.id",
      "sortOrder": "ASC"
    }
  ],
  "includeFacets": true
}

示例响应

状态代码:: 200

{
  "count": 2,
  "results": [
    {
      "project": {
        "name": "MyFirstProject",
        "id": "5a0690b2-823c-4389-a3ab-5ea2a9cbde75"
      },
      "fields": {
        "system.id": "2",
        "system.workitemtype": "User Story",
        "system.title": "Rest Api User Story",
        "system.assignedto": "John Doe <jodoe@microsoft.com>",
        "system.state": "Closed",
        "system.tags": "api; rest",
        "system.rev": "5",
        "system.createddate": "2018-01-05T17:14:40.033Z",
        "system.changeddate": "2018-01-05T17:55:36.953Z"
      },
      "hits": [
        {
          "fieldReferenceName": "system.tags",
          "highlights": [
            "<highlighthit>api</highlighthit>; <highlighthit>rest</highlighthit>"
          ]
        },
        {
          "fieldReferenceName": "system.title",
          "highlights": [
            "<highlighthit>Rest</highlighthit> <highlighthit>Api</highlighthit> User <highlighthit>Story</highlighthit>"
          ]
        }
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
    }
  ],
  "infoCode": 0,
  "facets": {
    "System.TeamProject": [
      {
        "name": "MyFirstProject",
        "id": "MyFirstProject",
        "resultCount": 2
      }
    ],
    "System.WorkItemType": [
      {
        "name": "Task",
        "id": "Task",
        "resultCount": 1
      },
      {
        "name": "User Story",
        "id": "User Story",
        "resultCount": 1
      },
      {
        "name": "Bug",
        "id": "Bug",
        "resultCount": 0
      },
      {
        "name": "Feature",
        "id": "Feature",
        "resultCount": 0
      }
    ],
    "System.State": [
      {
        "name": "Closed",
        "id": "Closed",
        "resultCount": 1
      },
      {
        "name": "New",
        "id": "New",
        "resultCount": 1
      },
      {
        "name": "Active",
        "id": "Active",
        "resultCount": 0
      }
    ],
    "System.AssignedTo": [
      {
        "name": "John Doe <jodoe@microsoft.com>",
        "id": "John Doe <jodoe@microsoft.com>",
        "resultCount": 2
      }
    ]
  }
}

定义

名称	说明
Project	定义项目的详细信息。
SortOption	定义如何对结果进行排序。
WorkItemHit	定义工作项结果字段中匹配的术语。
WorkItemResult	定义与工作项搜索请求匹配的工作项结果。
WorkItemSearchRequest	定义工作项搜索请求。
WorkItemSearchResponse	定义为工作项搜索请求返回的响应项。

Project

Object

定义项目的详细信息。

名称	类型	说明
id	string (uuid)	项目的 ID。
name	string	项目的名称。

SortOption

Object

定义如何对结果进行排序。

名称	类型	说明
field	string	应对其执行排序的字段名称。
sortOrder	string	要在其中对结果进行排序的顺序（ASC/DESC）。

WorkItemHit

Object

定义工作项结果字段中匹配的术语。

名称	类型	说明
fieldReferenceName	string	突出显示字段的引用名称。
highlights	string[]	字段的匹配/突出显示的代码片段。

WorkItemResult

Object

定义与工作项搜索请求匹配的工作项结果。

名称	类型	说明
fields	object	一组标准的工作项字段及其值。
hits	WorkItemHit[]	突出显示了与搜索请求匹配的字段片段。列表按代码片段的相关性进行排序。
project	Project	工作项的项目详细信息。
url	string	对工作项的引用。

WorkItemSearchRequest

Object

定义工作项搜索请求。

名称	类型	说明
$orderBy	SortOption[]	用于对搜索结果进行排序的选项。如果设置为 null，则结果将按相关性进行排序。如果提供了多个排序选项，则结果按 OrderBy 中指定的顺序进行排序。
$skip	integer (int32)	要跳过的结果数。
$top	integer (int32)	要返回的结果数。
filters	object	要应用的筛选器。如果没有要应用的筛选器，则将其设置为 null。
includeFacets	boolean	用于选择结果中的分面的标志。默认行为为 false。
searchText	string	搜索文本。

WorkItemSearchResponse

Object

定义为工作项搜索请求返回的响应项。

名称	类型	说明
count	integer (int32)	匹配的工作项总数。
facets	object	一个字典，用于存储针对每个方面 `Filter` 对象的数组。
infoCode	integer (int32)	指示任何其他信息的数字代码：0 - 正常，1 - 帐户正在重新编制索引，2 - 帐户索引尚未启动，3 - 请求无效，4 - 不支持前缀通配符查询，5 - 不支持代码分面的多字，6 - 帐户正在载入或重新编制索引，7 - 正在载入或重新编制帐户索引，8 - 允许的最大值修整 9 - 分支正在编制索引， 10 - 未启用分面，11 - 无法访问工作项，19 - 不支持包含代码类型筛选器的短语查询，20 - 不支持具有代码类型筛选器的通配符查询。任何其他信息代码都用于内部目的。
results	WorkItemResult[]	最匹配的工作项列表。

通过

Work Item Search Results - Fetch Work Item Search Results

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

Project

SortOption

WorkItemHit

WorkItemResult

WorkItemSearchRequest

WorkItemSearchResponse

其他资源