Help Center> CodeArts Repo> API Reference> APIs> Repository> Obtaining the Repository Branch List

Updated on 2023-09-12 GMT+08:00

View PDF

Obtaining the Repository Branch List

Function

URI

GET /v2/repositories/{repository_id}/branches

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
repository_id	Yes	Integer	Warehouse Short ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
page	No	String	Indicates the page number.
per_page	No	String	Number of data records on each page
match	No	String	Match Conditions

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the user token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
error	Error object	Response error.
result	BranchResponse object	Result
status	String	Status code in a response

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

**Table 6** BranchResponse
Parameter	Type	Description
branches	Array of BranchesItem objects	Branch Information
total	Double	Total

**Table 7** BranchesItem
Parameter	Type	Description
commit	CommitV2 object	Details
diverging_commit_counts	DivergingCommitCounts object	Submitted Discrepancy Qty.
name	String	Branch Name

**Table 8** CommitV2
Parameter	Type	Description
committed_date	String	Submitted
committer_name	String	Committed By
id	String	Submission ID
message	String	Details
short_id	String	Submit Short ID
title	String	Submit Title

**Table 9** DivergingCommitCounts
Parameter	Type	Description
ahead	Double	Leading Submissions
behind	Double	Number of Delayed Submissions

Example Requests

GET https://{endpoint}/v2/repositories/{repository_id}/branches

Example Responses

Status code: 200

{
  "result" : {
    "total" : 1,
    "branches" : [ {
      "name" : "master",
      "commit" : {
        "id" : "2912b8f2328e798f7d544272ffaebfccccb598ab",
        "title" : "Initial commit",
        "message" : "Initial commit",
        "committed_date" : "2021-12-06T09:24:50.000+08:00",
        "short_id" : "2912b8f2",
        "committer_name" : "repo"
      },
      "diverging_commit_counts" : {
        "behind" : 0,
        "ahead" : 0
      }
    } ]
  },
  "status" : "success"
}