Wiql - Query By Wiql

Reference

Service:: Work Item Tracking

API Version:: 5.0

Získá výsledky dotazu vzhledem k jeho 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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
project	path		string	ID projektu nebo název projektu
team	path		string	ID týmu nebo název týmu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavena na hodnotu 5.0.
$top	query		integer int32	Maximální počet výsledků, které se mají vrátit.
timePrecision	query		boolean	Zda se má použít časová přesnost.

Text požadavku

Name	Typ	Description
query	string	Text dotazu WIQL

Odpovědi

Name	Typ	Description
200 OK	WorkItemQueryResult	úspěšná operace

Zabezpečení

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

Name	Description
vso.work	Umožňuje číst pracovní položky, dotazy, panely, cesty oblastí a iterací a další metadata související se sledováním pracovních položek. Umožňuje také spouštět dotazy, prohledávat pracovní položky a přijímat oznámení o událostech pracovních položek prostřednictvím služeb.

Příklady

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

Definice

Name	Description
QueryResultType	Typ výsledku
QueryType	Typ dotazu.
Wiql	Dotaz WIQL
WorkItemFieldReference	Odkaz na pole v pracovní položce
WorkItemLink	Propojení mezi dvěma pracovními položkami.
WorkItemQueryResult	Výsledek dotazu na pracovní položky.
WorkItemQuerySortColumn	Sloupec řazení.
WorkItemReference	Obsahuje odkaz na pracovní položku.

QueryResultType

Typ výsledku

Name	Typ	Description
workItem	string	Seznam pracovních položek (pro ploché dotazy)
workItemLink	string	Seznam odkazů na pracovní položky (pro dotazy OneHop a Tree)

QueryType

Typ dotazu.

Name	Typ	Description
flat	string	Získá plochý seznam pracovních položek.
oneHop	string	Získá seznam pracovních položek a jejich přímé odkazy.
tree	string	Získá strom pracovních položek zobrazující jejich hierarchii propojení.

Wiql

Dotaz WIQL

Name	Typ	Description
query	string	Text dotazu WIQL

WorkItemFieldReference

Odkaz na pole v pracovní položce

Name	Typ	Description
name	string	Název pole.
referenceName	string	Referenční název pole.
url	string	Adresa URL REST prostředku.

WorkItemLink

Propojení mezi dvěma pracovními položkami.

Name	Typ	Description
rel	string	Typ odkazu.
source	WorkItemReference	Zdrojová pracovní položka.
target	WorkItemReference	Cílová pracovní položka.

WorkItemQueryResult

Výsledek dotazu na pracovní položky.

Name	Typ	Description
asOf	string	Datum, kdy byl dotaz spuštěn v kontextu.
columns	WorkItemFieldReference[]	Sloupce dotazu
queryResultType	QueryResultType	Typ výsledku
queryType	QueryType	Typ dotazu
sortColumns	WorkItemQuerySortColumn[]	Sloupce řazení dotazu.
workItemRelations	WorkItemLink[]	Odkazy pracovní položky vrácené dotazem
workItems	WorkItemReference[]	Pracovní položky vrácené dotazem

WorkItemQuerySortColumn

Sloupec řazení.

Name	Typ	Description
descending	boolean	Směr řazení.
field	WorkItemFieldReference	Pole pracovní položky.

WorkItemReference

Obsahuje odkaz na pracovní položku.

Name	Typ	Description
id	integer	ID pracovní položky.
url	string	ADRESA URL rozhraní REST API prostředku

Sdílet prostřednictvím