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

获取检视意见模板列表

功能介绍

获取检视意见模板列表

调试

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

URI

GET /v4/repositories/{repository_id}/discussion/templates

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

Integer

参数解释:

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

约束限制:

不涉及。

取值范围:

1-2147483647

表2 Query参数

参数

是否必选

参数类型

描述

is_default

Boolean

参数解释:

是否返回默认模板。

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 DiscussionTemplateDto objects

检视意见模板返回体

表5 DiscussionTemplateDto

参数

参数类型

描述

id

Integer

参数解释:

检视意见模板主键id。

取值范围:

1-2147483647

template_name

String

参数解释:

模板名称。

description

String

参数解释:

描述。

assignee_id

Integer

参数解释:

默认指派人。

取值范围:

1-2147483647

categories

String

参数解释:

意见分类key。

categories_en

String

参数解释:

意见分类英文。

categories_cn

String

参数解释:

意见分类中文。

modules

Array of strings

参数解释:

检视意见模块。

review_severity

String

参数解释:

严重程度key。

is_default

Boolean

参数解释:

是否设置为默认模板。

creator_id

Integer

参数解释:

模板作者id。

取值范围:

1-2147483647

created_at

String

参数解释:

创建时间。

updated_at

String

参数解释:

更新时间。

creator

UserBasicDto object

参数解释:

模板创建者。

assignee

UserBasicDto object

参数解释:

模板创建者。

表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

参数解释:

错误信息。

请求示例

响应示例

状态码:401

Unauthorized

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

状态码

状态码

描述

200

ok

401

Unauthorized

错误码

请参见错误码

相关文档