Pushes - Get

Service:

Git

API Version:

5.0

Récupère un envoi (push) particulier.

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

With optional parameters:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
pushId	path	True	integer int32	ID du push.
repositoryId	path	True	string	Nom ou ID du dépôt.
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.
includeCommits	query		integer int32	Nombre de validations à inclure dans le résultat.
includeRefUpdates	query		boolean	Si la valeur est true, incluez la liste des références qui ont été mises à jour par le push.

Réponses

Nom	Type	Description
200 OK	GitPush	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	Accorde la possibilité 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

Just the push

Sample Request

HTTP

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

Sample Response

Status code:

200

{
  "commits": [],
  "pushedBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "pushId": 23,
  "date": "2014-06-30T18:11:18.0929091Z",
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249"
    },
    "commits": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23/commits"
    },
    "pusher": {
      "href": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    }
  }
}

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.
GitPush
GitPushRef
GitRefUpdate
GitRepository
GitRepositoryRef
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
ProjectState	État du projet.
ProjectVisibility	Visibilité du projet.
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ResourceRef
TeamProjectCollectionReference	Objet de référence pour un TeamProjectCollection.
TeamProjectReference	Représente une référence superficielle à un TeamProject.
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.

GitPush

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
commits	GitCommitRef[]	Fournit des propriétés qui décrivent un commit Git et les métadonnées associées.
date	string
pushId	integer
pushedBy	IdentityRef
refUpdates	GitRefUpdate[]
repository	GitRepository
url	string

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

GitRefUpdate

Nom	Type	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitRepository

Nom	Type	Description
_links	ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
defaultBranch	string
id	string
isFork	boolean	True si le dépôt a été créé en tant que duplication
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Représente une référence superficielle à un TeamProject.
remoteUrl	string
size	integer	Taille compressée (octets) du dépôt.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Nom	Type	Description
collection	TeamProjectCollectionReference	Collection de projets d’équipe où réside cette duplication
id	string
isFork	boolean	True si le dépôt a été créé en tant que duplication
name	string
project	TeamProjectReference	Représente une référence superficielle à un TeamProject.
remoteUrl	string
sshUrl	string
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

ProjectState

État du projet.

Nom	Type	Description
all	string	Tous les projets, quel que soit leur état.
createPending	string	Project a été mis en file d’attente pour la création, mais le processus n’a pas encore démarré.
deleted	string	Le projet a été supprimé.
deleting	string	Le projet est en cours de suppression.
new	string	Le projet est en cours de création.
unchanged	string	Le projet n’a pas été modifié.
wellFormed	string	Le projet est entièrement créé et prêt à être utilisé.

ProjectVisibility

Visibilité du projet.

Nom	Type	Description
private	string	Le projet n’est visible que par les utilisateurs disposant d’un accès explicite.
public	string	Le projet est visible par tous.

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

TeamProjectCollectionReference

Objet de référence pour un TeamProjectCollection.

Nom	Type	Description
id	string	ID de collection.
name	string	Nom de la collection.
url	string	URL REST de collection.

TeamProjectReference

Représente une référence superficielle à un TeamProject.

Nom	Type	Description
abbreviation	string	Abréviation du projet.
defaultTeamImageUrl	string	Url de l’image d’identité d’équipe par défaut.
description	string	Description du projet (le cas échéant).
id	string	Identificateur de projet.
name	string	Nom du projet.
revision	integer	Révision du projet.
state	ProjectState	État du projet.
url	string	Url vers la version complète de l’objet.
visibility	ProjectVisibility	Visibilité du projet.

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