Partager via


Wiql - Query By Wiql

Obtient les résultats de la requête en fonction de son WIQL.

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

project
path

string

ID de projet ou nom du projet

team
path

string

ID d’équipe ou nom de l’équipe

api-version
query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 6.1-preview.2 » pour utiliser cette version de l’API.

$top
query

integer

int32

Nombre maximal de résultats à retourner.

timePrecision
query

boolean

Indique s’il faut utiliser ou non la précision temporelle.

Corps de la demande

Nom Type Description
query

string

Texte de la requête WIQL

Réponses

Nom Type Description
200 OK

WorkItemQueryResult

opération réussie

Sécurité

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

Nom Description
vso.work Accorde la possibilité de lire des éléments de travail, des requêtes, des tableaux, des chemins de zone et d’itérations et d’autres métadonnées associées au suivi des éléments de travail. Permet également d’exécuter des requêtes, de rechercher des éléments de travail et de recevoir des notifications sur les événements d’élément de travail via des hooks de service.

Exemples

Get results of a flat work item query.

Sample Request

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

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

Définitions

Nom Description
QueryResultType

Type de résultat

QueryType

Type de requête.

Wiql

Une requête WIQL

WorkItemFieldReference

Référence à un champ dans un élément de travail

WorkItemLink

Lien entre deux éléments de travail.

WorkItemQueryResult

Résultat d’une requête d’élément de travail.

WorkItemQuerySortColumn

Colonne de tri.

WorkItemReference

Contient une référence à un élément de travail.

QueryResultType

Type de résultat

Nom Type Description
workItem

string

Liste d’éléments de travail (pour les requêtes plates).

workItemLink

string

Liste des liens d’élément de travail (pour les requêtes OneHop et Tree).

QueryType

Type de requête.

Nom Type Description
flat

string

Obtient une liste plate d’éléments de travail.

oneHop

string

Obtient une liste des éléments de travail et leurs liens directs.

tree

string

Obtient une arborescence d’éléments de travail montrant leur hiérarchie de liens.

Wiql

Une requête WIQL

Nom Type Description
query

string

Texte de la requête WIQL

WorkItemFieldReference

Référence à un champ dans un élément de travail

Nom Type Description
name

string

Nom convivial du champ.

referenceName

string

Nom de référence du champ.

url

string

URL REST de la ressource.

Lien entre deux éléments de travail.

Nom Type Description
rel

string

Type de liaison.

source

WorkItemReference

Élément de travail source.

target

WorkItemReference

Élément de travail cible.

WorkItemQueryResult

Résultat d’une requête d’élément de travail.

Nom Type Description
asOf

string

Date à laquelle la requête a été exécutée dans le contexte de .

columns

WorkItemFieldReference[]

Colonnes de la requête.

queryResultType

QueryResultType

Type de résultat

queryType

QueryType

Type de la requête

sortColumns

WorkItemQuerySortColumn[]

Colonnes de tri de la requête.

workItemRelations

WorkItemLink[]

Liens d’élément de travail retournés par la requête.

workItems

WorkItemReference[]

Éléments de travail retournés par la requête.

WorkItemQuerySortColumn

Colonne de tri.

Nom Type Description
descending

boolean

Direction à suivre pour trier.

field

WorkItemFieldReference

Champ d’élément de travail.

WorkItemReference

Contient une référence à un élément de travail.

Nom Type Description
id

integer

ID de l’élément de travail.

url

string

URL de l’API REST de la ressource