PreviewWorkflow - Preview ticket approval workflow - Data Management

Previews the approval workflow of a ticket before submission.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
OrderId	integer	Yes	The ticket ID. Call ListOrders to query ticket IDs.	1069****
Tid	integer	No	The tenant ID. Note To view the tenant ID, log on to the DMS console and hover over the profile picture in the upper-right corner. View information about the current tenant.	23****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, used for log tracing and troubleshooting.	0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931
ErrorCode	string	The error code. Returned only when the request fails.	UnknownError
ErrorMessage	string	The error message. Returned only when the request fails.	UnknownError
WorkflowDetail	object	The workflow details.
WfCateName	string	The approval template name.	Owner与DBA
Comment	string	The approval template remarks.	系统定义审批线，先数据Owner审批，再DBA审批。
WorkflowNodeList	object
WorkflowNode	array<object>	The approval nodes.
	array<object>
NodeName	string	The approval node name.	Owner
NodeType	string	The approval node type. Valid values: USER_LIST: user-created. UNKNOWN: unknown source. SYS: system-predefined. Valid values: USER_LIST : UNKNOWN : SYS :	SYS
Comment	string	The approval node remarks.	系统节点，动态计算，由用户操作的资源对应的Owner来完成审批。
AuditUserList	object
AuditUser	array<object>	The approvers.
	object
UserId	integer	The approver ID.	16***
NickName	string	The approver nickname.	Owner
RealName	string	The approver name.	db_test
Success	boolean	Whether the request succeeded. Valid values: true: successful. false: failed.	true

Examples

Success response

JSON format

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "WorkflowDetail": {
    "WfCateName": "Owner与DBA",
    "Comment": "系统定义审批线，先数据Owner审批，再DBA审批。",
    "WorkflowNodeList": {
      "WorkflowNode": [
        {
          "NodeName": "Owner",
          "NodeType": "SYS",
          "Comment": "系统节点，动态计算，由用户操作的资源对应的Owner来完成审批。",
          "AuditUserList": {
            "AuditUser": [
              {
                "UserId": 0,
                "NickName": "Owner",
                "RealName": "db_test"
              }
            ]
          }
        }
      ]
    }
  },
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.