Queries - Get Queries Batch

Service:

Work Item Tracking

API Version:

5.0

Obtient une liste de requêtes par ids (maximum 1000)

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

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 « 5.0 » 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 par lot de requêtes. Les options possibles sont { Fail, Omit }.
ids	string[]	ID de requête demandés

Réponses

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

Sample Request

HTTP

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

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

Sample Response

Status code:

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 demande d’obtention d’une liste de requêtes
QueryErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une requête par 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 pour 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

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 l’objet du graphique. 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 dans les comptes et les organisations.
directoryAlias	string
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
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’il cible la version la plus récente
profileUrl	string
uniqueName	string
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 satisfait aux critères cibles.
linksOneHopMustContain	string	Retourne des éléments de travail où les critères de source, de cible et de 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

LogicalOperation

Opérateur logique séparant la clause condition

Nom	Type	Description
aND	string
nONE	string
oR	string

QueryBatchGetRequest

Décrit une demande d’obtention d’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 par lot de requêtes. Les options possibles sont { Fail, Omit }.
ids	string[]	ID de requête demandés

QueryErrorPolicy

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

Nom	Type	Description
fail	string
omit	string

QueryExpand

Paramètres de développement pour les requêtes. Les options possibles sont { None, Wiql, Clauses, All, Minimal }

Nom	Type	Description
all	string	Développe toutes les propriétés
clauses	string	Développe colonnes, liens, changeinfo, texte WIQL et clauses
minimal	string	Affiche les propriétés minimales et le texte WIQL
none	string	Développe Colonnes, Liens et ChangeInfo
wiql	string	Développe colonnes, liens, changeinfo et texte 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	ReferenceLinks	Lier des références à des 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	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	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 sa suppression. La suppression d’une requête ou d’un dossier ne rétablit pas les modifications d’autorisation qui lui ont été précédemment appliquées.
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	IdentityReference	Identité qui a exécuté la requête pour la dernière fois.
lastExecutedDate	string	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	Lors de la dernière modification de l’élément de requête.
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 arborescence ou une requête de lien à un tronçon.
targetClauses	WorkItemQueryClause	Clauses cibles dans une requête d’arborescence ou de lien à 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 satisfait aux critères de la cible et du lien.

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.

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 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 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 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	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 lors de la comparaison d’un champ à un champ
isFieldValue	boolean	Détermine s’il s’agit d’une comparaison de champ à champ
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 à valeur comparaison

WorkItemQuerySortColumn

Colonne de tri.

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