Queries - Get Queries Batch

Référence

Service:: Work Item Tracking

Version d'API:: 7.1

Obtient une liste de requêtes par ID (maximum 1 000)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/queriesbatch?api-version=7.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.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
$expand	QueryExpand	Paramètres de développement pour les requêtes. Les options possibles sont { None, Wiql, Clauses, All, Minimal }
errorPolicy	QueryErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une requête de lot de requêtes. Les options possibles sont { Fail, Omit }.
ids	string[] (uuid)	ID de requête demandés

Réponses

Nom	Type	Description
200 OK	QueryHierarchyItem[]	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.

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.

Exemples

Gets a list of queries by ids

Exemple de requête

HTTP

POST https://dev.azure.com/fabrikam/{project}/_apis/wit/queriesbatch?api-version=7.1

{
  "ids": [
    "c6725763-d9ae-487e-bb42-00222e2f4d9f",
    "c19eec2d-07a0-4c20-be57-3f7903792ca6",
    "298f94fd-30ea-40f3-8d25-3202c9effa3a"
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "count": 3,
  "value": [
    {
      "id": "c6725763-d9ae-487e-bb42-00222e2f4d9f",
      "name": "Work Items With Summary Values",
      "path": "Shared Queries/Troubleshooting/Work Items With Summary Values",
      "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": "2018-09-26T19:01:44.6Z",
      "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": "2018-09-26T19:01:44.6Z",
      "queryType": "oneHop",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c6725763-d9ae-487e-bb42-00222e2f4d9f"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/0389af80-0be8-4c1b-800e-9e91d081e052"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c6725763-d9ae-487e-bb42-00222e2f4d9f"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c6725763-d9ae-487e-bb42-00222e2f4d9f"
    },
    {
      "id": "c19eec2d-07a0-4c20-be57-3f7903792ca6",
      "name": "Product Planning",
      "path": "Shared Queries/Product Planning",
      "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": "2018-09-26T19:01:44.6Z",
      "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": "2018-09-26T19:01:44.6Z",
      "queryType": "flat",
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=c19eec2d-07a0-4c20-be57-3f7903792ca6"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        },
        "wiql": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/wiql/c19eec2d-07a0-4c20-be57-3f7903792ca6"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/c19eec2d-07a0-4c20-be57-3f7903792ca6"
    },
    {
      "id": "298f94fd-30ea-40f3-8d25-3202c9effa3a",
      "name": "Current Iteration",
      "path": "Shared Queries/Current Iteration",
      "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": "2018-09-26T19:01:44.6Z",
      "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": "2018-09-26T19:01:44.6Z",
      "isFolder": true,
      "hasChildren": true,
      "isPublic": true,
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "html": {
          "href": "http://localhost:8080/tfs/web/qr.aspx?pguid=833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d&qid=298f94fd-30ea-40f3-8d25-3202c9effa3a"
        },
        "parent": {
          "href": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/06285cdf-e6f2-4230-80fd-66a2e11116d2"
        }
      },
      "url": "https://dev.azure.com/fabrikam/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c/833d31e3-4fc9-48f4-9eef-4a0e9d8cf21d/_apis/wit/queries/298f94fd-30ea-40f3-8d25-3202c9effa3a"
    }
  ]
}

Définitions

Nom	Description
IdentityReference	Décrit une référence à une identité.
LinkQueryMode	Mode de requête de lien.
LogicalOperation	Opérateur logique séparant la clause condition
QueryBatchGetRequest	Décrit une requête pour obtenir une liste de requêtes
QueryErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une requête de lot de requêtes. Les options possibles sont { Fail, Omit }.
QueryExpand	Paramètres de développement pour les requêtes. Les options possibles sont { None, Wiql, Clauses, All, Minimal }
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.
QueryRecursionOption	Option de récursivité à utiliser dans une requête d’arborescence.
QueryType	Type de requête.
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
WorkItemFieldOperation	Décrit une opération de champ d’élément de travail.
WorkItemFieldReference	Référence à un champ dans un élément de travail
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.
WorkItemQuerySortColumn	Colonne de tri.

IdentityReference

Object

Décrit une référence à une identité.

Nom	Type	Description
_links	ReferenceLinks	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

Énumération

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

Énumération

Opérateur logique séparant la clause condition

Valeur	Description
and
none
or

QueryBatchGetRequest

Object

Décrit une requête pour obtenir une liste de requêtes

Nom	Type	Description
$expand	QueryExpand	Paramètres de développement pour les requêtes. Les options possibles sont { None, Wiql, Clauses, All, Minimal }
errorPolicy	QueryErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une requête de lot de requêtes. Les options possibles sont { Fail, Omit }.
ids	string[] (uuid)	ID de requête demandés

QueryErrorPolicy

Énumération

Indicateur permettant de contrôler la stratégie d’erreur dans une requête de lot de requêtes. Les options possibles sont { Fail, Omit }.

Valeur	Description
fail
omit

QueryExpand

Énumération

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

Object

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	ReferenceLinks	Lier des références aux ressources REST associées.
children	QueryHierarchyItem[]	Éléments de requête enfants à l’intérieur d’un dossier de requête.
clauses	WorkItemQueryClause	Clauses d’une requête plate.
columns	WorkItemFieldReference[]	Colonnes de la requête.
createdBy	IdentityReference	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	LinkQueryMode	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	IdentityReference	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	IdentityReference	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	WorkItemQueryClause	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	QueryRecursionOption	Option de récursivité à utiliser dans une requête d’arborescence.
queryType	QueryType	Type de requête.
sortColumns	WorkItemQuerySortColumn[]	Colonnes de tri de la requête.
sourceClauses	WorkItemQueryClause	Clauses sources dans une requête de lien à un tronçon ou à une arborescence.
targetClauses	WorkItemQueryClause	Clauses cibles dans une requête de lien à un tronçon ou à une arborescence.
url	string
wiql	string	Texte WIQL de la requête

QueryRecursionOption

Énumération

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

Énumération

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

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.

WorkItemFieldOperation

Object

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

Object

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

Object

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	WorkItemQueryClause[]	Clauses enfants si la clause actuelle est un opérateur logique
field	WorkItemFieldReference	Champ associé à la condition
fieldValue	WorkItemFieldReference	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	LogicalOperation	Opérateur logique séparant la clause condition
operator	WorkItemFieldOperation	Opérateur de champ
value	string	Côté droit de la condition lorsqu’un champ à comparer

WorkItemQuerySortColumn

Object

Colonne de tri.

Nom	Type	Description
descending	boolean	Direction à trier.
field	WorkItemFieldReference	Champ d’élément de travail.

Partager via

Queries - Get Queries Batch

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Étendues

Exemples

Gets a list of queries by ids

Exemple de requête

Exemple de réponse

Définitions

IdentityReference

LinkQueryMode

LogicalOperation

QueryBatchGetRequest

QueryErrorPolicy

QueryExpand

QueryHierarchyItem

QueryRecursionOption

QueryType

ReferenceLinks

WorkItemFieldOperation

WorkItemFieldReference

WorkItemQueryClause

WorkItemQuerySortColumn