Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Modifying the Ignored Files of a Task
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying the Ignored Files of a Task

Function

This API is used to modify the ignored file configuration of a task based on the task ID, file (directory) path, file (directory) name, and file ignore status. After a file or directory is ignored, the file or directory will not be checked.

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:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v4/task/{task_id}/ignore-files

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

Range

1 to 32 characters.

Default Value

N/A

Request Parameters

Table 2 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 3 Request body parameters

Parameter

Mandatory

Type

Description

nodes

No

Array of UpdateIgnoreFilesRepoTreeNode objects

Definition:

List of nodes in the file tree whose ignore status needs to be updated.

Constraints:

N/A

Range:

N/A

Default value:

N/A
Table 4 UpdateIgnoreFilesRepoTreeNode

Parameter

Mandatory

Type

Description

name

No

String

Definition:

Node name.

Constraints:

N/A

Range:

N/A

Default value:

N/A

file_path

No

String

Definition:

File path.

Constraints:

N/A

Range:

N/A

Default value:

N/A

is_leaf

No

Boolean

Definition:

Whether a node is a leaf node.

Constraints:

N/A

Range:

N/A

Default value:

N/A

checkbox_status

No

String

Definition

Whether the file ignore check box is selected.

Constraints

N/A

Range

  • unchecked: not selected

  • all: selected

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

result

String

Definition:

If the update is successful, the message Ignored files updated. is returned.

Range:

N/A

Status code: 400

Table 6 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 7 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

Modify the ignored file configuration of the task whose ID is 10155df661744d1f98f0055f1236702d. Unselect the CppDemo/CppDemoView.h path (that is, do not ignore the file) and select the CppDemo/KnightMath path (that is, ignore the file).

PUT https://{endpoint}/v4/task/10155df661744d1f98f0055f1236702d/ignore-files

{
  "nodes" : [ {
    "file_path" : "CppDemo/CppDemoView.h",
    "name" : "CppDemoView.h",
    "is_leaf" : true,
    "checkbox_status" : "unchecked"
  }, {
    "file_path" : "CppDemo/KnightMath",
    "name" : "KnightMath",
    "is_leaf" : false,
    "checkbox_status" : "all"
  } ]
}

Example Responses

Status code: 200

Request succeeded.

{
  "result" : "Ignored files updated."
}

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