Wiql - Query By Wiql

Referencia

Service:: Work Item Tracking

API Version:: 7.1-preview.2

Obtiene los resultados de la consulta dada su WIQL.

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

With optional parameters:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	El nombre de la organización de Azure DevOps.
project	path		string	Id. de proyecto o nombre del proyecto
team	path		string	Id. de equipo o nombre del equipo
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.2" para usar esta versión de la API.
$top	query		integer int32	Número máximo de resultados que se van a devolver.
timePrecision	query		boolean	Indica si se va a usar o no la precisión del tiempo.

Cuerpo de la solicitud

Nombre	Tipo	Description
query	string	Texto de la consulta WIQL

Respuestas

Nombre	Tipo	Description
200 OK	WorkItemQueryResult	operación correcta

Seguridad

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

Nombre	Description
vso.work	Concede la capacidad de leer elementos de trabajo, consultas, paneles, rutas de acceso de área e iteraciones y otros metadatos relacionados con el seguimiento de elementos de trabajo. También concede la capacidad de ejecutar consultas, buscar elementos de trabajo y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio.

Ejemplos

Get results of a flat work item query.

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=7.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"
    }
  ]
}

Definiciones

Nombre	Description
QueryResultType	Tipo del resultado.
QueryType	Tipo de consulta.
Wiql	Una consulta WIQL
WorkItemFieldReference	Referencia a un campo de un elemento de trabajo
WorkItemLink	Vínculo entre dos elementos de trabajo.
WorkItemQueryResult	Resultado de una consulta de elemento de trabajo.
WorkItemQuerySortColumn	Una columna de ordenación.
WorkItemReference	Contiene referencia a un elemento de trabajo.

QueryResultType

Tipo del resultado.

Nombre	Tipo	Description
workItem	string	Lista de elementos de trabajo (para consultas planas).
workItemLink	string	Una lista de vínculos de elementos de trabajo (para consultas OneHop y Tree).

QueryType

Tipo de consulta.

Nombre	Tipo	Description
flat	string	Obtiene una lista plana de elementos de trabajo.
oneHop	string	Obtiene una lista de elementos de trabajo y sus vínculos directos.
tree	string	Obtiene un árbol de elementos de trabajo que muestra su jerarquía de vínculos.

Wiql

Una consulta WIQL

Nombre	Tipo	Description
query	string	Texto de la consulta WIQL

WorkItemFieldReference

Referencia a un campo de un elemento de trabajo

Nombre	Tipo	Description
name	string	Nombre descriptivo del campo.
referenceName	string	Nombre de referencia del campo.
url	string	Dirección URL de REST del recurso.

WorkItemLink

Vínculo entre dos elementos de trabajo.

Nombre	Tipo	Description
rel	string	Tipo del vínculo.
source	WorkItemReference	Elemento de trabajo de origen.
target	WorkItemReference	Elemento de trabajo de destino.

WorkItemQueryResult

Resultado de una consulta de elemento de trabajo.

Nombre	Tipo	Description
asOf	string	Fecha en la que se ejecutó la consulta en el contexto de .
columns	WorkItemFieldReference[]	Columnas de la consulta.
queryResultType	QueryResultType	Tipo del resultado.
queryType	QueryType	Tipo de la consulta
sortColumns	WorkItemQuerySortColumn[]	Columnas de ordenación de la consulta.
workItemRelations	WorkItemLink[]	Los vínculos del elemento de trabajo devueltos por la consulta.
workItems	WorkItemReference[]	Elementos de trabajo devueltos por la consulta.

WorkItemQuerySortColumn

Una columna de ordenación.

Nombre	Tipo	Description
descending	boolean	Dirección por la que se va a ordenar.
field	WorkItemFieldReference	Un campo de elemento de trabajo.

WorkItemReference

Contiene referencia a un elemento de trabajo.

Nombre	Tipo	Description
id	integer	Id. de elemento de trabajo.
url	string	Dirección URL de la API REST del recurso

Compartir a través de