Pull Request Statuses - Get

Riferimento

Servizio:: Git

Versione API:: 7.1

Ottenere lo stato specifico della richiesta pull in base all'ID. L'ID di stato è univoco all'interno della richiesta pull in tutte le iterazioni.

GET https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=7.1

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
pullRequestId	path	True	integer (int32)	ID della richiesta pull.
repositoryId	path	True	string	ID repository del ramo di destinazione della richiesta pull.
statusId	path	True	integer (int32)	ID dello stato della richiesta pull.
project	path		string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.

Risposte

Nome	Tipo	Descrizione
200 OK	GitPullRequestStatus	operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome	Descrizione
vso.code	Concede la possibilità di leggere il codice sorgente e i metadati relativi a commit, insiemi di modifiche, rami e altri artefatti del controllo della versione. Concede inoltre la possibilità di cercare il codice e ricevere notifiche sugli eventi di controllo della versione tramite hook del servizio.
vso.code_status	Concede la possibilità di leggere e scrivere lo stato di commit e richiesta pull.

Esempio

Esempio di richiesta

HTTP

GET https://dev.azure.com/fabrikam/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses/{statusId}?api-version=7.1

Risposta di esempio

Codice di stato:: 200

{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:27.4949745Z",
  "updatedDate": "2017-09-19T14:50:27.4949745Z",
  "createdBy": {
    "id": "6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "displayName": "Normal Paulk",
    "uniqueName": "fabrikamfiber16@hotmail.com",
    "url": "https://dev.azure.com/fabrikam/_apis/Identities/6f168adb-59d4-4fc0-be3b-fb21b939b2a6",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=6f168adb-59d4-4fc0-be3b-fb21b939b2a6"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272/pullRequests/5/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

Definizioni

Nome	Descrizione
GitPullRequestStatus	Questa classe contiene i metadati di uno stato della richiesta pull di registrazione di un servizio o di un'estensione. Lo stato può essere associato a una richiesta pull o a un'iterazione.
GitStatusContext	Contesto di stato che identifica in modo univoco lo stato.
GitStatusState	Stato dello stato.
IdentityRef
PropertiesCollection	La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un `TypeCode != TypeCode.Object`) ad eccezione di `DBNull` vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.

GitPullRequestStatus

Object

Questa classe contiene i metadati di uno stato della richiesta pull di registrazione di un servizio o di un'estensione. Lo stato può essere associato a una richiesta pull o a un'iterazione.

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti di riferimento.
context	GitStatusContext	Contesto dello stato.
createdBy	IdentityRef	Identità che ha creato lo stato.
creationDate	string (date-time)	Data e ora di creazione dello stato.
description	string	Descrizione dello stato. Descrive in genere lo stato corrente dello stato.
id	integer (int32)	Identificatore di stato.
iterationId	integer (int32)	ID dell'iterazione a cui associare lo stato. Il valore minimo è 1.
properties	PropertiesCollection	Proprietà personalizzate dello stato.
state	GitStatusState	Stato dello stato.
targetUrl	string	URL con i dettagli sullo stato.
updatedDate	string (date-time)	Data e ora dell'ultimo aggiornamento dello stato.

GitStatusContext

Object

Contesto di stato che identifica in modo univoco lo stato.

Nome	Tipo	Descrizione
genre	string	Genere dello stato. In genere, il nome del servizio o dello strumento che genera lo stato può essere vuoto.
name	string	L'identificatore del nome dello stato non può essere null o vuoto.

GitStatusState

Enumerazione

Stato dello stato.

Valore	Descrizione
error	Stato con un errore.
failed	Stato non riuscito.
notApplicable	Lo stato non è applicabile all'oggetto di destinazione.
notSet	Stato non impostato. Stato predefinito.
pending	Stato in sospeso.
succeeded	Stato completato.

IdentityRef

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'oggetto grafico.
descriptor	string	Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni.
directoryAlias	string	Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName	string	Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id	string
imageUrl	string	Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive	boolean	Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser
isAadIdentity	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName	string	Deprecato: usare invece Domain+PrincipalName
url	string	Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

PropertiesCollection

Object

La classe rappresenta un contenitore di proprietà come raccolta di coppie chiave-valore. I valori di tutti i tipi primitivi (qualsiasi tipo con un TypeCode != TypeCode.Object) ad eccezione di DBNull vengono accettati. I valori di tipo Byte[], Int32, Double, DateType e String mantengono il tipo, le altre primitive vengono ricreate come String. Byte[] previsto come stringa con codifica Base64.

Nome	Tipo	Descrizione
count	integer (int32)	Conteggio delle proprietà nell'insieme.
item	object
keys	string[]	Set di chiavi nella raccolta.
values	string[]	Set di valori nell'insieme.

ReferenceLinks

Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

Condividi tramite

Pull Request Statuses - Get

Parametri dell'URI

Risposte

Sicurezza

oauth2

Ambiti

Esempio

Esempio di richiesta

Risposta di esempio

Definizioni

GitPullRequestStatus

GitStatusContext

GitStatusState

IdentityRef

PropertiesCollection

ReferenceLinks

Risorse aggiuntive