Pull Requests - Update

Odwołanie

Service:: Git

API Version:: 5.0

Aktualizowanie żądania ściągnięcia.

Są to właściwości, które można zaktualizować za pomocą interfejsu API:

Stan
Tytuł
Opis
CompletionOptions
MergeOptions
AutoCompleteSetBy.Id
TargetRefName (gdy funkcja retargeting żądania ściągnięcia jest włączona) Próba zaktualizowania innych właściwości poza tą listą spowoduje, że serwer zgłosi InvalidArgumentValueExceptionwyjątek lub w trybie dyskretnym zignoruj aktualizację.

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?api-version=5.0

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
pullRequestId	path	True	integer int32	Identyfikator żądania ściągnięcia do pobrania.
repositoryId	path	True	string	Identyfikator repozytorium gałęzi docelowej żądania ściągnięcia.
project	path		string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "5.0", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
_links	ReferenceLinks	Łącza do innych powiązanych obiektów.
artifactId	string	Ciąg, który jednoznacznie identyfikuje to żądanie ściągnięcia. Aby wygenerować identyfikator artefaktu dla żądania ściągnięcia, użyj tego szablonu: `vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}`
autoCompleteSetBy	IdentityRef	W przypadku ustawienia autouzupełnianie jest włączone dla tego żądania ściągnięcia i jest to tożsamość, która ją włączyła.
closedBy	IdentityRef	Użytkownik, który zamknął żądanie ściągnięcia.
closedDate	string	Data zamknięcia żądania ściągnięcia (ukończona, porzucona lub scalona zewnętrznie).
codeReviewId	integer	Identyfikator przeglądu kodu żądania ściągnięcia. Używane wewnętrznie.
commits	GitCommitRef[]	Zatwierdzenia zawarte w żądaniu ściągnięcia.
completionOptions	GitPullRequestCompletionOptions	Opcje wpływające na sposób scalania żądania ściągnięcia po jego zakończeniu.
completionQueueTime	string	Ostatnia data zakończenia żądania ściągnięcia wprowadzona do kolejki. Używane wewnętrznie.
createdBy	IdentityRef	Tożsamość użytkownika, który utworzył żądanie ściągnięcia.
creationDate	string	Data utworzenia żądania ściągnięcia.
description	string	Opis żądania ściągnięcia.
forkSource	GitForkRef	Jeśli jest to żądanie ściągnięcia z rozwidlenia, będzie zawierać informacje o jego źródle.
isDraft	boolean	Żądanie ściągnięcia draft/WIP.
labels	WebApiTagDefinition[]	Etykiety skojarzone z żądaniem ściągnięcia.
lastMergeCommit	GitCommitRef	Zatwierdzenie najnowszego scalania żądania ściągnięcia. Jeśli jest puste, najnowsze scalanie jest w toku lub zakończyło się niepowodzeniem.
lastMergeSourceCommit	GitCommitRef	Zatwierdzenie w nagłówku gałęzi źródłowej w momencie ostatniego scalania żądania ściągnięcia.
lastMergeTargetCommit	GitCommitRef	Zatwierdzenie w nagłówku gałęzi docelowej w momencie ostatniego scalania żądania ściągnięcia.
mergeFailureMessage	string	W przypadku ustawienia scalanie żądania ściągnięcia nie powiodło się z tego powodu.
mergeFailureType	PullRequestMergeFailureType	Typ błędu (jeśli istnieje) scalania żądania ściągnięcia.
mergeId	string	Identyfikator zadania użytego do uruchomienia scalania żądania ściągnięcia. Używane wewnętrznie.
mergeOptions	GitPullRequestMergeOptions	Opcje używane podczas uruchamiania scalania żądania ściągnięcia. Są one oddzielone od opcji uzupełniania, ponieważ ukończenie odbywa się tylko raz, a nowe scalanie będzie uruchamiane za każdym razem, gdy zmienia się gałąź źródłowa żądania ściągnięcia.
mergeStatus	PullRequestAsyncStatus	Bieżący stan scalania żądania ściągnięcia.
pullRequestId	integer	Identyfikator żądania ściągnięcia.
remoteUrl	string	Używane wewnętrznie.
repository	GitRepository	Repozytorium zawierające gałąź docelową żądania ściągnięcia.
reviewers	IdentityRefWithVote[]	Lista recenzentów żądania ściągnięcia wraz ze stanem ich głosów.
sourceRefName	string	Nazwa gałęzi źródłowej żądania ściągnięcia.
status	PullRequestStatus	Stan żądania ściągnięcia.
supportsIterations	boolean	Jeśli to prawda, to żądanie ściągnięcia obsługuje wiele iteracji. Obsługa iteracji oznacza, że poszczególne wypychania do gałęzi źródłowej żądania ściągnięcia można przeglądać, a komentarze pozostawione w jednej iteracji będą śledzone w przyszłych iteracji.
targetRefName	string	Nazwa gałęzi docelowej żądania ściągnięcia.
title	string	Tytuł żądania ściągnięcia.
url	string	Używane wewnętrznie.
workItemRefs	ResourceRef[]	Wszystkie odwołania do elementów roboczych skojarzone z tym żądaniem ściągnięcia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GitPullRequest	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.code_write	Umożliwia odczytywanie, aktualizowanie i usuwanie kodu źródłowego, uzyskiwanie dostępu do metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również tworzenie żądań ściągnięcia i przeglądów kodu oraz zarządzanie nimi oraz odbieranie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Nazwa

Opis

vso.code_write

Umożliwia odczytywanie, aktualizowanie i usuwanie kodu źródłowego, uzyskiwanie dostępu do metadanych dotyczących zatwierdzeń, zestawów zmian, gałęzi i innych artefaktów kontroli wersji. Umożliwia również tworzenie żądań ściągnięcia i przeglądów kodu oraz zarządzanie nimi oraz odbieranie powiadomień o zdarzeniach kontroli wersji za pośrednictwem punktów zaczepienia usługi.

Przykłady

Enable auto-completion and set other completion options

Update description

Update title

Enable auto-completion and set other completion options

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests/{pullRequestId}?api-version=5.0

{
  "autoCompleteSetBy": {
    "id": "d6245f20-2af8-44f4-9451-8107cb2767db"
  },
  "completionOptions": {
    "deleteSourceBranch": "true",
    "mergeCommitMessage": "Added known issues document",
    "squashMerge": "false"
  }
}

Sample Response

Status code:: 200

{
  "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",
      "description": "test project created on Halloween 2016",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/a7573007-bbb3-4341-b726-0c4148a07853",
      "state": "wellFormed",
      "revision": 7
    },
    "remoteUrl": "https://dev.azure.com/fabrikam/_git/2016_10_31"
  },
  "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",
    "author": {
      "name": "Normal Paulk",
      "email": "fabrikamfiber16@hotmail.com",
      "date": "2016-11-01T16:30:25Z"
    },
    "committer": {
      "name": "Normal Paulk",
      "email": "fabrikamfiber16@hotmail.com",
      "date": "2016-11-01T16:30:25Z"
    },
    "comment": "Merge pull request 21 from npaulk/known_issues into new_feature",
    "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",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/21"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719"
    },
    "workItems": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/21/workitems"
    },
    "sourceBranch": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
    },
    "targetBranch": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
    },
    "sourceCommit": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/05ce817c4692afc93c1eb952643bdf7ffbab18ee"
    },
    "targetCommit": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
    },
    "createdBy": {
      "href": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "iterations": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/21/iterations"
    }
  },
  "completionOptions": {
    "mergeCommitMessage": "Added known issues document",
    "deleteSourceBranch": true
  },
  "supportsIterations": true,
  "autoCompleteSetBy": {
    "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"
  },
  "artifactId": "vstfs:///Git/PullRequestId/a7573007-bbb3-4341-b726-0c4148a07853%2f3411ebc1-d5aa-464f-9615-0b527bc66719%2f21"
}

Update description

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests/22?api-version=5.0

{
  "description": "Updated pull request description"
}

Sample Response

Status code:: 200

{
  "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",
      "description": "test project created on Halloween 2016",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/a7573007-bbb3-4341-b726-0c4148a07853",
      "state": "wellFormed",
      "revision": 7
    },
    "remoteUrl": "https://dev.azure.com/fabrikam/_git/2016_10_31"
  },
  "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": "Updated pull request title",
  "description": "Updated pull request description",
  "sourceRefName": "refs/heads/npaulk/my_work",
  "targetRefName": "refs/heads/new_feature",
  "mergeStatus": "succeeded",
  "mergeId": "f5fc8381-3fb2-49fe-8a0d-27dcc2d6ef82",
  "lastMergeSourceCommit": {
    "commitId": "8c9396b5cf22f929767c7172e9dbbe777ddc6357",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/8c9396b5cf22f929767c7172e9dbbe777ddc6357"
  },
  "lastMergeTargetCommit": {
    "commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
  },
  "lastMergeCommit": {
    "commitId": "fd8da3e51efe350811d2157b2223df53d4db46c3",
    "author": {
      "name": "Normal Paulk",
      "email": "fabrikamfiber16@hotmail.com",
      "date": "2016-11-01T16:30:40Z"
    },
    "committer": {
      "name": "Normal Paulk",
      "email": "fabrikamfiber16@hotmail.com",
      "date": "2016-11-01T16:30:40Z"
    },
    "comment": "Merge pull request 22 from npaulk/my_work into new_feature",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/fd8da3e51efe350811d2157b2223df53d4db46c3"
  },
  "reviewers": [
    {
      "reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
      "vote": 10,
      "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",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719"
    },
    "workItems": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/workitems"
    },
    "sourceBranch": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
    },
    "targetBranch": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
    },
    "sourceCommit": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/8c9396b5cf22f929767c7172e9dbbe777ddc6357"
    },
    "targetCommit": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
    },
    "createdBy": {
      "href": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "iterations": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/iterations"
    }
  },
  "supportsIterations": true,
  "artifactId": "vstfs:///Git/PullRequestId/a7573007-bbb3-4341-b726-0c4148a07853%2f3411ebc1-d5aa-464f-9615-0b527bc66719%2f22"
}

Update title

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullrequests/22?api-version=5.0

{
  "title": "Updated pull request title"
}

Sample Response

Status code:: 200

{
  "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",
      "description": "test project created on Halloween 2016",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/a7573007-bbb3-4341-b726-0c4148a07853",
      "state": "wellFormed",
      "revision": 7
    },
    "remoteUrl": "https://dev.azure.com/fabrikam/_git/2016_10_31"
  },
  "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": "Updated pull request title",
  "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": "8c9396b5cf22f929767c7172e9dbbe777ddc6357",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/8c9396b5cf22f929767c7172e9dbbe777ddc6357"
  },
  "lastMergeTargetCommit": {
    "commitId": "f47bbc106853afe3c1b07a81754bce5f4b8dbf62",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
  },
  "lastMergeCommit": {
    "commitId": "fd8da3e51efe350811d2157b2223df53d4db46c3",
    "author": {
      "name": "Normal Paulk",
      "email": "fabrikamfiber16@hotmail.com",
      "date": "2016-11-01T16:30:40Z"
    },
    "committer": {
      "name": "Normal Paulk",
      "email": "fabrikamfiber16@hotmail.com",
      "date": "2016-11-01T16:30:40Z"
    },
    "comment": "Merge pull request 22 from npaulk/my_work into new_feature",
    "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/fd8da3e51efe350811d2157b2223df53d4db46c3"
  },
  "reviewers": [
    {
      "reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db",
      "vote": 10,
      "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",
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22"
    },
    "repository": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719"
    },
    "workItems": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/workitems"
    },
    "sourceBranch": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
    },
    "targetBranch": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/refs"
    },
    "sourceCommit": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/8c9396b5cf22f929767c7172e9dbbe777ddc6357"
    },
    "targetCommit": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/commits/f47bbc106853afe3c1b07a81754bce5f4b8dbf62"
    },
    "createdBy": {
      "href": "https://dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db"
    },
    "iterations": {
      "href": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/iterations"
    }
  },
  "supportsIterations": true,
  "artifactId": "vstfs:///Git/PullRequestId/a7573007-bbb3-4341-b726-0c4148a07853%2f3411ebc1-d5aa-464f-9615-0b527bc66719%2f22"
}

Definicje

Nazwa	Opis
ChangeCountDictionary
GitChange
GitCommitRef	Zawiera właściwości opisujące zatwierdzenie usługi Git i skojarzone metadane.
GitForkRef	Informacje na temat rozwidlenia ref.
GitPullRequest	Reprezentuje wszystkie dane skojarzone z żądaniem ściągnięcia.
GitPullRequestCompletionOptions	Preferencje dotyczące sposobu ukończenia żądania ściągnięcia.
GitPullRequestMergeOptions	Opcje, które są używane podczas tworzenia scalania żądania ściągnięcia.
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	Ta klasa zawiera metadane usługi/rozszerzenia delegowania stanu.
GitStatusContext	Kontekst stanu, który jednoznacznie identyfikuje stan.
GitStatusState	Stan stanu.
GitTemplate
GitUserDate	Informacje o użytkowniku i data operacji usługi Git.
IdentityRef
IdentityRefWithVote	Informacje o tożsamości, w tym głosowanie na żądanie ściągnięcia.
ItemContent
ItemContentType
ProjectState	Stan projektu.
ProjectVisibility	Widoczność projektu.
PullRequestAsyncStatus	Bieżący stan scalania żądania ściągnięcia.
PullRequestMergeFailureType	Typ błędu (jeśli istnieje) scalania żądania ściągnięcia.
PullRequestStatus	Stan żądania ściągnięcia.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ResourceRef
TeamProjectCollectionReference	Obiekt referencyjny dla obiektu TeamProjectCollection.
TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.
VersionControlChangeType	Typ zmiany wprowadzonej w elemencie.
WebApiTagDefinition	Reprezentacja definicji tagu, która jest wysyłana przez sieć.

ChangeCountDictionary

GitChange

Nazwa	Typ	Opis
changeId	integer	Identyfikator zmiany w grupie zmian.
changeType	VersionControlChangeType	Typ zmiany wprowadzonej w elemencie.
item	string	Bieżąca wersja.
newContent	ItemContent	Zawartość elementu po zmianie.
newContentTemplate	GitTemplate	Nowy szablon zawartości do użycia podczas wypychania nowych zmian.
originalPath	string	Oryginalna ścieżka elementu, jeśli różni się od bieżącej ścieżki.
sourceServerItem	string	Ścieżka elementu na serwerze.
url	string	Adres URL umożliwiający pobranie elementu.

GitCommitRef

Zawiera właściwości opisujące zatwierdzenie usługi Git i skojarzone metadane.

Nazwa	Typ	Opis
_links	ReferenceLinks	Kolekcja powiązanych linków referencyjnych REST.
author	GitUserDate	Autor zatwierdzenia.
changeCounts	ChangeCountDictionary	Liczba typów zmian (edycji, usuwania itp.) uwzględnionych w zatwierdzeniu.
changes	GitChange[]	Wyliczenie zmian uwzględnionych w zatwierdzeniu.
comment	string	Komentarz lub wiadomość zatwierdzenia.
commentTruncated	boolean	Wskazuje, czy komentarz został obcięty z pełnego komunikatu komentarza zatwierdzenia usługi Git.
commitId	string	Identyfikator (SHA-1) zatwierdzenia.
committer	GitUserDate	Zatwierdzanie zatwierdzenia.
parents	string[]	Wyliczenie identyfikatorów zatwierdzeń nadrzędnych dla tego zatwierdzenia.
push	GitPushRef	Wypychanie skojarzone z tym zatwierdzeniem.
remoteUrl	string	Zdalna ścieżka adresu URL do zatwierdzenia.
statuses	GitStatus[]	Lista metadanych stanu z usług i rozszerzeń, które mogą kojarzyć dodatkowe informacje z zatwierdzeniem.
url	string	Adres URL REST dla tego zasobu.
workItems	ResourceRef[]	Lista elementów roboczych skojarzonych z tym zatwierdzeniem.

GitForkRef

Informacje na temat rozwidlenia ref.

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	Identyfikator repozytorium rozwidlenia.
statuses	GitStatus[]	Ta klasa zawiera metadane usługi/rozszerzenia delegowania stanu.
url	string

GitPullRequest

Reprezentuje wszystkie dane skojarzone z żądaniem ściągnięcia.

Nazwa	Typ	Opis
_links	ReferenceLinks	Łącza do innych powiązanych obiektów.
artifactId	string	Ciąg, który jednoznacznie identyfikuje to żądanie ściągnięcia. Aby wygenerować identyfikator artefaktu dla żądania ściągnięcia, użyj tego szablonu: `vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}`
autoCompleteSetBy	IdentityRef	W przypadku ustawienia autouzupełnianie jest włączone dla tego żądania ściągnięcia i jest to tożsamość, która ją włączyła.
closedBy	IdentityRef	Użytkownik, który zamknął żądanie ściągnięcia.
closedDate	string	Data zamknięcia żądania ściągnięcia (ukończona, porzucona lub scalona zewnętrznie).
codeReviewId	integer	Identyfikator przeglądu kodu żądania ściągnięcia. Używane wewnętrznie.
commits	GitCommitRef[]	Zatwierdzenia zawarte w żądaniu ściągnięcia.
completionOptions	GitPullRequestCompletionOptions	Opcje wpływające na sposób scalania żądania ściągnięcia po jego zakończeniu.
completionQueueTime	string	Ostatnia data zakończenia żądania ściągnięcia wprowadzona do kolejki. Używane wewnętrznie.
createdBy	IdentityRef	Tożsamość użytkownika, który utworzył żądanie ściągnięcia.
creationDate	string	Data utworzenia żądania ściągnięcia.
description	string	Opis żądania ściągnięcia.
forkSource	GitForkRef	Jeśli jest to żądanie ściągnięcia z rozwidlenia, będzie zawierać informacje o jego źródle.
isDraft	boolean	Żądanie ściągnięcia draft/WIP.
labels	WebApiTagDefinition[]	Etykiety skojarzone z żądaniem ściągnięcia.
lastMergeCommit	GitCommitRef	Zatwierdzenie najnowszego scalania żądania ściągnięcia. Jeśli jest puste, najnowsze scalanie jest w toku lub zakończyło się niepowodzeniem.
lastMergeSourceCommit	GitCommitRef	Zatwierdzenie w nagłówku gałęzi źródłowej w momencie ostatniego scalania żądania ściągnięcia.
lastMergeTargetCommit	GitCommitRef	Zatwierdzenie w nagłówku gałęzi docelowej w momencie ostatniego scalania żądania ściągnięcia.
mergeFailureMessage	string	W przypadku ustawienia scalanie żądania ściągnięcia nie powiodło się z tego powodu.
mergeFailureType	PullRequestMergeFailureType	Typ błędu (jeśli istnieje) scalania żądania ściągnięcia.
mergeId	string	Identyfikator zadania użytego do uruchomienia scalania żądania ściągnięcia. Używane wewnętrznie.
mergeOptions	GitPullRequestMergeOptions	Opcje używane podczas uruchamiania scalania żądania ściągnięcia. Są one oddzielone od opcji uzupełniania, ponieważ ukończenie odbywa się tylko raz, a nowe scalanie będzie uruchamiane za każdym razem, gdy zmienia się gałąź źródłowa żądania ściągnięcia.
mergeStatus	PullRequestAsyncStatus	Bieżący stan scalania żądania ściągnięcia.
pullRequestId	integer	Identyfikator żądania ściągnięcia.
remoteUrl	string	Używane wewnętrznie.
repository	GitRepository	Repozytorium zawierające gałąź docelową żądania ściągnięcia.
reviewers	IdentityRefWithVote[]	Lista recenzentów żądania ściągnięcia wraz ze stanem ich głosów.
sourceRefName	string	Nazwa gałęzi źródłowej żądania ściągnięcia.
status	PullRequestStatus	Stan żądania ściągnięcia.
supportsIterations	boolean	Jeśli to prawda, to żądanie ściągnięcia obsługuje wiele iteracji. Obsługa iteracji oznacza, że poszczególne wypychania do gałęzi źródłowej żądania ściągnięcia można przeglądać, a komentarze pozostawione w jednej iteracji będą śledzone w przyszłych iteracji.
targetRefName	string	Nazwa gałęzi docelowej żądania ściągnięcia.
title	string	Tytuł żądania ściągnięcia.
url	string	Używane wewnętrznie.
workItemRefs	ResourceRef[]	Wszystkie odwołania do elementów roboczych skojarzone z tym żądaniem ściągnięcia.

GitPullRequestCompletionOptions

Preferencje dotyczące sposobu ukończenia żądania ściągnięcia.

Nazwa	Typ	Opis
bypassPolicy	boolean	Jeśli to prawda, zasady zostaną jawnie pominięte podczas wykonywania żądania ściągnięcia.
bypassReason	string	Jeśli zasady są pomijane, przyczyna ta jest przechowywana jako przyczyna użycia obejścia.
deleteSourceBranch	boolean	W przypadku wartości true gałąź źródłowa żądania ściągnięcia zostanie usunięta po zakończeniu.
mergeCommitMessage	string	W przypadku ustawienia ta wartość będzie używana jako komunikat zatwierdzenia zatwierdzenia zatwierdzenia scalania.
squashMerge	boolean	Jeśli wartość true, zatwierdzenia w żądaniu ściągnięcia zostaną scalone z określoną gałęzią docelową po zakończeniu.
transitionWorkItems	boolean	W przypadku wartości true spróbujemy przenieść wszystkie elementy robocze połączone z żądaniem ściągnięcia do następnego stanu logicznego (tj. Aktywne —> Rozwiązane)
triggeredByAutoComplete	boolean	Jeśli wartość true, bieżąca próba ukończenia została wyzwolona za pośrednictwem autouzupełnienia. Używane wewnętrznie.

GitPullRequestMergeOptions

Opcje, które są używane podczas tworzenia scalania żądania ściągnięcia.

Nazwa	Typ	Opis
detectRenameFalsePositives	boolean
disableRenames	boolean	Jeśli wartość true, wykrywanie zmiany nazwy nie zostanie wykonane podczas scalania.

GitPushRef

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Nazwa	Typ	Opis
_links	ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
defaultBranch	string
id	string
isFork	boolean	Prawda, jeśli repozytorium zostało utworzone jako rozwidlenie
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.
remoteUrl	string
size	integer	Skompresowany rozmiar (bajty) repozytorium.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Nazwa	Typ	Opis
collection	TeamProjectCollectionReference	Kolekcja projektów zespołowych, w której znajduje się ten rozwidlenie
id	string
isFork	boolean	Prawda, jeśli repozytorium zostało utworzone jako rozwidlenie
name	string
project	TeamProjectReference	Reprezentuje płytkie odwołanie do projektu TeamProject.
remoteUrl	string
sshUrl	string
url	string

GitStatus

Ta klasa zawiera metadane usługi/rozszerzenia delegowania stanu.

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki referencyjne.
context	GitStatusContext	Kontekst stanu.
createdBy	IdentityRef	Tożsamość, która utworzyła stan.
creationDate	string	Data i godzina utworzenia stanu.
description	string	Opis stanu. Zazwyczaj opisuje bieżący stan stanu.
id	integer	Identyfikator stanu.
state	GitStatusState	Stan stanu.
targetUrl	string	Adres URL ze szczegółami stanu.
updatedDate	string	Data i godzina ostatniej aktualizacji stanu.

GitStatusContext

Kontekst stanu, który jednoznacznie identyfikuje stan.

Nazwa	Typ	Opis
genre	string	Gatunek stanu. Zazwyczaj nazwa usługi/narzędzia generującego stan może być pusta.
name	string	Identyfikator nazwy stanu nie może być pusty ani mieć wartości null.

GitStatusState

Stan stanu.

Nazwa	Typ	Opis
error	string	Stan z błędem.
failed	string	Stan nie powiódł się.
notApplicable	string	Stan nie ma zastosowania do obiektu docelowego.
notSet	string	Stan nie jest ustawiony. Stan domyślny.
pending	string	Stan oczekiwania.
succeeded	string	Stan zakończył się pomyślnie.

GitTemplate

Nazwa	Typ	Opis
name	string	Nazwa szablonu
type	string	Typ szablonu

GitUserDate

Informacje o użytkowniku i data operacji usługi Git.

Nazwa	Typ	Opis
date	string	Data operacji usługi Git.
email	string	Email adres użytkownika wykonującego operację git.
imageUrl	string	Adres URL awatara użytkownika.
name	string	Nazwa użytkownika wykonującego operację Git.

IdentityRef

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

IdentityRefWithVote

Informacje o tożsamości, w tym głosowanie na żądanie ściągnięcia.

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwoływanie się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
isRequired	boolean	Wskazuje, czy jest to wymagany recenzent dla tego żądania ściągnięcia. Gałęzie mogą mieć zasady, które wymagają określonych recenzentów, są wymagane dla żądań ściągnięcia.
profileUrl	string
reviewerUrl	string	Adres URL umożliwiający pobranie informacji o tej tożsamości
uniqueName	string
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.
vote	integer	Zagłosuj na żądanie ściągnięcia: 10 - zatwierdzone 5 - zatwierdzone z sugestiami 0 - bez głosowania -5 - oczekiwanie na autora -10 - odrzucone
votedFor	IdentityRefWithVote[]	Grupy lub zespoły, do których przyczynił się ten recenzent. Grupy i zespoły mogą być recenzentami żądań ściągnięcia, ale nie mogą głosować bezpośrednio. Gdy członek grupy lub zespołu głosuje, głosowanie to zostanie uwzględnione w głosowaniu grupy lub zespołu. VotedFor jest listą takich głosów.

ItemContent

Nazwa	Typ	Opis
content	string
contentType	ItemContentType

ItemContentType

Nazwa	Typ	Opis
base64Encoded	string
rawText	string

ProjectState

Stan projektu.

Nazwa	Typ	Opis
all	string	Wszystkie projekty niezależnie od stanu.
createPending	string	Projekt został jeszcze w kolejce do utworzenia, ale proces nie został jeszcze uruchomiony.
deleted	string	Projekt został usunięty.
deleting	string	Projekt jest w trakcie usuwania.
new	string	Projekt jest w trakcie tworzenia.
unchanged	string	Projekt nie został zmieniony.
wellFormed	string	Projekt jest całkowicie tworzony i gotowy do użycia.

ProjectVisibility

Widoczność projektu.

Nazwa	Typ	Opis
private	string	Projekt jest widoczny tylko dla użytkowników z jawnym dostępem.
public	string	Projekt jest widoczny dla wszystkich.

PullRequestAsyncStatus

Bieżący stan scalania żądania ściągnięcia.

Nazwa	Typ	Opis
conflicts	string	Scalanie żądania ściągnięcia nie powiodło się z powodu konfliktów.
failure	string	Scalanie żądania ściągnięcia nie powiodło się.
notSet	string	Stan nie jest ustawiony. Stan domyślny.
queued	string	Scalanie żądania ściągnięcia jest w kolejce.
rejectedByPolicy	string	Scalanie żądania ściągnięcia odrzucone przez zasady.
succeeded	string	Scalanie żądania ściągnięcia powiodło się.

PullRequestMergeFailureType

Typ błędu (jeśli istnieje) scalania żądania ściągnięcia.

Nazwa	Typ	Opis
caseSensitive	string	Scalanie żądania ściągnięcia nie powiodło się z powodu niezgodności wielkości liter.
none	string	Typ nie jest ustawiony. Typ domyślny.
objectTooLarge	string	Scalanie żądania ściągnięcia nie powiodło się z powodu zbyt dużego obiektu.
unknown	string	Typ błędu scalania żądania ściągnięcia jest nieznany.

PullRequestStatus

Stan żądania ściągnięcia.

Nazwa	Typ	Opis
abandoned	string	Żądanie ściągnięcia zostało porzucone.
active	string	Żądanie ściągnięcia jest aktywne.
all	string	Używane w kryteriach wyszukiwania żądań ściągnięcia do uwzględnienia wszystkich stanów.
completed	string	Żądanie ściągnięcia zostało ukończone.
notSet	string	Stan nie jest ustawiony. Stan domyślny.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

ResourceRef

Nazwa	Typ	Opis
id	string
url	string

TeamProjectCollectionReference

Obiekt referencyjny dla obiektu TeamProjectCollection.

Nazwa	Typ	Opis
id	string	Identyfikator kolekcji.
name	string	Nazwa kolekcji.
url	string	Adres URL REST kolekcji.

TeamProjectReference

Reprezentuje płytkie odwołanie do projektu TeamProject.

Nazwa	Typ	Opis
abbreviation	string	Skrót projektu.
defaultTeamImageUrl	string	Adres URL domyślnego obrazu tożsamości zespołu.
description	string	Opis projektu (jeśli istnieje).
id	string	Identyfikator projektu.
name	string	Nazwa projektu.
revision	integer	Poprawka projektu.
state	ProjectState	Stan projektu.
url	string	Adres URL do pełnej wersji obiektu.
visibility	ProjectVisibility	Widoczność projektu.

VersionControlChangeType

Typ zmiany wprowadzonej w elemencie.

Nazwa	Typ	Opis
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

Reprezentacja definicji tagu, która jest wysyłana przez sieć.

Nazwa	Typ	Opis
active	boolean	Określa, czy definicja tagu jest aktywna.
id	string	Identyfikator definicji tagu.
name	string	Nazwa definicji tagu.
url	string	Adres URL zasobu dla definicji tagu.

Udostępnij za pośrednictwem

Pull Requests - Update

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Scopes

Przykłady

Enable auto-completion and set other completion options

Sample Request

Sample Response

Update description

Sample Request

Sample Response

Update title

Sample Request

Sample Response

Definicje

ChangeCountDictionary

GitChange

GitCommitRef

GitForkRef

GitPullRequest

GitPullRequestCompletionOptions

GitPullRequestMergeOptions

GitPushRef

GitRepository

GitRepositoryRef

GitStatus

GitStatusContext

GitStatusState

GitTemplate

GitUserDate

IdentityRef

IdentityRefWithVote

ItemContent

ItemContentType

ProjectState

ProjectVisibility

PullRequestAsyncStatus

PullRequestMergeFailureType

PullRequestStatus

ReferenceLinks

ResourceRef

TeamProjectCollectionReference

TeamProjectReference

VersionControlChangeType

WebApiTagDefinition

Dodatkowe zasoby