Commits - Get Push Commits

Référence

Service:: Git

API Version:: 5.0

Récupérez une liste de commits associés à un push particulier.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits?pushId={pushId}&api-version=5.0

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/commits?pushId={pushId}&top={top}&skip={skip}&includeLinks={includeLinks}&api-version=5.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
repositoryId	path	True	string	ID ou nom convivial du dépôt. Pour utiliser le nom convivial, projectId doit également être spécifié.
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 « 5.0 » pour utiliser cette version de l’API.
pushId	query	True	integer int32	ID du push.
includeLinks	query		boolean	Définissez sur false pour éviter d’inclure des liens d’URL REST pour les ressources. La valeur par défaut est true.
skip	query		integer int32	Nombre de validations à ignorer.
top	query		integer int32	Nombre maximal de commits à retourner (« obtenir les x principaux commits »).

Réponses

Nom	Type	Description
200 OK	GitCommitRef[]	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.code	Permet de lire le code source et les métadonnées sur les commits, 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 informé des événements de contrôle de version via des hooks de service.

Exemples

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits?pushId=1&api-version=5.0

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "commitId": "be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
      "author": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-01-29T23:32:09Z"
      },
      "committer": {
        "name": "Chuck Reinhart",
        "email": "fabrikamfiber3@hotmail.com",
        "date": "2014-01-29T23:32:09Z"
      },
      "comment": "First cut",
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
      "remoteUrl": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4",
      "_links": {
        "self": {
          "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
        },
        "repository": {
          "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
        },
        "web": {
          "href": "https://dev.azure.com/fabrikam/_git/Fabrikam-Fiber-Git/commit/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4"
        },
        "changes": {
          "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/commits/be67f8871a4d2c75f13a51c1d3c30ac0d74d4ef4/changes"
        }
      }
    }
  ]
}

Définitions

Nom	Description
ChangeCountDictionary
GitChange
GitCommitRef	Fournit des propriétés qui décrivent un commit Git et les métadonnées associées.
GitPushRef
GitStatus	Cette classe contient les métadonnées d’un service/d’une extension qui publie un status.
GitStatusContext	Contexte d’état qui identifie de manière unique le status.
GitStatusState	État du status.
GitTemplate
GitUserDate	Informations utilisateur et date pour les opérations Git.
IdentityRef
ItemContent
ItemContentType
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ResourceRef
VersionControlChangeType	Type de modification apportée à l’élément.

ChangeCountDictionary

GitChange

Nom	Type	Description
changeId	integer	ID de la modification dans le groupe de modifications.
changeType	VersionControlChangeType	Type de modification apportée à l’élément.
item	string	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 s’il est différent du chemin d’accès actuel.
sourceServerItem	string	Chemin de l’élément sur le serveur.
url	string	URL pour récupérer l’élément.

GitCommitRef

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

Nom	Type	Description
_links	ReferenceLinks	Collection de liens de référence REST associés.
author	GitUserDate	Auteur du commit.
changeCounts	ChangeCountDictionary	Nombre de types de modifications (modifications, suppressions, etc.) incluses dans le commit.
changes	GitChange[]	Énumération des modifications incluses dans le commit.
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) du commit.
committer	GitUserDate	Commiter du commit.
parents	string[]	Énumération des ID de validation parent pour ce commit.
push	GitPushRef	Push associé à ce commit.
remoteUrl	string	Chemin d’URL distante du commit.
statuses	GitStatus[]	Liste des métadonnées status des services et des 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 à ce commit.

GitPushRef

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitStatus

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

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

GitStatusContext

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

Nom	Type	Description
genre	string	Genre du status. En règle générale, le nom du service/de l’outil générant le status peut être vide.
name	string	Identificateur de nom du status, ne peut pas être null ou vide.

GitStatusState

État du status.

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

GitTemplate

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

GitUserDate

Informations utilisateur et date pour les opérations Git.

Nom	Type	Description
date	string	Date de l’opération Git.
email	string	Email adresse 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.

IdentityRef

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 graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations.
directoryAlias	string
displayName	string	Il s’agit du nom d’affichage non unique du sujet 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
profileUrl	string
uniqueName	string
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ItemContent

Nom	Type	Description
content	string
contentType	ItemContentType

ItemContentType

Nom	Type	Description
base64Encoded	string
rawText	string

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 de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ResourceRef

Nom	Type	Description
id	string
url	string

VersionControlChangeType

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

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

Partager via