On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Selected Rule Sets of a Task (Version 2)

Querying Selected Rule Sets of a Task (Version 2)

Updated on 2025-08-21 GMT+08:00

Online Debugging

CLI Examples

View PDF

Function

This API is used to query selected rule sets of a task (version 2).

Calling Method

For details, see Calling APIs.

URI

GET /v2/{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

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
[items]	Array of TaskRulesetInfo objects	Definition Rule set array. 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}/v2/{project_id}/tasks/{task_id}/rulesets

Example Responses

Status code: 200

Request succeeded!

[ {
  "template_id" : "396e1c2511744f6fa199d33b26038edd",
  "language" : "Java",
  "template_name" : "Java_cmetrics",
  "type" : "selected",
  "status" : "0"
}, {
  "template_id" : "4e988c481b4c46d0a3297fbe343a662d",
  "language" : "html",
  "template_name" : "General Criterion Set",
  "type" : "optional",
  "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

Previous topic: Querying Historical Check Results

Next topic: Querying Selected Rule Sets of a Task (Version 3)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot