All Products
Search

This Product

    Data Management:ApproveOrder

    Document Center

    Data Management:ApproveOrder

    Last Updated:Aug 28, 2026

    Approves, rejects, cancels, or transfers a ticket in a DMS approval workflow.

    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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    dms:ApproveOrder

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    The tenant ID. Call GetUserActiveTenant to query this ID.

    3***
    WorkflowInstanceId

    integer

    Yes

    The approval process ID. Call GetOrderBaseInfo to query this ID.

    1234
    ApprovalType

    string

    Yes

    The action to perform on the ticket. Valid values:

    • AGREE

    • CANCEL

    • REJECT

    • TRANSFER

    • ADD_APPROVAL_NODE

    Valid values:

    • REJECT :

      REJECT

    • ADD_APPROVAL_NODE :

      ADD_APPROVAL_NODE

    • TRANSFER :

      TRANSFER

    • CANCEL :

      CANCEL

    • AGREE :

      AGREE

    AGREE
    Comment

    string

    No

    The comment on the ticket.

    test
    NewApprover

    integer

    No

    The ID of the user to transfer the ticket to. Required when ApprovalType is set to TRANSFER.

    12***
    OldApprover

    integer

    No

    The ID of the user that transfers the ticket. Defaults to the current user. Administrators and DBAs can set this to another user's ID.

    23***
    ApprovalNodeId

    integer

    No

    Required when ApprovalType is set to ADD_APPROVAL_NODE. The ID of the user-defined approval node to add. Call the ListUserDefineWorkFlowNodes operation to query this ID.

    1
    ApprovalNodePos

    string

    No

    The position of the new approval node. Required when ApprovalType is set to ADD_APPROVAL_NODE. Valid values:

    • PRE_ADD_APPROVAL_NODE: before the current approval node.

    • POST_ADD_APPROVAL_NODE: after the current approval node.

    POST_ADD_APPROVAL_NODE
    NewApproverList

    string

    No

    Note

    Specify this parameter when ApprovalType is set to TRANSFER. Specify either NewApproverList or NewApprover, not both.

    The IDs of the users to transfer the ticket to. Separate multiple IDs with commas (,).

    154***,155***,156***
    RealLoginUserUid

    string

    No

    The UID of the Alibaba Cloud account that calls the API.

    21400447956867****

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D
    ErrorCode

    string

    The error code.

    UnknownError
    ErrorMessage

    string

    The error message.

    UnknownError
    Success

    boolean

    Whether the request was successful. Valid values:

    • true

    • false

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "427688B8-ADFB-4C4E-9D45-EF5C1FD6E23D",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.