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

Querying Selected Rule Sets of a Task (Version 3)

Updated on 2024-11-28 GMT+08:00

Online Debugging

CLI Examples

View PDF

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	Project ID.
task_id	Yes	String	Task ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Offset for pagination.
limit	No	Integer	Number of items displayed on each page. A maximum of 1,000 items are supported.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Media type and encoding format.
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
info	Array of TaskRulesetInfo objects	Rule set information.
total	Integer	Total number.

**Table 5** TaskRulesetInfo
Parameter	Type	Description
template_id	String	Rule set ID.
language	String	Rule set language.
template_name	String	Rule set name.
type	String	Rule set status. The value can be optional and selected.
status	String	Rule set attribute. The value can be 0 (default user rule set) and 1 (default system 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

Previous topic: Querying Selected Rule Sets of a Task (Version 2)

Next topic: Querying the Check Parameters of a Rule Set (Version 2)

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