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

Идентификатор проекта или имя проекта
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

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

Идентификатор проекта.
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 — максимально допустимое значение, 9 — индексируются ветви; 10 — фасетирование не включено, 11 — рабочие элементы недоступны, 19 — запросы фраз с фильтрами типов кода не поддерживаются, 20 — запросы с подстановочными знаками с фильтрами типов кода не поддерживаются. Любой другой информационный код используется для внутренних целей.
results

WorkItemResult[]

Список наиболее подходящих рабочих элементов.