Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Configuring Advanced Settings for a Task
Updated on 2023-11-28 GMT+08:00
View PDF

Configuring Advanced Settings for a Task

Function

Configures advanced settings for a task, such as custom image.

URI

POST /v2/{project_id}/tasks/{task_id}/settings

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

Can be obtained by calling the IAM API for obtaining the user token (the value of X-Subject-Token in the response header).

Minimum: 1

Maximum: 100000

Content-Type

Yes

String

Media type and encoding format.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

task_advanced_settings

Yes

Array of TaskAdvancedSettingsItem objects

Information about advanced settings parameters.
Table 4 TaskAdvancedSettingsItem

Parameter

Mandatory

Type

Description

key

Yes

String

Name of an advanced setting.

Minimum: 1

Maximum: 50

value

Yes

String

Value of an advanced setting.

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

Configure advanced options for tasks, such as customizing images.

POST https://{endpoint}/v2/{project_id}/tasks/{task_id}/settings

{
  "task_advanced_settings" : [ {
    "key" : "customImage",
    "value" : "xxxx"
  } ]
}

Example Responses

Status code: 200

Request succeeded!

null

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