文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ MergeRequest/ 获取可选的合并请求检视人
更新时间:2025-07-15 GMT+08:00
分享

获取可选的合并请求检视人

功能介绍

获取可选的合并请求检视人

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v4/repositories/{repository_id}/merge-requests/assignee-candidates

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

仓库的ID,通过查询用户所有仓库接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

target_branch

String

参数解释:

目标分支。创建MR时,代码将要合入的分支。

merge_request_iid

Integer

参数解释:

合并请求 iid。

取值范围:

1-2147483647

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

search

String

参数解释:

查询关键字,可模糊匹配用户名称、用户昵称、租户名称。

search_by_name_list

String

参数解释:

Search user list by name list。

target_project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

取值范围:

字符串长度32。

view

String

参数解释:

The type of assignee, merge user or approver

枚举值:

  • approver

  • assignee

mode

String

参数解释:

The type of assignee, merge user or approver

枚举值:

  • approver

  • assignee

only_developers

Boolean

参数解释:

The type of memeber, developer

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of MRVoteReviewerDto objects

参数解释:

合并请求检视用户详细信息

表5 MRVoteReviewerDto

参数

参数类型

描述

id

Integer

参数解释:

用户id。

取值范围:

1-2147483647

name

String

参数解释:

用户名称。

username

String

参数解释:

用户名。

state

String

用户状态

service_license_status

Integer

服务级权限状态 0:停用 1:启用

avatar_url

String

用户头像url

avatar_path

String

用户头像路径

email

String

用户邮箱

name_cn

String

用户中文名称

web_url

String

用户个人首页

nick_name

String

用户昵称

tenant_name

String

租户名称

error_message

String

参数解释:

部分查询接口校验到传参里的用户权限不足或不存在时,返回该用户但该字段不为空用于提示。

is_committer

Boolean

参数解释:

是否为committer。

is_verified

Boolean

参数解释:

是否为认证committer。

has_permission

Boolean

参数解释:

是否有相关权限。

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/2112015538/merge-requests/assignee-candidates

响应示例

状态码:200

可选合并请求检视人返回体

{
  "id" : 23559,
  "name" : "example_name/deploy_admin_trust",
  "username" : "0e87c9d84a7f49e786f9ee4bfaaf1b0f",
  "state" : "active",
  "service_license_status" : 1,
  "avatar_path" : null,
  "email" : "0e87c9d84a7f49e786f9ee4bfaaf1b0f@example.com",
  "name_cn" : "example_name/deploy_admin_trust",
  "web_url" : "https://example.com/0e87c9d84a7f49e786f9ee4bfaaf1b0f",
  "nick_name" : null,
  "tenant_name" : "example_name",
  "error_message" : null,
  "is_committer" : false,
  "is_verified" : false,
  "has_permission" : true
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

可选合并请求检视人返回体

401

Unauthorized

错误码

请参见错误码

相关文档