Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Selected Rule Sets of a Task (Version 3)
Updated on 2025-08-21 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 selected rule sets of a task (version 3).

Calling Method

For details, see Calling APIs.

URI

GET /v3/{project_id}/tasks/{task_id}/rulesets

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Unique 32-character UUID of a project. Obtain a UUID by calling the API forquerying projects.

Constraints

N/A

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 CodeArts Check task, branch task, or incremental task generated through an API has a unique ID.

Constraints

N/A

Range

N/A

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. It is similar to page_num.

Constraints

N/A

Range

0–999,999

limit

No

Integer

Definition

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

Constraints

N/A

Range

1-1,000

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

1–100,000 characters

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.

Range

N/A

total

Integer

Definition

Total number.

Range

N/A
Table 5 TaskRulesetInfo

Parameter

Type

Description

template_id

String

Definition

Rule set ID.

Range

32-character rule set ID.

language

String

Definition

Rule set language.

Range

N/A

template_name

String

Definition

Rule set name.

Range

N/A

type

String

Definition

Rule set selection status.

Range

  • selected: This rule set is already selected.

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

status

String

Definition

Rule set type.

Range

  • 0: user rule set

  • 1: default rule set

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

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

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "Network busy. Try again later."
}

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