Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Advanced Configurations of a Task
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Advanced Configurations of a Task

Function

This API is used to query the advanced configurations of a task by project ID, task ID, and configuration item list on multiple pages. The advanced configurations, including the names, values, and options, are returned.

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

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v2/{project_id}/tasks/{task_id}/settings

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

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

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 32 characters.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

config_list

No

String

Definition:

List of configuration items. The options are customImage, includePaths, authId, reviewData, and taskName. You are not advised to query multiple configuration items at the same time.

Constraints:

N/A

Value range:

  • customImage: custom image.

  • includePaths: checked directories.

  • authId: endpoint ID.

  • reviewData: code check gate.

  • taskName: task name.

offset

No

Integer

Definition:

Offset.

Constraints:

N/A

Value range:

≥0

limit

No

Integer

Definition:

Number of records displayed on each page.

Constraints:

N/A

Value range:

1–1000

Request Parameters

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

Value range:

1–100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

info

Array of TaskAdvancedSettings objects

Information about an advanced configuration.

total

Integer

Total number.
Table 5 TaskAdvancedSettings

Parameter

Type

Description

key

String

Definition:

Name of an advanced configuration.

Value range:

N/A

value

String

Definition:

Value of an advanced configuration.

Value range:

N/A

option_value

String

Definition:

Option for an advanced configuration.

Value range:

N/A

description

String

Definition:

Description of an advanced configuration.

Value 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

GET https://{endpoint}/v2/{project_id}/tasks/{task_id}/settings

Example Responses

Status code: 200

Request succeeded!

{
  "info" : [ {
    "key" : "customImage",
    "value" : "xxxxx",
    "description" : "Custom image.",
    "option_value" : ""
  } ],
  "total" : 1
}

Status code: 400

Bad Request

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

Status code: 401

Unauthorized

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

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management