On this page

Show all

Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Task Configuration Check Parameters

Task Configuration Check Parameters

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

View PDF

Function

URI

POST /v2/{project_id}/tasks/{task_id}/config-parameters

**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
X-Auth-Token	Yes	String	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
Content-Type	Yes	String	Media type and encoding format.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
check_id	Yes	Integer	Check Tool ID Minimum: 1 Maximum: 11
ruleset_id	Yes	String	Rule Set ID Minimum: 1 Maximum: 64
language	Yes	String	Rule Set Language Minimum: 1 Maximum: 128
status	Yes	String	off: disabled; on: enabled Minimum: 1 Maximum: 3
task_check_settings	Yes	Array of TaskCheckSettingsItem objects	Checking Parameter Information

**Table 4** TaskCheckSettingsItem
Parameter	Mandatory	Type	Description
cfg_key	Yes	String	Check the key value corresponding to the parameter. Minimum: 1 Maximum: 50
status	Yes	String	Parameter Status Minimum: 1 Maximum: 3
cfg_value	No	String	Checking Parameter Values Minimum: 1 Maximum: 1000

Response Parameters

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

Task configuration check parameter: Check whether the language type of the parameter is csharp and the status is on.

POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/config-parameters

{
  "check_id" : 11,
  "ruleset_id" : "b113bxxxxxxxx5738bee86ecxxxxxxxx",
  "language" : "csharp",
  "status" : "on",
  "task_check_settings" : [ {
    "cfg_key" : "csharpCompileTool",
    "status" : "on",
    "cfg_value" : "msbuild"
  } ]
}

Example Responses

Status code: 200

Request succeeded!

null

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: Querying Check Parameters of a Task Rule Set (V2)

Next topic: Modifying a Task Rule Set

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