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

Querying Advanced Settings of a Task

Function

Advanced settings of a query task.

URI

GET /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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

(Optional) Offset for pagination.

Minimum: 0

Default: 0

limit

No

Integer

(Optional) Number of records displayed on each page.

Minimum: 1

Maximum: 1000

Default: 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Media type and encoding format.

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

info

Array of TaskAdvancedSettings objects

Information about an advanced setting.

total

Integer

Total number.
Table 5 TaskAdvancedSettings

Parameter

Type

Description

key

String

Name of an advanced setting.

value

String

Value of an advanced setting.

option_value

String

Options for an advanced setting.

description

String

Description of an advanced setting.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 7 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}/settings

Example Responses

Status code: 200

Request succeeded!

{
  "info" : [ {
    "key" : "customImage",
    "value" : "xxxxx",
    "description" : "Custom image.",
    "option_value" : ""
  } ],
  "total" : 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