Obtaining a Review List

repository_id

Yes

String

Explanation:

Repository ID.

Constraints:

Mandatory

Range:

Minimum value: 1

Maximum value: 214748364

merge_request_iid

Yes

Integer

Explanation:

MR IID (MR sequence number in the repository).

Constraints:

Mandatory

Range:

Minimum value: 1

Maximum value: 2147483647

type

No

String

Explanation:

Review comment type.

Range:

• user: Review comments created by a user.
• system: Review comments created by the system.

unresolved

No

String

Explanation:

Whether to return unresolved reviews.

Range:

• true: Yes
• false: No

view

No

String

Explanation:

Whether to return basic or detailed information.

Range:

• basic: Return basic information.
• simple: Return detailed information.

author_id

No

String

Explanation:

A user ID or username for filtering review comments created by a user.

Range:

Max. 255 characters.

page

No

Integer

Explanation:

Number of the page whose review comments will be returned.

Range:

Minimum value: 1

Maximum value: 2147483647

Default value:

1

per_page

No

Integer

Explanation:

Pagination parameter, which indicates the number of comments displayed on each page.

Range:

Minimum value: 1

Maximum value: 100

Default value:

20

error

Error object

Explanation:

Response error code.

result

Array of MergeRequestDiscussionDto object

Explanation:

Review comment information.

Range:

None

status

String

Explanation:

Response status.

Range:

• success: The API call is successful.
• failed: The API call failed.

code

String

Explanation:

Error code returned when the API fails to be called.

Range:

• CH.10000. The system is busy. Try again later.

message

String

Explanation:

Error message returned when the API fails to be called.

Range:

• The system is busy. Try again later.

id

String

Explanation:

ID shared by the main comment and reply, which is generally called discussion_id.

Range:

40 digits and letters.

individual_note

Boolean

Explanation:

Whether the comment is individual and does not need resolution by others.

Range:

• true: Yes
• false: No

notes

Array of NoteDto objects

Explanation:

Main comment and reply list. The first one is the main comment. (This API is used to create a main comment. Therefore, there is only one comment.)

Range:

None

project_id

Integer

Explanation:

Repository ID.

Range:

Minimum value: 1

Maximum value: 2147483647

noteable_type

String

Explanation:

Comment type.

Range:

• MergeRequest: Comment for MR (When you select a commit under an MR and add a review comment, the comment is still of the MergeRequest type).
• Commit: Comment for code or a specific commit.

commit_id

String

Explanation:

Associated commit ID: SHA value of a commit. This field applies when noteable_type is set to Commit.

Range:

40 digits and letters.

project_full_path

String

Explanation:

Repository path.

Range:

None

a_mode

String

Explanation:

Mode of an associated file before the change. If the file is new, the value is 0.

Range:

File permissions supported by Git, for example, 100644, 100755, 120000, and 160000.

b_mode

String

Explanation:

Mode of an associated file after the change. If the file is deleted, the value is 0.

Range:

File permissions supported by Git, for example, 100644, 100755, 120000, and 160000.

deleted_file

Boolean

Explanation:

Whether an associated file is deleted.

Range:

• true: Yes
• false or null: No

new_file

Boolean

Explanation:

Whether an associated file is new.

Range:

• true: Yes
• false or null: No

resolved

Boolean

Explanation:

Whether the review comment has been resolved.

Range:

• true: Yes
• false or null: No

archived

Boolean

Explanation:

Whether the review comment has been archived. Archived comments cannot be edited, deleted, replied, or resolved.

Range:

• true: Yes
• false or null: No

review_categories

String

Explanation:

Comment type key.

The values of review_categories and review_categories_cnreview_categories_en must match.

Range:

None

review_categories_cn

String

Explanation:

Comment type in Chinese.

The values of review_categories and review_categories_cn must match.

Range:

None

review_categories_en

String

Explanation:

Comment type in English.

The values of review_categories and review_categories_en must match.

Range:

None

review_modules

String

Explanation:

Review comment module.

Range:

None

severity

String

Explanation:

Review comment severity key.

Range:

• suggestion
• minor
• major
• fatal

severity_cn

String

Explanation:

Severity in Chinese.

Range:

• Suggestion
• Minor
• Major
• Fatal

severity_en

String

Explanation:

Severity in English.

Range:

• Suggestion
• Minor
• Major
• Fatal

assignee

UserBasicDto object

Explanation:

Assignee details.

Range:

None

proposer

UserBasicDto object

Explanation:

Reviewer details.

Range:

None

merge_request_version_params

MergeRequestVersionParamsDto object

Explanation:

MR version details.

Range:

None

diff_file

String

Explanation:

File path change.

Range:

None

added_lines

Integer

Explanation:

Number of new lines.

Range:

Minimum value: 0

Maximum value: 2147483647

removed_lines

Integer

Explanation:

Number of deleted lines.

Range:

Minimum value: 0

Maximum value: 2147483647

id

Integer

Explanation:

Comment ID, which is not shared by the main comment and replies.

Range:

Minimum value: 1

Maximum value: 2147483647

type

String

Explanation:

Note type.

Range:

• DiffNote: A comment that needs to be resolved on the file change page.
• MergeRequestNote: A comment that needs to be resolved on the details page.
• null: A comment that does not need to be resolved on the details page.

body

String

Explanation:

Review comment content.

Range:

Maximum length: 8,000 characters.

Characters: Unicode \u0000 to \uffff. Special characters, such as emojis and uncommon characters, are not supported.

Blank: The value cannot be null, an empty string, or only spaces.

attachment

String

Explanation:

Attachment. (This field has been discarded.)

Range:

None

author

UserBasicDto object

Explanation:

Author details.

Range:

None

created_at

String

Explanation:

Creation time.

Constraints:

Format: yyyy-MM-ddTHH:mm:ss.SSS+08:00

updated_at

String

Explanation:

Update time.

Constraints:

Format: yyyy-MM-ddTHH:mm:ss.SSS+08:00

system

Boolean

Explanation:

Whether the comment is generated by the system.

Range:

• true: Yes. The comment is created by the system.
• false: No. The comment is created by a user.

noteable_id

Integer

Explanation:

MR ID.

Range:

Minimum value: 1

Maximum value: 2147483647

noteable_type

String

Explanation:

Comment type.

Range:

• MergeRequest: Comment for MR or CR (When you select a commit under an MR or CR and add a review comment, the comment is still of the MergeRequest type).
• Commit: Comment for code or a specific commit.

commit_id

String

Explanation:

Associated commit ID: SHA value of a commit. This field applies when noteable_type is set to Commit.

Range:

40 digits and letters.

resolvable

Boolean

Explanation:

Whether the comment needs to be resolved.

Range:

• true: Yes
• false or null: No

is_reply

Boolean

Explanation:

Whether the comment is a reply.

Range:

• true: Yes. The comment is a reply.
• false: No. The comment is a main comment.

resolved_by

UserBasicDto object

Explanation:

Comment resolver.

Range:

None

noteable_iid

Integer

Explanation:

MR IID, indicating the sequence number of the MR in the repository.

Range:

Minimum value: 1

Maximum value: 2147483647

discussion_id

String

Explanation:

Review comment ID, which is shared by the main comment and replies.

Range:

40 digits and letters.

project

String

Explanation:

Project path.

Range:

None

diff_file

String

Explanation:

File path change.

Range:

None

diff

String

Explanation:

File content change.

Range:

None

archived

Boolean

Explanation:

Whether the review comment has been archived. Archived comments cannot be edited, deleted, replied, or resolved.

Range:

• true: Yes
• false or null: No

review_categories

String

Explanation:

Comment type key.

The values of review_categories, review_categories_cn, and review_categories_en must match.

Range:

None

review_categories_cn

String

Explanation:

Comment type in Chinese.

The values of review_categories and review_categories_cn must match.

Range:

None

review_categories_en

String

Explanation:

Comment type in English.

The values of review_categories and review_categories_en must match.

Range:

None

review_modules

String

Explanation:

Review comment module.

Range:

None

severity

String

Explanation:

Severity. Non-suggestion reviews cannot be resolved by the assignee, MR creator, or committer.

Range:

• suggestion
• minor

• major
• fatal

severity_cn

String

Explanation:

Severity in Chinese.

Range:

• Suggestion
• Minor
• Major
• Fatal

severity_en

String

Explanation:

Severity in English.

Range:

• Suggestion
• Minor
• Major
• Fatal

file_path

String

Explanation:

File path. (This field has been discarded.)

Range:

None

line

String

Explanation:

Line number. (This field has been discarded.)

Range:

None

assignee

UserBasicDto object

Explanation:

Assignee details.

Range:

None

proposer

UserBasicDto object

Explanation:

Reviewer details.

Range:

None

position

PositionDto object

Explanation:

Code location information to associate the comment with.

Range:

None

resolved

Boolean

Explanation:

Whether the review comment has been resolved.

Range:

• true: Yes
• false or null: No

is_outdated

Boolean

Explanation:

Whether the review comment is for the latest commit.

Range:

• true: Yes
• false or null: No

base_sha

String

Explanation:

Base commit node of the source branch.

Range:

40 digits and letters.

start_sha

String

Explanation:

Latest commit node of the source branch.

Range:

40 digits and letters.

head_sha

String

Explanation:

Latest commit node of the target branch.

Range:

40 digits and letters.

old_path

String

Explanation:

Old file path.

Range:

None

new_path

String

Explanation:

New file path.

Range:

None

position_type

String

Explanation:

Change type.

Range:

None

Default value:

text

old_line

Integer

Explanation:

Line number before change. If the value is less than or equal to 0 or is null, the line is new and displayed in green on the right for comparison.

Range:

–1 to 2147483647 or null

new_line

Integer

Explanation:

New line No.

If the value is less than or equal to 0 or is null, the line is deleted and displayed in red on the left for comparison.

Range:

–1 to 2147483647 or null

id

Integer

Explanation:

User ID.

Range:

Minimum value: 1

Maximum value: 2147483647

name

String

Explanation:

Name.

Range:

Max. 255 characters.

username

String

Explanation:

Username.

Range:

Max. 255 characters.

state

String

Explanation:

Status.

Range:

Max. 255 characters.

avatar_url

String

Explanation:

URL for obtaining the profile picture.

Range:

None

avatar_path

String

Explanation:

Path for obtaining the profile picture.

Range:

None

email

String

Explanation:

Email address.

Range:

None

name_cn

String

Explanation:

Chinese name.

Constraints:

The value is the same as that of username. This field has been discarded.

Range:

None

web_url

String

Explanation:

Homepage URL.

Range:

None

nick_name

String

Explanation:

Alias.

Range:

None

tenant_name

String

Explanation:

Tenant name.

Range:

None

diff_id

Integer

Explanation:

Each MR version has a unique diff_id. (In this API, the MR version is the latest.)

Range:

Minimum value: 1

Maximum value: 2147483647

start_sha

String

Explanation:

Latest commit node of the target branch.

Range:

40 digits and letters.

commit_id

String

Explanation:

Associated commit ID: SHA value of a commit. This field applies when noteable_type is set to Commit.

Range:

40 digits and letters.

200

OK

404

CH.00406001

MergeRequest Not Found

MR information is not found.

Refresh the MR page and try again.