通过

Pull Requests - Update

  • 参考
服务:
Git
API 版本:
5.0

更新拉取请求。

以下是可以使用 API 更新的属性：

  • 状态
  • Title
  • 说明
  • CompletionOptions
  • MergeOptions
  • AutoCompleteSetBy.Id
  • TargetRefName (启用 PR 重定向功能时，) 尝试更新此列表之外的其他属性将导致服务器引发 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

要检索的拉取请求的 ID。
repositoryId
 path True

string

拉取请求的目标分支的存储库 ID。
project
 path

string

项目 ID 或项目名称
api-version
 query True

string

要使用的 API 版本。 应将其设置为“5.0”才能使用此版本的 API。

请求正文

名称 类型 说明
_links

ReferenceLinks

指向其他相关对象的链接。
artifactId

string

唯一标识此拉取请求的字符串。 若要为拉取请求生成项目 ID，请使用以下模板：vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy

IdentityRef

如果设置，则为此拉取请求启用自动完成，这是启用它的标识。
closedBy

IdentityRef

关闭拉取请求的用户。
closedDate

string

关闭拉取请求 (完成、放弃或在外部) 合并的日期。
codeReviewId

integer

拉取请求的代码评审 ID。 内部使用。
commits

GitCommitRef[]

包含在拉取请求中的提交。
completionOptions

GitPullRequestCompletionOptions

影响拉取请求在完成时合并方式的选项。
completionQueueTime

string

拉取请求进入要完成的队列的最近日期。 内部使用。
createdBy

IdentityRef

创建拉取请求的用户的标识。
creationDate

string

创建拉取请求的日期。
description

string

拉取请求的说明。
forkSource

GitForkRef

如果这是来自分叉的 PR，则包含有关其源的信息。
isDraft

boolean

草稿/WIP 拉取请求。
labels

WebApiTagDefinition[]

与拉取请求关联的标签。
lastMergeCommit

GitCommitRef

最近拉取请求合并的提交。 如果为空，则最近的合并正在进行或未成功。
lastMergeSourceCommit

GitCommitRef

上次拉取请求合并时源分支头处的提交。
lastMergeTargetCommit

GitCommitRef

上次拉取请求合并时目标分支头处的提交。
mergeFailureMessage

string

如果已设置，拉取请求合并失败。
mergeFailureType

PullRequestMergeFailureType

如果拉取请求合并有任何) ，则 (失败的类型。
mergeId

string

用于运行拉取请求合并的作业的 ID。 内部使用。
mergeOptions

GitPullRequestMergeOptions

运行拉取请求合并时使用的选项。 这些选项与完成选项不同，因为完成仅发生一次，并且每次拉取请求的源分支更改时都会运行新的合并。
mergeStatus

PullRequestAsyncStatus

拉取请求合并的当前状态。
pullRequestId

integer

拉取请求的 ID。
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

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称 说明
vso.code_write 授予读取、更新和删除源代码、访问有关提交、更改集、分支和其他版本控制项目元数据的能力。 此外，还授予创建和管理拉取请求和代码评审以及通过服务挂钩接收有关版本控制事件的通知的能力。

示例

Enable auto-completion and set other completion options
Update description
Update title

Enable auto-completion and set other completion options

示例请求

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

示例响应

状态代码:
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

示例请求

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

示例响应

状态代码:
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

示例请求

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

示例响应

状态代码:
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

TeamProjectCollection 的引用对象。
TeamProjectReference

表示对 TeamProject 的浅表引用。
VersionControlChangeType

对项所做的更改的类型。
WebApiTagDefinition

通过网络发送的标记定义的表示形式。

ChangeCountDictionary

Object

GitChange

Object
名称 类型 说明
changeId

integer

更改组中更改的 ID。
changeType

VersionControlChangeType

对项所做的更改的类型。
item

string

当前版本。
newContent

ItemContent

更改后的项的内容。
newContentTemplate

GitTemplate

推送新更改时要使用的新内容模板。
originalPath

string

项的原始路径（如果不同于当前路径）。
sourceServerItem

string

服务器上的项的路径。
url

string

用于检索项的 URL。

GitCommitRef

Object

提供描述 Git 提交和关联元数据的属性。

名称 类型 说明
_links

ReferenceLinks

相关 REST 引用链接的集合。
author

GitUserDate

提交的作者。
changeCounts

ChangeCountDictionary

提交中包含的更改类型 (编辑、删除等) 计数。
changes

GitChange[]

提交中包含的更改的枚举。
comment

string

提交注释或消息。
commentTruncated

boolean

指示注释是否从完整的 Git 提交注释消息中截断。
commitId

string

提交的 ID (SHA-1) 。
committer

GitUserDate

提交的提交者。
parents

string[]

此提交的父提交 ID 的枚举。
push

GitPushRef

与此提交关联的推送。
remoteUrl

string

提交的远程 URL 路径。
statuses

GitStatus[]

来自服务和扩展的状态元数据的列表，这些元数据可能会将其他信息关联到提交。
url

string

此资源的 REST URL。
workItems

ResourceRef[]

与此提交关联的工作项列表。

GitForkRef

Object

有关分叉参考的信息。

名称 类型 说明
_links

ReferenceLinks

表示 REST 引用链接集合的类。
creator

IdentityRef

isLocked

boolean

isLockedBy

IdentityRef

name

string

objectId

string

peeledObjectId

string

repository

GitRepository

分叉的存储库 ID。
statuses

GitStatus[]

此类包含发布状态的服务/扩展的元数据。
url

string

GitPullRequest

Object

表示与拉取请求关联的所有数据。

名称 类型 说明
_links

ReferenceLinks

指向其他相关对象的链接。
artifactId

string

唯一标识此拉取请求的字符串。 若要为拉取请求生成项目 ID，请使用以下模板：vstfs:///Git/PullRequestId/{projectId}/{repositoryId}/{pullRequestId}
autoCompleteSetBy

IdentityRef

如果设置，则为此拉取请求启用自动完成，这是启用它的标识。
closedBy

IdentityRef

关闭拉取请求的用户。
closedDate

string

关闭拉取请求 (完成、放弃或在外部) 合并的日期。
codeReviewId

integer

拉取请求的代码评审 ID。 内部使用。
commits

GitCommitRef[]

包含在拉取请求中的提交。
completionOptions

GitPullRequestCompletionOptions

影响拉取请求在完成时合并方式的选项。
completionQueueTime

string

拉取请求进入要完成的队列的最近日期。 内部使用。
createdBy

IdentityRef

创建拉取请求的用户的标识。
creationDate

string

创建拉取请求的日期。
description

string

拉取请求的说明。
forkSource

GitForkRef

如果这是来自分叉的 PR，则包含有关其源的信息。
isDraft

boolean

草稿/WIP 拉取请求。
labels

WebApiTagDefinition[]

与拉取请求关联的标签。
lastMergeCommit

GitCommitRef

最近拉取请求合并的提交。 如果为空，则最近的合并正在进行或未成功。
lastMergeSourceCommit

GitCommitRef

上次拉取请求合并时源分支头处的提交。
lastMergeTargetCommit

GitCommitRef

上次拉取请求合并时目标分支头处的提交。
mergeFailureMessage

string

如果已设置，拉取请求合并失败。
mergeFailureType

PullRequestMergeFailureType

如果拉取请求合并有任何) ，则 (失败的类型。
mergeId

string

用于运行拉取请求合并的作业的 ID。 内部使用。
mergeOptions

GitPullRequestMergeOptions

运行拉取请求合并时使用的选项。 这些选项与完成选项不同，因为完成仅发生一次，并且每次拉取请求的源分支更改时都会运行新的合并。
mergeStatus

PullRequestAsyncStatus

拉取请求合并的当前状态。
pullRequestId

integer

拉取请求的 ID。
remoteUrl

string

内部使用。
repository

GitRepository

包含拉取请求的目标分支的存储库。
reviewers

IdentityRefWithVote[]

拉取请求的审阅者列表及其投票状态。
sourceRefName

string

拉取请求的源分支的名称。
status

PullRequestStatus

拉取请求的状态。
supportsIterations

boolean

如果为 true，则此拉取请求支持多次迭代。 迭代支持意味着可以查看对拉取请求源分支的单个推送，并将在将来的迭代中跟踪一次迭代中留下的注释。
targetRefName

string

拉取请求的目标分支的名称。
title

string

拉取请求的标题。
url

string

内部使用。
workItemRefs

ResourceRef[]

与此拉取请求关联的任何工作项引用。

GitPullRequestCompletionOptions

Object

有关如何完成拉取请求的首选项。

名称 类型 说明
bypassPolicy

boolean

如果为 true，则在完成拉取请求时将显式绕过策略。
bypassReason

string

如果绕过策略，则会存储此原因，说明为何使用绕过。
deleteSourceBranch

boolean

如果为 true，则拉取请求的源分支将在完成后删除。
mergeCommitMessage

string

如果设置，则将用作合并提交的提交消息。
squashMerge

boolean

如果为 true，则拉取请求中的提交将在完成时压缩合并到指定的目标分支中。
transitionWorkItems

boolean

如果为 true，我们将尝试将链接到拉取请求的任何工作项转换为下一个逻辑状态 (即活动 -> 已解决)

triggeredByAutoComplete

boolean

如果为 true，则当前完成尝试是通过自动完成触发的。 内部使用。

GitPullRequestMergeOptions

Object

创建拉取请求合并时使用的选项。

名称 类型 说明
detectRenameFalsePositives

boolean

disableRenames

boolean

如果为 true，则合并期间不会执行重命名检测。

GitPushRef

Object
名称 类型 说明
_links

ReferenceLinks

表示 REST 引用链接集合的类。
date

string

pushId

integer

pushedBy

IdentityRef

url

string

GitRepository

Object
名称 类型 说明
_links

ReferenceLinks

表示 REST 引用链接集合的类。
defaultBranch

string

id

string

isFork

boolean

如此 如果存储库是作为分支创建的
name

string

parentRepository

GitRepositoryRef

project

TeamProjectReference

表示对 TeamProject 的浅表引用。
remoteUrl

string

size

integer

存储库的压缩大小 (字节) 。
sshUrl

string

url

string

validRemoteUrls

string[]

GitRepositoryRef

Object
名称 类型 说明
collection

TeamProjectCollectionReference

此分支所在的团队项目集合
id

string

isFork

boolean

如此 如果存储库是作为分支创建的
name

string

project

TeamProjectReference

表示对 TeamProject 的浅表引用。
remoteUrl

string

sshUrl

string

url

string

GitStatus

Object

此类包含发布状态的服务/扩展的元数据。

名称 类型 说明
_links

ReferenceLinks

参考链接。
context

GitStatusContext

状态的上下文。
createdBy

IdentityRef

创建状态的标识。
creationDate

string

状态的创建日期和时间。
description

string

状态说明。 通常描述状态的当前状态。
id

integer

状态标识符。
state

GitStatusState

状态的状态。
targetUrl

string

包含状态详细信息的 URL。
updatedDate

string

状态的上次更新日期和时间。

GitStatusContext

Object

唯一标识状态的状态上下文。

名称 类型 说明
genre

string

状态的流派。 生成状态的服务/工具的名称通常可以为空。
name

string

状态的名称标识符不能为 null 或空。

GitStatusState

Enumeration

状态的状态。

值 说明
error

出现错误的状态。
failed

状态失败。
notApplicable

状态不适用于目标对象。
notSet

未设置状态。 默认状态。
pending

状态挂起。
succeeded

状态成功。

GitTemplate

Object
名称 类型 说明
name

string

模板的名称
type

string

模板的类型

GitUserDate

Object

Git 操作的用户信息和日期。

名称 类型 说明
date

string

Git 操作的日期。
email

string

Email执行 Git 操作的用户的地址。
imageUrl

string

用户头像的 URL。
name

string

执行 Git 操作的用户的名称。

IdentityRef

Object
名称 类型 说明
_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

Object

标识信息，包括对拉取请求的投票。

名称 类型 说明
_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[]

此审阅者参与的组或团队。
组和团队可以是拉取请求的审阅者，但不能直接投票。 当组或团队的成员投票时，该投票将汇总到组或团队投票中。 VotedFor 是此类投票的列表。

ItemContent

Object
名称 类型 说明
content

string

contentType

ItemContentType

ItemContentType

Enumeration
值 说明
base64Encoded
rawText

ProjectState

Enumeration

项目状态。

值 说明
all

无论状态如何，所有项目。
createPending

项目已排队等待创建，但该过程尚未启动。
deleted

已删除项目。
deleting

正在删除项目。
new

项目正在创建中。
unchanged

项目尚未更改。
wellFormed

项目已完全创建并可供使用。

ProjectVisibility

Enumeration

项目可见性。

值 说明
private

项目仅对具有显式访问权限的用户可见。
public

该项目对所有人都可见。

PullRequestAsyncStatus

Enumeration

拉取请求合并的当前状态。

值 说明
conflicts

拉取请求合并由于冲突而失败。
failure

拉取请求合并失败。
notSet

未设置状态。 默认状态。
queued

拉取请求合并已排队。
rejectedByPolicy

策略拒绝的拉取请求合并。
succeeded

拉取请求合并成功。

PullRequestMergeFailureType

Enumeration

如果拉取请求合并的任何) ，则 (失败类型。

值 说明
caseSensitive

拉取请求合并失败，原因是大小写不匹配。
none

未设置类型。 默认类型。
objectTooLarge

拉取请求合并失败，因为对象太大。
unknown

拉取请求合并失败类型未知。

PullRequestStatus

Enumeration

拉取请求的状态。

值 说明
abandoned

拉取请求被放弃。
active

拉取请求处于活动状态。
all

用于拉取请求搜索条件以包含所有状态。
completed

拉取请求已完成。
notSet

状态未设置。 默认状态。
Object

表示 REST 引用链接集合的类。

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。

ResourceRef

Object
名称 类型 说明
id

string

url

string

TeamProjectCollectionReference

Object

TeamProjectCollection 的引用对象。

名称 类型 说明
id

string

集合 ID。
name

string

集合名称。
url

string

集合 REST URL。

TeamProjectReference

Object

表示对 TeamProject 的浅表引用。

名称 类型 说明
abbreviation

string

项目缩写。
defaultTeamImageUrl

string

默认团队标识图像的 URL。
description

string

如果有任何) ，则 (项目的说明。
id

string

项目标识符。
name

string

项目名称。
revision

integer

项目修订。
state

ProjectState

项目状态。
url

string

对象完整版本的 URL。
visibility

ProjectVisibility

项目可见性。

VersionControlChangeType

Enumeration

对项所做的更改的类型。

值 说明
add
all
branch
delete
edit
encoding
lock
merge
none
property
rename
rollback
sourceRename
targetRename
undelete

WebApiTagDefinition

Object

通过网络发送的标记定义的表示形式。

名称 类型 说明
active

boolean

标记定义是否处于活动状态。
id

string

标记定义的 ID。
name

string

标记定义的名称。
url

string

标记定义的资源 URL。