Queries - Search Queries

Служба:

Work Item Tracking

Версия API:

5.0

Выполняет поиск по всем запросам, к которые у пользователя есть доступ в текущем проекте

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=5.0

С использованием необязательных параметров:

GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=5.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
$filter	query	True	string	Текст для фильтрации запросов.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 5.0.
$expand	query		QueryExpand
$includeDeleted	query		boolean	Включение удаленных запросов и папок
$top	query		integer int32	Количество возвращаемых запросов (по умолчанию — 50, а максимальное — 200).

Ответы

Имя	Тип	Описание
200 OK	QueryHierarchyItemsResult	успешная операция

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя	Описание
vso.work	Предоставляет возможность чтения рабочих элементов, запросов, досок, путей областей и итераций, а также других метаданных, связанных с отслеживанием рабочих элементов. Также предоставляет возможность выполнять запросы, искать рабочие элементы и получать уведомления о событиях рабочих элементов с помощью перехватчиков служб.

Определения

Имя	Описание
IdentityReference	Описывает ссылку на удостоверение.
LinkQueryMode	Режим запроса ссылки.
LogicalOperation	Логический оператор, разделяющий предложение условия
QueryExpand	Параметры развертывания для запросов. Возможные параметры: { None, Wiql, Clauses, All, Minimal }
QueryHierarchyItem	Представляет элемент в иерархии запросов рабочих элементов. Это может быть запрос или папка.
QueryHierarchyItemsResult
QueryRecursionOption	Параметр рекурсии для использования в запросе в виде дерева.
QueryType	Тип запроса.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
WorkItemFieldOperation	Описывает операцию с полем рабочего элемента.
WorkItemFieldReference	Ссылка на поле в рабочем элементе
WorkItemQueryClause	Представляет предложение в запросе рабочего элемента. Здесь показана структура запроса рабочего элемента.
WorkItemQuerySortColumn	Столбец сортировки.

IdentityReference

Object

Описывает ссылку на удостоверение.

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
name	string	Устаревшее свойство обратной совместимости. Это было конкретное значение WIT из констант. Будут скрыты (но существуют) на клиенте, если они не нацелены на последнюю версию
profileUrl	string
uniqueName	string
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

LinkQueryMode

Enumeration

Режим запроса ссылки.

Значение	Описание
linksOneHopDoesNotContain	Возвращает рабочие элементы, удовлетворяющие источнику, только если ни один связанный рабочий элемент не удовлетворяет критериям ссылки и целевого объекта.
linksOneHopMayContain	Возвращает рабочие элементы, удовлетворяющие критериям источника и ссылки, даже если ни один связанный рабочий элемент не удовлетворяет целевым критериям.
linksOneHopMustContain	Возвращает рабочие элементы, в которых удовлетворяются критерии источника, целевого объекта и ссылки.
linksRecursiveDoesNotContain
linksRecursiveMayContain	Возвращает рабочие элементы иерархии рабочих элементов, которые по умолчанию удовлетворяют источнику
linksRecursiveMustContain
workItems

LogicalOperation

Enumeration

Логический оператор, разделяющий предложение условия

Значение	Описание
aND
nONE
oR

QueryExpand

Enumeration

Параметры развертывания для запросов. Возможные параметры: { None, Wiql, Clauses, All, Minimal }

Значение	Описание
all	Разворачивает все свойства
clauses	Разворачивает столбцы, ссылки, ChangeInfo, текст и предложения WIQL.
minimal	Отображение минимальных свойств и текста WIQL
none	Разворачивает столбцы, ссылки и ChangeInfo
wiql	Разворачивает текст Columns, Links, ChangeInfo и WIQL

QueryHierarchyItem

Object

Представляет элемент в иерархии запросов рабочих элементов. Это может быть запрос или папка.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на связанные ресурсы REST.
children	QueryHierarchyItem[]	Дочерние элементы запроса в папке запроса.
clauses	WorkItemQueryClause	Предложения для неструктурированного запроса.
columns	WorkItemFieldReference[]	Столбцы запроса.
createdBy	IdentityReference	Удостоверение, создавшего элемент запроса.
createdDate	string	При создании элемента запроса.
filterOptions	LinkQueryMode	Режим запроса ссылки.
hasChildren	boolean	Если это папка запроса, указывает, содержит ли она дочерние элементы.
id	string	Идентификатор элемента запроса.
isDeleted	boolean	Указывает, удален ли этот элемент запроса. Установка значения false для удаленного элемента запроса приведет к отмене его удаления. При удалении запроса или папки не будут возвращены изменения разрешений, которые были применены к ним ранее.
isFolder	boolean	Указывает, является ли это папкой запроса или запросом.
isInvalidSyntax	boolean	Указывает, является ли wiQL этого запроса недопустимым. Это может быть вызвано недопустимым синтаксисом или недопустимым путем к области или итерации.
isPublic	boolean	Указывает, является ли этот элемент запроса общедоступным или закрытым.
lastExecutedBy	IdentityReference	Идентификатор, который последний раз выполнял запрос.
lastExecutedDate	string	Время последнего выполнения запроса.
lastModifiedBy	IdentityReference	Удостоверение, последнее изменение которого был изменен элемент запроса.
lastModifiedDate	string	Время последнего изменения элемента запроса.
linkClauses	WorkItemQueryClause	Предложение запроса ссылки.
name	string	Имя элемента запроса.
path	string	Путь к элементу запроса.
queryRecursionOption	QueryRecursionOption	Параметр рекурсии для использования в запросе в виде дерева.
queryType	QueryType	Тип запроса.
sortColumns	WorkItemQuerySortColumn[]	Столбцы сортировки запроса.
sourceClauses	WorkItemQueryClause	Исходные предложения в дереве или запросе ссылки на один прыжок.
targetClauses	WorkItemQueryClause	Целевые предложения в дереве или запросе ссылки на один прыжок.
url	string
wiql	string	Текст WIQL запроса

QueryHierarchyItemsResult

Object

Имя	Тип	Описание
count	integer	Количество элементов.
hasMore	boolean	Указывает, достигнут ли максимальный предел возврата, но есть ли еще больше элементов.
value	QueryHierarchyItem[]	Список элементов

QueryRecursionOption

Enumeration

Параметр рекурсии для использования в запросе в виде дерева.

Значение	Описание
childFirst	Возвращает рабочие элементы, удовлетворяющие целевым критериям, даже если ни один рабочий элемент не удовлетворяет критериям источника и ссылки.
parentFirst	Возвращает рабочие элементы, удовлетворяющие источнику, даже если ни один связанный рабочий элемент не удовлетворяет критериям целевого объекта и ссылки.

QueryType

Enumeration

Тип запроса.

Значение	Описание
flat	Возвращает плоский список рабочих элементов.
oneHop	Возвращает список рабочих элементов и их прямых ссылок.
tree	Возвращает дерево рабочих элементов, отображающее их иерархию ссылок.

ReferenceLinks

Object

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

WorkItemFieldOperation

Object

Описывает операцию с полем рабочего элемента.

Имя	Тип	Описание
name	string	Имя операции.
referenceName	string	Имя ссылки на операцию.

WorkItemFieldReference

Object

Ссылка на поле в рабочем элементе

Имя	Тип	Описание
name	string	Имя поля.
referenceName	string	Имя ссылки на поле.
url	string	URL-адрес REST ресурса.

WorkItemQueryClause

Object

Представляет предложение в запросе рабочего элемента. Здесь показана структура запроса рабочего элемента.

Имя	Тип	Описание
clauses	WorkItemQueryClause[]	Дочерние предложения, если текущее предложение является логическим оператором
field	WorkItemFieldReference	Поле, связанное с условием
fieldValue	WorkItemFieldReference	Правая часть условия при сравнении поля с полем
isFieldValue	boolean	Определяет, является ли это поле сравнением полей.
logicalOperator	LogicalOperation	Логический оператор, разделяющий предложение условия
operator	WorkItemFieldOperation	Оператор field
value	string	Справа от условия при сравнении поля с значением

WorkItemQuerySortColumn

Object

Столбец сортировки.

Имя	Тип	Описание
descending	boolean	Направление сортировки.
field	WorkItemFieldReference	Поле рабочего элемента.