Help Center/ DataArts Studio/ API Reference/ DataArts Security APIs/ Permission Approval/ Obtaining the Approval Service Ticket List
Updated on 2025-11-17 GMT+08:00

Obtaining the Approval Service Ticket List

Function

This API is used to obtain the approval service ticket list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/security/openapi/permission-approve/approvals

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of items displayed on each page

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0.

proposer_name

No

String

Applicant name

approval_id

No

String

Service ticket ID

workspace_id

No

String

Workspace ID

status_list

No

Array of integers

Service ticket status

application_start_time

No

Long

Application start time

application_end_time

No

Long

Application end time

order_by_desc

No

Boolean

Ascending or descending order

order_by

No

String

Sorting parameter, which can be START_TIME or END_TIME

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

workspace

Yes

String

Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.

X-Auth-Token

Yes

String

IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This parameter is mandatory for token authentication.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

approvals

Array of PermissionApprovalOpenapiDTO objects

Service ticket list

total

Long

Total number of rule groups

Table 5 PermissionApprovalOpenapiDTO

Parameter

Type

Description

approval_dispatch_error_msg

String

Approval dispatch error message

approval_dispatch_status

String

Approval dispatch status, which can be 0 (successful), 1 (failed), or null (non-SMN node)

approval_type

String

Application type. The value is DATA_PERMISSION.

approve_reason

String

Application reason

current_node_id

String

Approval node ID

current_node_name

String

Approver

current_node_type

String

Approver type

detail

PermissionApprovalDetailDTO object

Approval details

end_time

Long

Service ticket end time

expire_time

Long

Expiration time

id

String

Service ticket ID

instance_id

String

Instance ID

permission_set_id

String

ID of the permission set to which the approver belongs

project_id

String

Project ID

proposer_id

String

Applicant ID

proposer_name

String

Applicant name

proposer_workspace_id

String

ID of the workspace where the permission applicant is located

reason

String

Rejection reason

start_time

Long

Service ticket start time

status

String

Service ticket status, which can be WAITING_APPROVE, APPROVED, REJECT, or REVOKE

workspace_id

String

Workspace ID

workspace_name

String

Workspace name

Table 6 PermissionApprovalDetailDTO

Parameter

Type

Description

cluster_id

String

Cluster ID

cluster_name

String

Cluster name

datasource_type

String

Data source type

  • Hive

  • GaussDB(DWS)

  • DLI

expire_time

Long

Timeout duration

permissions

Array of permissions objects

Details of the requested permissions

proposers

Array of proposers objects

Applicant details

Table 7 permissions

Parameter

Type

Description

column_name

String

Column name

database_name

String

Database name

permission_action

Array of strings

Permissions

permission_set_id

String

ID of the workspace permission set to which the requested permissions belong

schema_name

String

Schema name

secrecy_level_id

String

Security level ID

table_name

String

Table name

Table 8 proposers

Parameter

Type

Description

id

String

Applicant ID

name

String

Applicant name

type

String

Applicant type, which can be USER, USER_GROUP, ROLE, or WORKSPACE_ACCOUNT

Status code: 400

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

/v1/{project_id}/security/openapi/permission-approve/approvals

Example Responses

None

Status Codes

Status Code

Description

200

ok

400

Bad Request