Pull Request Reviewers - Create Pull Request Reviewer

参考

服务:: Git

API 版本:: 7.1

将审阅者添加到拉取请求或投票。

PUT https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
pullRequestId	path	True	integer (int32)	拉取请求的 ID。
repositoryId	path	True	string	拉取请求的目标分支的存储库 ID。
reviewerId	path	True	string	审阅者的 ID。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
hasDeclined	boolean	指示此审阅者是否已拒绝查看此拉取请求。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
isFlagged	boolean	指示此审阅者是否已标记此拉取请求的注意。
isReapprove	boolean	指示是否仍应处理此批准投票，即使投票未更改。
isRequired	boolean	指示此拉取请求是否为必需审阅者。分支可以具有需要特定审阅者才能执行拉取请求的策略。
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
reviewerUrl	string	用于检索有关此标识信息的 URL
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。
vote	integer (int16)	对拉取请求进行投票： 10 - 已批准 5 - 已批准建议 0 - 无投票 -5 - 等待作者 -10 - 拒绝
votedFor	IdentityRefWithVote[]	此审阅者参与的组或团队。组和团队可以是拉取请求的审阅者，但不能直接投票。当组或团队的成员投票时，该投票将汇总到组或团队投票中。 VotedFor 是此类投票的列表。

响应

名称	类型	说明
200 OK	IdentityRefWithVote	成功作

安全性

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

示例

Add a reviewer

Set vote

Add a reviewer

示例请求

HTTP

PUT https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/19d9411e-9a34-45bb-b985-d24d9d87c0c9?api-version=7.1

{
  "vote": 0,
  "id": "19d9411e-9a34-45bb-b985-d24d9d87c0c9"
}

示例响应

状态代码:: 200

{
  "reviewerUrl": "https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/19d9411e-9a34-45bb-b985-d24d9d87c0c9",
  "vote": 0,
  "id": "19d9411e-9a34-45bb-b985-d24d9d87c0c9",
  "displayName": "Johnnie McLeod",
  "uniqueName": "fabrikamfiber2@hotmail.com",
  "url": "https://dev.azure.com/fabrikam/_apis/Identities/19d9411e-9a34-45bb-b985-d24d9d87c0c9",
  "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=19d9411e-9a34-45bb-b985-d24d9d87c0c9"
}

Set vote

示例请求

HTTP

PUT https://dev.azure.com/fabrikam/_apis/git/repositories/3411ebc1-d5aa-464f-9615-0b527bc66719/pullRequests/22/reviewers/d6245f20-2af8-44f4-9451-8107cb2767db?api-version=7.1

{
  "vote": 10,
  "id": "d6245f20-2af8-44f4-9451-8107cb2767db"
}

示例响应

状态代码:: 200

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

定义

名称	说明
IdentityRefWithVote	标识信息，包括对拉取请求的投票。
ReferenceLinks	表示 REST 引用链接集合的类。

IdentityRefWithVote

Object

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

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个有趣的链接。可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
hasDeclined	boolean	指示此审阅者是否已拒绝查看此拉取请求。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用
inactive	boolean	已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType）
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType）
isDeletedInOrigin	boolean
isFlagged	boolean	指示此审阅者是否已标记此拉取请求的注意。
isReapprove	boolean	指示是否仍应处理此批准投票，即使投票未更改。
isRequired	boolean	指示此拉取请求是否为必需审阅者。分支可以具有需要特定审阅者才能执行拉取请求的策略。
profileUrl	string	已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用
reviewerUrl	string	用于检索有关此标识信息的 URL
uniqueName	string	已弃用 - 请改用 Domain+PrincipalName
url	string	此 URL 是指向此图形主题的源资源的完整路由。
vote	integer (int16)	对拉取请求进行投票： 10 - 已批准 5 - 已批准建议 0 - 无投票 -5 - 等待作者 -10 - 拒绝
votedFor	IdentityRefWithVote[]	此审阅者参与的组或团队。组和团队可以是拉取请求的审阅者，但不能直接投票。当组或团队的成员投票时，该投票将汇总到组或团队投票中。 VotedFor 是此类投票的列表。

ReferenceLinks

Object

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

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读链接。

通过

Pull Request Reviewers - Create Pull Request Reviewer

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

Add a reviewer

示例请求

示例响应

Set vote

示例请求

示例响应

定义

IdentityRefWithVote

ReferenceLinks

其他资源