On this page

Show all

Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Check Parameters of a Task Rule Set (v3)

Querying Check Parameters of a Task Rule Set (v3)

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

View PDF

Function

URI

GET /v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
task_id	Yes	String	Task ID
ruleset_id	Yes	String	Rule Set ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
language	Yes	String	Rule Set Language
offset	No	Integer	Pagination index, offset, which is optional. Minimum: 0 Default: 0
limit	No	Integer	Number of records displayed on each page. This parameter is optional. Minimum: 1 Maximum: 1000 Default: 10

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	No	String	Setting the Media Type and Encoding Format
X-Auth-Token	Yes	String	The user token is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). Minimum: 1 Maximum: 100000

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	Array of TaskCheckParamters objects	Historical data
total	Integer	Total

**Table 5** TaskCheckParamters
Parameter	Type	Description
check_id	Integer	Check Tool ID
name	String	Compilation Parameter Name
checker_configs	Array of CheckConfigInfo objects	Checking Parameter Settings

**Table 6** CheckConfigInfo
Parameter	Type	Description
name	String	Check the parameter name.
cfg_key	String	Check the key value corresponding to the parameter.
default_value	String	Checking the Default Value of a Parameter
option_value	String	Check the optional parameters.
is_required	Integer	0: optional; 1: mandatory
description	String	Check Parameter Description
type	Integer	Parameter type. The options are as follows: 0: text; 2: optional.
status	String	Parameter status. The options are on (enabled) and off (disabled).
value	String	Checks parameter values.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Status code: 401

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error Codes
error_msg	String	Description

Example Requests

GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters

Example Responses

Status code: 200

Request succeeded!

{
  "total" : 1,
  "data" : [ {
    "check_id" : 0,
    "name" : "compile_tool",
    "check_configs" : [ {
      "value" : "",
      "name" : "Command",
      "cfg_key" : "",
      "default_value" : "",
      "option_value" : "",
      "is_required" : 0,
      "description" : "Command",
      "type" : 0,
      "status" : "on"
    } ]
  } ]
}

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

Previous topic: Executing a Check Task

Next topic: Querying the Selected Rule Sets of a Task (V2)

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.

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