Pull Request Statuses - Get

Referenz

Service:: Git

API Version:: 7.1-preview.1

Rufen Sie die spezifischen Pull Request-status nach ID ab. Die status-ID ist innerhalb des Pull Requests über alle Iterationen hinweg eindeutig.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
pullRequestId	path	True	integer int32	ID des Pull Requests.
repositoryId	path	True	string	Die Repository-ID des Zielbranchs des Pull Requests.
statusId	path	True	integer int32	ID des Pull Request-status.
project	path		string	Projekt-ID oder Projektname
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Antworten

Name	Typ	Beschreibung
200 OK	GitPullRequestStatus	Erfolgreicher Vorgang

Sicherheit

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	Beschreibung
vso.code	Ermöglicht das Lesen von Quellcode und Metadaten zu Commits, Changesets, Branches und anderen Versionskontrollartefakten. Bietet außerdem die Möglichkeit, Code zu suchen und über Versionskontrollereignisse über Diensthooks benachrichtigt zu werden.
vso.code_status	Gewährt die Möglichkeit, Commits und Pull Request-status zu lesen und zu schreiben.

Beispiele

Sample Request

HTTP

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

Sample Response

Status code:: 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 Diensts bzw. einer Erweiterung, die Pull Request status. Der Status kann einem Pull Request oder einer Iteration zugeordnet werden.
GitStatusContext	Statuskontext, der die status eindeutig identifiziert.
GitStatusState	Status der status.
IdentityRef
PropertiesCollection	Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem `TypeCode != TypeCode.Object`) außer für `DBNull` werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

GitPullRequestStatus

Diese Klasse enthält die Metadaten eines Diensts bzw. einer Erweiterung, die Pull Request status. Der Status kann einem Pull Request oder einer Iteration zugeordnet werden.

Name	Typ	Beschreibung
_links	ReferenceLinks	Referenzlinks.
context	GitStatusContext	Kontext des status.
createdBy	IdentityRef	Identität, die die status erstellt hat.
creationDate	string	Erstellungsdatum und -uhrzeit des status.
description	string	Statusbeschreibung. Beschreibt in der Regel den aktuellen Zustand des status.
id	integer	Statusbezeichner.
iterationId	integer	ID der Iteration, der status zugeordnet werden soll. Der Mindestwert ist 1.
properties	PropertiesCollection	Benutzerdefinierte Eigenschaften des status.
state	GitStatusState	Status der status.
targetUrl	string	URL mit status Details.
updatedDate	string	Datum und Uhrzeit der letzten Aktualisierung des status.

GitStatusContext

Statuskontext, der die status eindeutig identifiziert.

Name	Typ	Beschreibung
genre	string	Genre der status. In der Regel kann der Name des Diensts/Tools, der die status generiert, leer sein.
name	string	Der Namensbezeichner des status darf nicht NULL oder leer sein.

GitStatusState

Status der status.

Name	Typ	Beschreibung
error	string	Status mit einem Fehler.
failed	string	Fehler beim Status.
notApplicable	string	Der Status gilt nicht für das Zielobjekt.
notSet	string	Statusstatus nicht festgelegt. Standardzustand.
pending	string	Status ausstehend.
succeeded	string	Status erfolgreich.

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar
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– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName	string	Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

PropertiesCollection

Die -Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüssel-Wert-Paaren dar. Werte aller primitiven Typen (jeder Typ mit einem TypeCode != TypeCode.Object) außer für DBNull werden akzeptiert. Werte des Typs Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als String umgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

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

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

Share via