Work Items - Get Work Items Batch

Référence

Service:: Work Item Tracking

API Version:: 6.1-preview.1

Obtient des éléments de travail pour une liste d’ID d’élément de travail (maximum 200)

POST https://dev.azure.com/{organization}/{project}/_apis/wit/workitemsbatch?api-version=6.1-preview.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path		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 « 6.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
$expand	WorkItemExpand	Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }
asOf	string	Chaîne d’heure de date UTC AsOf
errorPolicy	WorkItemErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une demande d’obtention en bloc d’éléments de travail. Les options possibles sont {Fail, Omit}.
fields	string[]	Champs demandés
ids	integer[]	ID d’élément de travail demandés

Réponses

Nom	Type	Description
200 OK	WorkItem[]	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. Permet également 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

Get list of work items for specific fields

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/_apis/wit/workitemsbatch?api-version=6.1-preview.1

{
  "ids": [
    297,
    299,
    300
  ],
  "fields": [
    "System.Id",
    "System.Title",
    "System.WorkItemType",
    "Microsoft.VSTS.Scheduling.RemainingWork"
  ]
}

Sample Response

Status code:: 200

{
  "count": 3,
  "value": [
    {
      "id": 297,
      "rev": 1,
      "fields": {
        "System.Id": 297,
        "System.WorkItemType": "Product Backlog Item",
        "System.Title": "Customer can sign in using their Microsoft Account"
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/297"
    },
    {
      "id": 299,
      "rev": 7,
      "fields": {
        "System.Id": 299,
        "System.WorkItemType": "Task",
        "System.Title": "JavaScript implementation for Microsoft Account",
        "Microsoft.VSTS.Scheduling.RemainingWork": 4
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/299"
    },
    {
      "id": 300,
      "rev": 1,
      "fields": {
        "System.Id": 300,
        "System.WorkItemType": "Task",
        "System.Title": "Unit Testing for MSA login",
        "Microsoft.VSTS.Scheduling.RemainingWork": 3
      },
      "url": "https://dev.azure.com/fabrikam/_apis/wit/workItems/300"
    }
  ]
}

Définitions

Nom	Description
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
WorkItem	Décrit un élément de travail.
WorkItemBatchGetRequest	Décrit une demande d’obtention d’un ensemble d’éléments de travail
WorkItemCommentVersionRef	Représente la référence à une version spécifique d’un commentaire sur un élément de travail.
WorkItemErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une demande d’obtention en bloc d’éléments de travail. Les options possibles sont {Fail, Omit}.
WorkItemExpand	Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }
WorkItemRelation

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.

WorkItem

Décrit un élément de travail.

Nom	Type	Description
_links	ReferenceLinks	Lier des références à des ressources REST associées.
commentVersionRef	WorkItemCommentVersionRef	Référence à une version spécifique du commentaire ajouté/modifié/supprimé dans cette révision.
fields	object	Carte du champ et des valeurs de l’élément de travail.
id	integer	ID de l’élément de travail.
relations	WorkItemRelation[]	Relations de l’élément de travail.
rev	integer	Numéro de révision de l’élément de travail.
url	string

WorkItemBatchGetRequest

Décrit une demande d’obtention d’un ensemble d’éléments de travail

Nom	Type	Description
$expand	WorkItemExpand	Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }
asOf	string	Chaîne d’heure de date UTC AsOf
errorPolicy	WorkItemErrorPolicy	Indicateur permettant de contrôler la stratégie d’erreur dans une demande d’obtention en bloc d’éléments de travail. Les options possibles sont {Fail, Omit}.
fields	string[]	Champs demandés
ids	integer[]	ID d’élément de travail demandés

WorkItemCommentVersionRef

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

Nom	Type	Description
commentId	integer	ID attribué au commentaire.
createdInRevision	integer	[Interne] Révision de l’élément de travail où 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
version	integer	Numéro de version.

WorkItemErrorPolicy

Indicateur permettant de contrôler la stratégie d’erreur dans une demande d’obtention en bloc d’éléments de travail. Les options possibles sont {Fail, Omit}.

Nom	Type	Description
fail	string	Stratégie d’erreur de travail d’échec.
omit	string	Omettez la stratégie d’erreur de travail.

WorkItemExpand

Paramètres de développement pour les attributs d’élément de travail. Les options possibles sont { None, Relations, Fields, Links, All }

Nom	Type	Description
all	string	Développe tout.
fields	string	Champs, élément de travail développer.
links	string	Développez l’élément de travail liens.
none	string	Comportement par défaut
relations	string	Développez l’élément de travail Relations.

WorkItemRelation

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

Partager via