Help Center/ CodeArts Req/ API Reference/ API/ Work Items of the Scrum Project/ Checking Whether the Current User has the Permission to Set Workloads
Updated on 2025-09-10 GMT+08:00

Checking Whether the Current User has the Permission to Set Workloads

Function

This API is used to check whether the current user has the permission to set workloads.

Calling Method

For details, see Calling APIs.

URI

GET /v3/projects/{project_uuid}/issues/{issue_id}/history-permission

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_uuid

Yes

String

Definition:

32-character UUID of a project, which uniquely identifies a project. Obtain the value of this parameter from the project_id field in the response body of the Querying the Project List API.

Constraints:

Regular expression: ^[A-Za-z0-9]{32}$

Value range:

N/A

Default value:

N/A

issue_id

Yes

String

Definition:

Work item ID, which can be obtained from the Performing Advanced Query of Work Items API. The value of the id field in the response message body is the work item ID.

Constraints:

The value must contain 1 to 10 digits.

Value range:

Minimum length: 1 character. Maximum length: 10 characters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token.

Constraints:

Mandatory.

Value range:

Minimum length: 10 characters. Maximum length: 32,768 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

result

result object

Definition:

Returned result.

status

String

Definition:

Returned status.

Value range:

success: Command execution succeeds.

error: Command execution failed.

Table 4 result

Parameter

Type

Description

is_history_processor

Boolean

Definition:

Whether the user has the permission to operate workloads.

Value range:

true (default value)

false (not the default value)

Example Requests

{endpoint}/v3/projects/381fcca9c056482d92da3e8b9da71db5/issues/69813204/history-permission

Example Responses

Status code: 200

Whether the current user has successfully obtained the work hour operation permission.

{
  "result" : {
    "is_history_processor" : true
  },
  "status" : "success"
}

Status Codes

Status Code

Description

200

Whether the current user has successfully obtained the work hour operation permission.

Error Codes

See Error Codes.