Wiql - Query By Wiql

Ссылка

Service:: Work Item Tracking

API Version:: 6.1-preview.2

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

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

With optional parameters:

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

Параметры URI

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

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

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

Ответы

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

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

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

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

Примеры

Get results of a flat work item query.

Sample Request

HTTP

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

{
  "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"
}

Sample Response

Status code:: 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	string	Список рабочих элементов (для неструктурированных запросов).
workItemLink	string	Список ссылок на рабочие элементы (для запросов OneHop и Tree).

QueryType

Тип запроса.

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

Wiql

Запрос WIQL

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

WorkItemFieldReference

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

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

WorkItemLink

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

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

WorkItemQueryResult

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

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

WorkItemQuerySortColumn

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

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

WorkItemReference

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

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

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