Pull Request Statuses - Get

Referenz

Dienst:: Git

API-Version:: 7.1

Rufen Sie den spezifischen Pullanforderungsstatus nach ID ab. Die Status-ID ist innerhalb der Pullanforderung für alle Iterationen eindeutig.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
pullRequestId	path	True	integer (int32)	ID der Pullanforderung.
repositoryId	path	True	string	Die Repository-ID des Zielzweigs der Pullanforderung.
statusId	path	True	integer (int32)	ID des Pullanforderungsstatus.
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.

Antworten

Name	Typ	Beschreibung
200 OK	GitPullRequestStatus	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.
vso.code_status	Gewährt die Möglichkeit, commit- und Pullanforderungsstatus zu lesen und zu schreiben.

Beispiele

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
GitPullRequestStatus	Diese Klasse enthält die Metadaten eines Dienst-/Erweiterungsposting-Abrufanforderungsstatus. Der Status kann einer Pullanforderung oder einer Iteration zugeordnet werden.
GitStatusContext	Statuskontext, der den Status eindeutig identifiziert.
GitStatusState	Status des Status.
IdentityRef
PropertiesCollection	Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem `TypeCode != TypeCode.Object`) mit Ausnahme von `DBNull` werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

GitPullRequestStatus

Objekt

Diese Klasse enthält die Metadaten eines Dienst-/Erweiterungsposting-Abrufanforderungsstatus. Der Status kann einer Pullanforderung oder einer Iteration zugeordnet werden.

Name	Typ	Beschreibung
_links	ReferenceLinks	Referenzlinks.
context	GitStatusContext	Kontext des Status.
createdBy	IdentityRef	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.
iterationId	integer (int32)	ID der Iteration, der der Status zugeordnet werden soll. Der Mindestwert ist 1.
properties	PropertiesCollection	Benutzerdefinierte Eigenschaften des Status.
state	GitStatusState	Status des Status.
targetUrl	string	URL mit Statusdetails.
updatedDate	string (date-time)	Datum und Uhrzeit der letzten Aktualisierung des Status.

GitStatusContext

Objekt

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

Enumeration

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.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	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.

PropertiesCollection

Objekt

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name	Typ	Beschreibung
count	integer (int32)	Die Anzahl der Eigenschaften in der Auflistung.
item	object
keys	string[]	Der Satz von Schlüsseln in der Auflistung.
values	string[]	Der Wertesatz in der Auflistung.

ReferenceLinks

Objekt

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.

Freigeben über

Pull Request Statuses - Get

URI-Parameter

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Beispielanforderung

Beispiel für eine Antwort

Definitionen

GitPullRequestStatus

GitStatusContext

GitStatusState

IdentityRef

PropertiesCollection

ReferenceLinks

Zusätzliche Ressourcen