Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ MergeRequest/ Obtaining the Review Comment Template List
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the Review Comment Template List

Function

This API is used to obtain the review comment template list.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:repository:getRepository

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/discussion/templates

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

is_default

No

Boolean

Definition

Whether to return the default template.

offset

No

Integer

Definition

Offset, which starts from 0.

Value range:

0~2147483647

Default value:

0

limit

No

Integer

Definition

Number of returned records.

Value range:

1~100

Default value:

20

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-Total

String

Definition

Total number of review comment templates.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of DiscussionTemplateDto objects

Response body for the review comment template
Table 6 DiscussionTemplateDto

Parameter

Type

Description

id

Integer

Definition

Review comment template primary key ID.

Value range:

1~2147483647

template_name

String

Definition

Template name.

description

String

Definition

Description.

assignee_id

Integer

Definition

Default assignee.

Value range:

1~2147483647

categories

String

Definition

Comment type key.

categories_en

String

Definition

Comment type.

categories_cn

String

Definition

Comment type (CN).

modules

Array of strings

Definition

Review comment module.

review_severity

String

Definition

Severity key.

is_default

Boolean

Definition

Whether to set as the default template.

creator_id

Integer

Definition

Template author ID.

Value range:

1~2147483647

created_at

String

Definition

Creation time.

updated_at

String

Definition

Update time.

creator

UserBasicDto object

Definition

Template creator.

assignee

UserBasicDto object

Definition

Template creator.
Table 7 UserBasicDto

Parameter

Type

Description

id

Integer

Definition

User ID.

Value range:

1~2147483647

name

String

Definition

Username.

username

String

Definition

Username.

state

String

Definition:

User status

Value range:

  • active: available account

  • blocked: locked user

  • error: The user is not found

Enumeration values:

  • active

  • blocked

  • error

service_license_status

Integer

Service-level permission status. 0: disabled; 1: enabled

avatar_url

String

User profile picture URL

avatar_path

String

User profile picture path

email

String

User email

name_cn

String

Username (CN)

web_url

String

User homepage

nick_name

String

User alias

tenant_name

String

Tenant name

error_message

String

Definition

When some query APIs detect that the user permission in the transfer parameter is insufficient or the user does not exist, the user is returned but the field is not empty for information.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

None

Example Responses

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

ok

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: MergeRequest