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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path		string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.1' 以使用此版本的 API。

要求本文

名稱	類型	Description
$orderBy	SortOption[]	排序搜尋結果的選項。如果設定為 null，則會依相關性傳回結果。如果提供多個排序選項，結果會依照 OrderBy 中指定的順序排序。
$skip	integer	要略過的結果數目。
$top	integer	要傳回的結果數目。
filters	object	要套用的篩選準則。如果沒有要套用的篩選準則，請將它設定為 null。
includeFacets	boolean	旗標，以選擇結果中的 Facet。預設行為為 false。
searchText	string	搜尋的文字。

回應

名稱	類型	Description
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

名稱	Description
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
      }
    ]
  }
}

定義

名稱	Description
Project	定義專案的詳細資料。
SortOption	定義如何排序結果。
WorkItemHit	定義工作專案結果欄位中相符的字詞。
WorkItemResult	定義符合工作專案搜尋要求的工作專案結果。
WorkItemSearchRequest	定義工作專案搜尋要求。
WorkItemSearchResponse	定義工作專案搜尋要求所傳回的回應專案。

Project

定義專案的詳細資料。

名稱	類型	Description
id	string	專案的識別碼。
name	string	專案的名稱。

SortOption

定義如何排序結果。

名稱	類型	Description
field	string	應該完成排序的功能變數名稱。
sortOrder	string	順序 (ASC/DESC) ，其中應該排序結果。

WorkItemHit

定義工作專案結果欄位中相符的字詞。

名稱	類型	Description
fieldReferenceName	string	醒目提示欄位的參考名稱。
highlights	string[]	欄位的相符/醒目提示程式碼片段。

WorkItemResult

定義符合工作專案搜尋要求的工作專案結果。

名稱	類型	Description
fields	object	一組標準的工作專案欄位及其值。
hits	WorkItemHit[]	符合搜尋要求之欄位的醒目提示程式碼片段。清單會依程式碼片段的相關性排序。
project	Project	工作專案的專案詳細資料。
url	string	工作專案的參考。

WorkItemSearchRequest

定義工作專案搜尋要求。

名稱	類型	Description
$orderBy	SortOption[]	排序搜尋結果的選項。如果設定為 null，則會依相關性傳回結果。如果提供多個排序選項，結果會依照 OrderBy 中指定的順序排序。
$skip	integer	要略過的結果數目。
$top	integer	要傳回的結果數目。
filters	object	要套用的篩選準則。如果沒有要套用的篩選準則，請將它設定為 null。
includeFacets	boolean	旗標，以選擇結果中的 Facet。預設行為為 false。
searchText	string	搜尋的文字。

WorkItemSearchResponse

定義工作專案搜尋要求所傳回的回應專案。

名稱	類型	Description
count	integer	相符的工作專案總數。
facets	object	字典，針對每個 Facet 儲存物件的陣列 `Filter` 。
infoCode	integer	指出任何其他資訊的數值代碼：0 - 確定，1 - 帳戶正在重新編制索引，2 - 帳戶索引尚未啟動，3 - 要求無效，4 - 不支援前置詞萬用字元查詢，5 - 程式碼 Facet 不支援的多字詞，6 - 帳戶正在上線或重新編制索引，7 - 帳戶正在上線或重新編制索引，8 - 已修剪為允許的 maxresult 9 - 分支編制索引的頂端值。 10 - 未啟用 Facet、11 - 無法存取工作專案、19 - 不支援程式碼類型篩選的片語查詢、20 - 不支援程式碼類型篩選的萬用字元查詢。任何其他資訊程式碼都用於內部用途。
results	WorkItemResult[]	最符合的工作專案清單。