Pull Requests - Update

Ссылка

Service:: Git

API Version:: 5.0

Обновление запроса на вытягивание.

Ниже приведены свойства, которые можно обновить с помощью API:

Состояние
Заголовок
Описание
CompletionOptions
MergeOptions
AutoCompleteSetBy.Id
TargetRefName (если включена функция перенацеливания запроса на вытягивание). Попытка обновить другие свойства за пределами этого списка приведет к тому, что сервер либо вызовет InvalidArgumentValueExceptionисключение , либо проигнорирует обновление автоматически.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
pullRequestId	path	True	integer int32	Идентификатор извлекаемого запроса на вытягивание.
repositoryId	path	True	string	Идентификатор репозитория целевой ветви запроса на вытягивание.
project	path		string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 5.0.

Текст запроса

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на другие связанные объекты.
artifactId	string	Строка, однозначно идентифицирующая этот запрос на вытягивание. Чтобы создать идентификатор артефакта для запроса на вытягивание, используйте следующий шаблон: `vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}`
autoCompleteSetBy	IdentityRef	Если задано значение , для этого запроса на вытягивание включено автозавервание, и это удостоверение, которое включило его.
closedBy	IdentityRef	Пользователь, который закрыл запрос на вытягивание.
closedDate	string	Дата закрытия запроса на вытягивание (завершение, отмена или внешнее слияние).
codeReviewId	integer	Идентификатор проверки кода запроса на вытягивание. Для внутреннего использования.
commits	GitCommitRef[]	Фиксации, содержащиеся в запросе на вытягивание.
completionOptions	GitPullRequestCompletionOptions	Параметры, влияющие на способ объединения запроса на вытягивание после его завершения.
completionQueueTime	string	Самая последняя дата, когда запрос на вытягивание вошел в очередь для завершения. Для внутреннего использования.
createdBy	IdentityRef	Удостоверение пользователя, создавшего запрос на вытягивание.
creationDate	string	Дата создания запроса на вытягивание.
description	string	Описание запроса на вытягивание.
forkSource	GitForkRef	Если это запрос на вытягивание из вилки, он будет содержать сведения об источнике.
isDraft	boolean	Черновик или WIP-запрос на вытягивание.
labels	WebApiTagDefinition[]	Метки, связанные с запросом на вытягивание.
lastMergeCommit	GitCommitRef	Фиксация последнего слияния запроса на вытягивание. Если он пуст, последнее слияние выполняется или не выполнено.
lastMergeSourceCommit	GitCommitRef	Фиксация в начале исходной ветви во время последнего слияния запроса на вытягивание.
lastMergeTargetCommit	GitCommitRef	Фиксация в начале целевой ветви во время последнего слияния запроса на вытягивание.
mergeFailureMessage	string	Если задано значение , слияние запроса на вытягивание по этой причине завершилось сбоем.
mergeFailureType	PullRequestMergeFailureType	Тип сбоя (если таковой есть) при слиянии запроса на вытягивание.
mergeId	string	Идентификатор задания, используемого для выполнения слияния запроса на вытягивание. Для внутреннего использования.
mergeOptions	GitPullRequestMergeOptions	Параметры, используемые при выполнении слияния запроса на вытягивание. Они отличаются от параметров завершения, так как завершение происходит только один раз, а новое слияние будет выполняться при каждом изменении исходной ветви запроса на вытягивание.
mergeStatus	PullRequestAsyncStatus	Текущее состояние слияния запроса на вытягивание.
pullRequestId	integer	Идентификатор запроса на вытягивание.
remoteUrl	string	Для внутреннего использования.
repository	GitRepository	Репозиторий, содержащий целевую ветвь запроса на вытягивание.
reviewers	IdentityRefWithVote[]	Список рецензентов по запросу на вытягивание, а также состояние их голосов.
sourceRefName	string	Имя исходной ветви запроса на вытягивание.
status	PullRequestStatus	Состояние запроса на вытягивание.
supportsIterations	boolean	Если значение равно true, этот запрос на вытягивание поддерживает несколько итераций. Поддержка итерации означает, что отдельные отправки в исходную ветвь запроса на вытягивание можно просмотреть, а комментарии, оставленные в одной итерации, будут отслеживаться в будущих итерациях.
targetRefName	string	Имя целевой ветви запроса на вытягивание.
title	string	Заголовок запроса на вытягивание.
url	string	Для внутреннего использования.
workItemRefs	ResourceRef[]	Ссылки на все рабочие элементы, связанные с этим запросом на вытягивание.

Ответы

Имя	Тип	Описание
200 OK	GitPullRequest	успешная операция

Безопасность

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

Имя	Описание
vso.code_write	Предоставляет возможность чтения, обновления и удаления исходного кода, доступа к метаданным о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность создавать запросы на вытягивание и проверки кода и управлять ими, а также получать уведомления о событиях управления версиями с помощью перехватчиков служб.

Имя

Описание

vso.code_write

Предоставляет возможность чтения, обновления и удаления исходного кода, доступа к метаданным о фиксациях, наборах изменений, ветвях и других артефактах управления версиями. Кроме того, предоставляет возможность создавать запросы на вытягивание и проверки кода и управлять ими, а также получать уведомления о событиях управления версиями с помощью перехватчиков служб.

Примеры

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

Определения

Имя	Описание
ChangeCountDictionary
GitChange
GitCommitRef	Предоставляет свойства, описывающие фиксацию Git и связанные метаданные.
GitForkRef	Сведения о ссылке на вилку.
GitPullRequest	Представляет все данные, связанные с запросом на вытягивание.
GitPullRequestCompletionOptions	Настройки о том, как должен быть выполнен запрос на вытягивание.
GitPullRequestMergeOptions	Параметры, используемые при создании слияния запросов на вытягивание.
GitPushRef
GitRepository
GitRepositoryRef
GitStatus	Этот класс содержит метаданные службы или расширения, публикующей состояние.
GitStatusContext	Контекст состояния, однозначно определяющий состояние.
GitStatusState	Состояние состояния.
GitTemplate
GitUserDate	Сведения о пользователе и дата для операций Git.
IdentityRef
IdentityRefWithVote	Сведения об удостоверениях, включая голосование по запросу на вытягивание.
ItemContent
ItemContentType
ProjectState	Состояние проекта.
ProjectVisibility	Видимость проекта.
PullRequestAsyncStatus	Текущее состояние слияния запроса на вытягивание.
PullRequestMergeFailureType	Тип сбоя (если таковой есть) при слиянии запроса на вытягивание.
PullRequestStatus	Состояние запроса на вытягивание.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ResourceRef
TeamProjectCollectionReference	Объект reference для TeamProjectCollection.
TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
VersionControlChangeType	Тип изменения, внесенного в элемент.
WebApiTagDefinition	Представление определения тега, которое передается по сети.

ChangeCountDictionary

GitChange

Имя	Тип	Описание
changeId	integer	Идентификатор изменения в группе изменений.
changeType	VersionControlChangeType	Тип изменения, внесенного в элемент.
item	string	Текущая версия.
newContent	ItemContent	Содержимое элемента после изменения.
newContentTemplate	GitTemplate	Новый шаблон содержимого, используемый при отправке новых изменений.
originalPath	string	Исходный путь к элементу, если он отличается от текущего пути.
sourceServerItem	string	Путь к элементу на сервере.
url	string	URL-адрес для получения элемента.

GitCommitRef

Предоставляет свойства, описывающие фиксацию Git и связанные метаданные.

Имя	Тип	Описание
_links	ReferenceLinks	Коллекция связанных ссылок на REST.
author	GitUserDate	Автор фиксации.
changeCounts	ChangeCountDictionary	Количество типов изменений (редактирования, удаления и т. д.), включенных в фиксацию.
changes	GitChange[]	Перечисление изменений, включенных в фиксацию.
comment	string	Комментарий или сообщение фиксации.
commentTruncated	boolean	Указывает, усекается ли комментарий из полного сообщения о фиксации Git.
commitId	string	Идентификатор (SHA-1) фиксации.
committer	GitUserDate	Фиксация фиксации.
parents	string[]	Перечисление идентификаторов родительской фиксации для этой фиксации.
push	GitPushRef	Отправка, связанная с этой фиксацией.
remoteUrl	string	Удаленный URL-путь к фиксации.
statuses	GitStatus[]	Список метаданных состояния из служб и расширений, которые могут связывать дополнительные сведения с фиксацией.
url	string	URL-адрес REST для этого ресурса.
workItems	ResourceRef[]	Список рабочих элементов, связанных с этой фиксацией.

GitForkRef

Сведения о ссылке на вилку.

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
creator	IdentityRef
isLocked	boolean
isLockedBy	IdentityRef
name	string
objectId	string
peeledObjectId	string
repository	GitRepository	Идентификатор репозитория вилки.
statuses	GitStatus[]	Этот класс содержит метаданные службы или расширения, публикующей состояние.
url	string

GitPullRequest

Представляет все данные, связанные с запросом на вытягивание.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на другие связанные объекты.
artifactId	string	Строка, однозначно идентифицирующая этот запрос на вытягивание. Чтобы создать идентификатор артефакта для запроса на вытягивание, используйте следующий шаблон: `vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}`
autoCompleteSetBy	IdentityRef	Если этот параметр задан, для этого запроса на вытягивание включено автоматическое завершение, и это удостоверение, которое включило его.
closedBy	IdentityRef	Пользователь, который закрыл запрос на вытягивание.
closedDate	string	Дата закрытия запроса на вытягивание (завершена, отменена или объединена извне).
codeReviewId	integer	Идентификатор проверки кода запроса на вытягивание. Для внутреннего использования.
commits	GitCommitRef[]	Фиксации, содержащиеся в запросе на вытягивание.
completionOptions	GitPullRequestCompletionOptions	Параметры, влияющие на способ объединения запроса на вытягивание после его завершения.
completionQueueTime	string	Самая последняя дата, когда запрос на вытягивание вошел в очередь для завершения. Для внутреннего использования.
createdBy	IdentityRef	Удостоверение пользователя, создавшего запрос на вытягивание.
creationDate	string	Дата создания запроса на вытягивание.
description	string	Описание запроса на вытягивание.
forkSource	GitForkRef	Если это запрос на вытягивание из вилки, он будет содержать сведения о своем источнике.
isDraft	boolean	Черновик или запрос на вытягивание WIP.
labels	WebApiTagDefinition[]	Метки, связанные с запросом на вытягивание.
lastMergeCommit	GitCommitRef	Фиксация последнего слияния запросов на вытягивание. Если этот параметр пуст, последнее слияние выполняется или не удалось выполнить.
lastMergeSourceCommit	GitCommitRef	Фиксация в начале исходной ветви во время последнего слияния запроса на вытягивание.
lastMergeTargetCommit	GitCommitRef	Фиксация в начале целевой ветви во время последнего слияния запроса на вытягивание.
mergeFailureMessage	string	Если этот параметр задан, по этой причине не удалось выполнить слияние запроса на вытягивание.
mergeFailureType	PullRequestMergeFailureType	Тип сбоя (если таковой есть) при слиянии запроса на вытягивание.
mergeId	string	Идентификатор задания, используемого для выполнения слияния запросов на вытягивание. Для внутреннего использования.
mergeOptions	GitPullRequestMergeOptions	Параметры, используемые при выполнении слияния запроса на вытягивание. Эти параметры отличаются от параметров завершения, так как завершение происходит только один раз, и при каждом изменении исходной ветви запроса на вытягивание будет выполняться новое слияние.
mergeStatus	PullRequestAsyncStatus	Текущее состояние слияния запросов на вытягивание.
pullRequestId	integer	Идентификатор запроса на вытягивание.
remoteUrl	string	Для внутреннего использования.
repository	GitRepository	Репозиторий, содержащий целевую ветвь запроса на вытягивание.
reviewers	IdentityRefWithVote[]	Список рецензентов по запросу на вытягивание, а также состояние их голосов.
sourceRefName	string	Имя исходной ветви запроса на вытягивание.
status	PullRequestStatus	Состояние запроса на вытягивание.
supportsIterations	boolean	Если значение равно true, этот запрос на вытягивание поддерживает несколько итераций. Поддержка итерации означает, что отдельные отправки в исходную ветвь запроса на вытягивание можно просмотреть, а комментарии, оставленные в одной итерации, будут отслеживаться в будущих итерациях.
targetRefName	string	Имя целевой ветви запроса на вытягивание.
title	string	Заголовок запроса на вытягивание.
url	string	Для внутреннего использования.
workItemRefs	ResourceRef[]	Ссылки на все рабочие элементы, связанные с этим запросом на вытягивание.

GitPullRequestCompletionOptions

Настройки о том, как должен быть выполнен запрос на вытягивание.

Имя	Тип	Описание
bypassPolicy	boolean	Если задано значение true, политики будут явно обходиться во время выполнения запроса на вытягивание.
bypassReason	string	Если политики обходятся, эта причина сохраняется в том, почему использовался обход.
deleteSourceBranch	boolean	Если задано значение true, исходная ветвь запроса на вытягивание будет удалена после завершения.
mergeCommitMessage	string	Если этот параметр задан, он будет использоваться в качестве сообщения фиксации при фиксации слиянием.
squashMerge	boolean	Если значение равно true, фиксации в запросе на вытягивание будут объединены в указанную целевую ветвь после завершения.
transitionWorkItems	boolean	Если задано значение true, мы попытаемся перевести все рабочие элементы, связанные с запросом на вытягивание, в следующее логическое состояние (т. е. Активный —> Разрешено).
triggeredByAutoComplete	boolean	Если задано значение true, текущая попытка завершения была активирована с помощью автоматического завершения. Для внутреннего использования.

GitPullRequestMergeOptions

Параметры, используемые при создании слияния запросов на вытягивание.

Имя	Тип	Описание
detectRenameFalsePositives	boolean
disableRenames	boolean	Если задано значение true, обнаружение переименования во время слияния выполняться не будет.

GitPushRef

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
date	string
pushId	integer
pushedBy	IdentityRef
url	string

GitRepository

Имя	Тип	Описание
_links	ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
defaultBranch	string
id	string
isFork	boolean	Значение true, если репозиторий был создан как вилка
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
remoteUrl	string
size	integer	Сжатый размер (байты) репозитория.
sshUrl	string
url	string
validRemoteUrls	string[]

GitRepositoryRef

Имя	Тип	Описание
collection	TeamProjectCollectionReference	Коллекция командных проектов, в которой находится эта вилка
id	string
isFork	boolean	Значение true, если репозиторий был создан как вилка
name	string
project	TeamProjectReference	Представляет неглубокую ссылку на TeamProject.
remoteUrl	string
sshUrl	string
url	string

GitStatus

Этот класс содержит метаданные службы или расширения, публикующей состояние.

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на справочные материалы.
context	GitStatusContext	Контекст состояния.
createdBy	IdentityRef	Удостоверение, создающее состояние.
creationDate	string	Дата и время создания состояния.
description	string	Описание состояния. Обычно описывает текущее состояние состояния.
id	integer	Идентификатор состояния.
state	GitStatusState	Состояние состояния.
targetUrl	string	URL-адрес со сведениями о состоянии.
updatedDate	string	Дата и время последнего обновления состояния.

GitStatusContext

Контекст состояния, однозначно определяющий состояние.

Имя	Тип	Описание
genre	string	Жанр состояния. Как правило, имя службы или средства, создающего состояние, может быть пустым.
name	string	Идентификатор имени состояния, не может быть пустым или пустым.

GitStatusState

Состояние состояния.

Имя	Тип	Описание
error	string	Состояние с ошибкой.
failed	string	Сбой состояния.
notApplicable	string	Состояние неприменимо к целевому объекту.
notSet	string	Состояние состояния не задано. Состояние по умолчанию.
pending	string	Состояние ожидания.
succeeded	string	Состояние выполнено успешно.

GitTemplate

Имя	Тип	Описание
name	string	Имя шаблона
type	string	Тип шаблона

GitUserDate

Сведения о пользователе и дата для операций Git.

Имя	Тип	Описание
date	string	Дата операции Git.
email	string	Email адрес пользователя, выполняющего операцию Git.
imageUrl	string	URL-адрес аватара пользователя.
name	string	Имя пользователя, выполняющего операцию Git.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.

IdentityRefWithVote

Сведения об удостоверениях, включая голосование по запросу на вытягивание.

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
isRequired	boolean	Указывает, является ли этот рецензент обязательным для этого запроса на вытягивание. Ветви могут иметь политики, требующие определенных рецензентов для запросов на вытягивание.
profileUrl	string
reviewerUrl	string	URL-адрес для получения сведений об этом удостоверении
uniqueName	string
url	string	Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа.
vote	integer	Проголосуйте по запросу на вытягивание: 10 - утверждено 5 - утверждено с предложениями 0 - без голосования -5 - ожидание автора -10 - отклонено
votedFor	IdentityRefWithVote[]	Группы или команды, в которых участвовал этот рецензент. Группы и команды могут быть рецензентами запросов на вытягивание, но не могут голосовать напрямую. Когда член группы или команды голосует, этот голос свертывается в голос группы или команды. VoteFor — это список таких голосов.

ItemContent

Имя	Тип	Описание
content	string
contentType	ItemContentType

ItemContentType

Имя	Тип	Описание
base64Encoded	string
rawText	string

ProjectState

Состояние проекта.

Имя	Тип	Описание
all	string	Все проекты независимо от состояния.
createPending	string	Проект поставлен в очередь для создания, но процесс еще не запущен.
deleted	string	Проект удален.
deleting	string	Проект находится в процессе удаления.
new	string	Проект находится в процессе создания.
unchanged	string	Проект не был изменен.
wellFormed	string	Проект полностью создан и готов к использованию.

ProjectVisibility

Видимость проекта.

Имя	Тип	Описание
private	string	Проект виден только пользователям с явным доступом.
public	string	Проект виден всем.

PullRequestAsyncStatus

Текущее состояние слияния запроса на вытягивание.

Имя	Тип	Описание
conflicts	string	Слияние запроса на вытягивание завершилось сбоем из-за конфликтов.
failure	string	Не удалось выполнить слияние запроса на вытягивание.
notSet	string	Состояние не задано. Состояние по умолчанию.
queued	string	Слияние запросов на вытягивание помещается в очередь.
rejectedByPolicy	string	Слияние запроса на вытягивание отклонено политикой.
succeeded	string	Слияние запроса на вытягивание выполнено успешно.

PullRequestMergeFailureType

Тип сбоя (если таковой есть) при слиянии запроса на вытягивание.

Имя	Тип	Описание
caseSensitive	string	Слияние запроса на вытягивание завершилось сбоем из-за несоответствия вариантов.
none	string	Тип не задан. Тип по умолчанию.
objectTooLarge	string	Слияние запроса на вытягивание завершилось сбоем из-за слишком большого размера объекта.
unknown	string	Тип сбоя слияния запроса на вытягивание неизвестен.

PullRequestStatus

Состояние запроса на вытягивание.

Имя	Тип	Описание
abandoned	string	Запрос на вытягивание отклоняется.
active	string	Запрос на вытягивание активен.
all	string	Используется в критериях поиска запроса на вытягивание для включения всех состояний.
completed	string	Запрос на вытягивание завершен.
notSet	string	Состояние не задано. Состояние по умолчанию.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

ResourceRef

Имя	Тип	Описание
id	string
url	string

TeamProjectCollectionReference

Объект reference для TeamProjectCollection.

Имя	Тип	Описание
id	string	Идентификатор коллекции.
name	string	Имя коллекции.
url	string	URL-адрес REST коллекции.

TeamProjectReference

Представляет неглубокую ссылку на TeamProject.

Имя	Тип	Описание
abbreviation	string	Сокращение проекта.
defaultTeamImageUrl	string	URL-адрес образа удостоверения команды по умолчанию.
description	string	Описание проекта (при наличии).
id	string	Идентификатор проекта.
name	string	Имя проекта.
revision	integer	Редакция проекта.
state	ProjectState	Состояние проекта.
url	string	URL-адрес полной версии объекта.
visibility	ProjectVisibility	Видимость проекта.

VersionControlChangeType

Тип изменения, внесенного в элемент.

Имя	Тип	Описание
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

Представление определения тега, которое передается по сети.

Имя	Тип	Описание
active	boolean	Является ли определение тега активным.
id	string	Идентификатор определения тега.
name	string	Имя определения тега.
url	string	URL-адрес ресурса для определения тега.

Поделиться через

Pull Requests - Update

Параметры URI

Текст запроса

Ответы

Безопасность

oauth2

Scopes

Примеры

Enable auto-completion and set other completion options

Sample Request

Sample Response

Update description

Sample Request

Sample Response

Update title

Sample Request

Sample Response

Определения

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

Дополнительные ресурсы