Wiql - Query By Wiql

Reference

Služba:: Work Item Tracking

Verze rozhraní API:: 7.1

Získá výsledky dotazu vzhledem k jeho WIQL.

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

S volitelnými parametry:

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

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. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.
$top	query		integer (int32)	Maximální počet výsledků, které se mají vrátit.
timePrecision	query		boolean	Bez ohledu na to, jestli 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

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

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 volání služby.

Příklady

Get results of a flat work item query.

Ukázkový požadavek

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/wiql?api-version=7.1

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

Ukázková odpověď

Stavový kód:: 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žku
WorkItemQuerySortColumn	Sloupec řazení.
WorkItemReference	Obsahuje odkaz na pracovní položku.

QueryResultType

Výčet

Typ výsledku

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

QueryType

Výčet

Typ dotazu.

Hodnota	Description
flat	Získá plochý seznam pracovních položek.
oneHop	Získá seznam pracovních položek a jejich přímých odkazů.
tree	Získá strom pracovních položek zobrazující jejich hierarchii propojení.

Wiql

Objekt

Dotaz WIQL

Name	Typ	Description
query	string	Text dotazu WIQL

WorkItemFieldReference

Objekt

Odkaz na pole v pracovní položce

Name	Typ	Description
name	string	Popisný název pole
referenceName	string	Název odkazu pole.
url	string	Adresa URL REST prostředku.

WorkItemLink

Objekt

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

Objekt

Výsledek dotazu na pracovní položku

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

WorkItemQuerySortColumn

Objekt

Sloupec řazení.

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

WorkItemReference

Objekt

Obsahuje odkaz na pracovní položku.

Name	Typ	Description
id	integer (int32)	ID pracovní položky
url	string	Adresa URL rozhraní REST API prostředku

Sdílet prostřednictvím

Wiql - Query By Wiql

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Get results of a flat work item query.

Ukázkový požadavek

Ukázková odpověď

Definice

QueryResultType

QueryType

Wiql

WorkItemFieldReference

WorkItemLink

WorkItemQueryResult

WorkItemQuerySortColumn

WorkItemReference