Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Creating a Check Task (Version 3)

Updated on 2026-08-10 GMT+08:00

Creating a Check Task (Version 3)

Function

This API is used to create a code check task in a project based on the project ID, repository address, branch, task name, and rule set, and returns the ID of the new code check task.

Calling Method

For details, see Calling APIs.

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
codeartscheck:task:create	Write	task *	-	-	-
codeartscheck:task:create	Write	-	codeartscheck:ProjectId	-	-

URI

POST /v3/task

Request Parameters

**Table 1** 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 The length is the value of [1-100000]. Default Value N/A
Content-Type	Yes	String	Definition Encoding format. Constraints N/A Range N/A Default Value application/json: The return value is in JSON format for any input value.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
branch	Yes	String	Definition: Repository branch. Constraints: N/A. Value range: 1 to 200 characters. Default value: N/A.
config_template	Yes	CreateTaskV3ConfigTemplate object	Definition: Task configuration template parameter, which stores configurations related to the task. Constraints: N/A Value range: N/A Default value: N/A
name	Yes	String	Definition: Task name. Constraints: 1 to 128 characters. The value can contain any letters, digits, periods (.), hyphens (-), and underscores (_). Value range: 1 to 128 characters. Default value: N/A.
project_id	Yes	String	Definition : 32-character project UUID. Obtain it by calling the API used to query the project list. Constraints: N/A Value range: 32-character project ID. Default value: N/A
project_name	Yes	String	Definition : Project name. Obtain the name by calling the API used to query the project list. Constraints: N/A Value range: N/A Default value: N/A
repo_url	Yes	String	Definition: Code repository address. Constraints: N/A Value range: For a CodeArts Repo repository, enter an address starting with git. For a non-CodeArts Repo repository, enter an address starting with http. Default value: N/A

**Table 3** CreateTaskV3ConfigTemplate
Parameter	Mandatory	Type	Description
repo_type	Yes	String	Definition: Code repository type. Constraints: N/A Value range: DevCloud: CodeArts Repo repository. Gitee: Gitee repository. GitHub: GitHub repository. GitPub: Git repository. gitcode: GitCode repository. gitlab: GitLab repository. self_gitlab: self-built GitLab repository. tfs_git: TFS repository. bitbucket: Bitbucket repository. Default value: N/A
branch	Yes	String	Definition: Branch name. Constraints: N/A Range: N/A Default value: N/A
rule_sets	Yes	Array of ConfigTemplateRuleSet objects	Definition Rule set list. Constraints N/A
project_id	No	String	Definition : 32-character project UUID. Obtain it by calling the API used to query the project list. Constraints: N/A Value range: 32-character project ID. Default value: N/A
project_name	No	String	Definition : Project name. Obtain the name by calling the API used to query the project list. Constraints: N/A Value range: N/A Default value: N/A
authId	No	String	Definition: The ID of an existing code source endpoint for storing repository information in a project. Constraints: This parameter is mandatory for repositories other than CodeArts Repo. Range: N/A Default value: N/A
authType	No	String	Definition: Authorization type. Constraints: This parameter is mandatory for repositories other than CodeArts Repo. Value range: DevCloud: CodeArts Repo repository. Gitee: Gitee repository. GitHub: GitHub repository. GitPub: Git repository. gitcode: GitCode repository. gitlab: GitLab repository. self_gitlab: self-built GitLab repository. tfs_git: TFS repository. bitbucket: Bitbucket repository. Default value: N/A

**Table 4** ConfigTemplateRuleSet
Parameter	Mandatory	Type	Description
language	No	String	Definition Language type. Constraints N/A Range Custom language or system language. The following system languages are supported: ARKTS C# CANGJIE C++ CSS GO HTML JAVA JAVASCRIPT KOTLIN LUA PHP PYTHON RUST SCALA SHELL SQL TERRAFORM TYPESCRIPT AZURERESOURCEMANAGER DOCKER KUBERNETES Default Value N/A

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
result	CreateTaskV3Result object	Definition: Result of creating a check task.
httpStatus	String	Definition: HTTP response status. Value range: OK: The request has been successfully processed, and the server returns the requested resource or operation result. ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations). INTERNAL_SERVER_ERROR: internal API exception. BAD_REQUEST: abnormal parameter verification.
status	String	Definition: API response status. Value range: success: successful response. error: response failed.

**Table 6** CreateTaskV3Result
Parameter	Type	Description
id	String	Definition Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID. Range N/A
checkParamList	Array of CustomParameter objects	Definition Custom parameters.
criterionSets	Array of ConfigTemplateRuleSetInfo objects	Definition Rule set list. Generally, an empty array [] is returned.
customParams	Array of CustomParameter objects	Definition Custom parameter list. Generally, an empty array [] is returned.
enableSubModule	Boolean	Definition Whether to support sub-modules. Range N/A
modelSets	Array of strings	Definition Model set list. Generally, an empty array [] is returned.
reviewData	Array of strings	Definition Gate configuration. Generally, an empty array [] is returned.
ruleSets	Array of strings	Definition Rule set configuration. Generally, an empty array [] is returned.
smLevelSwitch	Boolean	Definition Whether to support SM series cryptographic algorithms. Range true: enabled false: disabled
taskIds	Array	Definition Task ID list. Generally, an empty array [] is returned.
versionUpdateDelayDays	Array	Definition Version upgrade buffer period. Generally, an empty array [] is returned.

**Table 7** ConfigTemplateRuleSetInfo
Parameter	Type	Description
language	String	Definition Language type. Range Custom language or system language. The following system languages are supported: ARKTS C# CANGJIE C++ CSS GO HTML JAVA JAVASCRIPT KOTLIN LUA PHP PYTHON RUST SCALA SHELL SQL TERRAFORM TYPESCRIPT AZURERESOURCEMANAGER DOCKER KUBERNETES
ruleSetId	String	Definition: Rule set ID. Value range: 1 to 32 characters.

**Table 8** CustomParameter
Parameter	Type	Description
isPrivate	Boolean	Definition: Private parameter or not. Value range: true: The parameter is private. false: The parameter is not private.
key	String	Definition: Key of a custom parameter. Value range: 1 to 128 characters.
value	String	Definition: Value of a custom parameter. Value range: 1 to 8,192 characters.

Status code: 400

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 401

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

Create a code check task named CppWebHookTest, with the branch being master, the check language being C++, and the repository type being CodeArts Repo in the project whose project ID is 8c7c74775f4f496596e4a39d34b209c3 and project name is projectName.

POST https://{endpoint}/v3/task

{
  "repo_url" : "git@codehub.devcloud.example.com:8c7c74775f4f496596e4a39d34b209c3/CppWebHookTest.git",
  "branch" : "master",
  "name" : "CppWebHookTest",
  "config_template" : {
    "branch" : "master",
    "repo_type" : "DevCloud",
    "rule_sets" : [ {
      "language" : "C++"
    } ],
    "project_id" : "8c7c74775f4f496596e4a39d34b209c3",
    "project_name" : "projectName"
  },
  "project_id" : "8c7c74775f4f496596e4a39d34b209c3",
  "project_name" : "projectName"
}

Example Responses

Status code: 200

Request succeeded.

{
  "httpStatus" : "OK",
  "result" : {
    "checkParamList" : [ ],
    "criterionSets" : [ ],
    "customParams" : [ ],
    "id" : "8df8d58f832a408f88e4aebea0ff6fc5",
    "modelSets" : [ ],
    "reviewData" : [ ],
    "ruleSets" : [ ],
    "taskIds" : [ ],
    "versionUpdateDelayDays" : [ ]
  },
  "status" : "success"
}

Status code: 400

A request error occurred.

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

The permission is insufficient.

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code	Description
200	Request succeeded.
400	A request error occurred.
401	The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management

Previous topic: Obtaining the Check List Based on the Task Type

Next topic: Querying System Configuration

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.

Chatbot