Pushes - Get

Référence

Service:: Git

Version d'API:: 7.1

Récupère un push particulier.

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

Avec des paramètres facultatifs:

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

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

Just the push

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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 une validation Git et les métadonnées associées.
GitPush
GitPushRef
GitRefUpdate
GitRepository
GitRepositoryRef
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.
IdentityRef
ItemContent
ItemContentType
ProjectState	État du projet.
ProjectVisibility	Visibilité du projet.
ReferenceLinks	Classe à représenter une collection de liens de référence REST.
ResourceRef
TeamProjectCollectionReference	Objet reference pour un TeamProjectCollection.
TeamProjectReference	Représente une référence superficielle à un TeamProject.
VersionControlChangeType	Type de modification apportée à l’élément.

ChangeCountDictionary

Object

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.

GitPush

Object

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

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

GitRefUpdate

Object

Nom	Type	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string (uuid)

GitRepository

Object

Nom	Type	Description
_links	ReferenceLinks	Classe à représenter une collection de liens de référence REST.
defaultBranch	string
id	string (uuid)
isDisabled	boolean	True si le référentiel est désactivé. False sinon.
isFork	boolean	True si le référentiel a été créé en tant que fourche.
isInMaintenance	boolean	True si le référentiel est en maintenance. False sinon.
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Représente une référence superficielle à un TeamProject.
remoteUrl	string
size	integer (int64)	Taille compressée (octets) du référentiel.
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

Object

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

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

ProjectState

Énumération

État du projet.

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

ProjectVisibility

Énumération

Visibilité du projet.

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

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

TeamProjectCollectionReference

Object

Objet reference pour un TeamProjectCollection.

Nom	Type	Description
avatarUrl	string	URL de l’avatar de collection.
id	string (uuid)	ID de collection.
name	string	Nom de la collection.
url	string	URL REST de collection.

TeamProjectReference

Object

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 (uuid)	Identificateur du projet.
lastUpdateTime	string (date-time)	Heure de la dernière mise à jour du projet.
name	string	Nom du projet.
revision	integer (int64)	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

É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

Pushes - Get

Paramètres URI

Réponses

Sécurité

oauth2

Étendues

Exemples

Just the push

Exemple de requête

Exemple de réponse

Définitions

ChangeCountDictionary

GitChange

GitCommitRef

GitPush

GitPushRef

GitRefUpdate

GitRepository

GitRepositoryRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

IdentityRef

ItemContent

ItemContentType

ProjectState

ProjectVisibility

ReferenceLinks

ResourceRef

TeamProjectCollectionReference

TeamProjectReference

VersionControlChangeType

Ressources supplémentaires