Queries - Search Queries
Recherche toutes les requêtes à laquelle l’utilisateur a accès dans le projet actuel
GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&api-version=7.1GET https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$filter={$filter}&$top={$top}&$expand={$expand}&$includeDeleted={$includeDeleted}&api-version=7.1Paramè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 |
|
$filter
|
query | True |
string |
Texte avec lequel filtrer les requêtes. |
|
api-version
|
query | True |
string |
Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API. |
|
$expand
|
query | |||
|
$include
|
query |
boolean |
Inclure les requêtes et dossiers supprimés |
|
|
$top
|
query |
integer (int32) |
Nombre de requêtes à retourner (la valeur par défaut est 50 et la valeur maximale est de 200). |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
opération réussie |
Sécurité
oauth2
Type:
oauth2
Flux:
accessCode
URL d’autorisation:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton:
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
Étendues
| Nom | Description |
|---|---|
| vso.work | Octroie la possibilité de lire des éléments de travail, des requêtes, des tableaux, des zones et des itérations, ainsi que d’autres métadonnées associées au suivi des éléments de travail. Accorde également la possibilité 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. |
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 |
Paramètres de développement pour les requêtes. Les options possibles sont { None, Wiql, Clauses, All, Minimal } |
|
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 |
|
|
Query |
Option de récursivité à utiliser dans une requête d’arborescence. |
|
Query |
Type de requête. |
|
Reference |
Classe à 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 graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur 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 complet non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source. |
| id |
string (uuid) |
|
| 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 des constantes. Sera masqué (mais existe) sur le client, sauf s’ils ciblent 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é : utiliser Domain+PrincipalName à la place |
| url |
string |
Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe. |
LinkQueryMode
Mode de requête de lien.
| Valeur | Description |
|---|---|
| linksOneHopDoesNotContain |
Retourne des éléments de travail qui répondent à la source, uniquement si aucun élément de travail lié ne satisfait aux critères de lien et de cible. |
| linksOneHopMayContain |
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 satisfait aux critères cibles. |
| linksOneHopMustContain |
Retourne des éléments de travail où les critères source, cible et lien sont tous satisfaits. |
| linksRecursiveDoesNotContain | |
| linksRecursiveMayContain |
Retourne les éléments de travail une hiérarchie d’éléments de travail qui répondent par défaut à la source |
| linksRecursiveMustContain | |
| workItems |
Retourne la liste plate des éléments de travail. |
LogicalOperation
Opérateur logique séparant la clause condition
| Valeur | Description |
|---|---|
| and | |
| none | |
| or |
QueryExpand
Paramètres de développement pour les requêtes. Les options possibles sont { None, Wiql, Clauses, All, Minimal }
| Valeur | Description |
|---|---|
| all |
Développe toutes les propriétés |
| clauses |
Développe les colonnes, les liens, changeInfo, le texte WIQL et les clauses |
| minimal |
Affiche des propriétés minimales et le texte WIQL |
| none |
Développe les colonnes, les liens et ChangeInfo |
| wiql |
Développe des colonnes, des liens, du texte ChangeInfo et WIQL |
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 aux 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 (date-time) |
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 (uuid) |
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é l’annule. La suppression d’une requête ou d’un dossier ne ramène pas les modifications d’autorisation qui ont été précédemment appliquées à celle-ci. |
| 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’accès de zone/itération 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 (date-time) |
Lors de la dernière exécution de la requête. |
| lastModifiedBy |
Identité qui a modifié l’élément de requête pour la dernière fois. |
|
| lastModifiedDate |
string (date-time) |
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 de lien à un tronçon ou à une arborescence. |
|
| targetClauses |
Clauses cibles dans une requête de lien à un tronçon ou à une arborescence. |
|
| url |
string |
|
| wiql |
string |
Texte WIQL de la requête |
QueryHierarchyItemsResult
| Nom | Type | Description |
|---|---|---|
| count |
integer (int32) |
Nombre d’éléments. |
| hasMore |
boolean |
Indique si la limite maximale de retour a été atteinte, mais qu’il y a encore plus d’éléments |
| value |
Liste des éléments |
QueryRecursionOption
Option de récursivité à utiliser dans une requête d’arborescence.
| Valeur | Description |
|---|---|
| childFirst |
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 |
Retourne des éléments de travail qui répondent à la source, même si aucun élément de travail lié ne satisfait aux critères de cible et de lien. |
QueryType
Type de requête.
| Valeur | Description |
|---|---|
| flat |
Obtient une liste plate d’éléments de travail. |
| oneHop |
Obtient une liste d’éléments de travail et de leurs liens directs. |
| tree |
Obtient une arborescence d’éléments de travail montrant leur hiérarchie de liens. |
ReferenceLinks
Classe à 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 lorsqu’un champ à comparer |
|
| isFieldValue |
boolean |
Détermine s’il s’agit d’un champ de comparaison de champs |
| 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 à comparer |
WorkItemQuerySortColumn
Colonne de tri.
| Nom | Type | Description |
|---|---|---|
| descending |
boolean |
Direction à trier. |
| field |
Champ d’élément de travail. |