Predefined Queries - List

Service:

Work

Version d'API:

7.2-preview.1

Récupère l’ensemble de requêtes connues

GET https://dev.azure.com/{organization}/{project}/_apis/work/predefinedqueries?api-version=7.2-preview.1

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
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.2-preview.1 » pour utiliser cette version de l’API.

Réponses

Nom	Type	Description
200 OK	PredefinedQuery[]	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, ainsi que de recevoir des notifications sur les événements des éléments de travail via des connecteurs de service.

Définitions

Nom	Description
PredefinedQuery	Représente une requête prédéfinie unique.
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
WorkItem	Décrit un élément de travail.
WorkItemCommentVersionRef	Représente la référence à une version spécifique d’un commentaire sur un élément de travail.
WorkItemRelation

PredefinedQuery

Object

Représente une requête prédéfinie unique.

Nom	Type	Description
hasMore	boolean	Indique si la requête a retourné le jeu complet de données ou si les données ont été tronquées.
id	string	ID de la requête
name	string	Nom localisé de la requête
results	WorkItem[]	Résultats de la requête. Il s’agit d’un ensemble d’objets WorkItem avec uniquement l’ensemble « id ». Le client est responsable de la pagination des données en fonction des besoins.
url	string	URL de l’API REST à utiliser pour récupérer les résultats de cette requête
webUrl	string	URL à utiliser pour afficher une page dans le navigateur avec les résultats de cette requête

ReferenceLinks

Object

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.

WorkItem

Object

Décrit un élément de travail.

Nom	Type	Description
_links	ReferenceLinks	Lier des références aux ressources REST associées.
commentVersionRef	WorkItemCommentVersionRef	Référence à une version spécifique du commentaire ajouté/modifié/supprimé dans cette révision.
fields	object	Mappage du champ et des valeurs de l’élément de travail.
id	integer (int32)	ID de l’élément de travail.
multilineFieldsFormat		Dictionnaire décrivant le format des champs multilignes sélectionnés par le dernier utilisateur de modification.
relations	WorkItemRelation[]	Relations de l’élément de travail.
rev	integer (int32)	Numéro de révision de l’élément de travail.
url	string	URL REST de la ressource.

WorkItemCommentVersionRef

Object

Représente la référence à une version spécifique d’un commentaire sur un élément de travail.

Nom	Type	Description
commentId	integer (int32)	ID affecté au commentaire.
createdInRevision	integer (int32)	[Interne] Révision de l’élément de travail dans laquelle ce commentaire a été ajouté à l’origine.
isDeleted	boolean	[Interne] Spécifie si le commentaire a été supprimé.
text	string	[Interne] Texte du commentaire.
url	string	URL REST de la ressource.
version	integer (int32)	Numéro de version.

WorkItemRelation

Object

Nom	Type	Description
attributes	object	Collection d’attributs de lien.
rel	string	Type de relation.
url	string	URL du lien.