Wiql - Query By Wiql

Riferimento

Service:: Work Item Tracking

API Version:: 5.0

Ottiene i risultati della query in base al relativo 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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path		string	ID progetto o nome progetto
team	path		string	ID team o nome team
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '5.0' per usare questa versione dell'API.
$top	query		integer int32	Numero massimo di risultati da restituire.
timePrecision	query		boolean	Indica se usare o meno la precisione del tempo.

Corpo della richiesta

Nome	Tipo	Descrizione
query	string	Testo della query WIQL

Risposte

Nome	Tipo	Descrizione
200 OK	WorkItemQueryResult	operazione riuscita

Sicurezza

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	Descrizione
vso.work	Concede la possibilità di leggere elementi di lavoro, query, schede, aree e percorsi iterazioni e altri metadati correlati al rilevamento degli elementi di lavoro. Concede inoltre la possibilità di eseguire query, cercare elementi di lavoro e ricevere notifiche sugli eventi dell'elemento di lavoro tramite hook del servizio.

Esempio

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

Definizioni

Nome	Descrizione
QueryResultType	Tipo di risultato
QueryType	Tipo di query.
Wiql	Query WIQL
WorkItemFieldReference	Riferimento a un campo in un elemento di lavoro
WorkItemLink	Collegamento tra due elementi di lavoro.
WorkItemQueryResult	Risultato di una query dell'elemento di lavoro.
WorkItemQuerySortColumn	Colonna di ordinamento.
WorkItemReference	Contiene riferimento a un elemento di lavoro.

QueryResultType

Tipo di risultato

Nome	Tipo	Descrizione
workItem	string	Elenco di elementi di lavoro (per query flat).
workItemLink	string	Elenco dei collegamenti all'elemento di lavoro (per query OneHop e Tree).

QueryType

Tipo di query.

Nome	Tipo	Descrizione
flat	string	Ottiene un elenco flat di elementi di lavoro.
oneHop	string	Ottiene un elenco di elementi di lavoro e i relativi collegamenti diretti.
tree	string	Ottiene un albero di elementi di lavoro che mostrano la gerarchia dei collegamenti.

Wiql

Query WIQL

Nome	Tipo	Descrizione
query	string	Testo della query WIQL

WorkItemFieldReference

Riferimento a un campo in un elemento di lavoro

Nome	Tipo	Descrizione
name	string	Nome del campo.
referenceName	string	Nome di riferimento del campo.
url	string	URL REST della risorsa.

WorkItemLink

Collegamento tra due elementi di lavoro.

Nome	Tipo	Descrizione
rel	string	Tipo di collegamento.
source	WorkItemReference	Elemento di lavoro di origine.
target	WorkItemReference	Elemento di lavoro di destinazione.

WorkItemQueryResult

Risultato di una query dell'elemento di lavoro.

Nome	Tipo	Descrizione
asOf	string	Data di esecuzione della query nel contesto di .
columns	WorkItemFieldReference[]	Colonne della query.
queryResultType	QueryResultType	Tipo di risultato
queryType	QueryType	Tipo della query
sortColumns	WorkItemQuerySortColumn[]	Colonne di ordinamento della query.
workItemRelations	WorkItemLink[]	I collegamenti dell'elemento di lavoro restituiti dalla query.
workItems	WorkItemReference[]	Elementi di lavoro restituiti dalla query.

WorkItemQuerySortColumn

Colonna di ordinamento.

Nome	Tipo	Descrizione
descending	boolean	Direzione da ordinare.
field	WorkItemFieldReference	Campo elemento di lavoro.

WorkItemReference

Contiene riferimento a un elemento di lavoro.

Nome	Tipo	Descrizione
id	integer	ID elemento di lavoro.
url	string	URL DELL'API REST della risorsa

Condividi tramite