Wiql - Query By Wiql

Ссылка

Служба:: Work Item Tracking

Версия API:: 5.0

Возвращает результаты запроса с помощью WIQL.

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?api-version=5.0

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

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?timePrecision={timePrecision}&$top={$top}&api-version=5.0

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Имя организации Azure DevOps.
project	path		string	Идентификатор проекта или имя проекта
team	path		string	Идентификатор команды или имя команды
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 5.0.
$top	query		integer (int32)	Максимальное число возвращаемых результатов.
timePrecision	query		boolean	Следует ли использовать точность времени.

Текст запроса

Имя	Тип	Описание
query	string	Текст запроса WIQL

Ответы

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

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

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

Имя

Описание

vso.work

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

Примеры

Get results of a flat work item query.

Образец запроса

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=5.0

{
  "query": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Task' AND [State] <> 'Closed' AND [State] <> 'Removed' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}

Пример ответа

Код состояния:: 200

{
  "queryType": "flat",
  "asOf": "2014-12-29T20:49:34.617Z",
  "columns": [
    {
      "referenceName": "System.Id",
      "name": "ID",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
    },
    {
      "referenceName": "System.State",
      "name": "State",
      "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
    }
  ],
  "sortColumns": [
    {
      "field": {
        "referenceName": "Microsoft.VSTS.Common.Priority",
        "name": "Priority",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/Microsoft.VSTS.Common.Priority"
      },
      "descending": false
    },
    {
      "field": {
        "referenceName": "System.CreatedDate",
        "name": "Created Date",
        "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.CreatedDate"
      },
      "descending": true
    }
  ],
  "workItems": [
    {
      "id": 300,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    },
    {
      "id": 299,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 298,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
    },
    {
      "id": 17,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
    },
    {
      "id": 16,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
    },
    {
      "id": 15,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
    },
    {
      "id": 14,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
    },
    {
      "id": 9,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
    },
    {
      "id": 8,
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
    }
  ]
}

Определения

Имя	Описание
QueryResultType	Тип результата
QueryType	Тип запроса.
Wiql	Запрос WIQL
WorkItemFieldReference	Ссылка на поле в рабочем элементе
WorkItemLink	Связь между двумя рабочими элементами.
WorkItemQueryResult	Результат запроса рабочего элемента.
WorkItemQuerySortColumn	Столбец сортировки.
WorkItemReference	Содержит ссылку на рабочий элемент.

QueryResultType

Перечисление

Тип результата

Значение	Описание
workItem	Список рабочих элементов (для неструктурированных запросов).
workItemLink	Список ссылок на рабочий элемент (для запросов OneHop и дерева).

QueryType

Перечисление

Тип запроса.

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

Wiql

Object

Запрос WIQL

Имя	Тип	Описание
query	string	Текст запроса WIQL

WorkItemFieldReference

Object

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

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

WorkItemLink

Object

Связь между двумя рабочими элементами.

Имя	Тип	Описание
rel	string	Тип ссылки.
source	WorkItemReference	Исходный рабочий элемент.
target	WorkItemReference	Целевой рабочий элемент.

WorkItemQueryResult

Object

Результат запроса рабочего элемента.

Имя	Тип	Описание
asOf	string (date-time)	Дата выполнения запроса в контексте.
columns	WorkItemFieldReference[]	Столбцы запроса.
queryResultType	QueryResultType	Тип результата
queryType	QueryType	Тип запроса
sortColumns	WorkItemQuerySortColumn[]	Столбцы сортировки запроса.
workItemRelations	WorkItemLink[]	Ссылки на рабочий элемент, возвращаемые запросом.
workItems	WorkItemReference[]	Рабочие элементы, возвращаемые запросом.

WorkItemQuerySortColumn

Object

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

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

WorkItemReference

Object

Содержит ссылку на рабочий элемент.

Имя	Тип	Описание
id	integer (int32)	Идентификатор рабочего элемента.
url	string	URL-адрес REST API ресурса

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

Wiql - Query By Wiql

Параметры URI

Текст запроса

Ответы

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

oauth2

Области

Примеры

Get results of a flat work item query.

Образец запроса

Пример ответа

Определения

QueryResultType

QueryType

Wiql

WorkItemFieldReference

WorkItemLink

WorkItemQueryResult

WorkItemQuerySortColumn

WorkItemReference

Дополнительные ресурсы