Queries - Create
Crée une requête ou déplace une requête.
En savoir plus sur la syntaxe WIQL (Work Item Query Language) ici.
POST https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?api-version=7.1-preview.2
POST https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?validateWiqlOnly={validateWiqlOnly}&api-version=7.1-preview.2
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Nom de l’organisation Azure DevOps. |
project
|
path | True |
string |
ID de projet ou nom du projet |
query
|
path | True |
string |
ID parent ou chemin d’accès sous lequel la requête doit être créée. |
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. |
validate
|
query |
boolean |
Si vous souhaitez uniquement valider votre requête WIQL sans en créer une, définissez-la sur true. La valeur par défaut est false. |
Corps de la demande
Nom | Type | Description |
---|---|---|
_links |
Lier des références à des ressources REST associées. |
|
children |
Éléments de requête enfants à l’intérieur d’un dossier de requête. |
|
clauses |
Clauses d’une requête plate. |
|
columns |
Colonnes de la requête. |
|
createdBy |
Identité qui a créé l’élément de requête. |
|
createdDate |
string |
Lorsque l’élément de requête a été créé. |
filterOptions |
Mode de requête de lien. |
|
hasChildren |
boolean |
S’il s’agit d’un dossier de requête, indique s’il contient des enfants. |
id |
string |
ID de l’élément de requête. |
isDeleted |
boolean |
Indique si cet élément de requête est supprimé. La définition de cette valeur sur false sur un élément de requête supprimé annule la suppression de celui-ci. La suppression de la suppression d’une requête ou d’un dossier ne ramène pas les modifications d’autorisation qui y ont été appliquées précédemment. |
isFolder |
boolean |
Indique s’il s’agit d’un dossier de requête ou d’une requête. |
isInvalidSyntax |
boolean |
Indique si le WIQL de cette requête n’est pas valide. Cela peut être dû à une syntaxe non valide ou à un chemin d’itération/zone non valide. |
isPublic |
boolean |
Indique si cet élément de requête est public ou privé. |
lastExecutedBy |
Identité qui a exécuté la dernière requête. |
|
lastExecutedDate |
string |
Lors de la dernière exécution de la requête. |
lastModifiedBy |
Identité qui a modifié l’élément de requête en dernier. |
|
lastModifiedDate |
string |
Lorsque l’élément de requête a été modifié pour la dernière fois. |
linkClauses |
Clause de requête de lien. |
|
name |
string |
Nom de l’élément de requête. |
path |
string |
Chemin d’accès de l’élément de requête. |
queryRecursionOption |
Option de récursivité à utiliser dans une requête d’arborescence. |
|
queryType |
Type de requête. |
|
sortColumns |
Colonnes de tri de la requête. |
|
sourceClauses |
Clauses sources dans une requête d’arborescence ou de lien à un tronçon. |
|
targetClauses |
Clauses cibles dans une requête de lien d’arborescence ou d’un tronçon. |
|
url |
string |
|
wiql |
string |
Texte WIQL de la requête |
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_write | Autorise la lecture, la création et la mise à jour d’éléments de travail et de requêtes, la mise à jour des métadonnées du tableau, la zone de lecture et les itérations des chemins d’autres métadonnées associées au suivi des éléments de travail, à exécuter des requêtes et à recevoir des notifications sur les événements d’élément de travail via des hooks de service. |
Exemples
Create a folder |
Create a query |
Move a query or folder |
Create a folder
Sample Request
POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=7.1-preview.2
{
"name": "Website team",
"isFolder": true
}
Sample Response
{
"id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
"name": "Website team",
"path": "Shared Queries/Website team",
"createdBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"createdDate": "2016-06-01T16:58:56.323Z",
"lastModifiedBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"lastModifiedDate": "2016-06-01T16:58:56.323Z",
"isFolder": true,
"hasChildren": false,
"isPublic": true,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/eb5c1e25-9b3e-4416-a833-e500122882c7"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}
Create a query
Sample Request
POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=7.1-preview.2
{
"name": "All Bugs",
"wiql": "Select [System.Id], [System.Title], [System.State] From WorkItems Where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc"
}
Sample Response
{
"id": "342f0f44-4069-46b1-a940-3d0468979ceb",
"name": "All Bugs",
"path": "Shared Queries/Website team/All Bugs",
"createdBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"createdDate": "2016-06-01T16:58:56.64Z",
"lastModifiedBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"lastModifiedDate": "2016-06-01T16:58:56.64Z",
"queryType": "flat",
"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
}
],
"wiql": "select [System.Id], [System.Title], [System.State] from WorkItems where [System.WorkItemType] = 'Bug' order by [Microsoft.VSTS.Common.Priority] asc, [System.CreatedDate] desc",
"isPublic": true,
"clauses": {
"field": {
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.WorkItemType"
},
"operator": {
"referenceName": "SupportedOperations.Equals",
"name": "="
},
"value": "Bug"
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=342f0f44-4069-46b1-a940-3d0468979ceb"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"wiql": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/wiql/342f0f44-4069-46b1-a940-3d0468979ceb"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/342f0f44-4069-46b1-a940-3d0468979ceb"
}
Move a query or folder
Sample Request
POST https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/queries/{query}?api-version=7.1-preview.2
{
"id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}
Sample Response
{
"id": "8a8c8212-15ca-41ed-97aa-1d6fbfbcd581",
"name": "Website",
"path": "My Queries/Website",
"createdBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"createdDate": "2016-06-01T16:58:56.323Z",
"lastModifiedBy": {
"displayName": "Jamal Hartnett",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"_links": {
"avatar": {
"href": "https://dev.azure.com/mseng/_apis/GraphProfile/MemberAvatars/aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
}
},
"id": "d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"uniqueName": "fabrikamfiber4@hotmail.com",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d291b0c4-a05c-4ea6-8df1-4b41d5f39eff",
"descriptor": "aad.YTkzODFkODYtNTYxYS03ZDdiLWJjM2QtZDUzMjllMjM5OTAz"
},
"lastModifiedDate": "2016-06-01T16:58:59.407Z",
"isFolder": true,
"hasChildren": true,
"isPublic": false,
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"html": {
"href": "https://dev.azure.com/fabrikam/web/qr.aspx?pguid=6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c&qid=8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
},
"parent": {
"href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/3c65fbc1-d427-48ce-9091-633dde9e27e2"
}
},
"url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/_apis/wit/queries/8a8c8212-15ca-41ed-97aa-1d6fbfbcd581"
}
Définitions
Nom | Description |
---|---|
Identity |
Décrit une référence à une identité. |
Link |
Mode de requête de lien. |
Logical |
Opérateur logique séparant la clause condition |
Query |
Représente un élément dans la hiérarchie de requête d’élément de travail. Il peut s’agir d’une requête ou d’un dossier. |
Query |
Option de récursivité à utiliser dans une requête d’arborescence. |
Query |
Type de requête. |
Reference |
Classe pour représenter une collection de liens de référence REST. |
Work |
Décrit une opération de champ d’élément de travail. |
Work |
Référence à un champ dans un élément de travail |
Work |
Représente une clause dans une requête d’élément de travail. Cela montre la structure d’une requête d’élément de travail. |
Work |
Colonne de tri. |
IdentityReference
Décrit une référence à une identité.
Nom | Type | Description |
---|---|---|
_links |
Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique. |
|
descriptor |
string |
Le descripteur est le principal moyen de référencer l’objet du graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations. |
directoryAlias |
string |
Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links » |
displayName |
string |
Il s’agit du nom d’affichage non unique du sujet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source. |
id |
string |
|
imageUrl |
string |
Déconseillé : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links » |
inactive |
boolean |
Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links » |
isAadIdentity |
boolean |
Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
name |
string |
Propriété back-compat héritée. Il s’agit de la valeur spécifique WIT de Constantes. Sera masqué (mais existe) sur le client, sauf s’il cible la version la plus récente |
profileUrl |
string |
Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef |
uniqueName |
string |
Déconseillé : utilisez Domain+PrincipalName à la place |
url |
string |
Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique. |
LinkQueryMode
Mode de requête de lien.
Nom | Type | Description |
---|---|---|
linksOneHopDoesNotContain |
string |
Retourne des éléments de travail qui satisfont la source, uniquement si aucun élément de travail lié ne satisfait aux critères de lien et de cible. |
linksOneHopMayContain |
string |
Retourne des éléments de travail qui répondent aux critères source et de lien, même si aucun élément de travail lié ne répond aux critères cibles. |
linksOneHopMustContain |
string |
Retourne des éléments de travail dans lesquels les critères source, cible et lien sont tous satisfaits. |
linksRecursiveDoesNotContain |
string |
|
linksRecursiveMayContain |
string |
Retourne des éléments de travail une hiérarchie d’éléments de travail qui, par défaut, satisfont la source |
linksRecursiveMustContain |
string |
|
workItems |
string |
Retourne la liste plate des éléments de travail. |
LogicalOperation
Opérateur logique séparant la clause condition
Nom | Type | Description |
---|---|---|
and |
string |
|
none |
string |
|
or |
string |
QueryHierarchyItem
Représente un élément dans la hiérarchie de requête d’élément de travail. Il peut s’agir d’une requête ou d’un dossier.
Nom | Type | Description |
---|---|---|
_links |
Lier des références à des ressources REST associées. |
|
children |
Éléments de requête enfants à l’intérieur d’un dossier de requête. |
|
clauses |
Clauses d’une requête plate. |
|
columns |
Colonnes de la requête. |
|
createdBy |
Identité qui a créé l’élément de requête. |
|
createdDate |
string |
Lorsque l’élément de requête a été créé. |
filterOptions |
Mode de requête de lien. |
|
hasChildren |
boolean |
S’il s’agit d’un dossier de requête, indique s’il contient des enfants. |
id |
string |
ID de l’élément de requête. |
isDeleted |
boolean |
Indique si cet élément de requête est supprimé. La définition de cette valeur sur false sur un élément de requête supprimé annule la suppression de celui-ci. La suppression de la suppression d’une requête ou d’un dossier ne ramène pas les modifications d’autorisation qui y ont été appliquées précédemment. |
isFolder |
boolean |
Indique s’il s’agit d’un dossier de requête ou d’une requête. |
isInvalidSyntax |
boolean |
Indique si le WIQL de cette requête n’est pas valide. Cela peut être dû à une syntaxe non valide ou à un chemin d’itération/zone non valide. |
isPublic |
boolean |
Indique si cet élément de requête est public ou privé. |
lastExecutedBy |
Identité qui a exécuté la dernière requête. |
|
lastExecutedDate |
string |
Lors de la dernière exécution de la requête. |
lastModifiedBy |
Identité qui a modifié l’élément de requête en dernier. |
|
lastModifiedDate |
string |
Lorsque l’élément de requête a été modifié pour la dernière fois. |
linkClauses |
Clause de requête de lien. |
|
name |
string |
Nom de l’élément de requête. |
path |
string |
Chemin d’accès de l’élément de requête. |
queryRecursionOption |
Option de récursivité à utiliser dans une requête d’arborescence. |
|
queryType |
Type de requête. |
|
sortColumns |
Colonnes de tri de la requête. |
|
sourceClauses |
Clauses sources dans une requête d’arborescence ou de lien à un tronçon. |
|
targetClauses |
Clauses cibles dans une requête de lien d’arborescence ou d’un tronçon. |
|
url |
string |
|
wiql |
string |
Texte WIQL de la requête |
QueryRecursionOption
Option de récursivité à utiliser dans une requête d’arborescence.
Nom | Type | Description |
---|---|---|
childFirst |
string |
Retourne des éléments de travail qui répondent aux critères cibles, même si aucun élément de travail ne satisfait aux critères source et de lien. |
parentFirst |
string |
Retourne des éléments de travail qui satisfont la source, même si aucun élément de travail lié ne répond aux critères cibles et de liaison. |
QueryType
Type de requête.
Nom | Type | Description |
---|---|---|
flat |
string |
Obtient une liste plate d’éléments de travail. |
oneHop |
string |
Obtient la 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. |
ReferenceLinks
Classe pour représenter une collection de liens de référence REST.
Nom | Type | Description |
---|---|---|
links |
object |
Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule. |
WorkItemFieldOperation
Décrit une opération de champ d’élément de travail.
Nom | Type | Description |
---|---|---|
name |
string |
Nom convivial de l’opération. |
referenceName |
string |
Nom de référence de l’opération. |
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. |
WorkItemQueryClause
Représente une clause dans une requête d’élément de travail. Cela montre la structure d’une requête d’élément de travail.
Nom | Type | Description |
---|---|---|
clauses |
Clauses enfants si la clause actuelle est un opérateur logique |
|
field |
Champ associé à la condition |
|
fieldValue |
Côté droit de la condition lors d’une comparaison de champ à champ |
|
isFieldValue |
boolean |
Détermine s’il s’agit d’une comparaison de champ à champ |
logicalOperator |
Opérateur logique séparant la clause condition |
|
operator |
Opérateur de champ |
|
value |
string |
Côté droit de la condition lorsqu’un champ doit être comparé |
WorkItemQuerySortColumn
Colonne de tri.
Nom | Type | Description |
---|---|---|
descending |
boolean |
Direction à suivre pour trier. |
field |
Champ d’élément de travail. |