Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the task list
Updated on 2023-11-28 GMT+08:00
View PDF

Querying the task list

Function

This API is used to query the task list of a project based on project_id.

URI

GET /v2/{project_id}/tasks

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Pagination index, offset

Minimum: 0

Default: 0

limit

No

Integer

Number of records displayed on each page. A maximum of 100 records can be displayed on each page.

Minimum: 1

Maximum: 100

Default: 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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.

Minimum: 1

Maximum: 100000

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

tasks

Array of SimpleTaskInfoV2 objects

Task Info

total

Integer

Total
Table 5 SimpleTaskInfoV2

Parameter

Type

Description

task_id

String

Specifies the task ID.

task_name

String

Indicates the task name.

creator_id

String

Creator ID.

git_url

String

Code Repository Address

git_branch

String

Code repository branch. If the MR mode is used, the value is the source branch.

created_at

String

Created

last_check_time

String

Last Check Time

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

GET https://{endpoint}/v2/{task_id}/tasks

Example Responses

Status code: 200

Request succeeded!

{
  "tasks" : [ {
    "task_id" : "435b58e********d01c94a6",
    "task_name" : "CSharp_02201119",
    "creator_id" : "ecadebb5041***9780f3d905e20",
    "git_url" : "git@********_02201119.git",
    "git_branch" : "master",
    "created_at" : "2020-02-20 11:21:11",
    "last_check_time" : "2020-02-20 11:37:46"
  }, {
    "task_id" : "435b58343tg5g36907c1384d01c94a6",
    "task_name" : "CSharp_066",
    "creator_id" : "ecadebb3664*****",
    "git_url" : "git@****_02201119.git",
    "git_branch" : "master",
    "created_at" : "2020-02-20 11:21:11",
    "last_check_time" : "2020-02-20 11:37:46"
  } ],
  "total" : 2
}

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "The network is busy. Please try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "The authentication information has expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: Task Management