Pushes - Get
Ruft einen bestimmten Push ab.
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId}?api-version=7.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pushes/{pushId}?includeCommits={includeCommits}&includeRefUpdates={includeRefUpdates}&api-version=7.1
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
push
|
path | True |
integer (int32) |
ID des Pushs. |
repository
|
path | True |
string |
Der Name oder die ID des Repositorys. |
project
|
path |
string |
Projekt-ID oder Projektname |
|
api-version
|
query | True |
string |
Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden. |
include
|
query |
integer (int32) |
Die Anzahl der Commits, die in das Ergebnis eingeschlossen werden sollen. |
|
include
|
query |
boolean |
Wenn "true", fügen Sie die Liste der Refs ein, die vom Push aktualisiert wurden. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreicher Vorgang |
Sicherheit
oauth2
Typ:
oauth2
Ablauf:
accessCode
Autorisierungs-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
Bereiche
Name | Beschreibung |
---|---|
vso.code | Gewährt die Möglichkeit, Quellcode und Metadaten zu Commits, Changesets, Verzweigungen und anderen Versionskontrollartefakten zu lesen. Gewährt außerdem die Möglichkeit, Code zu durchsuchen und über Dienst-Hooks über Versionssteuerungsereignisse benachrichtigt zu werden. |
Beispiele
Just the push
Beispielanforderung
GET https://dev.azure.com/fabrikam/_apis/git/repositories/278d5cd2-584d-4b63-824a-2ba458937249/pushes/23?api-version=7.1
Beispiel für eine Antwort
{
"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"
}
}
}
Definitionen
Name | Beschreibung |
---|---|
Change |
|
Git |
|
Git |
Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben. |
Git |
|
Git |
|
Git |
|
Git |
|
Git |
|
Git |
Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, der einen Status veröffentlicht. |
Git |
Statuskontext, der den Status eindeutig identifiziert. |
Git |
Status des Status. |
Git |
|
Git |
Benutzerinformationen und Datum für Git-Vorgänge. |
Identity |
|
Item |
|
Item |
|
Project |
Projektstatus. |
Project |
Projektsichtbarkeit. |
Reference |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
Resource |
|
Team |
Reference-Objekt für eine TeamProjectCollection. |
Team |
Stellt einen flachen Verweis auf ein TeamProject dar. |
Version |
Der Typ der Änderung, die an dem Element vorgenommen wurde. |
ChangeCountDictionary
GitChange
Name | Typ | Beschreibung |
---|---|---|
changeId |
integer (int32) |
ID der Änderung innerhalb der Gruppe der Änderungen. |
changeType |
Der Typ der Änderung, die an dem Element vorgenommen wurde. |
|
item |
string (T) |
Aktuelle Version. |
newContent |
Inhalt des Elements nach der Änderung. |
|
newContentTemplate |
Neue Inhaltsvorlage, die beim Pushen neuer Änderungen verwendet werden soll. |
|
originalPath |
string |
Ursprünglicher Pfad des Elements, wenn es sich von dem aktuellen Pfad unterscheidet. |
sourceServerItem |
string |
Pfad des Elements auf dem Server. |
url |
string |
URL zum Abrufen des Elements. |
GitCommitRef
Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben.
Name | Typ | Beschreibung |
---|---|---|
_links |
Eine Sammlung verwandter REST-Referenzverknüpfungslinks. |
|
author |
Autor des Commits. |
|
changeCounts |
Zählt die Typen von Änderungen (Bearbeitungen, Löschungen usw.), die im Commit enthalten sind. |
|
changes |
Eine Aufzählung der Änderungen, die im Commit enthalten sind. |
|
comment |
string |
Kommentar oder Nachricht des Commits. |
commentTruncated |
boolean |
Gibt an, ob der Kommentar aus der vollständigen Git Commit-Kommentarnachricht abgeschnitten wird. |
commitId |
string |
ID (SHA-1) des Commits. |
commitTooManyChanges |
boolean |
Gibt an, dass commit zu viele Änderungen enthält, die angezeigt werden sollen. |
committer |
Committer des Commits. |
|
parents |
string[] |
Eine Aufzählung der übergeordneten Commit-IDs für diesen Commit. |
push |
Der Push, der diesem Commit zugeordnet ist. |
|
remoteUrl |
string |
Remote-URL-Pfad zum Commit. |
statuses |
Eine Liste der Statusmetadaten von Diensten und Erweiterungen, die dem Commit zusätzliche Informationen zuordnen können. |
|
url |
string |
REST-URL für diese Ressource. |
workItems |
Eine Liste der Arbeitsaufgaben, die diesem Commit zugeordnet sind. |
GitPush
Name | Typ | Beschreibung |
---|---|---|
_links |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
commits |
Stellt Eigenschaften bereit, die einen Git-Commit und zugehörige Metadaten beschreiben. |
|
date |
string (date-time) |
|
pushId |
integer (int32) |
|
pushedBy | ||
refUpdates | ||
repository | ||
url |
string |
GitPushRef
Name | Typ | Beschreibung |
---|---|---|
_links |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
date |
string (date-time) |
|
pushId |
integer (int32) |
|
pushedBy | ||
url |
string |
GitRefUpdate
Name | Typ | Beschreibung |
---|---|---|
isLocked |
boolean |
|
name |
string |
|
newObjectId |
string |
|
oldObjectId |
string |
|
repositoryId |
string (uuid) |
GitRepository
Name | Typ | Beschreibung |
---|---|---|
_links |
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt. |
|
defaultBranch |
string |
|
id |
string (uuid) |
|
isDisabled |
boolean |
True, wenn das Repository deaktiviert ist. Andernfalls "False". |
isFork |
boolean |
True, wenn das Repository als Verzweigung erstellt wurde. |
isInMaintenance |
boolean |
True, wenn sich das Repository in der Wartung befindet. Andernfalls "False". |
name |
string |
|
parentRepository | ||
project |
Stellt einen flachen Verweis auf ein TeamProject dar. |
|
remoteUrl |
string |
|
size |
integer (int64) |
Komprimierte Größe (Bytes) des Repositorys. |
sshUrl |
string |
|
url |
string |
|
validRemoteUrls |
string[] |
|
webUrl |
string |
GitRepositoryRef
Name | Typ | Beschreibung |
---|---|---|
collection |
Teamprojektsammlung, in der sich diese Verzweigung befindet |
|
id |
string (uuid) |
|
isFork |
boolean |
True, wenn das Repository als Verzweigung erstellt wurde |
name |
string |
|
project |
Stellt einen flachen Verweis auf ein TeamProject dar. |
|
remoteUrl |
string |
|
sshUrl |
string |
|
url |
string |
GitStatus
Diese Klasse enthält die Metadaten eines Diensts/einer Erweiterung, der einen Status veröffentlicht.
Name | Typ | Beschreibung |
---|---|---|
_links |
Referenzlinks. |
|
context |
Kontext des Status. |
|
createdBy |
Identität, die den Status erstellt hat. |
|
creationDate |
string (date-time) |
Erstellungsdatum und -uhrzeit des Status. |
description |
string |
Statusbeschreibung. Beschreibt in der Regel den aktuellen Status des Status. |
id |
integer (int32) |
Statusbezeichner. |
state |
Status des Status. |
|
targetUrl |
string |
URL mit Statusdetails. |
updatedDate |
string (date-time) |
Datum und Uhrzeit der letzten Aktualisierung des Status. |
GitStatusContext
Statuskontext, der den Status eindeutig identifiziert.
Name | Typ | Beschreibung |
---|---|---|
genre |
string |
Genre des Status. Normalerweise kann der Name des Diensts/Tools, der den Status generiert, leer sein. |
name |
string |
Der Namensbezeichner des Status darf nicht null oder leer sein. |
GitStatusState
Status des Status.
Wert | Beschreibung |
---|---|
error |
Status mit einem Fehler. |
failed |
Fehler beim Status. |
notApplicable |
Der Status gilt nicht für das Zielobjekt. |
notSet |
Statusstatus nicht festgelegt. Standardstatus. |
pending |
Status steht aus. |
succeeded |
Status erfolgreich. |
GitTemplate
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Name der Vorlage |
type |
string |
Typ der Vorlage |
GitUserDate
Benutzerinformationen und Datum für Git-Vorgänge.
Name | Typ | Beschreibung |
---|---|---|
date |
string (date-time) |
Datum des Git-Vorgangs. |
string |
E-Mail-Adresse des Benutzers, der den Git-Vorgang ausführt. |
|
imageUrl |
string |
URL für den Avatar des Benutzers. |
name |
string |
Der Name des Benutzers, der den Git-Vorgang ausführt. |
IdentityRef
Name | Typ | Beschreibung |
---|---|---|
_links |
Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten. |
|
descriptor |
string |
Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert. |
directoryAlias |
string |
Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird |
displayName |
string |
Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern. |
id |
string |
|
imageUrl |
string |
Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links" |
inactive |
boolean |
Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird. |
isAadIdentity |
boolean |
Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet |
uniqueName |
string |
Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName". |
url |
string |
Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs. |
ItemContent
Name | Typ | Beschreibung |
---|---|---|
content |
string |
|
contentType |
ItemContentType
Wert | Beschreibung |
---|---|
base64Encoded | |
rawText |
ProjectState
Projektstatus.
Wert | Beschreibung |
---|---|
all |
Alle Projekte unabhängig vom Status außer "Gelöscht". |
createPending |
Projekt wurde zur Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet. |
deleted |
Projekt wurde gelöscht. |
deleting |
Project wird gerade gelöscht. |
new |
Projekt wird gerade erstellt. |
unchanged |
Projekt wurde nicht geändert. |
wellFormed |
Project wird vollständig erstellt und kann verwendet werden. |
ProjectVisibility
Projektsichtbarkeit.
Wert | Beschreibung |
---|---|
private |
Das Projekt ist nur für Benutzer mit expliziten Zugriff sichtbar. |
public |
Das Projekt ist für alle sichtbar. |
ReferenceLinks
Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
Name | Typ | Beschreibung |
---|---|---|
links |
object |
Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen. |
ResourceRef
Name | Typ | Beschreibung |
---|---|---|
id |
string |
|
url |
string |
TeamProjectCollectionReference
Reference-Objekt für eine TeamProjectCollection.
Name | Typ | Beschreibung |
---|---|---|
avatarUrl |
string |
Sammlung Avatar-URL. |
id |
string (uuid) |
Sammlungs-ID. |
name |
string |
Sammlungsname. |
url |
string |
Rest-URL der Sammlung. |
TeamProjectReference
Stellt einen flachen Verweis auf ein TeamProject dar.
Name | Typ | Beschreibung |
---|---|---|
abbreviation |
string |
Projektkürzel. |
defaultTeamImageUrl |
string |
Url zum standardmäßigen Teamidentitätsbild. |
description |
string |
Die Beschreibung des Projekts (falls vorhanden). |
id |
string (uuid) |
Projektbezeichner. |
lastUpdateTime |
string (date-time) |
Zeitpunkt der letzten Aktualisierung des Projekts. |
name |
string |
Projektname. |
revision |
integer (int64) |
Projektrevision. |
state |
Projektstatus. |
|
url |
string |
Die URL zur Vollversion des Objekts. |
visibility |
Projektsichtbarkeit. |
VersionControlChangeType
Der Typ der Änderung, die an dem Element vorgenommen wurde.
Wert | Beschreibung |
---|---|
add | |
all | |
branch | |
delete | |
edit | |
encoding | |
lock | |
merge | |
none | |
property | |
rename | |
rollback | |
sourceRename | |
targetRename | |
undelete |