Call ListWorkFlowTemplates get approval templates list.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListWorkFlowTemplates

The operation that you want to perform. Value: ListWorkFlowTemplates .

Tid Long Yes -1

The ID of the tenant.

Note The tenant ID is taken from the tenant ID displayed when you move the pointer on your profile picture. For more information, see View tenant information .
SearchName String No Admin

The name of the search template.

Response parameters

Parameter Type Sample response Description
ErrorCode String UnknownError

The error codes.

ErrorMessage String UnknownError

The error message.

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

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

WorkFlowTemplates Array of WorkFlowTemplate

The list of approval templates.

WorkFlowTemplate
Comment String test

The description of the consumer group.

CreateUserId Long 1234

The ID of the creator.

Enabled String Y

Specifies whether the transcoding template is enabled. Valid values:

  • Y: enabled
  • N: Disabled
IsSystem Integer 1

Indicates whether the approval template is system-defined. Valid values:

  • 1: Yes
  • 0: No
TemplateId Long 12345

The ID of the launch template.

TemplateName String Admin

The name of the launch template.

WorkflowNodes Array of WorkflowNode

The information about the approval node.

WorkflowNode
Comment String test

The description of the consumer group.

CreateUserId Long 1234

The ID of the creator.

NodeId Long 123

The ID of the node.

NodeName String test

The name of the node.

NodeType String SYS

The type of the node. Valid values:

  • SYS: System defined
  • USER_LIST: a user-defined identifier.
Position Integer 1

The order.

TemplateId Long 12345

The ID of the launch template.

Examples

Sample request


     http(s)://[Endpoint]/? Action=ListWorkFlowTemplates &Tid=-1 &<common request parameters> 
   

Sample success responses

XML format


     <RequestId> 41067071-0243-4aab-b3cf-4de6d54f53b4 </RequestId> <Success> true </Success> <WorkFlowTemplates> <WorkFlowTemplate> <Comment> system define approval line, it is only necessary to administrator approval </Comment> <WorkFlowNodes> <WorkFlowNode> <Comment> system node dynamically computed by an administrator to complete the examination and approval </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> System-defined approval line, First Data Owner approval then DBA approval last Admin approval </Comment> <WorkflowNodes> <WorkFlowNode> <Comment> system node dynamic calculation operated by a user of the resource corresponding to the Owner of the project to complete the examination and approval </Comment> <NodeName> Owner </NodeName> <Position> 0 </Position> <NodeType> SYS </NodeType> <NodeId> 3762 </NodeId> <TemplateId> 6244 </TemplateId> </WorkFlowNode> <WorkFlowNode> <Comment> system node dynamic calculation operated by a user of the resource corresponding to the DBA to complete the examination and approval </Comment> <NodeName> DBA </NodeName> <Position> 0 </Position> <NodeType> SYS </NodeType> <NodeId> 3761 </NodeId> <TemplateId> 6244 </TemplateId> </WorkFlowNode> <WorkFlowNode> <Comment> system node dynamically computed by an administrator to complete the examination and approval </Comment> <NodeName> Admin </NodeName> <Position> 0 </Position> <NodeType> SYS </NodeType> <NodeId> 3763 </NodeId> <TemplateId> 6244 </TemplateId> </WorkFlowNode> </WorkflowNodes> <TemplateName> Owner-->DBA-->Admin </TemplateName> <Enabled> Y </Enabled> <IsSystem> 1 </IsSystem> <TemplateId> 6244 </TemplateId> </WorkFlowTemplate> </WorkFlowTemplates> 
   

JSON


     {"RequestId": "41064071-0243-4 AAB-B3CF-4DE6D54F53B4", "Success": true, "WorkFlowTemplates": { "WorkFlowTemplate": [ { "Comment": "The system-defined approval line, only the administrator's approval is required", "WorkFlowNodes": { "WorkFlowNode": [ { "Comment": "System node, dynamic computing, approved by the administrator", "NodeName": "Admin", "Position": 0, "NodeType": "SYS", " NodeId ": 3763, " TemplateId ": 6243 } ] }, " TemplateName ": " Admin ", " Enabled ": " Y ", " IsSystem ": 1, " TemplateId ": 6243 }, { " Comment ": " The approval line defined in system, data Owner approval first, DBA approval again and Admin approval again. "WorkflowNodes": { "WorkFlowNode": [ { "Comment": "The system node, which is dynamically calculated. The approval process will be completed by the Owner corresponding to the resource you operate.", "NodeName": "Owner", "Position": 0, "NodeType": "SYS", "NodeId": 3762, "TemplateId": 6244 }, { "Comment": "The system node, which is dynamically computed. The approval is completed by the DBA corresponding to the resource operated by the user.", "NodeName": "DBA", "Position": 0, "NodeType": "SYS", "NodeId": 3761, "TemplateId": 6244 }, {"Comment": "The system node that dynamically calculates the result. Approval is handled by the administrator.", "NodeName": "Admin", "Position": 0, "NodeType": "SYS", "NodeId": 3763, "TemplateId": 6244 } ] }, "TemplateName": "Owner -->DBA -->Admin", "Enabled": "Y", "IsSystem": 1, "TemplateId": 6244 } ] }} 
   

Error codes

For more information about error codes, see error center.