Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Selected Rule Sets of a Task (Version 3)
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Selected Rule Sets of a Task (Version 3)

Function

This API is used to query the selected and enabled rule sets of a task based on the project ID and task ID. The rule set name, ID, and language are returned. Pagination query is supported.

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 /v3/{project_id}/tasks/{task_id}/rulesets

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:

1 to 32 characters.

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

Range

1 to 32 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

needExtendInfo

No

String

Definition

Whether extended information is required, including disabled rule sets of the same language, rule set names, and usage status.

Constraints

N/A

Range

  • true: required

  • false: not required

offset

No

Integer

Definition

Page number, which is used to specify the number of the page on which data is to be returned. This parameter is used together with the limit parameter to obtain data by page. For example, if the offset is 10 and the limit is 100, the system returns 100 data records starting from the 901th data record.

Constraints

N/A

Range

0~999999

limit

No

Integer

Definition

Number of records on each page. It is similar to page_size.

Constraints

N/A

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

Range

The length is the value of [1-100000].

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

Array of TaskRulesetInfo objects

Definition:

Rule set information.

total

Integer

Definition

Total number.

Range

N/A
Table 5 TaskRulesetInfo

Parameter

Type

Description

template_id

String

Definition:

Rule set ID.

Value range:

1 to 32 characters.

language

String

Definition

Rule set language.

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

template_name

String

Definition:

Rule set name.

Value range:

1 to 128 characters, including letters, digits, periods (.), hyphens (-), and underscores (_).

type

String

Definition:

Rule set selection status.

Value range:

  • selected: This rule set is already selected.

  • optional: This is a default rule set of a disabled language in the current project.

status

String

Definition:

Rule set type.

Value range:

  • 0: custom rule set.

  • 1: system rule set.

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}/v3/{project_id}/tasks/{task_id}/rulesets

Example Responses

Status code: 200

Request succeeded.

{
  "total" : 1,
  "data" : [ {
    "template_id" : "111111xxxx3246",
    "language" : "java",
    "type" : "selected",
    "template_name" : "General Criterion Set",
    "status" : "1"
  } ]
}

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