Freigeben über


Pull Request Statuses - Create

Erstellen Sie einen Pull Request status.

Das einzige erforderliche Feld für den status istContext.Name, dass die status eindeutig identifiziert. Beachten Sie, dass Sie iterationId im Anforderungstext angeben können, um die status für die Iteration zu posten.

POST https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/statuses?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.

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.

Anforderungstext

Name Typ Beschreibung
_links

ReferenceLinks

Verweislinks.

context

GitStatusContext

Kontext des status.

createdBy

IdentityRef

Identität, die den 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

Zustand des status.

targetUrl

string

URL mit status Details.

updatedDate

string

Datum und Uhrzeit der letzten Aktualisierung des status.

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_write Ermöglicht das Lesen, Aktualisieren und Löschen von Quellcode sowie den Zugriff auf Metadaten zu Commits, Changesets, Branches und anderen Versionskontrollartefakten. Ermöglicht außerdem das Erstellen und Verwalten von Pull Requests und Code Reviews sowie das Empfangen von Benachrichtigungen zu Versionskontrollereignissen über Diensthaken.
vso.code_status Ermöglicht das Lesen und Schreiben von Commit- und Pull Request-status.

Beispiele

On iteration
On pull request
With properties

On iteration

Sample Request

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

{
  "iterationId": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

{
  "iterationId": 1,
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-2",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.4429056Z",
  "updatedDate": "2017-09-19T14:50:26.4429056Z",
  "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/2/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

On pull request

Sample Request

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

{
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

{
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-4",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:25.1680228Z",
  "updatedDate": "2017-09-19T14:50:25.1680228Z",
  "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/1/statuses/1"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/b92c8408-a0c9-4292-88af-bc005a1b8272"
    }
  }
}

With properties

Sample Request

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

{
  "properties": {
    "sampleId": 7,
    "customInfo": "Custom status information",
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.7410146Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    },
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "globalId": {
      "$type": "System.Guid",
      "$value": "1e788cb9-9d3d-4dc6-ac05-822092d17f90"
    }
  },
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "targetUrl": "http://fabrikam-fiber-inc.com/CI/builds/1"
}

Sample Response

{
  "properties": {
    "bytes": {
      "$type": "System.Byte[]",
      "$value": "dGhpcyBpcyBzYW1wbGUgYmFzZTY0IGVuY29kZWQgc3RyaW5n"
    },
    "customInfo": {
      "$type": "System.String",
      "$value": "Custom status information"
    },
    "globalId": {
      "$type": "System.String",
      "$value": "1e788cb99d3d4dc6ac05822092d17f90"
    },
    "sampleId": {
      "$type": "System.Int32",
      "$value": 7
    },
    "startedDateTime": {
      "$type": "System.DateTime",
      "$value": "2017-09-19T14:50:26.74Z"
    },
    "weight": {
      "$type": "System.Double",
      "$value": 1.75
    }
  },
  "id": 1,
  "state": "succeeded",
  "description": "Sample status succeeded",
  "context": {
    "name": "sample-status-1",
    "genre": "vsts-samples"
  },
  "creationDate": "2017-09-19T14:50:26.7780242Z",
  "updatedDate": "2017-09-19T14:50:26.7780242Z",
  "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/3/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/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

Zustand des 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) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ 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/einer Erweiterung, die Pull Request status. Der Status kann einem Pull Request oder einer Iteration zugeordnet werden.

Name Typ Beschreibung
_links

ReferenceLinks

Verweislinks.

context

GitStatusContext

Kontext des status.

createdBy

IdentityRef

Identität, die den 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

Zustand des 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

Zustand des 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 Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.

descriptor

string

Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand 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 "selbst" des IdentityRef-Wörterbuchs "_links" verwiesen wird.

displayName

string

Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.

id

string

imageUrl

string

Veraltet: Verfügbar im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links"

inactive

boolean

Veraltet: Kann durch Abfragen des Graph-Mitgliedschaftsstatus abgerufen werden, 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 bereits 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) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ 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 Schlüsselsatz in der Auflistung.

values

string[]

Der Wertsatz in der Auflistung.

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

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.