Help Center/ CodeArts Repo/ API Reference/ APIs/ Repository/ Querying a Commit of a Repository Branch by the Repository ID

Updated on 2025-01-14 GMT+08:00

View PDF

Querying a Commit of a Repository Branch by the Repository ID

Function

This API is used to query a commit of a repository branch by the repository ID.

URI

GET /v1/repositories/{repository_id}/commits

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Repository primary key ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
author	No	String	Committer.
begin_date	No	String	Start commit date, in the format of yyyy-MM-dd.
end_date	No	String	End commit date, in the format of yyyy-MM-dd.
message	No	String	Commit message.
page_index	No	Integer	Page index. Default value: 1
page_size	No	Integer	Number of records on each page. Default value: 10
path	No	String	File path.
ref_name	Yes	String	Branch or tag name, in SHA format.
stat_format	No	String	Commit file change details (excluding diff)

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Explanation: User token. It can be obtained by calling the corresponding IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: Mandatory Range: 1–100,000 characters. Default value: None

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	CommitList object	Response result.
status	String	Response status.

**Table 5** Error
Parameter	Type	Description
code	String	Error code.
message	String	Error message.

**Table 6** CommitList
Parameter	Type	Description
commits	Array of Commit objects	Commit list.
total	Integer	Total commits.

**Table 7** Commit
Parameter	Type	Description
author_email	String	Author email.
author_name	String	Author.
authored_date	String	Author commit time.
committed_date	String	Commit time.
committer_email	String	Committer email.
committer_name	String	Committer.
format	Object	File change details. The format is determined by the stat_format parameter.
id	String	SHA ID of a commit.
message	String	Commit message.
parent_ids	Array of strings	Parent commit ID.

Example Requests

null

GET https://{endpoint}/v1/repositories/{repository_id}/commits

Example Responses

Status code: 200

{
  "result" : {
    "total" : 1,
    "commits" : [ {
      "id" : "a27fafa7d8da2dd55f691bef989226d22f50d8ce",
      "message" : "Initial commit",
      "parent_ids" : [ ],
      "authored_date" : null,
      "author_name" : "repo",
      "author_email" : "repo@huawei.com",
      "committed_date" : "2019-10-15 09:40:29",
      "committer_name" : "repo",
      "committer_email" : "repo@huawei.com"
    } ]
  },
  "status" : "success"
}