调用ListWorkFlowTemplates获取审批模板列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListWorkFlowTemplates

系统规定参数。取值:ListWorkFlowTemplates

Tid Long -1

租户ID。

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

搜索模板名。

返回数据

名称 类型 示例值 描述
ErrorCode String UnknownError

错误码。

ErrorMessage String UnknownError

错误消息。

RequestId String 41067071-0243-4AAB-B3CF-4DE6D54F53B4

请求ID。

Success Boolean true

请求是否成功。

WorkFlowTemplates Array of WorkFlowTemplate

审批模板列表。

WorkFlowTemplate
Comment String test

备注。

CreateUserId Long 1234

创建人ID。

Enabled String Y

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

  • Y:启用
  • N:禁用
IsSystem Integer 1

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

  • 1:是
  • 0:否
TemplateId Long 12345

模板ID。

TemplateName String Admin

模板名称。

WorkflowNodes Array of WorkflowNode

审批节点信息。

WorkflowNode
Comment String test

备注。

CreateUserId Long 1234

创建人ID。

NodeId Long 123

节点ID。

NodeName String test

节点名称。

NodeType String SYS

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

  • SYS:系统定义
  • USER_LIST:用户自定义
Position Integer 1

顺序。

TemplateId Long 12345

模板ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListWorkFlowTemplates
&Tid=-1
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>41067071-0243-4AAB-B3CF-4DE6D54F53B4</RequestId>
<Success>true</Success>
<WorkFlowTemplates>
    <WorkFlowTemplate>
        <Comment>系统定义审批线,仅需管理员审批</Comment>
        <WorkFlowNodes>
            <WorkFlowNode>
                <Comment>系统节点,动态计算,由管理员来完成审批</Comment>
                <NodeName>Admin</NodeName>
                <Position>0</Position>
                <NodeType>SYS</NodeType>
                <NodeId>3763</NodeId>
                <TemplateId>6243</TemplateId>
            </WorkFlowNode>
        </WorkFlowNodes>
        <TemplateName>Admin</TemplateName>
        <Enabled>Y</Enabled>
        <IsSystem>1</IsSystem>
        <TemplateId>6243</TemplateId>
    </WorkFlowTemplate>
    <WorkFlowTemplate>
        <Comment>系统定义审批线,先数据Owner审批,再DBA审批,最后Admin审批</Comment>
        <WorkflowNodes>
            <WorkFlowNode>
                <Comment>系统节点,动态计算,由用户操作的资源对应的Owner来完成审批</Comment>
                <NodeName>Owner</NodeName>
                <Position>0</Position>
                <NodeType>SYS</NodeType>
                <NodeId>3762</NodeId>
                <TemplateId>6244</TemplateId>
            </WorkFlowNode>
            <WorkFlowNode>
                <Comment>系统节点,动态计算,由用户操作的资源对应的DBA来完成审批</Comment>
                <NodeName>DBA</NodeName>
                <Position>0</Position>
                <NodeType>SYS</NodeType>
                <NodeId>3761</NodeId>
                <TemplateId>6244</TemplateId>
            </WorkFlowNode>
            <WorkFlowNode>
                <Comment>系统节点,动态计算,由管理员来完成审批</Comment>
                <NodeName>Admin</NodeName>
                <Position>0</Position>
                <NodeType>SYS</NodeType>
                <NodeId>3763</NodeId>
                <TemplateId>6244</TemplateId>
            </WorkFlowNode>
        </WorkflowNodes>
        <TemplateName>Owner--&gt;DBA--&gt;Admin</TemplateName>
        <Enabled>Y</Enabled>
        <IsSystem>1</IsSystem>
        <TemplateId>6244</TemplateId>
    </WorkFlowTemplate>
</WorkFlowTemplates>

JSON 格式

{
  "RequestId": "41067071-0243-4AAB-B3CF-4DE6D54F53B4",
  "Success": true,
  "WorkFlowTemplates": {
    "WorkFlowTemplate": [
      {
        "Comment": "系统定义审批线,仅需管理员审批",
        "WorkFlowNodes": {
          "WorkFlowNode": [
            {
              "Comment": "系统节点,动态计算,由管理员来完成审批",
              "NodeName": "Admin",
              "Position": 0,
              "NodeType": "SYS",
              "NodeId": 3763,
              "TemplateId": 6243
            }
          ]
        },
        "TemplateName": "Admin",
        "Enabled": "Y",
        "IsSystem": 1,
        "TemplateId": 6243
      },
      {
        "Comment": "系统定义审批线,先数据Owner审批,再DBA审批,最后Admin审批",
        "WorkflowNodes": {
          "WorkFlowNode": [
            {
              "Comment": "系统节点,动态计算,由用户操作的资源对应的Owner来完成审批",
              "NodeName": "Owner",
              "Position": 0,
              "NodeType": "SYS",
              "NodeId": 3762,
              "TemplateId": 6244
            },
            {
              "Comment": "系统节点,动态计算,由用户操作的资源对应的DBA来完成审批",
              "NodeName": "DBA",
              "Position": 0,
              "NodeType": "SYS",
              "NodeId": 3761,
              "TemplateId": 6244
            },
            {
              "Comment": "系统节点,动态计算,由管理员来完成审批",
              "NodeName": "Admin",
              "Position": 0,
              "NodeType": "SYS",
              "NodeId": 3763,
              "TemplateId": 6244
            }
          ]
        },
        "TemplateName": "Owner-->DBA-->Admin",
        "Enabled": "Y",
        "IsSystem": 1,
        "TemplateId": 6244
      }
    ]
  }
}

错误码

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