All Products
Search

This Product

    Data Management:SetWorkflowExtraInfo

    Document Center

    Data Management:SetWorkflowExtraInfo

    Last Updated:Aug 28, 2026

    Configures whether the operation buttons, such as Agree, Revoke, and Sign, are displayed in the ticket approval section of the DMS console.

    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:SetWorkflowExtraInfo

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    Tid

    integer

    No

    The ID of the tenant.

    Note

    To view the ID of the tenant, go to the DMS console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.

    3***
    ThirdpartyWorkflowUrl

    string

    No

    The URL of the third-party approval workflow.

    https://xxx
    ThirdpartyWorkflowComment

    string

    No

    The remarks for the third-party approval workflow.

    test
    WorkflowInstanceId

    integer

    Yes

    The ID of the approval workflow. You can call the GetOrderBaseInfo operation to query this ID.

    184****
    RenderAgree

    boolean

    No

    Specifies whether the Agree button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:

    • true (default): The Agree button is displayed.

    • false: The Agree button is not displayed.

    true
    RenderReject

    boolean

    No

    Specifies whether the Reject button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:

    • true (default): The Reject button is displayed.

    • false: The Reject button is not displayed.

    false
    RenderAddApprovalNode

    boolean

    No

    Specifies whether the Sign button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:

    • true (default): The Sign button is displayed.

    • false: The Sign button is not displayed.

    false
    RenderTransfer

    boolean

    No

    Specifies whether the Forward button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:

    • true (default): The Forward button is displayed.

    • false: The Forward button is not displayed.

    true
    RenderCancel

    boolean

    No

    Specifies whether the Revoke button is displayed in the ticket approval section of the DMS console for a third-party approval workflow. Valid values:

    • true (default): The Revoke button is displayed.

    • false: The Revoke button is not displayed.

    true

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID, which you can use to query logs and troubleshoot issues.

    8401893F-4235-55D5-B563-7CF7A7D037DE
    ErrorCode

    string

    The error code returned if the request failed.

    UnknownError
    ErrorMessage

    string

    The error message returned if the request failed.

    UnknownError
    Data

    boolean

    Indicates whether the call succeeded.

    true
    Success

    boolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "RequestId": "8401893F-4235-55D5-B563-7CF7A7D037DE",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Data": true,
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.