文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Discussion/ 获取仓库检视意见列表
更新时间:2025-07-24 GMT+08:00
分享

获取仓库检视意见列表

功能介绍

获取仓库检视意见列表

调试

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

URI

GET /v4/repositories/{repository_id}/reviews

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

noteable_type

String

参数解释:

意见类型。

取值范围:

  • Commit,提交。

  • MergeRequest,合并请求。

枚举值:

  • Commit

  • MergeRequest

search

String

参数解释:

查询评论内容。

start_date

String

参数解释:

开始日期。

end_date

String

参数解释:

结束日期。

only_count

Boolean

参数解释:

是否仅返回todo。

取值范围:

  • true,仅返回带有提交计数和diffs计数的结果。

  • false,按照compare_view参数返回结果信息。

默认取值:

false

review_categories

String

参数解释:

搜索的检视意见分类。

取值范围:

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

review_modules

String

参数解释:

搜索的检视意见模块。

取值范围:

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

severity

String

参数解释:

检视意见严重程度

枚举值:

  • suggestion

  • minor

  • major

  • fatal

assignee_id

Integer

参数解释:

检视意见指派人id。

取值范围:

1-2147483647

proposer_id

Integer

参数解释:

检视意见检视人id。

取值范围:

1-2147483647

target_branch

String

参数解释:

目标分支名称。

取值范围:

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

取值范围:

1-2000

include_reply

Boolean

参数解释:

是否包含回复。

取值范围:

  • true,包含。

  • false,不包含。

默认取值:

false

order_by

String

参数解释:

排序方式。

取值范围:

  • created,创建时间。

  • updated,更新时间。

默认取值:

created_at

枚举值:

  • created_at

  • updated_at

sort

String

参数解释:

检视意见返回排序

  • asc 按创建时间正序返回

  • desc 按创建时间倒序返回

offset

Integer

参数解释:

偏移量,从0开始。

取值范围:

0-2147483647

默认取值:

0

limit

Integer

参数解释:

返回数量。

取值范围:

1-100

默认取值:

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ReviewDto objects

检视意见详细信息

表5 ReviewDto

参数

参数类型

描述

assignee

UserBasicDto object

参数解释:

检视意见指派人。

author

UserBasicDto object

参数解释:

合并请求或commit作者。

note

String

参数解释:

评论内容。

created_at

String

参数解释:

创建时间。

is_reply

Boolean

参数解释:

是否为回复。

resolved_by

UserBasicDto object

参数解释:

检视意见解决人。

discussion_id

String

参数解释:

检视意见id(主评论和回复共用)。

repository_path

String

参数解释:

仓库路径。

repository_id

Integer

参数解释:

仓库id。

取值范围:

1-2147483647

review_categories

String

参数解释:

意见分类key。

review_categories_cn

String

参数解释:

意见分类中文。

review_categories_en

String

参数解释:

意见分类英文。

review_modules

String

参数解释:

检视意见模块。

severity

String

参数解释:

严重程度key。

枚举值:

  • suggestion

  • minor

  • major

  • fatal

severity_cn

String

参数解释:

严重程度中文。

约束限制:

  • 建议

  • 一般

  • 严重

  • 致命

severity_en

String

参数解释:

严重程度英文。

枚举值:

  • Suggestion

  • Minor

  • Major

  • Fatal

proposer

UserBasicDto object

参数解释:

检视意见检视人。

reviewer

UserBasicDto object

参数解释:

检视意见作者。

resolved

Boolean

参数解释:

是否已解决。

resolved_at

String

参数解释:

解决时间。

link

String

参数解释:

合并请求或commit链接。

moderation_result

Boolean

参数解释:

内容审核结果。

moderation_time

Long

参数解释:

内容审核时间。

moderation_status

Integer

参数解释:

内容审核状态。

merge_request_id

Integer

参数解释:

合并请求id(noteable_type=MergRequest时返回)。

merge_request_iid

Integer

参数解释:

合并请求iid(noteable_type=MergRequest时返回)。

merge_request_title

String

参数解释:

合并请求标题(noteable_type=MergRequest时返回)。

merge_request_state

String

参数解释:

合并请求状态(noteable_type=MergRequest时返回)。

commit_id

String

参数解释:

commit id(noteable_type=Commit时返回)。

表6 UserBasicDto

参数

参数类型

描述

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

参数解释:

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

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

error_msg

String

参数解释:

错误信息。

请求示例

响应示例

状态码:200

OK

[ {
  "assignee" : {
    "id" : 9124,
    "name" : "example_name",
    "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
    "state" : "active",
    "service_license_status" : null,
    "avatar_url" : null,
    "avatar_path" : null,
    "email" : "liujian@example.com",
    "name_cn" : "example_name",
    "web_url" : "https://example.com/c369c68f1ff84679b5a8ed904d8bff1c",
    "nick_name" : "beta_dv",
    "tenant_name" : "example_name",
    "error_message" : null
  },
  "author" : {
    "id" : 9124,
    "name" : "example_name",
    "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
    "state" : "active",
    "service_license_status" : null,
    "avatar_url" : null,
    "avatar_path" : null,
    "email" : "liujian@example.com",
    "name_cn" : "example_name",
    "web_url" : "https://example.com/c369c68f1ff84679b5a8ed904d8bff1c",
    "nick_name" : "beta_dv",
    "tenant_name" : "example_name",
    "error_message" : null
  },
  "note" : "test",
  "created_at" : "2025-06-19T21:56:37.000+08:00",
  "is_reply" : false,
  "resolved_by" : null,
  "discussion_id" : "ba3daf3922c7fa2f7adebff2457d40aaced95d00",
  "repository_path" : "4f96a4f00f17466bab756a2379236c85/mr_test",
  "repository_id" : 2111987241,
  "review_categories" : "realize",
  "review_categories_cn" : "算法实现",
  "review_categories_en" : "Algorithm",
  "review_modules" : 789,
  "severity" : "suggestion",
  "severity_cn" : "建议",
  "severity_en" : "Suggestion",
  "proposer" : {
    "id" : 9124,
    "name" : "example_name",
    "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
    "state" : "active",
    "service_license_status" : null,
    "avatar_url" : null,
    "avatar_path" : null,
    "email" : "liujian@example.com",
    "name_cn" : "example_name",
    "web_url" : "https://example.com/c369c68f1ff84679b5a8ed904d8bff1c",
    "nick_name" : "beta_dv",
    "tenant_name" : "example_name",
    "error_message" : null
  },
  "reviewer" : {
    "id" : 9124,
    "name" : "example_name",
    "username" : "c369c68f1ff84679b5a8ed904d8bff1c",
    "state" : "active",
    "service_license_status" : null,
    "avatar_url" : null,
    "avatar_path" : null,
    "email" : "liujian@example.com",
    "name_cn" : "example_name",
    "web_url" : "https://example.com/c369c68f1ff84679b5a8ed904d8bff1c",
    "nick_name" : "beta_dv",
    "tenant_name" : "example_name",
    "error_message" : null
  },
  "resolved" : false,
  "resolved_at" : null,
  "link" : "https://example.com/********/2111987241/37/mergedetail?source=dev&target=0319-test",
  "moderation_result" : null,
  "moderation_time" : null,
  "moderation_status" : null,
  "merge_request_id" : 72447,
  "merge_request_iid" : 37,
  "merge_request_title" : "mr_title",
  "merge_request_state" : "opened"
} ]

状态码:401

Unauthorized

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

状态码

状态码

描述

200

OK

401

Unauthorized

错误码

请参见错误码

相关文档