文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ Repository/ 根据仓库短ID和合并请求短ID获取检视人信息
更新时间：2024-11-11 GMT+08:00
查看PDF
分享

根据仓库短ID和合并请求短ID获取检视人信息

功能介绍

根据仓库短ID和合并请求短ID获取检视人信息。

调试

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

URI

GET/v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/approval-reviewers

表1 Query参数

参数

是否必选

参数类型

描述

repository_id

是

String

参数解释：

仓库短id。

约束限制：

必传。

取值范围：

0-2147483647。

默认取值：

不涉及。

merge_request_iid

是

integer

参数解释：

合并请求的短id。

约束限制：

必传。

取值范围：

0-2147483647。

默认取值：

不涉及。

page

否

integer

参数解释：

每页条目数。

取值范围：

最小值：1

最大值：100

默认取值：

100

per_page

否

integer

参数解释：

每页条目数。

取值范围：

最小值：1

最大值：100

默认取值：

20

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

result

MergeRequestApprovalReviewersDto object

参数解释：

检视人信息。

status

String

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败
表4 MergeRequestApprovalReviewersDto

参数

参数类型

描述

approval_merge_request_reviewers

Array of ApprovalUserDto objects

参数解释：

检视人列表。
表5 ApprovalUserDto

参数

参数类型

描述

id

Integer

参数解释：

自增主键

username

String

参数解释：

用户名

name

String

参数解释：

名称

nick_name

String

参数解释：

昵称

state

String

参数解释：

检视状态

请求示例

GET https://{endpoint}/v2/repositories/{repository_id}/merge-requests/{merge_request_iid}/approval-reviewers

响应示例

状态码： 200

OK 
{
    "result": {
        "approval_merge_request_reviewers": [{
            "id": 453613,
            "name": "test",
            "username": "test",
            "state": "required",
            "nick_name": "test"
        }]
    },
    "status": "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档