Pushes - Get

Reference

Service:: Git

API Version:: 5.0

Načte konkrétní nabízené oznámení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
pushId	path	True	integer int32	ID nabízeného oznámení.
repositoryId	path	True	string	Název nebo ID úložiště.
project	path		string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavena na hodnotu 5.0.
includeCommits	query		integer int32	Počet potvrzení, která se mají zahrnout do výsledku.
includeRefUpdates	query		boolean	Pokud ano, uveďte seznam odkazů, které byly aktualizovány nasdílením změn.

Odpovědi

Name	Typ	Description
200 OK	GitPush	úspěšná operace

Zabezpečení

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

Name	Description
vso.code	Umožňuje číst zdrojový kód a metadata o potvrzeních, sadách změn, větvích a dalších artefaktech správy verzí. Umožňuje také prohledávat kód a dostávat oznámení o událostech správy verzí prostřednictvím služby Hooks.

Příklady

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"
    }
  }
}

Definice

Name	Description
ChangeCountDictionary
GitChange
GitCommitRef	Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.
GitPush
GitPushRef
GitRefUpdate
GitRepository
GitRepositoryRef
GitStatus	Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.
GitStatusContext	Kontext stavu, který jednoznačně identifikuje stav.
GitStatusState	Stav stavu.
GitTemplate
GitUserDate	Informace o uživateli a datum operací Gitu
IdentityRef
ItemContent
ItemContentType
ProjectState	Stav projektu.
ProjectVisibility	Viditelnost projektu.
ReferenceLinks	Třída představující kolekci odkazů REST.
ResourceRef
TeamProjectCollectionReference	Referenční objekt pro TeamProjectCollection.
TeamProjectReference	Představuje mělký odkaz na TeamProject.
VersionControlChangeType	Typ změny provedené u položky

ChangeCountDictionary

GitChange

Name	Typ	Description
changeId	integer	ID změny v rámci skupiny změn.
changeType	VersionControlChangeType	Typ změny provedené u položky
item	string	Aktuální verze.
newContent	ItemContent	Obsah položky po změně.
newContentTemplate	GitTemplate	Nová šablona obsahu, která se má použít při nabízení nových změn.
originalPath	string	Původní cesta k položce, pokud se liší od aktuální cesty.
sourceServerItem	string	Cesta k položce na serveru.
url	string	Adresa URL pro načtení položky

GitCommitRef

Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.

Name	Typ	Description
_links	ReferenceLinks	Kolekce souvisejících odkazů REST.
author	GitUserDate	Autor potvrzení
changeCounts	ChangeCountDictionary	Počty typů změn (úpravy, odstranění atd.), které jsou součástí potvrzení.
changes	GitChange[]	Výčet změn zahrnutých s potvrzením.
comment	string	Komentář nebo zpráva potvrzení
commentTruncated	boolean	Označuje, jestli je komentář zkrácený od úplné zprávy komentáře k potvrzení Gitu.
commitId	string	ID (SHA-1) potvrzení.
committer	GitUserDate	Committer potvrzení.
parents	string[]	Výčet ID nadřazeného potvrzení pro toto potvrzení.
push	GitPushRef	Nasdílení změn přidružené k tomuto potvrzení
remoteUrl	string	Cesta vzdálené adresy URL k potvrzení.
statuses	GitStatus[]	Seznam metadat stavu ze služeb a rozšíření, která můžou k potvrzení přidružit další informace.
url	string	Adresa URL REST pro tento prostředek.
workItems	ResourceRef[]	Seznam pracovních položek přidružených k tomuto potvrzení.

GitPush

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
commits	GitCommitRef[]	Poskytuje vlastnosti, které popisují potvrzení Gitu a přidružená metadata.
date	string
pushId	integer
pushedBy	IdentityRef
refUpdates	GitRefUpdate[]
repository	GitRepository
url	string

GitPushRef

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRefUpdate

Name	Typ	Description
isLocked	boolean
name	string
newObjectId	string
oldObjectId	string
repositoryId	string

GitRepository

Name	Typ	Description
_links	ReferenceLinks	Třída představující kolekci odkazů REST.
defaultBranch	string
id	string
isFork	boolean	Hodnota True, pokud se úložiště vytvořilo jako fork
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Představuje mělký odkaz na TeamProject.
remoteUrl	string
size	integer	Komprimovaná velikost (bajty) úložiště.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Name	Typ	Description
collection	TeamProjectCollectionReference	Kolekce týmových projektů, kde se nachází tento fork
id	string
isFork	boolean	Hodnota True, pokud se úložiště vytvořilo jako fork
name	string
project	TeamProjectReference	Představuje mělký odkaz na TeamProject.
remoteUrl	string
sshUrl	string
url	string

GitStatus

Tato třída obsahuje metadata služby nebo rozšíření, které zveřejňuje stav.

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
context	GitStatusContext	Kontext stavu
createdBy	IdentityRef	Identita, která vytvořila stav.
creationDate	string	Datum a čas vytvoření stavu.
description	string	Popis stavu. Obvykle popisuje aktuální stav stavu.
id	integer	Identifikátor stavu.
state	GitStatusState	Stav stavu.
targetUrl	string	Adresa URL s podrobnostmi o stavu
updatedDate	string	Datum a čas poslední aktualizace stavu.

GitStatusContext

Kontext stavu, který jednoznačně identifikuje stav.

Name	Typ	Description
genre	string	Žánr stavu. Název služby nebo nástroje, který generuje stav, může být obvykle prázdný.
name	string	Identifikátor názvu stavu nesmí být null ani prázdný.

GitStatusState

Stav stavu.

Name	Typ	Description
error	string	Stav s chybou
failed	string	Stav se nezdařil.
notApplicable	string	Stav se nevztahuje na cílový objekt.
notSet	string	Stav není nastavený. Výchozí stav.
pending	string	Stav čeká na vyřízení.
succeeded	string	Stav byl úspěšný.

GitTemplate

Name	Typ	Description
name	string	Název šablony
type	string	Typ šablony

GitUserDate

Informace o uživateli a datum operací Gitu

Name	Typ	Description
date	string	Datum operace Git.
email	string	Email adresu uživatele, který provádí operaci Gitu.
imageUrl	string	Adresa URL avatara uživatele
name	string	Jméno uživatele, který provádí operaci Git.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

ItemContent

Name	Typ	Description
content	string
contentType	ItemContentType

ItemContentType

Name	Typ	Description
base64Encoded	string
rawText	string

ProjectState

Stav projektu.

Name	Typ	Description
all	string	Všechny projekty bez ohledu na stav.
createPending	string	Projekt byl zařazen do fronty k vytvoření, ale tento proces ještě nebyl zahájen.
deleted	string	Projekt byl odstraněn.
deleting	string	Projekt se právě odstraňuje.
new	string	Projekt se právě vytváří.
unchanged	string	Projekt nebyl změněn.
wellFormed	string	Projekt je zcela vytvořený a připravený k použití.

ProjectVisibility

Viditelnost projektu.

Name	Typ	Description
private	string	Projekt je viditelný pouze uživatelům s explicitním přístupem.
public	string	Projekt je viditelný pro všechny.

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení.

ResourceRef

Name	Typ	Description
id	string
url	string

TeamProjectCollectionReference

Referenční objekt pro TeamProjectCollection.

Name	Typ	Description
id	string	ID kolekce.
name	string	Název kolekce.
url	string	Adresa URL REST kolekce.

TeamProjectReference

Představuje mělký odkaz na TeamProject.

Name	Typ	Description
abbreviation	string	Zkratka projektu
defaultTeamImageUrl	string	Adresa URL výchozího obrázku týmové identity
description	string	Popis projektu (pokud existuje).
id	string	Identifikátor projektu.
name	string	Název projektu.
revision	integer	Revize projektu.
state	ProjectState	Stav projektu.
url	string	Adresa URL na plnou verzi objektu.
visibility	ProjectVisibility	Viditelnost projektu.

VersionControlChangeType

Typ změny provedené u položky

Name	Typ	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

Sdílet prostřednictvím