Wiql - Query By Id
Obtient les résultats de la requête en fonction de l’ID de requête.
GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?api-version=7.1-preview.2GET https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?timePrecision={timePrecision}&$top={$top}&api-version=7.1-preview.2Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
id
|
path | True |
string uuid |
ID de requête. |
|
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 « 7.1-preview.2 » pour utiliser cette version de l’API. |
|
$top
|
query |
integer int32 |
Nombre maximal de résultats à retourner. |
|
|
time
|
query |
boolean |
Indique s’il faut utiliser ou non la précision temporelle. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
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
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/wiql/{id}?api-version=7.1-preview.2
Sample Response
{
"queryType": "tree",
"asOf": "2014-12-29T20:49:33.803Z",
"columns": [
{
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Id"
},
{
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
{
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.Title"
},
{
"referenceName": "System.AssignedTo",
"name": "Assigned To",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.AssignedTo"
},
{
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.State"
}
],
"workItemRelations": [
{
"target": {
"id": 4,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/4"
}
},
{
"target": {
"id": 5,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/5"
}
},
{
"target": {
"id": 6,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/6"
}
},
{
"target": {
"id": 7,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 7,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
},
"target": {
"id": 8,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/8"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 7,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/7"
},
"target": {
"id": 9,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/9"
}
},
{
"target": {
"id": 11,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/11"
}
},
{
"target": {
"id": 12,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/12"
}
},
{
"target": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 1,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/1"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 2,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/2"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 3,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/3"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 20,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/20"
},
"target": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 13,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/13"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 14,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/14"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 15,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/15"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 16,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/16"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 17,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/17"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 18,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/18"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 10,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/10"
},
"target": {
"id": 19,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/19"
}
},
{
"target": {
"id": 21,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/21"
}
},
{
"target": {
"id": 33,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/33"
}
},
{
"target": {
"id": 34,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/34"
}
},
{
"target": {
"id": 46,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/46"
}
},
{
"target": {
"id": 47,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/47"
}
},
{
"target": {
"id": 58,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/58"
}
},
{
"target": {
"id": 59,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/59"
}
},
{
"target": {
"id": 297,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 297,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
},
"target": {
"id": 299,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
}
},
{
"rel": "System.LinkTypes.Hierarchy-Forward",
"source": {
"id": 297,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
},
"target": {
"id": 300,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
}
},
{
"target": {
"id": 298,
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/298"
}
}
]
}Définitions
| Nom | Description |
|---|---|
|
Query |
Type de résultat |
|
Query |
Type de requête. |
|
Work |
Référence à un champ dans un élément de travail |
|
Work |
Lien entre deux éléments de travail. |
|
Work |
Résultat d’une requête d’élément de travail. |
|
Work |
Colonne de tri. |
|
Work |
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. |
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. |
WorkItemLink
Lien entre deux éléments de travail.
| Nom | Type | Description |
|---|---|---|
| rel |
string |
Type de liaison. |
| source |
Élément de travail source. |
|
| target |
É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 |
Colonnes de la requête. |
|
| queryResultType |
Type de résultat |
|
| queryType |
Type de la requête |
|
| sortColumns |
Colonnes de tri de la requête. |
|
| workItemRelations |
Liens d’élément de travail retournés par la requête. |
|
| workItems |
Éléments de travail retournés par la requête. |
WorkItemQuerySortColumn
Colonne de tri.
| Nom | Type | Description |
|---|---|---|
| descending |
boolean |
Direction à suivre pour trier. |
| field |
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 |
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour