All Products
Search
Document Center

Data Management:PreviewWorkflow

Last Updated:Nov 10, 2025

Previews the approval process of a ticket before the ticket is submitted.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:PreviewWorkflowget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
OrderIdlongYes

The ticket ID. You can call the ListOrders operation to query the ticket ID.

1069****
TidlongNo

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 View information about the current tenant section of the "Manage DMS tenants" topic.
23****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID. You can use the request ID to locate logs and troubleshoot issues.

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
WorkflowDetailobject

The details of the workflow.

WfCateNamestring

The name of the approval template.

Commentstring

The remarks of the approval template.

WorkflowNodeListarray<object>

The approval nodes.

WorkflowNodeobject
NodeNamestring

The name of the approval node.

Owner
NodeTypestring

The type of the approval node.

Valid values:

  • USER_LIST: The approval node is created by a user.
  • UNKNOWN: The source of the approval node is unknown.
  • SYS: The approval node is predefined by the system.
SYS
Commentstring

The remarks of the approval node.

AuditUserListarray<object>

The approvers.

AuditUserobject
UserIdlong

The ID of the approver.

16***
NickNamestring

The nickname of the approver.

Owner
RealNamestring

The name of the approver.

db_test
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "WorkflowDetail": {
    "WfCateName": "",
    "Comment": "",
    "WorkflowNodeList": {
      "WorkflowNode": [
        {
          "NodeName": "Owner",
          "NodeType": "SYS",
          "Comment": "",
          "AuditUserList": {
            "AuditUser": [
              {
                "UserId": 0,
                "NickName": "Owner",
                "RealName": "db_test"
              }
            ]
          }
        }
      ]
    }
  },
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.