Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Executing a Check Task
Updated on 2023-11-28 GMT+08:00
View PDF

Executing a Check Task

Function

Execute the check task.

URI

POST /v2/tasks/{task_id}/run

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

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

Content-Type

Yes

String

Media type and encoding format.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

username

No

String

Name of the user who has the permission on the temporary repository corresponding to the task.

access_token

No

String

Token of the user who has the permission on the temporary repository corresponding to the task.

git_url

No

String

Temporary repository address corresponding to the task.

git_branch

No

String

Temporary warehouse branch corresponding to the task.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

exec_id

String

Execution ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Execute the check task. The URL of the code repository corresponding to the task is displayed based on the site requirements. The branch of the code repository is master, and the user name is displayed based on the site requirements.

POST https://{endpoint}/v2/tasks/{taskid}/run

{
  "git_url" : "http://github.xxxxxxxx.git",
  "git_branch" : "master",
  "username" : "test",
  "access_token" : "xLD56xxxxxxxxxJF3Sdxxxx"
}

Example Responses

Status code: 200

Request succeeded!

{
  "exec_id" : "d163535d0*******81d6a7654443e"
}

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