PreviewWorkflow - 预览工单审批流

该API用于在正式提交审批前,预览工单审批流。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dms:PreviewWorkflowget
*全部资源
*

请求参数

名称类型必填描述示例值
OrderIdlong

工单 ID。您可通过调用接口 ListOrders 获取该参数的值。

1069****
Tidlong

租户 ID。

说明 取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息
23****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID,用于定位日志,排查问题。

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

错误码,请求异常时返回。

UnknownError
ErrorMessagestring

错误信息,请求异常时返回。

UnknownError
WorkflowDetailobject

工作流详细信息。

WfCateNamestring

审批模板名称。

Owner与DBA
Commentstring

审批模板备注。

系统定义审批线,先数据Owner审批,再DBA审批。
WorkflowNodeListarray<object>

审批节点列表。

WorkflowNodeobject
NodeNamestring

审批节点名称。

Owner
NodeTypestring

节点类型。

枚举值:
  • USER_LIST用户自定义
  • UNKNOWN未知
  • SYS系统定义
SYS
Commentstring

审批节点备注。

系统节点,动态计算,由用户操作的资源对应的Owner来完成审批。
AuditUserListarray<object>

审批用户列表。

AuditUserobject
UserIdlong

用户 ID。

16***
NickNamestring

用户昵称。

Owner
RealNamestring

用户名称。

db_test
Successboolean

请求是否成功,返回值如下:

  • true:请求成功。
  • false:请求失败。
true

示例

正常返回示例

JSON格式

{
  "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
}

错误码

访问错误中心查看更多错误码。