Stats - Get

Référence

Service:: Git

Version d'API:: 7.1

Récupérer des statistiques sur une branche unique.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/stats/branches?name={name}&api-version=7.1

Avec des paramètres facultatifs:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/stats/branches?name={name}&baseVersionDescriptor.version={baseVersionDescriptor.version}&baseVersionDescriptor.versionOptions={baseVersionDescriptor.versionOptions}&baseVersionDescriptor.versionType={baseVersionDescriptor.versionType}&api-version=7.1

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
repositoryId	path	True	string	Nom ou ID du référentiel.
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 « 7.1 » pour utiliser cette version de l’API.
name	query	True	string	Nom de la branche.
baseVersionDescriptor.version	query		string	Identificateur de chaîne de version (nom de balise/branche, SHA1 de commit)
baseVersionDescriptor.versionOptions	query		GitVersionOptions	Options de version : spécifier des modificateurs supplémentaires à la version (par exemple Précédent)
baseVersionDescriptor.versionType	query		GitVersionType	Type de version (branche, balise ou validation). Détermine la façon dont l’ID est interprété

Réponses

Nom	Type	Description
200 OK	GitBranchStats	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.code	Accorde la possibilité de lire le code source et les métadonnées sur les validations, les ensembles de modifications, les branches et d’autres artefacts de contrôle de version. Accorde également la possibilité de rechercher du code et d’être averti des événements de contrôle de version via des hooks de service.

Exemples

For a single branch

For a tag or commit

For a single branch

Exemple de requête

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/stats/branches?name=develop&api-version=7.1

Exemple de réponse

Code d’état:: 200

{
  "commit": {
    "commitId": "67cae2b029dff7eb3dc062b49403aaedca5bad8d",
    "author": {
      "name": "Chuck Reinhart",
      "email": "fabrikamfiber3@hotmail.com",
      "date": "2014-01-29T23:52:56Z"
    },
    "committer": {
      "name": "Chuck Reinhart",
      "email": "fabrikamfiber3@hotmail.com",
      "date": "2014-01-29T23:52:56Z"
    },
    "comment": "home page",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/67cae2b029dff7eb3dc062b49403aaedca5bad8d"
  },
  "name": "develop",
  "aheadCount": 1,
  "behindCount": 17,
  "isBaseVersion": false
}

For a tag or commit

Exemple de requête

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/stats/branches?name=develop&api-version=7.1

Exemple de réponse

Code d’état:: 200

{
  "commit": {
    "parents": [
      "be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
    ],
    "treeId": "f9a2a90cbeac747fff9dadcf77ff5bcd12b65a44",
    "commitId": "67cae2b029dff7eb3dc062b49403aaedca5bad8d",
    "author": {
      "name": "Chuck Reinhart",
      "email": "fabrikamfiber3@hotmail.com",
      "date": "2014-01-29T23:52:56Z"
    },
    "committer": {
      "name": "Chuck Reinhart",
      "email": "fabrikamfiber3@hotmail.com",
      "date": "2014-01-29T23:52:56Z"
    },
    "comment": "home page\n",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/67cae2b029dff7eb3dc062b49403aaedca5bad8d"
  },
  "name": "develop",
  "aheadCount": 0,
  "behindCount": 0,
  "isBaseVersion": true
}

Définitions

Nom	Description
ChangeCountDictionary
GitBranchStats	Avant et derrière compte pour une référence particulière.
GitChange
GitCommitRef	Fournit des propriétés qui décrivent une validation Git et les métadonnées associées.
GitPushRef
GitStatus	Cette classe contient les métadonnées d’un service/extension qui publie un état.
GitStatusContext	Contexte d’état qui identifie de manière unique l’état.
GitStatusState	État de l’état.
GitTemplate
GitUserDate	Informations utilisateur et date des opérations Git.
GitVersionOptions	Options de version : spécifier des modificateurs supplémentaires à la version (par exemple Précédent)
GitVersionType	Type de version (branche, balise ou validation). Détermine la façon dont l’ID est interprété
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
ResourceRef
VersionControlChangeType	Type de modification apportée à l’élément.

ChangeCountDictionary

Object

GitBranchStats

Object

Avant et derrière compte pour une référence particulière.

Nom	Type	Description
aheadCount	integer (int32)	Nombre de validations à l’avance.
behindCount	integer (int32)	Nombre de validations derrière.
commit	GitCommitRef	Validation actuelle.
isBaseVersion	boolean	True si c’est le résultat de la version de base.
name	string	Nom de la référence.

GitChange

Object

Nom	Type	Description
changeId	integer (int32)	ID de la modification dans le groupe de modifications.
changeType	VersionControlChangeType	Type de modification apportée à l’élément.
item	string (T)	Version actuelle.
newContent	ItemContent	Contenu de l’élément après la modification.
newContentTemplate	GitTemplate	Nouveau modèle de contenu à utiliser lors de l’envoi de nouvelles modifications.
originalPath	string	Chemin d’accès d’origine de l’élément si différent du chemin actuel.
sourceServerItem	string	Chemin d’accès de l’élément sur le serveur.
url	string	URL pour récupérer l’élément.

GitCommitRef

Object

Fournit des propriétés qui décrivent une validation Git et les métadonnées associées.

Nom	Type	Description
_links	ReferenceLinks	Collection de liens de référence REST connexes.
author	GitUserDate	Auteur de la validation.
changeCounts	ChangeCountDictionary	Nombre de types de modifications (modifications, suppressions, etc.) inclus dans la validation.
changes	GitChange[]	Énumération des modifications incluses dans la validation.
comment	string	Commentaire ou message de la validation.
commentTruncated	boolean	Indique si le commentaire est tronqué à partir du message de commentaire de validation Git complet.
commitId	string	ID (SHA-1) de la validation.
commitTooManyChanges	boolean	Indique que la validation contient trop de modifications à afficher
committer	GitUserDate	Commiter de la validation.
parents	string[]	Énumération des ID de validation parent pour cette validation.
push	GitPushRef	Push associé à cette validation.
remoteUrl	string	Chemin d’accès d’URL distant à la validation.
statuses	GitStatus[]	Liste des métadonnées d’état des services et extensions qui peuvent associer des informations supplémentaires à la validation.
url	string	URL REST pour cette ressource.
workItems	ResourceRef[]	Liste des éléments de travail associés à cette validation.

GitPushRef

Object

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
date	string (date-time)
pushId	integer (int32)
pushedBy	IdentityRef
url	string

GitStatus

Object

Cette classe contient les métadonnées d’un service/extension qui publie un état.

Nom	Type	Description
_links	ReferenceLinks	Liens de référence.
context	GitStatusContext	Contexte de l’état.
createdBy	IdentityRef	Identité qui a créé l’état.
creationDate	string (date-time)	Date et heure de création de l’état.
description	string	Description de l’état. Décrit généralement l’état actuel de l’état.
id	integer (int32)	Identificateur d’état.
state	GitStatusState	État de l’état.
targetUrl	string	URL avec les détails de l’état.
updatedDate	string (date-time)	Date et heure de la dernière mise à jour de l’état.

GitStatusContext

Object

Contexte d’état qui identifie de manière unique l’état.

Nom	Type	Description
genre	string	Genre du statut. En règle générale, le nom du service/outil qui génère l’état peut être vide.
name	string	L’identificateur de nom de l’état ne peut pas être null ou vide.

GitStatusState

Énumération

État de l’état.

Valeur	Description
error	État avec une erreur.
failed	Échec de l’état.
notApplicable	L’état n’est pas applicable à l’objet cible.
notSet	État non défini. État par défaut.
pending	État en attente.
succeeded	État réussi.

GitTemplate

Object

Nom	Type	Description
name	string	Nom du modèle
type	string	Type du modèle

GitUserDate

Object

Informations utilisateur et date des opérations Git.

Nom	Type	Description
date	string (date-time)	Date de l’opération Git.
email	string	Adresse e-mail de l’utilisateur effectuant l’opération Git.
imageUrl	string	URL de l’avatar de l’utilisateur.
name	string	Nom de l’utilisateur effectuant l’opération Git.

GitVersionOptions

Énumération

Options de version : spécifier des modificateurs supplémentaires à la version (par exemple Précédent)

Valeur	Description
firstParent	Premier parent de validation (HEAD^)
none	Non spécifié
previousChange	Valider cet élément modifié avant la version actuelle

GitVersionType

Énumération

Type de version (branche, balise ou validation). Détermine la façon dont l’ID est interprété

Valeur	Description
branch	Interpréter la version en tant que nom de branche
commit	Interpréter la version en tant qu’ID de validation (SHA1)
tag	Interpréter la version en tant que nom de balise

IdentityRef

Object

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
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
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.

ItemContent

Object

Nom	Type	Description
content	string
contentType	ItemContentType

ItemContentType

Énumération

Valeur	Description
base64Encoded
rawText

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.

ResourceRef

Object

Nom	Type	Description
id	string
url	string

VersionControlChangeType

Énumération

Type de modification apportée à l’élément.

Valeur	Description
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

Partager via

Stats - Get

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

For a single branch

Exemple de requête

Exemple de réponse

For a tag or commit

Exemple de requête

Exemple de réponse

Définitions

ChangeCountDictionary

GitBranchStats

GitChange

GitCommitRef

GitPushRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

GitVersionOptions

GitVersionType

IdentityRef

ItemContent

ItemContentType

ReferenceLinks

ResourceRef

VersionControlChangeType