Freigeben über


Wiql - Query By Wiql

Ruft die Ergebnisse der Abfrage ab, die ihrem WIQL gegeben ist.

POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?api-version=7.1-preview.2
POST https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?timePrecision={timePrecision}&$top={$top}&api-version=7.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 "7.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

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 Beschreibung
vso.work Ermöglicht das Lesen von Arbeitselementen, Abfragen, Boards, Bereichs- und Iterationspfaden und anderen Metadaten zur Nachverfolgung von Arbeitselementen. Bietet außerdem die Möglichkeit, Abfragen auszuführen, Arbeitselemente zu durchsuchen und Benachrichtigungen über Arbeitselementereignisse über Diensthooks zu erhalten.

Beispiele

Get results of a flat work item query.

Sample Request

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

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

Verweis auf ein Feld in einem Arbeitselement

WorkItemLink

Eine Verknüpfung zwischen zwei Arbeitselementen.

WorkItemQueryResult

Das Ergebnis einer Arbeitselementabfrage.

WorkItemQuerySortColumn

Eine Sortierspalte.

WorkItemReference

Enthält einen Verweis auf ein Arbeitselement.

QueryResultType

Der Ergebnistyp

Name Typ Beschreibung
workItem

string

Eine Liste von Arbeitselementen (für flache Abfragen).

workItemLink

string

Eine Liste von Arbeitselementlinks (für OneHop- und Tree-Abfragen).

QueryType

Der Abfragetyp.

Name Typ Beschreibung
flat

string

Ruft eine flache Liste von Arbeitselementen ab.

oneHop

string

Ruft eine Liste der Arbeitselemente und deren direkte Links ab.

tree

string

Ruft eine Struktur von Arbeitselementen ab, die deren Linkhierarchie anzeigen.

Wiql

Eine WIQL-Abfrage

Name Typ Beschreibung
query

string

Der Text der WIQL-Abfrage

WorkItemFieldReference

Verweis auf ein Feld in einem Arbeitselement

Name Typ Beschreibung
name

string

Der Anzeigename des Felds.

referenceName

string

Der Verweisname des Felds.

url

string

Die REST-URL der Ressource.

Eine Verknüpfung zwischen zwei Arbeitselementen.

Name Typ Beschreibung
rel

string

Der Typ des Links.

source

WorkItemReference

Das Quellarbeitselement.

target

WorkItemReference

Das Zielarbeitselement.

WorkItemQueryResult

Das Ergebnis einer Arbeitselementabfrage.

Name Typ Beschreibung
asOf

string

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 Arbeitselementlinks.

workItems

WorkItemReference[]

Die von der Abfrage zurückgegebenen Arbeitselemente.

WorkItemQuerySortColumn

Eine Sortierspalte.

Name Typ Beschreibung
descending

boolean

Die Richtung, nach der sortiert werden soll.

field

WorkItemFieldReference

Ein Arbeitselementfeld.

WorkItemReference

Enthält einen Verweis auf ein Arbeitselement.

Name Typ Beschreibung
id

integer

Arbeitselement-ID.

url

string

REST-API-URL der Ressource