Wiql - Query By Wiql

Referenz

Dienst:: Work Item Tracking

API-Version:: 6.1-preview.2

Ruft die Ergebnisse der Abfrage ab, deren WIQL angegeben ist.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
project	path		string	Projekt-ID oder Projektname
team	path		string	Team-ID oder Teamname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "6.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.
$top	query		integer (int32)	Die maximale Anzahl der zurückzugebenden Ergebnisse.
timePrecision	query		boolean	Gibt an, ob die Zeitgenauigkeit verwendet werden soll.

Anforderungstext

Name	Typ	Beschreibung
query	string	Der Text der WIQL-Abfrage

Antworten

Name	Typ	Beschreibung
200 OK	WorkItemQueryResult	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.work	Gewährt die Möglichkeit, Arbeitsaufgaben, Abfragen, Boards, Flächen- und Iterationspfade und andere Metadaten zur Nachverfolgung von Arbeitsaufgaben zu lesen. Gewährt außerdem die Möglichkeit, Abfragen auszuführen, Arbeitsaufgaben zu durchsuchen und Benachrichtigungen über Arbeitsaufgabenereignisse über Dienst-Hooks zu erhalten.

Beispiele

Get results of a flat work item query.

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
QueryResultType	Der Ergebnistyp
QueryType	Der Abfragetyp.
Wiql	Eine WIQL-Abfrage
WorkItemFieldReference	Verweisen auf ein Feld in einer Arbeitsaufgabe
WorkItemLink	Eine Verknüpfung zwischen zwei Arbeitsaufgaben.
WorkItemQueryResult	Das Ergebnis einer Arbeitsaufgabenabfrage.
WorkItemQuerySortColumn	Eine Sortierspalte.
WorkItemReference	Enthält einen Verweis auf eine Arbeitsaufgabe.

QueryResultType

Enumeration

Der Ergebnistyp

Wert	Beschreibung
workItem	Eine Liste der Arbeitsaufgaben (für flache Abfragen).
workItemLink	Eine Liste der Arbeitsaufgabenlinks (für OneHop- und Strukturabfragen).

QueryType

Enumeration

Der Abfragetyp.

Wert	Beschreibung
flat	Ruft eine flache Liste von Arbeitsaufgaben ab.
oneHop	Ruft eine Liste der Arbeitsaufgaben und deren direkte Verknüpfungen ab.
tree	Ruft eine Struktur der Arbeitsaufgaben ab, die ihre Verknüpfungshierarchie anzeigen.

Wiql

Objekt

Eine WIQL-Abfrage

Name	Typ	Beschreibung
query	string	Der Text der WIQL-Abfrage

WorkItemFieldReference

Objekt

Verweisen auf ein Feld in einer Arbeitsaufgabe

Name	Typ	Beschreibung
name	string	Der Anzeigename des Felds.
referenceName	string	Der Verweisname des Felds.
url	string	Die REST-URL der Ressource.

WorkItemLink

Objekt

Eine Verknüpfung zwischen zwei Arbeitsaufgaben.

Name	Typ	Beschreibung
rel	string	Der Typ des Links.
source	WorkItemReference	Die Arbeitsaufgabe der Quelle.
target	WorkItemReference	Die Zielarbeitsaufgabe.

WorkItemQueryResult

Objekt

Das Ergebnis einer Arbeitsaufgabenabfrage.

Name	Typ	Beschreibung
asOf	string (date-time)	Das Datum, an dem die Abfrage im Kontext ausgeführt wurde.
columns	WorkItemFieldReference[]	Die Spalten der Abfrage.
queryResultType	QueryResultType	Der Ergebnistyp
queryType	QueryType	Der Typ der Abfrage
sortColumns	WorkItemQuerySortColumn[]	Die Sortierspalten der Abfrage.
workItemRelations	WorkItemLink[]	Die von der Abfrage zurückgegebenen Arbeitsaufgabenlinks.
workItems	WorkItemReference[]	Die arbeitsaufgaben, die von der Abfrage zurückgegeben werden.

WorkItemQuerySortColumn

Objekt

Eine Sortierspalte.

Name	Typ	Beschreibung
descending	boolean	Die Richtung, nach der sortiert werden soll.
field	WorkItemFieldReference	Ein Arbeitselementfeld.

WorkItemReference

Objekt

Enthält einen Verweis auf eine Arbeitsaufgabe.

Name	Typ	Beschreibung
id	integer (int32)	Arbeitselement-ID.
url	string	REST-API-URL der Ressource

Freigeben über

Wiql - Query By Wiql

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Get results of a flat work item query.

Beispielanforderung

Beispiel für eine Antwort

Definitionen

QueryResultType

QueryType

Wiql

WorkItemFieldReference

WorkItemLink

WorkItemQueryResult

WorkItemQuerySortColumn

WorkItemReference