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 매개 변수

Name	In(다음 안에)	필수	형식	Description
organization	path	True	string	Azure DevOps 조직의 이름입니다.
project	path		string	프로젝트 ID 또는 프로젝트 이름
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1-preview.1'로 설정해야 합니다.

요청 본문

Name	형식	Description
$orderBy	SortOption[]	검색 결과를 정렬하는 옵션입니다. null로 설정하면 결과는 관련성별로 정렬된 상태로 반환됩니다. 둘 이상의 정렬 옵션이 제공되면 결과는 OrderBy에 지정된 순서대로 정렬됩니다.
$skip	integer	건너뛸 결과 수입니다.
$top	integer	반환할 결과 수입니다.
filters	object	적용할 필터입니다. 적용할 필터가 없는 경우 null로 설정합니다.
includeFacets	boolean	결과에서 패싯을 선택하는 플래그입니다. 기본 동작은 false입니다.
searchText	string	검색 텍스트입니다.

응답

Name	형식	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

Name	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
      }
    ]
  }
}

정의

Name	Description
Project	프로젝트의 세부 정보를 정의합니다.
SortOption	결과를 정렬하는 방법을 정의합니다.
WorkItemHit	작업 항목 결과의 필드에서 일치하는 용어를 정의합니다.
WorkItemResult	작업 항목 검색 요청과 일치하는 작업 항목 결과를 정의합니다.
WorkItemSearchRequest	작업 항목 검색 요청을 정의합니다.
WorkItemSearchResponse	작업 항목 검색 요청에 대해 반환되는 응답 항목을 정의합니다.

Project

프로젝트의 세부 정보를 정의합니다.

Name	형식	Description
id	string	프로젝트의 ID입니다.
name	string	프로젝트의 이름입니다.

SortOption

결과를 정렬하는 방법을 정의합니다.

Name	형식	Description
field	string	정렬을 수행할 필드 이름입니다.
sortOrder	string	결과를 정렬해야 하는 순서(ASC/DESC)입니다.

WorkItemHit

작업 항목 결과의 필드에서 일치하는 용어를 정의합니다.

Name	형식	Description
fieldReferenceName	string	강조 표시된 필드의 참조 이름입니다.
highlights	string[]	필드의 일치/강조 표시된 코드 조각입니다.

WorkItemResult

작업 항목 검색 요청과 일치하는 작업 항목 결과를 정의합니다.

Name	형식	Description
fields	object	작업 항목 필드 및 해당 값의 표준 집합입니다.
hits	WorkItemHit[]	검색 요청과 일치하는 필드의 강조 표시된 코드 조각입니다. 목록은 코드 조각의 관련성에 따라 정렬됩니다.
project	Project	작업 항목의 프로젝트 세부 정보입니다.
url	string	작업 항목에 대한 참조입니다.

WorkItemSearchRequest

작업 항목 검색 요청을 정의합니다.

Name	형식	Description
$orderBy	SortOption[]	검색 결과를 정렬하는 옵션입니다. null로 설정하면 결과는 관련성별로 정렬된 상태로 반환됩니다. 둘 이상의 정렬 옵션이 제공되면 결과는 OrderBy에 지정된 순서대로 정렬됩니다.
$skip	integer	건너뛸 결과 수입니다.
$top	integer	반환할 결과 수입니다.
filters	object	적용할 필터입니다. 적용할 필터가 없는 경우 null로 설정합니다.
includeFacets	boolean	결과에서 패싯을 선택하는 플래그입니다. 기본 동작은 false입니다.
searchText	string	검색 텍스트입니다.

WorkItemSearchResponse

작업 항목 검색 요청에 대해 반환되는 응답 항목을 정의합니다.

Name	형식	Description
count	integer	일치하는 총 작업 항목 수입니다.
facets	object	각 패싯에 대해 개체 배열 `Filter` 을 저장하는 사전입니다.
infoCode	integer	추가 정보를 나타내는 숫자 코드: 0 - 확인, 1 - 계정이 다시 인덱싱되고 있습니다. 2 - 계정 인덱싱이 시작되지 않음, 3 - 잘못된 요청, 4 - 접두사 와일드카드 쿼리가 지원되지 않음, 5 - 코드 패싯이 지원되지 않는 MultiWords, 6 - 계정이 온보딩되고, 7 - 계정이 온보딩되거나 다시 인덱싱되고 있습니다, 8 - 최대 업데이트 허용 9로 트리밍된 최상위 값 - 분기가 인덱싱되고 있습니다. 10 - 패싯을 사용할 수 없음, 11 - 작업 항목에 액세스할 수 없음, 19 - 코드 형식 필터가 지원되지 않는 구 쿼리, 20 - 코드 형식 필터가 있는 와일드카드 쿼리는 지원되지 않습니다. 다른 정보 코드는 내부 용도로 사용됩니다.
results	WorkItemResult[]	일치하는 상위 작업 항목 목록입니다.