文档

ListWorkFlowTemplates - 获取审批模板列表

获取审批模板列表。

调试

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

授权信息

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

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

请求参数

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

租户 ID。

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

搜索模板名。

Admin

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

41067071-0243-4AAB-B3CF-4DE6D54F53B4
ErrorCodestring

错误码。

UnknownError
ErrorMessagestring

错误消息。

UnknownError
Successboolean

请求是否成功。

true
WorkFlowTemplatesobject []

审批模板列表。

IsSysteminteger

是否系统定义的审批模板,取值和说明如下:

  • 1:是
  • 0:否
1
WorkflowNodesobject []

审批节点信息。

Commentstring

备注。

test
NodeTypestring

节点类型,取值和说明如下:

  • SYS:系统定义
  • USER_LIST:用户自定义
SYS
NodeNamestring

节点名称。

test
Positioninteger

顺序。

1
CreateUserIdlong

创建人 ID。

1234
TemplateIdlong

模板 ID。

12345
NodeIdlong

节点 ID。

123
Commentstring

备注。

test
Enabledstring

模板是否启用,取值和说明如下:

  • Y:启用
  • N:禁用
Y
TemplateNamestring

模板名称。

Admin
TemplateIdlong

模板 ID。

12345
CreateUserIdlong

创建人 ID。

1234

示例

正常返回示例

JSON格式

{
  "RequestId": "41067071-0243-4AAB-B3CF-4DE6D54F53B4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "WorkFlowTemplates": {
    "WorkFlowTemplate": [
      {
        "IsSystem": 1,
        "WorkflowNodes": {
          "WorkflowNode": [
            {
              "Comment": "test",
              "NodeType": "SYS",
              "NodeName": "test",
              "Position": 1,
              "CreateUserId": 1234,
              "TemplateId": 12345,
              "NodeId": 123
            }
          ]
        },
        "Comment": "test",
        "Enabled": "Y",
        "TemplateName": "Admin",
        "TemplateId": 12345,
        "CreateUserId": 1234
      }
    ]
  }
}

JSON格式

{
  "RequestId": "41067071-0243-4AAB-B3CF-4DE6D54F53B4",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "WorkFlowTemplates": {
    "WorkFlowTemplate": [
      {
        "IsSystem": 1,
        "WorkflowNodes": {
          "WorkflowNode": [
            {
              "Comment": "test",
              "NodeType": "SYS",
              "NodeName": "test",
              "Position": 1,
              "CreateUserId": 1234,
              "TemplateId": 12345,
              "NodeId": 123
            }
          ]
        },
        "Comment": "test",
        "Enabled": "Y",
        "TemplateName": "Admin",
        "TemplateId": 12345,
        "CreateUserId": 1234
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈