Wiql - Query By Id
Возвращает результаты запроса, заданные идентификатором запроса.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?api-version=7.1-preview.2GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?timePrecision={timePrecision}&$top={$top}&api-version=7.1-preview.2Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
id
|
path | True |
string uuid |
Идентификатор запроса. |
|
organization
|
path | True |
string |
Название организации Azure DevOps. |
|
project
|
path |
string |
Идентификатор или имя проекта |
|
|
team
|
path |
string |
Идентификатор или имя команды |
|
|
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.2. |
|
$top
|
query |
integer int32 |
Максимальное число возвращаемых результатов. |
|
|
time
|
query |
boolean |
Указывает, следует ли использовать точность времени. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
успешная операция |
Безопасность
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
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/wiql/{id}?api-version=7.1-preview.2
Sample Response
{
"queryType": "tree",
"asOf": "2014-12-29T20:49:33.803Z",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
},
{
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
},
{
"referenceName": "System.AssignedTo",
"name": "Assigned To",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
},
{
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
}
],
"workItemRelations": [
{
"target": {
"id": 4,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/4"
}
},
{
"target": {
"id": 5,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/5"
}
},
{
"target": {
"id": 6,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/6"
}
},
{
"target": {
"id": 7,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 7,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
},
"target": {
"id": 8,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 7,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
},
"target": {
"id": 9,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
}
},
{
"target": {
"id": 11,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/11"
}
},
{
"target": {
"id": 12,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
}
},
{
"target": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 1,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 2,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 3,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/3"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 13,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/13"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 14,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 15,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 16,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 17,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 18,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/18"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 19,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/19"
}
},
{
"target": {
"id": 21,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/21"
}
},
{
"target": {
"id": 33,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/33"
}
},
{
"target": {
"id": 34,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/34"
}
},
{
"target": {
"id": 46,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/46"
}
},
{
"target": {
"id": 47,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/47"
}
},
{
"target": {
"id": 58,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/58"
}
},
{
"target": {
"id": 59,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/59"
}
},
{
"target": {
"id": 297,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 297,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
},
"target": {
"id": 299,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 297,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
},
"target": {
"id": 300,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
}
},
{
"target": {
"id": 298,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
}
}
]
}Определения
| Имя | Описание |
|---|---|
|
Query |
Тип результата |
|
Query |
Тип запроса. |
|
Work |
Ссылка на поле в рабочем элементе |
|
Work |
Связь между двумя рабочими элементами. |
|
Work |
Результат запроса рабочего элемента. |
|
Work |
Столбец сортировки. |
|
Work |
Содержит ссылку на рабочий элемент. |
QueryResultType
Тип результата
| Имя | Тип | Описание |
|---|---|---|
| workItem |
string |
Список рабочих элементов (для неструктурированных запросов). |
| workItemLink |
string |
Список ссылок на рабочие элементы (для запросов OneHop и tree). |
QueryType
Тип запроса.
| Имя | Тип | Описание |
|---|---|---|
| flat |
string |
Возвращает плоский список рабочих элементов. |
| oneHop |
string |
Возвращает список рабочих элементов и их прямые ссылки. |
| tree |
string |
Возвращает дерево рабочих элементов, отображающее их иерархию ссылок. |
WorkItemFieldReference
Ссылка на поле в рабочем элементе
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Понятное имя поля. |
| referenceName |
string |
Имя ссылки поля. |
| url |
string |
URL-адрес REST ресурса. |
WorkItemLink
Связь между двумя рабочими элементами.
| Имя | Тип | Описание |
|---|---|---|
| rel |
string |
Тип ссылки. |
| source |
Исходный рабочий элемент. |
|
| target |
Целевой рабочий элемент. |
WorkItemQueryResult
Результат запроса рабочего элемента.
| Имя | Тип | Описание |
|---|---|---|
| asOf |
string |
Дата выполнения запроса в контексте . |
| columns |
Столбцы запроса. |
|
| queryResultType |
Тип результата |
|
| queryType |
Тип запроса |
|
| sortColumns |
Столбцы сортировки запроса. |
|
| workItemRelations |
Ссылки на рабочие элементы, возвращаемые запросом. |
|
| workItems |
Рабочие элементы, возвращаемые запросом. |
WorkItemQuerySortColumn
Столбец сортировки.
| Имя | Тип | Описание |
|---|---|---|
| descending |
boolean |
Направление сортировки. |
| field |
Поле рабочего элемента. |
WorkItemReference
Содержит ссылку на рабочий элемент.
| Имя | Тип | Описание |
|---|---|---|
| id |
integer |
Идентификатор рабочего элемента. |
| url |
string |
URL-адрес REST API ресурса |
Обратная связь
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделе https://aka.ms/ContentUserFeedback.
Отправить и просмотреть отзыв по