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

Creating a Check Task

Function

Create a check task but do not execute it.

URI

POST /v2/{project_id}/task

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token.

It can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Minimum: 1

Maximum: 100000

Content-Type

Yes

String

Media type and encoding format.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

check_type

No

Array of strings

Check type, in array format. The default value is source.

git_url

Yes

String

Repository address

git_branch

Yes

String

Repository Branch

language

Yes

Array of strings

Check language. The value is in array format and can be cpp,java,js,python,php,css,html,go,typescript,csharp.

rule_sets

No

Array of RuleSetV2 objects

Specifying a Rule Set

task_type

No

String

Check type. The value can be full or inc. full indicates full check, and inc indicates MR check.

username

No

String

Name of the user who has the permission to access the repository.

access_token

No

String

Token of a user who has permission on the repository.

endpoint_id

No

String

Specifies the endpoint ID of the user who has the repository permission.

inc_config

No

IncConfigV2 object

Parameters related to incremental check

enable_fossbot

No

Boolean

Indicates whether to enable fossbot check. By default, fossbot check is disabled.

resource_pool_id

No

String

Specifies the resource pool ID, which can be obtained from the resource pool management page.
Table 4 RuleSetV2

Parameter

Mandatory

Type

Description

ruleset_id

No

String

Rule set ID, which needs to be obtained from the web page.

language

Yes

String

Check the language. cpp,java,js,python,php,css,html,go,typescript,csharp is supported.
Table 5 IncConfigV2

Parameter

Mandatory

Type

Description

parent_task_id

No

String

ID of the parent task to be associated. This parameter is required for pipeline creation or MR creation.

git_source_branch

No

String

Incrementally check code source branches.

git_target_branch

No

String

Incrementally check the code target branch.

merge_id

No

String

Unique MR ID

event_type

No

String

Webhook triggering event type. The options are merge_request and push_request.

action

No

String

Webhook event status, which can be open, close, or update.

title

No

String

MR Title

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

task_id

String

Specifies the check task ID.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

Create a check task. The check type of the check task is source, the corresponding code repository URL is displayed based on the site requirements, the code repository branch is master, and the language type is cpp.

POST https://{endpoint}/v2/{project_id}/task

{
  "check_type" : [ "source" ],
  "git_url" : "git@code*****************958.git",
  "git_branch" : "master",
  "language" : [ "cpp", "js" ]
}

Example Responses

Status code: 200

Request succeeded!

{
  "task_id" : "d161fd0**********cb3c1d6a783e"
}

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