Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ MergeRequest/ Obtaining the List of File Change History Versions
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the List of File Change History Versions

Function

This API is used to obtain the history versions list of file change.

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:getMergeRequest

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/merge-requests/{merge_request_iid}/versions

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

merge_request_iid

Yes

Integer

Definition

MR internal ID (IID).

Value range:

1~2147483647
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

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 file change historical versions.
Table 5 Response body parameters

Parameter

Type

Description

id

Integer

Definition:

Diff primary key ID

head_commit_sha

String

Definition:

Head commit node

base_commit_sha

String

Definition:

Base commit node

start_commit_sha

String

Definition

Start commit node.

created_at

String

Definition:

Creation time

merge_request_id

Integer

Definition:

MR primary key ID

state

String

Definition:

Status

real_size

String

Definition:

Diff size

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

GET https://{endpoint}/v4/repositories/2112015544/merge-requests/1/versions

Example Responses

Status code: 200

Obtain the list of history versions list of a file

[ {
  "id" : 5336,
  "merge_request_id" : 76882,
  "head_commit_sha" : "726e1f18234af14f6a154e0c7f6c2d430f73dc8c",
  "base_commit_sha" : "726e1f18234af14f6a154e0c7f6c2d430f73dc8c",
  "created_at" : "2025-08-07T14:29:41.000+08:00",
  "start_commit_sha" : "3015d9cfac5f67bd16dd1dbb4db5a51d689b8010",
  "state" : "collected",
  "real_size" : 5
} ]

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Obtain the list of history versions list of a file

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: MergeRequest