All Products
Search
Document Center

DataWorks:ListMyRelatedApprovals

Last Updated:Jun 24, 2026

Query all permission application orders where the current user is an approver or stakeholder.

Operation description

Request Description

  • This API is used to retrieve all permission application orders where the current user is an approver, including pending and processed application orders.

  • You can use the Statuses parameter to filter application orders by specific status.

  • NextToken is used for paginated requests. It can be omitted or set to null for the first request. For subsequent requests, pass the NextToken value from the previous response.

  • PageSize defaults to 10, with a maximum of 200.

  • DefSchema and ResourceType are required fields. Other parameters can be filled in as needed.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

DefSchema

string

Yes

Filter by resource type.

Note: The resource types supported by the system for applications are constrained by ResourceSchema.name.

Reference: ResourceSchema International Site Documentation

MaxCompute

ResourceType

array

Yes

Filter by minimum permission resource type.

Note: The minimum permission resource type is constrained by ResourceSchema.resources[*].isValidLeaf being true.

Reference: ResourceSchema International Site Documentation

["table", "column"]

string

No

Resource type

project

Resource

object

No

Filter by resource with exact/generalized matching. The resource description is constrained by ResourceSchema.

Reference: ResourceSchema International Site Documentation

DefSchema

string

No

Resource type.

Note: The resource types supported by the system for applications are constrained by ResourceSchema.name.

Reference: ResourceSchema International Site Documentation

MaxCompute

DefVersion

string

No

The resource parsing version is constrained by ResourceSchema.version.

ResourceSchema International Site Documentation

v1.0.0

MetaData

object

No

Resource metadata.

Note: The metadata is constrained by ResourceSchema.resources. A valid resource declaration must include the full-path metadata declaration from level 0 to validLeaf layer.

Reference: ResourceSchema International Site Documentation

any

No

Resource metadata

{ "workspace": "449056", "project": "sync_destination" }

StartTime

integer

No

Application time start (millisecond timestamp)

1771948800000

EndTime

integer

No

Application time end (millisecond timestamp)

1779724799999

Statuses

array

No

Filter by approval status. Enum values:

  • WaitApproval: Pending approval

  • Confirmed: Pending authorization

  • RejectApproval: Approval rejected

  • AuthorizeSucceed: Authorization succeeded

  • AuthorizeFailed: Authorization failed

  • Deleted: Deleted

  • Canceled: Withdrawn

WAIT_APPROVAL

string

No

Approval status

Deleted

Grantee

object

No

Filter by authorization principal.

Note: The authorization principal types supported by the system are constrained by ResourceSchema.authPrincipal.

Reference: ResourceSchema International Site Documentation

PrincipalType

string

No

Authorization principal type:

  • RamRole

  • RamUser

  • DataworksTenantMember

  • DataworksTenantRole

  • DataworksProjectMember

  • DataworksProjectRole

  • DlfRole

RamRole

PrincipalId

string

No

Authorization principal ID:

  • RamUser: Dataworks UserId

  • RamRole: Dataworks UserId prefixed with "ROLE_"

  • DataworksTenantMember: Dataworks UserId

  • DataworksTenantRole: Dataworks tenant roleCode

  • DataworksProjectRole: Dataworks workspace roleCode

  • DataworksProjectMember: Dataworks UserId

  • DlfRole: DlfNext role name

ROLE_3133343434

AccessTypes

array

No

Filter by requested permissions.

Note: Different resource levels support different application permission types, all constrained by ResourceSchema.isValidLeaf, accessTypeRestrictions, and authMethodAccessTypes.

Reference: ResourceSchema International Site Documentation

string

No

Permission

select

NextToken

string

No

Pagination cursor

eyJpZCI6MTIzfQ==

PageSize

integer

No

Page size (default 10, maximum 200)

20

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

API request ID, generated by UUID

0bc5df3a17****903790e8e8a

Data

object

Paginated results

PageSize

integer

Page size (default 10, maximum 200)

10

NextToken

string

Pagination cursor

eyJpZCI6NDU2fQ==

HasMore

boolean

Whether there is more data

false

Data

array<object>

Application order details

array<object>

Approval process and application content

ProcessInstanceId

string

The process instance ID.

176906667488145

DefSchema

string

The resource type.

MaxCompute

Reason

string

The reason for the request.

业务需要

ApplicationTime

integer

The time when the request was submitted, in milliseconds since the Unix epoch.

1779695088000

Status

string

The approval status. Valid values:

  • WaitApproval: Waiting for approval.

  • Confirmed: Pending authorization.

  • RejectApproval: Approval rejected.

  • AuthorizeSucceed: Authorization succeeded.

  • AuthorizeFailed: Authorization failed.

  • Deleted: Deleted.

  • Canceled: Canceled.

Deleted

Contents

array<object>

The content of the request.

array<object>

The content of the request.

Id

string

The unique ID of the request content.

1009516415

ProcessInstanceId

string

The ID of the approval process instance for the request.

777799223

TenantId

string

The tenant ID.

69973837489

ResourceName

string

The name of the resource type at the leaf-node level.

table

DefSchema

string

The resource type.

MaxCompute

AuthMethod

string

The authorization method.

default

Resource

object

The resource declaration.

DefSchema

string

The name of the ResourceSchema required to parse the resource.

MaxCompute

DefVersion

string

The version of the ResourceSchema required to parse the resource.

v1.0.0

MetaData

object

The resource metadata. The content is constrained by the ResourceSchema.

any

The resource content.

{ "schema": "default", "threeTierModel": false, "project": "sync_dtestn", "workspace": "4477656", "table": "order", "tenant": "524257424864736" }

Grantee

object

The grantee.

PrincipalType

string

The principal type. Valid values:

  • RamRole

  • RamUser

  • DataworksTenantMember

  • DataworksTenantRole

  • DataworksProjectMember

  • DataworksProjectRole

  • DlfRole

RamRole

PrincipalId

string

The principal ID.

Note: The format of this ID depends on the PrincipalType:

  • RamUser: The user ID.

  • RamRole: The user ID, prefixed with ROLE_.

  • DataworksTenantMember: The user ID.

  • DataworksTenantRole: The role code in the Dataworks tenant.

  • DataworksProjectRole: The role code in the Dataworks workspace.

  • DataworksProjectMember: The user ID.

  • DlfRole: The name of the DlfNext role.

ROLE_3133343434

AccessTypes

array

The permissions requested for the resource.

string

The permission.

select

FinalAccessTypes

array

The permissions granted for the resource after the final approval.

string

The permission.

select

ExpirationTime

integer

The permission's expiration time, in milliseconds since the Unix epoch.

1779695088000

Status

string

The approval status. Valid values:

  • WaitApproval: Waiting for approval.

  • Confirmed: Pending authorization.

  • RejectApproval: Approval rejected.

  • AuthorizeSucceed: Authorization succeeded.

  • AuthorizeFailed: Authorization failed.

  • Deleted: Deleted.

  • Canceled: Canceled.

Deleted

CreateTime

integer

The time when the entry was created, in milliseconds since the Unix epoch.

2025-09-11 10:13:21

UpdateTime

integer

The time when the entry was last updated, in milliseconds since the Unix epoch.

2024-03-05 18:24:13

Examples

Success response

JSON format

{
  "RequestId": "0bc5df3a17****903790e8e8a",
  "Data": {
    "PageSize": 10,
    "NextToken": "eyJpZCI6NDU2fQ==",
    "HasMore": false,
    "Data": [
      {
        "ProcessInstanceId": "176906667488145",
        "DefSchema": "MaxCompute",
        "Reason": "业务需要",
        "ApplicationTime": 1779695088000,
        "Status": "Deleted",
        "Contents": [
          {
            "Id": "1009516415",
            "ProcessInstanceId": "777799223",
            "TenantId": "69973837489",
            "ResourceName": "table",
            "DefSchema": "MaxCompute",
            "AuthMethod": "default",
            "Resource": {
              "DefSchema": "MaxCompute",
              "DefVersion": "v1.0.0",
              "MetaData": {
                "key": "{\n                \"schema\": \"default\",\n                \"threeTierModel\": false,\n                \"project\": \"sync_dtestn\",\n                \"workspace\": \"4477656\",\n                \"table\": \"order\",\n                \"tenant\": \"524257424864736\"\n              }"
              }
            },
            "Grantee": {
              "PrincipalType": "RamRole",
              "PrincipalId": "ROLE_3133343434"
            },
            "AccessTypes": [
              "select"
            ],
            "FinalAccessTypes": [
              "select"
            ],
            "ExpirationTime": 1779695088000,
            "Status": "Deleted",
            "CreateTime": 0,
            "UpdateTime": 0
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.