Querying a Task by ID

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

task_id

Yes

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.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

merge_id

No

String

Definition:

Merge request ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

job_id

No

String

Definition :

Execution record ID, that is, the unique ID of each version or quality gate scan. Obtain the ID by calling the API used to execute the check task.

Constraints:

N/A

Value range:

1 to 64 characters.

Default value:

N/A

operator

No

String

Definition:

Operator.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

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.

result

TaskBasicInfoV3 object

Definition:

Task information.

Range:

N/A

status

String

Definition:

API response status.

Value range:

• success: successful response.

• error: response failed.

avastarType

String

Definition:

Avatar color.

Value range:

• pure-blue: blue.

• pure-purple: purple.

• pure-tomato: red.

• pure-green: green.

• pure-orange: orange.

• pure-pink: pink.

branchName

String

Definition:

Branch name.

Value range:

1 to 200 characters.

canChangeIgnoreMode

Boolean

Definition:

Whether the ignored file mode can be updated.

Value range:

• true: The ignored file mode can be updated.

• false: The ignored file mode cannot be updated.

canDelete

Boolean

Definition:

Whether the user has the delete permission.

Value range:

• true: The delete permission is granted.

• false: The delete permission is not granted.

canEdit

Boolean

Definition:

Whether the user has the edit permission.

Value range:

• true: The edit permission is granted.

• false: The edit permission is not granted.

canEditTemplateSwitch

Boolean

Definition:

Whether the user has permission for switching task templates.

Value range:

• true: The user has permission for switching task templates.

• false: The user does not have permission for switching task templates.

canExecute

Boolean

Definition:

Whether the user has the execute permission.

Value range:

• true: The execute permission is granted.

• false: The execute permission is not granted.

canRead

Boolean

Definition:

Whether the user has the read permission.

Value range:

• true: The read permission is granted.

• false: The read permission is not granted.

checkParamList

Array of CustomParameter objects

Definition:

Custom parameters.

Range:

N/A

checkParamMap

checkParamMap object

Definition:

A map-format representation of the custom parameter list checkParamList. For example, if checkParamList contains a parameter with key param1 and value value1, then checkParamMap will include a field param1 with value value1.

Value range:

N/A

configTemplateId

String

Definition:

ID of the task configuration template.

Value range:

1 to 128 characters.

createTime

String

Definition:

Task creation time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

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.

defaultBranchName

String

Definition:

Name of the default branch.

Value range:

1 to 200 characters.

fileEncoding

String

Definition:

File code.

Value range:

• UTF-8: UTF-8 format.

• GBK: GBK format.

hwCloudRegion

String

Definition:

Huawei Cloud region.

Value range:

1 to 32 characters.

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.

Value range:

1 to 128 characters.

includePaths

String

Definition:

Checked directory.

By default, all code in the code repository is checked.

If you specify one or more directories, the files in the specified directories are checked.

Value range:

1 to 200 characters.

isSetMrWebhook

Boolean

Definition:

Whether to enable the function of triggering a task when a merge request is created.

Value range:

• true: enabled.

• false: disabled.

isSetPushWebhook

Boolean

Definition:

Whether to enable the function of triggering a task upon code commit.

Value range:

• true: enabled.

• false: disabled.

isSetWebhook

Boolean

Definition:

Whether to enable the function of triggering a task when a merge request is created.

Value range:

• true: enabled.

• false: disabled.

isTemplateTask

Boolean

Definition:

Task template or not.

Range:

• true: task template.

• false: not a task template.

jobId

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID.

Value range:

1 to 128 characters.

jobTimeout

String

Definition:

Timeout interval, in minutes. The format is fixed at xxx min, where xxx is an integer. 0 < xxx ≤ 1200.

Range:

N/A

lastFinishedFullJobId

String

Definition:

Execution ID of the last check task.

Range:

1 to 128 characters.

lastJob

JobBasicInfoV3 object

Definition:

Execution record information.

Range:

N/A

lastReviser

String

Definition:

Last modifier of the task.

Range:

N/A

lastUpdateTime

String

Definition:

Time (UTC) when a task was last updated. Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

modelSets

Array of strings

Definition:

Model set list. Generally, an empty array [] is returned.

mrCheckBranchStrategy

Integer

Definition:

Gate policy for the MR check branch.

Value range:

• 0: whitelist.

name

String

Definition:

Code check task name.

Value range:

1 to 128 characters.

notificationConfig

String

Definition:

Whether to use the project notification settings. The value is in the format of x,x,x,x,x,x, where x can be 0 or 1.

If x is 0, the notification settings of the task are used. If x is 1, the notification settings of the project are used.

From left to right, x indicates system notifications, email notifications, WeCom notifications, DingTalk notifications, Feishu notifications, and webhooks.

Value range:

The value is in the format of x,x,x,x,x,x, where x can be 0 or 1.

owner

String

Definition:

Owner of a code check task.

Value range:

1 to 255 characters.

ownerId

String

Definition:

ID of an owner of a code check task.

Value range:

1 to 64 characters.

projectId

String

Definition :

32-character project UUID. Obtain it by calling the API used to query the project list.

Value range:

32 characters.

projectName

String

Definition:

Project name.

Value range:

1 to 128 characters.

region

String

Definition:

Region. The value is suzhou.

Value range:

suzhou.

repoId

String

Definition:

ID of the CodeArts Repo repository corresponding to the code repository address.

Value range:

1 to 128 characters.

repoUrl

String

Definition:

Code repository address.

Value range:

1 to 1,024 characters.

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.

source

String

Definition:

Task source, typically set to "customer".

Value range:

customer.

taskGroupId

String

Definition:

Task group ID.

Value range:

1 to 128 characters.

taskIds

Array of strings

Definition:

Task ID list. Generally, an empty array [] is returned.

tenantId

String

Definition:

Tenant ID of the task. The ID is obtained from IAM.

Value range:

1 to 32 characters.

useCache

Boolean

Definition:

Whether to use the cache to query task information.

Value range:

• true: Cache is used.

• false: Cache is not used.

useWorkspaceNotificationConfig

Integer

Definition:

Whether to use the project notification configuration items. The value is derived by applying a bitwise NOT operation to the corresponding binary value in notificationConfig, then converting the result to a decimal number.

For example, if notificationConfig is set to 1,1,0,1,0,0, its binary value is 110100. After applying a bitwise NOT operation, it becomes 001011, which converts to the decimal value 11. In this case, the value of useWorkspaceNotificationConfig is 11.

Value range:

0–31

versionUpdateDelayDays

Array of strings

Definition:

Version upgrade buffer period. Generally, an empty array [] is returned.

webhookCheckMode

Integer

Definition:

Webhook check mode. Generally, the value is 0, indicating that MRs from other code repositories are not allowed.

Value range:

0

zone

String

Definition:

Region, which is generally green.

Range:

green.

param1

String

Definition:

The name of the field is the key of the custom parameter, and the value of the field is the value of the custom parameter.

Value range:

1 to 8,192 characters.

param2

String

Definition:

The name of the field is the key of the custom parameter, and the value of the field is the value of the custom parameter.

Value range:

1 to 8,192 characters.

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.

Range:

1 to 128 characters.

value

String

Definition:

Value of a custom parameter.

Value range:

1 to 8,192 characters.

executor

String

Definition:

Name of the user who executes the task.

Value range:

1 to 255 characters.

finishTime

String

Definition:

Execution completion time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

id

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID.

Value range:

1 to 32 characters.

jobResult

JobResultInfo object

Definition:

Execution result.

Range:

N/A

jobType

String

Definition:

Task type.

Range:

• FULL: version-level task.

• INC_GIT: gate-level task.

• INC_COMMIT: incremental check of a specified commit ID in a pipeline.

• INC_LAST_SUCCESS_COMMIT: incremental check between the commit ID specified by a pipeline and the commit ID of the last successful gate check.

process

ProcessInfo object

Definition:

Execution record information.

Range:

N/A

reviewResult

String

Definition:

Gate check result.

Range:

• success: The gate is passed.

• error: The gate is not passed.

ruleSets

Array of ConfigTemplateRuleSetInfo objects

Definition:

Rule set configurations.

source

String

Definition:

Trigger source.

Value range:

• customer: triggered manually.

• Scheduled: triggered by a scheduled task.

• CodeCheckEdge: triggered by Edge.

• CodeArtsPipeline: triggered by a pipeline.

• DevCloudWebhook: triggered by a webhook from CodeArts Repo.

• GitCodeActionPipeline: triggered by the GitCodeAction plug-in from the CodeArts Pipeline.

sourceRepoUrl

String

Definition:

Code repository address of the source branch.

Value range:

1 to 1,024 characters.

startTime

String

Definition:

Execution start time (UTC). Format: yyyy-MM-ddTHH:mm:ssZ. For example, 2025-11-28T06:55:41Z.

Value range:

N/A

status

String

Definition:

Task execution status.

Range:

• quering: initial state.

• running: task being executed.

• success: check successful.

• failed: check failed.

• aborted: task aborted.

subJobIds

Array of strings

Definition:

Sub-task ID. Generally, an empty array [] is returned.

subJobStatuses

Array of strings

Definition:

Sub-task status. Generally, an empty array [] is returned.

targetRepoUrl

String

Definition:

Code repository address of the target branch.

Value range:

1 to 1,024 characters.

taskId

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.

Value range:

1 to 32 characters.

totalExecuteTime

String

Definition:

Task execution duration. The format is %dm%ds, for example, 6m6s.

Value range:

N/A

CRITICAL

Integer

Definition:

Number of major issues.

Value range:

≥0

DELAYSTATUS_COUNT

Integer

Definition:

Number of deferred issues.

Value range:

≥0

FATAL

Integer

Definition:

Number of critical issues.

Value range:

≥0

GENERAL

Integer

Definition:

Number of minor issues.

Value range:

≥0

INFO

Integer

Definition:

Number of information issues.

Value range:

≥0

PROMPT

Integer

Definition:

Number of suggestions.

Value range:

≥0

codeLine

Integer

Definition:

Number of scanned code lines, excluding blank and comment lines.

Value range:

≥0

defectCount

Integer

Definition:

Total bugs.

Value range:

≥0

dismissed

Integer

Definition:

Number of ignored issues.

Value range:

≥0

fileTotal

Integer

Definition:

Total number of files.

Value range:

≥0

fixed

Integer

Definition:

Number of fixed issues.

Value range:

≥0

id

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID.

Value range:

N/A

jobId

String

Definition:

Execution ID, which is returned by the API of code check task execution. Each code check task has a unique execution ID.

Value range:

N/A

newUnsolvedDefectCount

Integer

Definition:

Number of new issues that are not resolved.

Value range:

≥0

nonSecurityDefectCount

Integer

Definition:

Number of non-security issues.

Value range:

≥0

reviewResult

String

Definition:

Gate check result.

Range:

• success: The gate is passed.

• error: The gate is not passed.

securityDefectCount

Integer

Definition:

Number of security issues.

Value range:

≥0

solvedDefectCount

Integer

Definition:

Number of resolved issues.

Range:

N/A

unsolvedDefectCount

Integer

Definition:

Number of unresolved issues.

Range:

N/A

exeTime

String

Definition:

Execution time, in seconds.

Range:

N/A

executeTime

String

Definition:

Execution time. The format is %dm%ds, for example, 6m6s.

Value range:

N/A

message

String

Definition:

Execution process.

Range:

N/A

process

String

Definition:

Task execution progress, in percentage.

Range:

N/A

status

String

Definition:

Task execution status.

Range:

• quering: initial state.

• running: task being executed.

• success: check successful.

• failed: check failed.

• aborted: task aborted.

language

String

Definition:

Language type.

Value 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

ruleSetId

String

Definition:

Rule set ID.

Value range:

1 to 32 characters.

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

200

Request succeeded!

400

Bad Request

401

Unauthorized