Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Modifying Task Permissions in Batches
Updated on 2025-08-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying Task Permissions in Batches

Function

This API is used to modifying task permissions in batches.

Calling Method

For details, see Calling APIs.

URI

POST /v1/job/permissions/batch

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

project_id

No

String

CodeArts project ID. For details about how to obtain the CodeArts project ID, see Obtaining a CodeArts Project ID.

job_ids

No

Array of strings

A collection of task IDs.

project_switch

No

Boolean

Whether to synchronize the latest project permissions.

permissions

No

Array of permissions objects

Roles' permissions.
Table 2 permissions

Parameter

Mandatory

Type

Description

role_id

No

String

Role ID.

is_modify

No

Boolean

Permission for modification.

is_delete

No

Boolean

Permission for deletion.

is_view

No

Boolean

Permissions for view.

is_execute

No

Boolean

Permissions for execution.

is_copy

No

Boolean

Permission for cloning.

is_forbidden

No

Boolean

Permission for disabling.

is_manager

No

Boolean

Permission for management.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition

API response status.

Range

● success: The API call is successful.

● fail: The API call failed.

error

Object

Definition

Error message.

Range

N/A.

result

String

Definition

Data returned after the API is successfully called.

Range

N/A.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

POST https://{endpoint}/v1/job/permissions/batch

Example Responses

Status code: 200

OK

{
  "result" : null,
  "error" : null,
  "status" : "success"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent Topic: Build Task Management