Work Item Search Results - Fetch Work Item Search Results

参考

Service:: Search

API Version:: 7.1-preview.1

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

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

URI 参数

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

请求正文

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

响应

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

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

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

示例

Sample Request

HTTP

POST https://almsearch.dev.azure.com/fabrikam/_apis/search/workitemsearchresults?api-version=7.1-preview.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
}

Sample Response

Status code:: 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

定义项目的详细信息。

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

SortOption

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

名称	类型	说明
field	string	应对其执行排序的字段名称。
sortOrder	string	对结果进行排序 (ASC/DESC) 排序。

WorkItemHit

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

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

WorkItemResult

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

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

WorkItemSearchRequest

定义工作项搜索请求。

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

WorkItemSearchResponse

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

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

通过