Help Center/ CodeArts Build/ API Reference/ APIs/ Build Task Management/ Determining If a Task Uses Project-level Permissions
Updated on 2025-08-22 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Determining If a Task Uses Project-level Permissions

Function

This API is used to determine if a task uses project-level permissions.

Calling Method

For details, see Calling APIs.

URI

POST /v1/job/project/permission

Request Parameters

Table 1 Request body parameters

Parameter

Mandatory

Type

Description

job_id

No

String

Definition

Enter the ID of the build task whose history you want to query. To obtain this ID, open the build task details page in your browser, and copy the 32-character string, which includes both digits and letters, at the end of the URL.

Constraints

N/A.

Range

The value is 32 characters long. Only letters and digits are allowed.

Default Value

N/A.

project_id

No

String

Definition

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

Constraints

N/A.

Range

Use a 32-character string containing a mix of digits and letters.

Default Value

N/A.

project_switch

No

Boolean

Definition

Whether to synchronize the latest project permissions.

Constraints

N/A.

Range

AES or DESC

Default Value

N/A.

Response Parameters

Status code: 200

Table 2 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 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

POST https://{endpoint}/v1/job/project/permission

Example Responses

Status code: 200

OK

{
  "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