Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Pipeline/ Obtaining the List of Tasks Associated with CodeArts Pipeline
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Obtaining the List of Tasks Associated with CodeArts Pipeline

Function

This API is used to obtain the list of tasks associated with CodeArts pipeline.

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

Read

-

-

-

-

URI

GET https://{hostURL}/v4/repositories/{repository_id}/pipelines/{pipeline_id}/jobs

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

pipeline_id

Yes

Integer

Definition

Pipeline ID.

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 results of the current request.
Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of JobWithStageDto objects

Task phase information
Table 6 JobWithStageDto

Parameter

Type

Description

id

Integer

Task ID

Value range:

1~2147483647

sha

String

Commit ID

ref

String

Branch

status

String

Stage status. pending: queuing; running: running; success: successful; failed: failed; canceled: canceled; skipped: skipped; and timedout: timed out

Enumeration values:

  • pending

  • running

  • success

  • failed

  • canceled

  • skipped

  • timedout

name

String

Job name

target_url

String

Task link

created_at

String

Creation time

updated_at

String

Update time.

started_at

String

Start time

finished_at

String

End time

third_build_id

String

ID of a task in the build system

stage_id

Integer

Stage ID

Value range:

1~2147483647

stage

String

Stage name

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 8 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/2111976239/pipelines/6/jobs

Example Responses

Status code: 200

OK

[ {
  "id" : 31930,
  "sha" : "1c46c505c84853887efe2ea9ea02a1333bae2237",
  "ref" : "dev",
  "status" : "success",
  "name" : "Task 1.",
  "target_url" : "https://example.com/cicd/project/72271b5446614062a01b8be944c9f372/pipeline/detail/724cb378007d4303b91f85161f67d6b0/c9cfdc8b918e44c09ad1cdd8c6b13c78\"",
  "created_at" : "2025-05-17T11:02:25.000+08:00",
  "started_at" : "2025-05-17T11:02:25.000+08:00",
  "finished_at" : "2025-05-17T11:02:56.000+08:00",
  "updated_at\"" : "2025-05-17T11:02:56.000+08:00",
  "third_build_id" : "0ede266890ddd33cff76da30090b9780",
  "stage_id" : 123,
  "stage" : "external"
} ]

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000002",
  "error_msg" : "Recognize authentication information failed."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

OK

401

Unauthorized

404

Not Found

Error Codes

See Error Codes.

Parent topic: Pipeline