Queries - Search Queries

Ссылка

Service:: Work Item Tracking

API Version:: 7.1-preview.2

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

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

With optional parameters:

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

Параметры URI

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

Ответы

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

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

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	Предоставляет возможность считывать рабочие элементы, запросы, доски, пути к областям и итерациям, а также другие метаданные, связанные с отслеживанием рабочих элементов. Кроме того, предоставляет возможность выполнять запросы, искать рабочие элементы и получать уведомления о событиях рабочих элементов через перехватчики служб.

Имя

Описание

vso.work

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

Определения

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

IdentityReference

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

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое — можно получить запрос пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Нерекомендуемое — можно получить запрос к состоянию членства Graph, на которое ссылается запись "membershipState" словаря GraphUser "_links".
isAadIdentity	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Нерекомендуемый — может быть выведен из типа субъекта дескриптора (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
name	string	Устаревшее свойство back-compat. Это было конкретное значение WIT из констант. Будут скрыты (но существуют) на клиенте, если они не предназначены для последней версии
profileUrl	string	Не рекомендуется — не используется в большинстве уже существовающих реализаций ToIdentityRef
uniqueName	string	Не рекомендуется использовать вместо него домен+principalName.
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

LinkQueryMode

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

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

LogicalOperation

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

Имя	Тип	Описание
and	string
none	string
or	string

QueryExpand

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

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

QueryHierarchyItem

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

Имя	Тип	Описание
_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

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

QueryRecursionOption

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

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

QueryType

Тип запроса.

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

ReferenceLinks

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

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

WorkItemFieldOperation

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

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

WorkItemFieldReference

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

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

WorkItemQueryClause

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

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

WorkItemQuerySortColumn

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

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

Поделиться через