Wiql - Query By Wiql

Odwołanie

Service:: Work Item Tracking

API Version:: 6.1-preview.2

Pobiera wyniki zapytania, biorąc pod uwagę jego WIQL.

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path		string	Identyfikator projektu lub nazwa projektu
team	path		string	Identyfikator zespołu lub nazwa zespołu
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "6.1-preview.2", aby używać tej wersji interfejsu API.
$top	query		integer int32	Maksymalna liczba wyników do zwrócenia.
timePrecision	query		boolean	Niezależnie od tego, czy należy używać precyzji czasu.

Treść żądania

Nazwa	Typ	Opis
query	string	Tekst zapytania WIQL

Odpowiedzi

Nazwa	Typ	Opis
200 OK	WorkItemQueryResult	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.work	Umożliwia odczytywanie elementów roboczych, zapytań, tablic, ścieżek obszaru i iteracji oraz innych metadanych powiązanych elementów roboczych. Umożliwia również wykonywanie zapytań, wyszukiwanie elementów roboczych i odbieranie powiadomień o zdarzeniach elementów roboczych za pośrednictwem punktów zaczepienia usługi.

Przykłady

Get results of a flat work item query.

Sample Request

HTTP

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

Definicje

Nazwa	Opis
QueryResultType	Typ wyniku
QueryType	Typ zapytania.
Wiql	Zapytanie WIQL
WorkItemFieldReference	Odwołanie do pola w elemencie roboczym
WorkItemLink	Łącze między dwoma elementami roboczymi.
WorkItemQueryResult	Wynik zapytania elementu roboczego.
WorkItemQuerySortColumn	Kolumna sortowania.
WorkItemReference	Zawiera odwołanie do elementu roboczego.

QueryResultType

Typ wyniku

Nazwa	Typ	Opis
workItem	string	Lista elementów roboczych (w przypadku zapytań płaskich).
workItemLink	string	Lista łączy elementów roboczych (w przypadku zapytań OneHop i Drzewa).

QueryType

Typ zapytania.

Nazwa	Typ	Opis
flat	string	Pobiera płaską listę elementów roboczych.
oneHop	string	Pobiera listę elementów roboczych i ich linków bezpośrednich.
tree	string	Pobiera drzewo elementów roboczych z ich hierarchią linków.

Wiql

Zapytanie WIQL

Nazwa	Typ	Opis
query	string	Tekst zapytania WIQL

WorkItemFieldReference

Odwołanie do pola w elemencie roboczym

Nazwa	Typ	Opis
name	string	Przyjazna nazwa pola.
referenceName	string	Nazwa odwołania pola.
url	string	Adres URL REST zasobu.

WorkItemLink

Łącze między dwoma elementami roboczymi.

Nazwa	Typ	Opis
rel	string	Typ łącza.
source	WorkItemReference	Źródłowy element roboczy.
target	WorkItemReference	Docelowy element roboczy.

WorkItemQueryResult

Wynik zapytania elementu roboczego.

Nazwa	Typ	Opis
asOf	string	Data uruchomienia zapytania w kontekście.
columns	WorkItemFieldReference[]	Kolumny zapytania.
queryResultType	QueryResultType	Typ wyniku
queryType	QueryType	Typ zapytania
sortColumns	WorkItemQuerySortColumn[]	Sortowanie kolumn zapytania.
workItemRelations	WorkItemLink[]	Linki elementu roboczego zwrócone przez zapytanie.
workItems	WorkItemReference[]	Elementy robocze zwrócone przez zapytanie.

WorkItemQuerySortColumn

Kolumna sortowania.

Nazwa	Typ	Opis
descending	boolean	Kierunek sortowania według.
field	WorkItemFieldReference	Pole elementu roboczego.

WorkItemReference

Zawiera odwołanie do elementu roboczego.

Nazwa	Typ	Opis
id	integer	Identyfikator elementu roboczego.
url	string	Adres URL interfejsu API REST zasobu

Udostępnij za pośrednictwem