Todos os produtos
Search
Central de documentação

:ListWorkFlowTemplates

Última atualização: Jul 08, 2026

Chame a API ListWorkFlowTemplates para obter a lista de modelos de aprovação.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos chamar esta operação no OpenAPI Explorer. Use o OpenAPI Explorer para pesquisar operações de API, chamá-las e gerar dinamicamente códigos de exemplo do SDK.

Parâmetros da solicitação

Parâmetro Tipo Obrigatório Exemplo Descrição
Action String Sim ListWorkFlowTemplates

Operação a ser executada. Valor: ListWorkFlowTemplates .

Tid Long Sim -1

ID do locatário.

Nota Obtenha o ID do locatário ao passar o ponteiro do mouse sobre sua foto de perfil. Para mais informações, consulte Visualizar informações do locatário .
SearchName String Não Admin

Nome do modelo de pesquisa.

Parâmetros de resposta

Parâmetro Tipo Resposta de exemplo Descrição
ErrorCode String UnknownError

Código de erro.

ErrorMessage String UnknownError

Mensagem de erro.

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

ID da solicitação.

Success Boolean true

Indica se a chamada foi bem-sucedida.

WorkFlowTemplates Array of WorkFlowTemplate

Lista de modelos de aprovação.

WorkFlowTemplate
Comment String test

Descrição do modelo de aprovação.

CreateUserId Long 1234

ID do criador.

Enabled String Y

Indica se o modelo de aprovação está ativado. Valores válidos:

  • Y: ativado
  • N: desativado
IsSystem Integer 1

Indica se o modelo de aprovação é definido pelo sistema. Valores válidos:

  • 1: sim
  • 0: não
TemplateId Long 12345

ID do modelo de aprovação.

TemplateName String Admin

Nome do modelo de aprovação.

WorkflowNodes Array of WorkflowNode

Informações sobre o nó de aprovação.

WorkflowNode
Comment String test

Descrição do nó de aprovação.

CreateUserId Long 1234

ID do criador.

NodeId Long 123

ID do nó.

NodeName String test

Nome do nó.

NodeType String SYS

Tipo do nó. Valores válidos:

  • SYS: definido pelo sistema
  • USER_LIST: identificador definido pelo usuário.
Position Integer 1

Ordem de execução.

TemplateId Long 12345

ID do modelo de aprovação.

Exemplos

Exemplo de solicitação


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

Exemplos de respostas de sucesso

Formato XML


     <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 } ] }} 
   

Códigos de erro

Para mais informações sobre códigos de erro, consulte o centro de erros.