Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Setting the Owner Matching Switch
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Setting the Owner Matching Switch

Function

This API is used to set the owner matching switch based on the task ID. After the owner matching switch is enabled, the owner of each code commit can be displayed after the code check task is complete.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:update

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

PUT /v1/tasks/{task_id}/owner-matching-switch

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enable

Yes

String

Definition:

Whether to enable owner matching. The value true indicates that the function is enabled, and the value false indicates that the function is disabled.

Constraints:

N/A

Value range:

  • true: Enable owner matching.

  • false: Disable owner matching.

Default value:

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

httpStatus

String

Definition:

HTTP response status.

Value range:

  • OK: The request has been successfully processed, and the server returns the requested resource or operation result.

  • ACCEPTED: The request has been accepted by the server, but the processing is not complete (usually used for asynchronous operations).

  • INTERNAL_SERVER_ERROR: internal API exception.

  • BAD_REQUEST: abnormal parameter verification.

result

String

Definition:

Response result. If the request is successful, "" is returned.

Range:

N/A

status

String

Definition:

API response status.

Value range:

  • success: successful response.

  • error: response failed.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Enable the owner matching function for the task whose ID is 8df8d58f832a408f88e4aebea0ff6fc5.

PUT https://{endpoint}/v1/tasks/022eb30204264a2181a4a3d2bee3c7f1/owner-matching-switch?enable=true

Example Responses

Status code: 200

Request succeeded!

{
  "httpStatus" : "OK",
  "result" : "",
  "status" : "success"
}

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

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