Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the Selected Rule Sets of a Task (V2)
Updated on 2024-03-15 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Selected Rule Sets of a Task (V2)

Function

This API is used to query the selected rule set list (v2) of a task.

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

Project ID

task_id

Yes

String

Task ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Setting the Media Type and Encoding Format

X-Auth-Token

Yes

String

User token.

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 100000

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

[items]

Array of TaskRulesetInfo objects

Request succeeded!
Table 4 TaskRulesetInfo

Parameter

Type

Description

template_id

String

Rule Set ID

language

String

Rule Set Language

template_name

String

Rule Set

type

String

Rule set status. The options are as follows: optional; selected.

status

String

Rule set attribute. The value 0 indicates the default user rule set, and the value 1 indicates the default system rule set.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

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 Check Rule Set",
  "type" : "optional",
  "status" : "1"
} ]

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "The network is busy. Please try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "The authentication information has expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management