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 のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

要求本文

名前	型	説明
$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 - OK、1 - アカウントのインデックス再作成中、2 - アカウントのインデックス作成が開始されていません、3 - 無効な要求、4 - プレフィックスワイルドカードクエリがサポートされていません、5 - コードファセットがサポートされていないマルチワード、6 - アカウントがオンボード中、7 - アカウントがオンボードまたはインデックス再作成中、8 - maxresult にトリミングされた最上位値が 9 - ブランチがインデックス付けされています、 10 - ファセットが有効になっていない、11 - 作業項目にアクセスできない、19 - コード型フィルターがサポートされていないフレーズクエリ、20 - コード型フィルターがサポートされていないワイルドカードクエリ。その他の情報コードは、内部目的で使用されます。
results	WorkItemResult[]	一致した上位の作業項目の一覧。

Share via