Share via


Pull Requests - Get Pull Requests By Project

Ruft alle Pull Requests ab, die einem angegebenen Kriterium entsprechen.

Bitte beachten Sie, dass das Beschreibungsfeld im Ergebnis bis zu 400 Symbole abgeschnitten wird.

GET https://dev.azure.com/{organization}/{project}/_apis/git/pullrequests?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/git/pullrequests?searchCriteria.creatorId={searchCriteria.creatorId}&searchCriteria.includeLinks={searchCriteria.includeLinks}&searchCriteria.maxTime={searchCriteria.maxTime}&searchCriteria.minTime={searchCriteria.minTime}&searchCriteria.queryTimeRangeType={searchCriteria.queryTimeRangeType}&searchCriteria.repositoryId={searchCriteria.repositoryId}&searchCriteria.reviewerId={searchCriteria.reviewerId}&searchCriteria.sourceRefName={searchCriteria.sourceRefName}&searchCriteria.sourceRepositoryId={searchCriteria.sourceRepositoryId}&searchCriteria.status={searchCriteria.status}&searchCriteria.targetRefName={searchCriteria.targetRefName}&maxCommentLength={maxCommentLength}&$skip={$skip}&$top={$top}&api-version=7.1-preview.1

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

project
path True

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.

$skip
query

integer

int32

Die Anzahl der zu ignorierenden Pull Requests. Um beispielsweise die Ergebnisse 101-150 abzurufen, legen Sie oben auf 50 fest, und fahren Sie mit 100 fort.

$top
query

integer

int32

Die Anzahl der abzurufenden Pull Requests.

maxCommentLength
query

integer

int32

Wird nicht verwendet.

searchCriteria.creatorId
query

string

uuid

Wenn festgelegt, suchen Sie nach Pull Requests, die von dieser Identität erstellt wurden.

searchCriteria.includeLinks
query

boolean

Gibt an, ob das _links Feld in die flachen Verweise eingeschlossen werden soll

searchCriteria.maxTime
query

string

date-time

Wenn angegeben, filtert Pull Requests, die vor diesem Datum erstellt/geschlossen wurden, basierend auf dem angegebenen queryTimeRangeType.

searchCriteria.minTime
query

string

date-time

Wenn angegeben, filtert Pull Requests, die nach diesem Datum erstellt/geschlossen werden, basierend auf dem angegebenen queryTimeRangeType.

searchCriteria.queryTimeRangeType
query

PullRequestTimeRangeType

Der Typ des Zeitbereichs, der für minTime und maxTime verwendet werden soll. Standardmäßig auf Erstellt, wenn nicht festgelegt.

searchCriteria.repositoryId
query

string

uuid

Wenn festgelegt, suchen Sie nach Pull Requests, deren Zielbranch sich in diesem Repository befindet.

searchCriteria.reviewerId
query

string

uuid

Wenn festgelegt, suchen Sie nach Pull Requests, die diese Identität als Prüfer aufweisen.

searchCriteria.sourceRefName
query

string

Wenn festgelegt, suchen Sie nach Pull Requests aus diesem Branch.

searchCriteria.sourceRepositoryId
query

string

uuid

Wenn festgelegt, suchen Sie nach Pull Requests, deren Quellbranch sich in diesem Repository befindet.

searchCriteria.status
query

PullRequestStatus

Wenn festgelegt, suchen Sie nach Pull Requests, die sich in diesem Zustand befinden. Wird standardmäßig auf Aktiv festgelegt, wenn nicht festgelegt.

searchCriteria.targetRefName
query

string

Wenn festgelegt, suchen Sie in diesem Branch nach Pull Requests.

Antworten

Name Typ Beschreibung
200 OK

GitPullRequest[]

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. Ermöglicht außerdem die Suche nach Code und die Benachrichtigung über Versionskontrollereignisse über Diensthaken.

Beispiele

Pull requests by project

Sample Request

GET https://dev.azure.com/fabrikam/2016_10_31/_apis/git/pullrequests?api-version=7.1-preview.1

Sample Response

{
  "value": [
    {
      "repository": {
        "id": "3411ebc1-d5aa-464f-9615-0b527bc66719",
        "name": "2016_10_31",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719",
        "project": {
          "id": "a7573007-bbb3-4341-b726-0c4148a07853",
          "name": "2016_10_31",
          "state": "unchanged"
        }
      },
      "pullRequestId": 22,
      "codeReviewId": 22,
      "status": "active",
      "createdBy": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://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"
      },
      "creationDate": "2016-11-01T16:30:31.6655471Z",
      "title": "A new feature",
      "description": "Adding a new feature",
      "sourceRefName": "refs/heads/npaulk/my_work",
      "targetRefName": "refs/heads/new_feature",
      "mergeStatus": "succeeded",
      "mergeId": "f5fc8381-3fb2-49fe-8a0d-27dcc2d6ef82",
      "lastMergeSourceCommit": {
        "commitId": "b60280bc6e62e2f880f1b63c1e24987664d3bda3",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/b60280bc6e62e2f880f1b63c1e24987664d3bda3"
      },
      "lastMergeTargetCommit": {
        "commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
      },
      "lastMergeCommit": {
        "commitId": "39f52d24533cc712fc845ed9fd1b6c06b3942588",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/39f52d24533cc712fc845ed9fd1b6c06b3942588"
      },
      "reviewers": [
        {
          "reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
          "vote": 0,
          "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
          "displayName": "Normal Paulk",
          "uniqueName": "fabrikamfiber16@hotmail.com",
          "url": "https://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"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22",
      "supportsIterations": true
    },
    {
      "repository": {
        "id": "3411ebc1-d5aa-464f-9615-0b527bc66719",
        "name": "2016_10_31",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719",
        "project": {
          "id": "a7573007-bbb3-4341-b726-0c4148a07853",
          "name": "2016_10_31",
          "state": "unchanged"
        }
      },
      "pullRequestId": 21,
      "codeReviewId": 21,
      "status": "active",
      "createdBy": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://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"
      },
      "creationDate": "2016-11-01T16:30:23.8410158Z",
      "title": "Added known issues document",
      "description": "Added known issues document",
      "sourceRefName": "refs/heads/npaulk/known_issues",
      "targetRefName": "refs/heads/new_feature",
      "mergeStatus": "succeeded",
      "mergeId": "58a34c62-01b5-4029-8337-c99782ee9003",
      "lastMergeSourceCommit": {
        "commitId": "05ce817c4692afc93c1eb952643bdf7ffbab18ee",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/05ce817c4692afc93c1eb952643bdf7ffbab18ee"
      },
      "lastMergeTargetCommit": {
        "commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
      },
      "lastMergeCommit": {
        "commitId": "bf27525b51b5347483ed9d7dc52ce5a3cf2b045a",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/bf27525b51b5347483ed9d7dc52ce5a3cf2b045a"
      },
      "reviewers": [
        {
          "reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/21/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
          "vote": 0,
          "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
          "displayName": "Normal Paulk",
          "uniqueName": "fabrikamfiber16@hotmail.com",
          "url": "https://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"
        }
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/21",
      "supportsIterations": true
    },
    {
      "repository": {
        "id": "3411ebc1-d5aa-464f-9615-0b527bc66719",
        "name": "2016_10_31",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719",
        "project": {
          "id": "a7573007-bbb3-4341-b726-0c4148a07853",
          "name": "2016_10_31",
          "state": "unchanged"
        }
      },
      "pullRequestId": 1,
      "codeReviewId": 1,
      "status": "active",
      "createdBy": {
        "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
        "displayName": "Normal Paulk",
        "uniqueName": "fabrikamfiber16@hotmail.com",
        "url": "https://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"
      },
      "creationDate": "2016-10-31T20:20:32.3087249Z",
      "title": "some_branch edit",
      "description": " - Updated README.md",
      "sourceRefName": "refs/heads/some_branch",
      "targetRefName": "refs/heads/master",
      "mergeStatus": "succeeded",
      "mergeId": "b294fd81-d539-461d-b271-71a6e61f3c24",
      "lastMergeSourceCommit": {
        "commitId": "34a9e500f29d119802a828d7a759f6fa2e546750",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/34a9e500f29d119802a828d7a759f6fa2e546750"
      },
      "lastMergeTargetCommit": {
        "commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
      },
      "lastMergeCommit": {
        "commitId": "41e98d9939cf4ec0ce166079c22e2b40de862cf5",
        "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/41e98d9939cf4ec0ce166079c22e2b40de862cf5"
      },
      "reviewers": [
        {
          "reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/1/reviewers/98d08d98-a075-46e7-a81e-21bc6f12cae7",
          "vote": 0,
          "id": "98d08d98-a075-46e7-a81e-21bc6f12cae7",
          "displayName": "[2016_10_31]\\2016_10_31 Team",
          "uniqueName": "vstfs:///Classification/TeamProject/a7573007-bbb3-4341-b726-0c4148a07853\\2016_10_31 Team",
          "url": "https://dev.azure.com/fabrikam/_apis/Identities/98d08d98-a075-46e7-a81e-21bc6f12cae7",
          "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=98d08d98-a075-46e7-a81e-21bc6f12cae7",
          "isContainer": true
        }
      ],
      "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/1",
      "supportsIterations": true
    }
  ],
  "count": 3
}

Definitionen

Name Beschreibung
ChangeCountDictionary
GitChange
GitCommitRef

Stellt Eigenschaften bereit, die einen Git-Commit und die zugehörigen Metadaten beschreiben.

GitForkRef

Informationen zu einem Fork-Ref.

GitPullRequest

Stellt alle Daten dar, die einem Pull Request zugeordnet sind.

GitPullRequestCompletionOptions

Einstellungen dazu, wie der Pull Request abgeschlossen werden soll.

GitPullRequestMergeOptions

Die Optionen, die beim Erstellen einer Pull Request-Zusammenführung verwendet werden.

GitPullRequestMergeStrategy

Geben Sie die Strategie an, die zum Zusammenführen des Pull Requests während des Abschlusses verwendet wird. Wenn MergeStrategy nicht auf einen Wert festgelegt ist, wird ein No-FF-Merge erstellt, wenn SquashMerge == false ist. Wenn MergeStrategy nicht auf einen Wert festgelegt ist, werden die Pull Request-Commits gequetscht, wenn SquashMerge == true ist. Die SquashMerge-Eigenschaft ist veraltet. Es wird empfohlen, MergeStrategy in allen Fällen explizit festzulegen. Wenn für MergeStrategy ein expliziter Wert angegeben wird, wird die SquashMerge-Eigenschaft ignoriert.

GitPushRef
GitRepository
GitRepositoryRef
GitStatus

Diese Klasse enthält die Metadaten eines Diensts bzw. einer Erweiterung, die eine status.

GitStatusContext

Statuskontext, der die status eindeutig identifiziert.

GitStatusState

Zustand des status.

GitTemplate
GitUserDate

Benutzerinformationen und Datum für Git-Vorgänge.

IdentityRef
IdentityRefWithVote

Identitätsinformationen, einschließlich einer Abstimmung über einen Pull Request.

ItemContent
ItemContentType
ProjectState

Projektstatus.

ProjectVisibility

Projektsichtbarkeit.

PullRequestAsyncStatus

Die aktuelle status der Pull Request-Zusammenführung.

PullRequestMergeFailureType

Der Typ des Fehlers (sofern vorhanden) der Pull Request-Merge.

PullRequestStatus

Die status des Pull Requests.

PullRequestTimeRangeType

Der Typ des Zeitbereichs, der für minTime und maxTime verwendet werden soll. Standardwert: Erstellt, wenn nicht festgelegt.

ReferenceLinks

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

ResourceRef
TeamProjectCollectionReference

Referenzobjekt für eine TeamProjectCollection.

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

VersionControlChangeType

Der Typ der Änderung, die am Element vorgenommen wurde.

WebApiTagDefinition

Die Darstellung einer Tagdefinition, die über das Kabel gesendet wird.

ChangeCountDictionary

GitChange

Name Typ Beschreibung
changeId

integer

ID der Änderung innerhalb der Gruppe der Änderungen.

changeType

VersionControlChangeType

Der Typ der Änderung, die am Element vorgenommen wurde.

item

string

Aktuelle Version.

newContent

ItemContent

Inhalt des Elements nach der Änderung.

newContentTemplate

GitTemplate

Neue Inhaltsvorlage, die beim Übertragen neuer Änderungen verwendet werden soll.

originalPath

string

Der ursprüngliche Pfad des Elements, wenn sich vom aktuellen Pfad unterscheidet.

sourceServerItem

string

Pfad des Elements auf dem Server.

url

string

URL zum Abrufen des Elements.

GitCommitRef

Stellt Eigenschaften bereit, die einen Git-Commit und die zugehörigen Metadaten beschreiben.

Name Typ Beschreibung
_links

ReferenceLinks

Eine Auflistung verwandter REST-Verweislinks.

author

GitUserDate

Autor des Commits.

changeCounts

ChangeCountDictionary

Anzahl der Im Commit enthaltenen Arten von Änderungen (Bearbeitungen, Löschungen usw.).

changes

GitChange[]

Eine Enumeration der änderungen, die im Commit enthalten sind.

comment

string

Kommentar oder Meldung des Commits.

commentTruncated

boolean

Gibt an, ob der Kommentar aus der vollständigen Git-Commitkommentarnachricht abgeschnitten wird.

commitId

string

ID (SHA-1) des Commits.

commitTooManyChanges

boolean

Gibt an, dass commit zu viele Änderungen enthält, um angezeigt zu werden.

committer

GitUserDate

Committer des Commits.

parents

string[]

Eine Enumeration der übergeordneten Commit-IDs für diesen Commit.

push

GitPushRef

Der push, der diesem Commit zugeordnet ist.

remoteUrl

string

Remote-URL-Pfad zum Commit.

statuses

GitStatus[]

Eine Liste mit status Metadaten von Diensten und Erweiterungen, die dem Commit möglicherweise zusätzliche Informationen zuordnen.

url

string

REST-URL für diese Ressource.

workItems

ResourceRef[]

Eine Liste der Arbeitselemente, die diesem Commit zugeordnet sind.

GitForkRef

Informationen zu einem Fork-Ref.

Name Typ Beschreibung
_links

ReferenceLinks

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

creator

IdentityRef

isLocked

boolean

isLockedBy

IdentityRef

name

string

objectId

string

peeledObjectId

string

repository

GitRepository

Die Repository-ID des Forks.

statuses

GitStatus[]

Diese Klasse enthält die Metadaten eines Diensts bzw. einer Erweiterung, die eine status.

url

string

GitPullRequest

Stellt alle Daten dar, die einem Pull Request zugeordnet sind.

Name Typ Beschreibung
_links

ReferenceLinks

Links zu anderen verwandten Objekten.

artifactId

string

Eine Zeichenfolge, die diesen Pull Request eindeutig identifiziert. Verwenden Sie diese Vorlage, um eine Artefakt-ID für einen Pull Request zu generieren: vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}

autoCompleteSetBy

IdentityRef

Wenn dieser Wert festgelegt ist, ist die automatische Vervollständigung für diesen Pull Request aktiviert, und dies ist die Identität, die ihn aktiviert hat.

closedBy

IdentityRef

Der Benutzer, der den Pull Request geschlossen hat.

closedDate

string

Das Datum, an dem der Pull Request geschlossen wurde (abgeschlossen, abgebrochen oder extern zusammengeführt).

codeReviewId

integer

Die Codeüberprüfungs-ID des Pull Requests. Wird intern verwendet.

commits

GitCommitRef[]

Die im Pull Request enthaltenen Commits.

completionOptions

GitPullRequestCompletionOptions

Optionen, die sich darauf auswirken, wie der Pull Request nach Abschluss zusammengeführt wird.

completionQueueTime

string

Das letzte Datum, an dem der Pull Request in die Warteschlange gelangt ist, die abgeschlossen werden soll. Wird intern verwendet.

createdBy

IdentityRef

Die Identität des Benutzers, der den Pull Request erstellt hat.

creationDate

string

Das Datum, an dem der Pull Request erstellt wurde.

description

string

Die Beschreibung des Pull Requests.

forkSource

GitForkRef

Wenn dies ein PR von einem Fork ist, enthält dieser Informationen über die Quelle.

hasMultipleMergeBases

boolean

Warnung zu mehreren Mergebases

isDraft

boolean

Entwurf/WIP-Pull Request.

labels

WebApiTagDefinition[]

Die dem Pull Request zugeordneten Bezeichnungen.

lastMergeCommit

GitCommitRef

Der Commit des letzten Pull Request-Merges. Wenn leer, wird die letzte Zusammenführung ausgeführt oder war nicht erfolgreich.

lastMergeSourceCommit

GitCommitRef

Der Commit am Anfang des Quellbranchs zum Zeitpunkt der letzten Pull Request-Zusammenführung.

lastMergeTargetCommit

GitCommitRef

Der Commit am Anfang des Zielbranchs zum Zeitpunkt der letzten Pull Request-Zusammenführung.

mergeFailureMessage

string

Falls festgelegt, ist die Pull Request-Zusammenführung aus diesem Grund fehlgeschlagen.

mergeFailureType

PullRequestMergeFailureType

Der Typ des Fehlers (sofern vorhanden) der Pull Request-Merge.

mergeId

string

Die ID des Auftrags, der zum Ausführen des Pull Request-Merges verwendet wird. Wird intern verwendet.

mergeOptions

GitPullRequestMergeOptions

Optionen, die verwendet werden, wenn die Pull Request-Mergeausführung ausgeführt wird. Diese sind von den Vervollständigungsoptionen getrennt, da der Abschluss nur einmal erfolgt und bei jeder Änderung des Quellbranchs des Pull Request eine neue Zusammenführung ausgeführt wird.

mergeStatus

PullRequestAsyncStatus

Die aktuelle status der Pull Request-Zusammenführung.

pullRequestId

integer

Die ID des Pull Requests.

remoteUrl

string

Wird intern verwendet.

repository

GitRepository

Das Repository, das den Zielbranch des Pull Requests enthält.

reviewers

IdentityRefWithVote[]

Eine Liste der Prüfer im Pull Request zusammen mit dem Status ihrer Stimmen.

sourceRefName

string

Der Name des Quellbranchs des Pull Requests.

status

PullRequestStatus

Die status des Pull Requests.

supportsIterations

boolean

Wenn true, unterstützt dieser Pull Request mehrere Iterationen. Iterationsunterstützung bedeutet, dass einzelne Pushvorgänge an den Quellbranch des Pull Requests überprüft werden können, und Kommentare, die in einer Iteration verbleiben, über zukünftige Iterationen hinweg nachverfolgt werden.

targetRefName

string

Der Name des Zielbranchs des Pull Requests.

title

string

Der Titel des Pull Requests.

url

string

Wird intern verwendet.

workItemRefs

ResourceRef[]

Alle Arbeitselementverweise, die diesem Pull Request zugeordnet sind.

GitPullRequestCompletionOptions

Einstellungen dazu, wie der Pull Request abgeschlossen werden soll.

Name Typ Beschreibung
autoCompleteIgnoreConfigIds

integer[]

Liste aller Richtlinienkonfigurations-IDs, auf die die automatische Vervollständigung nicht warten sollte. Gilt nur für optionale Richtlinien (isBlocking == false). Die automatische Vervollständigung wartet immer auf erforderliche Richtlinien (isBlocking == true).

bypassPolicy

boolean

Wenn true, werden Richtlinien explizit umgangen, während der Pull Request abgeschlossen ist.

bypassReason

string

Wenn Richtlinien umgangen werden, wird dieser Grund als Grund für die Verwendung der Umgehung gespeichert.

deleteSourceBranch

boolean

Wenn true, wird der Quellbranch des Pull Requests nach Abschluss gelöscht.

mergeCommitMessage

string

Wenn festgelegt, wird dies als Commitmeldung des Mergecommits verwendet.

mergeStrategy

GitPullRequestMergeStrategy

Geben Sie die Strategie an, die zum Zusammenführen des Pull Requests während des Abschlusses verwendet wird. Wenn MergeStrategy nicht auf einen Wert festgelegt ist, wird ein No-FF-Merge erstellt, wenn SquashMerge == false ist. Wenn MergeStrategy nicht auf einen Wert festgelegt ist, werden die Pull Request-Commits gequetscht, wenn SquashMerge == true ist. Die SquashMerge-Eigenschaft ist veraltet. Es wird empfohlen, MergeStrategy in allen Fällen explizit festzulegen. Wenn für MergeStrategy ein expliziter Wert angegeben wird, wird die SquashMerge-Eigenschaft ignoriert.

squashMerge

boolean

SquashMerge ist veraltet. Sie sollten den Wert von MergeStrategy explizit festlegen. Wenn MergeStrategy auf einen beliebigen Wert festgelegt ist, wird der SquashMerge-Wert ignoriert. Wenn MergeStrategy nicht festgelegt ist, ist die Mergestrategie no-Fast-Forward, wenn dieses Flag false ist, oder squashen, wenn true.

transitionWorkItems

boolean

Wenn true, versuchen wir, alle Arbeitselemente, die mit dem Pull Request verknüpft sind, in den nächsten logischen Zustand (d. h. Aktiv –> Aufgelöst) zu übertragen.

triggeredByAutoComplete

boolean

Wenn true, wurde der aktuelle Vervollständigungsversuch über die automatische Vervollständigung ausgelöst. Wird intern verwendet.

GitPullRequestMergeOptions

Die Optionen, die beim Erstellen einer Pull Request-Zusammenführung verwendet werden.

Name Typ Beschreibung
conflictAuthorshipCommits

boolean

Wenn true, werden während der Zusammenführung angewendete Konfliktauflösungen in separate Commits eingefügt, um Autoreninformationen für Git Blame usw. beizubehalten.

detectRenameFalsePositives

boolean

disableRenames

boolean

Wenn true, wird die Umbenennungserkennung während der Zusammenführung nicht ausgeführt.

GitPullRequestMergeStrategy

Geben Sie die Strategie an, die zum Zusammenführen des Pull Requests während des Abschlusses verwendet wird. Wenn MergeStrategy nicht auf einen Wert festgelegt ist, wird ein No-FF-Merge erstellt, wenn SquashMerge == false ist. Wenn MergeStrategy nicht auf einen Wert festgelegt ist, werden die Pull Request-Commits gequetscht, wenn SquashMerge == true ist. Die SquashMerge-Eigenschaft ist veraltet. Es wird empfohlen, MergeStrategy in allen Fällen explizit festzulegen. Wenn für MergeStrategy ein expliziter Wert angegeben wird, wird die SquashMerge-Eigenschaft ignoriert.

Name Typ Beschreibung
noFastForward

string

Eine Zusammenführung mit zwei übergeordneten Fast-Forward. Der Quellbranch bleibt unverändert. Dies ist das Standardverhalten.

rebase

string

Neubasieren Sie den Quellbranch auf dem Zielbranch HEAD Commit, und Fast-Forward den Zielbranch. Der Quellbranch wird während des Rebasevorgangs aktualisiert.

rebaseMerge

string

Rebasen Sie den Quellbranch auf dem Zielbranch HEAD Commit, und erstellen Sie eine Zusammenführung ohne Fast-Forward mit zwei übergeordneten Fast-Forward. Der Quellbranch wird während des Rebasevorgangs aktualisiert.

squash

string

Fügen Sie alle Änderungen aus dem Pull Request in einen allein übergeordneten Commit ein.

GitPushRef

Name Typ Beschreibung
_links

ReferenceLinks

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

date

string

pushId

integer

pushedBy

IdentityRef

url

string

GitRepository

Name Typ Beschreibung
_links

ReferenceLinks

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

defaultBranch

string

id

string

isDisabled

boolean

True, wenn das Repository deaktiviert ist. Andernfalls FALSE.

isFork

boolean

True, wenn das Repository als Fork erstellt wurde.

isInMaintenance

boolean

True, wenn das Repository in Wartung ist. Andernfalls FALSE.

name

string

parentRepository

GitRepositoryRef

project

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

remoteUrl

string

size

integer

Komprimierte Größe (Bytes) des Repositorys.

sshUrl

string

url

string

validRemoteUrls

string[]

webUrl

string

GitRepositoryRef

Name Typ Beschreibung
collection

TeamProjectCollectionReference

Team Project Collection, in der sich dieser Fork befindet

id

string

isFork

boolean

True, wenn das Repository als Fork erstellt wurde

name

string

project

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

remoteUrl

string

sshUrl

string

url

string

GitStatus

Diese Klasse enthält die Metadaten eines Diensts bzw. einer Erweiterung, die eine status.

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.

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

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.

GitTemplate

Name Typ Beschreibung
name

string

Name der Vorlage

type

string

Typ der Vorlage

GitUserDate

Benutzerinformationen und Datum für Git-Vorgänge.

Name Typ Beschreibung
date

string

Datum des Git-Vorgangs.

email

string

Email Adresse des Benutzers, der den Git-Vorgang ausführt.

imageUrl

string

URL für den Avatar des Benutzers.

name

string

Name des Benutzers, der den Git-Vorgang ausführt.

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.

IdentityRefWithVote

Identitätsinformationen, einschließlich einer Abstimmung über einen Pull Request.

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.

hasDeclined

boolean

Gibt an, ob dieser Prüfer die Überprüfung dieses Pull Requests abgelehnt hat.

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

isFlagged

boolean

Gibt an, ob dieser Prüfer für aufmerksamkeitserregend für diesen Pull Request gekennzeichnet ist.

isReapprove

boolean

Gibt an, ob diese Genehmigungsabstimmung weiterhin behandelt werden soll, obwohl sich die Abstimmung nicht geändert hat.

isRequired

boolean

Gibt an, ob dies ein erforderlicher Prüfer für diesen Pull Request ist.
Branches können Richtlinien haben, die bestimmte Prüfer erfordern, die für Pull Requests erforderlich sind.

profileUrl

string

Veraltet– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.

reviewerUrl

string

URL zum Abrufen von Informationen zu dieser Identität

uniqueName

string

Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.

url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

vote

integer

Abstimmung über einen Pull Request:
10 - genehmigt 5 - genehmigt mit Vorschlägen 0 - keine Abstimmung -5 - warten auf Autor -10 - abgelehnt

votedFor

IdentityRefWithVote[]

Gruppen oder Teams, zu denen dieser Prüfer beigetragen hat.
Gruppen und Teams können Überprüfer für Pull Requests sein, aber nicht direkt abstimmen. Wenn ein Mitglied der Gruppe oder des Teams abstimmt, wird diese Stimme in die Gruppen- oder Teamabstimmung eingerollt. VoteFor ist eine Liste solcher Stimmen.

ItemContent

Name Typ Beschreibung
content

string

contentType

ItemContentType

ItemContentType

Name Typ Beschreibung
base64Encoded

string

rawText

string

ProjectState

Projektstatus.

Name Typ Beschreibung
all

string

Alle Projekte unabhängig vom Zustand mit Ausnahme von "Gelöscht".

createPending

string

Project wurde für die Erstellung in die Warteschlange gestellt, aber der Prozess wurde noch nicht gestartet.

deleted

string

Project wurde gelöscht.

deleting

string

Project wird gerade gelöscht.

new

string

Das Projekt wird gerade erstellt.

unchanged

string

Project wurde nicht geändert.

wellFormed

string

Project ist vollständig erstellt und einsatzbereit.

ProjectVisibility

Projektsichtbarkeit.

Name Typ Beschreibung
private

string

Das Projekt ist nur für Benutzer mit explizitem Zugriff sichtbar.

public

string

Das Projekt ist für alle sichtbar.

PullRequestAsyncStatus

Die aktuelle status der Pull Request-Zusammenführung.

Name Typ Beschreibung
conflicts

string

Fehler beim Zusammenführen von Pull Requests aufgrund von Konflikten.

failure

string

Fehler beim Zusammenführen von Pull Requests.

notSet

string

Der Status ist nicht festgelegt. Standardzustand.

queued

string

Pull Request Merge wird in die Warteschlange eingereiht.

rejectedByPolicy

string

Pull Request Merge wird von der Richtlinie abgelehnt.

succeeded

string

Pull Request Merge erfolgreich.

PullRequestMergeFailureType

Der Typ des Fehlers (sofern vorhanden) der Pull Request-Merge.

Name Typ Beschreibung
caseSensitive

string

Fehler bei der Zusammenführung von Pull Requests aufgrund eines Konflikts zwischen Groß- und Kleinschreibung.

none

string

Der Typ ist nicht festgelegt. Standardtyp.

objectTooLarge

string

Fehler beim Zusammenführen von Pull Requests, weil ein Objekt zu groß ist.

unknown

string

Fehlertyp der Pull Request-Zusammenführung unbekannt.

PullRequestStatus

Die status des Pull Requests.

Name Typ Beschreibung
abandoned

string

Pull Request wird abgebrochen.

active

string

Pull Request ist aktiv.

all

string

Wird in Pull Request-Suchkriterien verwendet, um alle Status einzuschließen.

completed

string

Der Pull Request ist abgeschlossen.

notSet

string

Status nicht festgelegt. Standardzustand.

PullRequestTimeRangeType

Der Typ des Zeitbereichs, der für minTime und maxTime verwendet werden soll. Standardwert: Erstellt, wenn nicht festgelegt.

Name Typ Beschreibung
closed

string

Das Datum, an dem der Pull Request geschlossen wurde (abgeschlossen, abgebrochen oder extern zusammengeführt).

created

string

Das Datum, an dem der Pull Request erstellt wurde.

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.

ResourceRef

Name Typ Beschreibung
id

string

url

string

TeamProjectCollectionReference

Referenzobjekt für eine TeamProjectCollection.

Name Typ Beschreibung
avatarUrl

string

Sammlungs-Avatar-URL.

id

string

Sammlungs-ID.

name

string

Sammlungsname.

url

string

SAMMLUNGS-REST-URL.

TeamProjectReference

Stellt einen flachen Verweis auf ein TeamProject dar.

Name Typ Beschreibung
abbreviation

string

Projektkürzel.

defaultTeamImageUrl

string

URL zum Standardmäßigen Teamidentitätsimage.

description

string

Die Projektbeschreibung (falls vorhanden).

id

string

Projektbezeichner.

lastUpdateTime

string

Zeitpunkt der letzten Aktualisierung des Projekts.

name

string

Der Projektname.

revision

integer

Projektrevision.

state

ProjectState

Projektstatus.

url

string

URL zur Vollversion des Objekts.

visibility

ProjectVisibility

Projektsichtbarkeit.

VersionControlChangeType

Der Typ der Änderung, die am Element vorgenommen wurde.

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

WebApiTagDefinition

Die Darstellung einer Tagdefinition, die über das Kabel gesendet wird.

Name Typ Beschreibung
active

boolean

Gibt an, ob die Tagdefinition aktiv ist.

id

string

ID der Tagdefinition.

name

string

Der Name der Tagdefinition.

url

string

Ressourcen-URL für die Tagdefinition.