Example 3: Querying Branches of a Repository

Scenario

This section uses a CodeArts user as an example to guide you how to use an API to query branches of a specified repository.

For details on how to call APIs, see Making an API Request.

Prerequisites

You have enabled CodeArts Repo on the console.

Approach

Query the repository list based on the user token, and then query the branch list of a specified repository based on the repository short ID. The procedure is as follows:

1. Query all repositories of a user.
2. Query branches of a repository.

Step 1: Querying All Repositories of a User

• API information:

  URI: GET v2/projects/repositories

• Request example:

• Response example:

  {
   "result": {
    "total": 40,
    "repositories": [
     {
      "star": false,
      "status": 5,
      "userRole": null,
      "repository_uuid": "25c88b23d4dc400fa7b3e2a152e4d53c",
      "repository_id": 522140,
      "repository_name": "1111111111111",
      "ssh_url": "git@codehub.devcloud.test.area.test.com:testzxq00001/1111111111111.git",
      "https_url": "https://codehub.devcloud.test.area.test.com/testzxq00001/1111111111111.git",
      "group_name": "testzxq00001",
      "web_url": "https://devcloud.test.area.test.com/codehub/522140/home",
      "visibility_level": 0,
      "created_at": "2020-07-22 10:45:56",
      "updated_at": "2020-07-22 10:45:56",
      "repository_size": "0.16M",
      "lfs_size": "0.00M",
      "creator_name": "devcloud_codehub_l00314597_01",
      "domain_name": "devcloud_codehub_l00314597_01",
      "is_owner": 1,
      "iam_user_uuid": "a618e34bd5704be3ae3395dfede06041",
      "project_uuid": "a689e057c2304abfa35d4ff65630a90a",
      "project_is_deleted": "false"
     }
    ]
   },
   "status": "success"}

Step 2: Querying Branches of a Repository

• API information:

  URI: GET v1/repositories/{repository_id}/branches

• Request example:

• Response example:

  {
   "result": {
    "total": 1,
    "branches": [
     {
      "name": "master",
      "is_protected": false
     }
    ]
   },
   "status": "success"
  }