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

Querying Selected Rule Sets of a Task (Version 2)

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

Project ID.

task_id

Yes

String

Task ID.

Request Parameters

Table 2 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 3 Response body parameters

Parameter

Type

Description

[items]

Array<Array<TaskRulesetInfo>>

Request succeeded!
Table 4 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 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 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