Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying Advanced Configurations of a Task
Updated on 2024-11-28 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Advanced Configurations of a Task

Function

This API is used to query advanced configurations of a task.

Calling Method

For details, see Calling APIs.

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

config_list

No

String

List of configuration items. The options are customImage, includePaths, authId, reviewData, and taskName. You are not advised to query multiple configuration items at the same time.

offset

No

Integer

(Optional) Offset for pagination.

limit

No

Integer

(Optional) Number of items displayed on each page.

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

User token. The token 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 4 Response body parameters

Parameter

Type

Description

info

Array of TaskAdvancedSettings objects

Information about an advanced configuration.

total

Integer

Total number.
Table 5 TaskAdvancedSettings

Parameter

Type

Description

key

String

Name of an advanced configuration.

value

String

Value of an advanced configuration.

option_value

String

Option for an advanced configuration.

description

String

Description of an advanced configuration.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

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