Wiql - Query By Wiql

Referência

Service:: Work Item Tracking

API Version:: 5.0

Obtém os resultados da consulta considerando seu WIQL.

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

With optional parameters:

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
project	path		string	ID do projeto ou nome do projeto
team	path		string	ID da equipe ou nome da equipe
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '5.0' para usar esta versão da API.
$top	query		integer int32	O número máximo de resultados a serem retornados.
timePrecision	query		boolean	Se deve ou não usar a precisão de tempo.

Corpo da solicitação

Nome	Tipo	Description
query	string	O texto da consulta WIQL

Respostas

Nome	Tipo	Description
200 OK	WorkItemQueryResult	operação bem-sucedida

Segurança

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

Nome	Description
vso.work	Concede a capacidade de ler itens de trabalho, consultas, quadros, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.

Exemplos

Get results of a flat work item query.

Sample Request

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

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

Definições

Nome	Description
QueryResultType	O tipo de resultado
QueryType	O tipo de consulta.
Wiql	Uma consulta WIQL
WorkItemFieldReference	Referência a um campo em um item de trabalho
WorkItemLink	Um link entre dois itens de trabalho.
WorkItemQueryResult	O resultado de uma consulta de item de trabalho.
WorkItemQuerySortColumn	Uma coluna de classificação.
WorkItemReference	Contém referência a um item de trabalho.

QueryResultType

O tipo de resultado

Nome	Tipo	Description
workItem	string	Uma lista de itens de trabalho (para consultas simples).
workItemLink	string	Uma lista de links de item de trabalho (para consultas OneHop e Tree).

QueryType

O tipo de consulta.

Nome	Tipo	Description
flat	string	Obtém uma lista simples de itens de trabalho.
oneHop	string	Obtém uma lista de itens de trabalho e seus links diretos.
tree	string	Obtém uma árvore de itens de trabalho mostrando sua hierarquia de vínculos.

Wiql

Uma consulta WIQL

Nome	Tipo	Description
query	string	O texto da consulta WIQL

WorkItemFieldReference

Referência a um campo em um item de trabalho

Nome	Tipo	Description
name	string	O nome do campo.
referenceName	string	O nome de referência do campo.
url	string	A URL REST do recurso.

WorkItemLink

Um link entre dois itens de trabalho.

Nome	Tipo	Description
rel	string	O tipo de link.
source	WorkItemReference	O item de trabalho de origem.
target	WorkItemReference	O item de trabalho de destino.

WorkItemQueryResult

O resultado de uma consulta de item de trabalho.

Nome	Tipo	Description
asOf	string	A data em que a consulta foi executada no contexto de.
columns	WorkItemFieldReference[]	As colunas da consulta.
queryResultType	QueryResultType	O tipo de resultado
queryType	QueryType	O tipo da consulta
sortColumns	WorkItemQuerySortColumn[]	As colunas de classificação da consulta.
workItemRelations	WorkItemLink[]	Os links de item de trabalho retornados pela consulta.
workItems	WorkItemReference[]	Os itens de trabalho retornados pela consulta.

WorkItemQuerySortColumn

Uma coluna de classificação.

Nome	Tipo	Description
descending	boolean	A direção pela qual classificar.
field	WorkItemFieldReference	Um campo de item de trabalho.

WorkItemReference

Contém referência a um item de trabalho.

Nome	Tipo	Description
id	integer	ID do item de trabalho.
url	string	URL da API REST do recurso

Compartilhar via