Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Obtaining Branches Associated with a Badge
Updated on 2025-08-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining Branches Associated with a Badge

Function

This API is used to obtain branches associated with a badge.

Calling Method

For details, see Calling APIs.

URI

GET /v1/job/{job_id}/badge/branches

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

job_id

Yes

String

Definition

Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL.

Constraints

N/A.

Range

The value is 32 characters long. Only letters and digits are allowed.

Default Value

N/A.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Details:

Number of items displayed on each page. The value of limit is no more than 100.

Constraints:

N/A

Value Range:

Only numbers that are 100 or less can be used.

offset

No

Integer

Definition

The index of the page to start the query from.

Constraints

N/A.

Range

Use only numbers that are 0 or greater.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Status.

result

Array of strings

Definition

Returned result: branch information.

Constraints

N/A.

Range

N/A.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/job/{job_id}/badge/branches

Example Responses

Status code: 200

OK

{
  "result" : [ "master" ],
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent Topic: Build Task Management