Obtaining the Latest Task Associated with CodeArts Pipeline
Function
This API is used to obtain the latest 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.
URI
GET https://{hostURL}/v4/repositories/{repository_id}/pipelines/{pipeline_id}/latest-jobs
| 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. Value range: 1~2147483647 |
| pipeline_id | Yes | Integer | Definition Pipeline ID. Value range: 1~2147483647 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Pipeline ID Value range: 1~2147483647 |
| status | String | Pipeline status. pending: queuing; running: running; success: successful; failed: failed; canceled: canceled; skipped: skipped; and timedout: timed out Enumeration values: |
| stages | Array of PipelineStageJobDto objects | Pipeline phase tasks |
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Stage ID Value range: 1~2147483647 |
| name | String | Stage name |
| sort_id | Integer | Stage sequence ID Value range: 1~2147483647 |
| status | String | Stage status. pending: queuing; running: running; success: successful; failed: failed; canceled: canceled; skipped: skipped; and timedout: timed out Enumeration values: |
| jobs | Array of BaseJobDto objects | Task details |
| 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: |
| 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 |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 404
| 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/latest-jobs Example Responses
Status code: 200
OK
{
"id" : 6,
"status" : "success",
"stages" : [ {
"id" : 8125,
"name" : "external",
"status" : "success",
"sort_id" : null,
"jobs" : [ {
"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"
} ]
} ]
} 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.