Pular para o conteúdo principal
Versão: 2.2.1

APIs do SoftExpert Workflow: Como iniciar, executar e consultar instâncias

As que são apresentadas nessa seção são principalmente utilizadas para interagir com o sistema através de uma interface gráfica do usuário, em vez de fornecer dados estruturados em formato JSON. Em outras palavras, o objetivo dessas APIs é permitir que você execute ações no sistema e visualize informações por meio da interface do usuário do SoftExpert Workflow, em vez de obter dados em um formato estruturado.

dica

Tais APIs são uteis quando o desenvolvedor deseja enviar o usuário de um sistema de terceiro diretamente para a interface do SoftExpert Workflow.

Workflow

Inicialização de workflow

GET /se/workflow/api/new_workflow.php

Inicia uma instância do SoftExpert Workflow.

Query parametersTipoRequeridoDescrição
processidStringSimIdentificador do processo
workflowtitleStringSimTítulo do workflow
useridStringSimIdentificador do usuário (opcional)

Essa API permite iniciar uma instância do SoftExpert Workflow, e pode ser acessada por meio de uma solicitação HTTP GET para o endpoint /se/workflow/api/new_workflow.php.

Para iniciar a instância, é necessário fornecer os valores dos seguintes parâmetros:

  • processid: identificador único do processo que deseja iniciar.
  • workflowtitle: título da instância do workflow que está sendo iniciada.
  • userid (opcional): matrícula do usuário que está iniciando a instância. A API pode ser usada para iniciar uma instância do workflow no sistema e, com isso, permitir que o processo seja executado.

É importante notar que o usuário que está iniciando a instância deve estar autenticado no sistema antes de usar essa API e possuir permissão para instanciar o workflow requerido. Além disso, os valores corretos dos parâmetros processid e workflowtitle devem ser fornecidos para que a instância seja iniciada.

Para chamar a API, você precisará enviar uma solicitação GET para a URL https://my-domain.softexpert.com/se/workflow/api/new_workflow.php, passando os parâmetros necessários como parte da string de consulta da URL. Por exemplo: https://my-domain.softexpert.com/se/workflow/api/new_workflow.php?processid=1234&workflowtitle=MeuWorkflow&userid=5678.

Após o sucesso da chamada da API, uma tela para execução da instância será aberta no SoftExpert Workflow. Nessa etapa, é imprescindível preencher todos os dados obrigatórios referentes à primeira atividade da instância e realizar uma ação que esteja previamente parametrizada nessa mesma atividade. Somente dessa forma será possível prosseguir com o fluxo de trabalho.

Execução de atividade

GET /se/workflow/api/execute_activity.php

Abre a tela de execução da atividade do SoftExpert Workflow.

Query parametersTipoRequeridoDescrição
workflowidStringSimIdentificador da instancia do SoftExpert Workflow
activityidStringSimIdentificador da atividade
activitysequenceStringSimSequência da atividade (Este parâmetro é requerido quando há mais de uma ação na atividade de mesmo identificador)

Esta API é usada para abrir a tela de execução de uma atividade no SoftExpert Workflow. Para usá-la, você precisará fornecer os valores para os parâmetros workflowid, activityid e, opcionalmente, activitysequence.

O parâmetro workflowid é o identificador da instância do SoftExpert Workflow que contém a atividade que você deseja executar. O parâmetro activityid é o identificador único da atividade que deseja executar. Se houver mais de uma ação na atividade com o mesmo identificador, você também precisará fornecer o parâmetro activitysequence, que especifica a sequência da ação que deseja executar.

Para chamar a API, você precisará enviar uma solicitação GET para a URL https://my-domain.softexpert.com/se/workflow/api/execute_activity.php, passando os parâmetros necessários como parte da string de consulta da URL. Por exemplo:https://my-domain.softexpert.com/se/workflow/api/execute_activity.php?workflowid=1234&activityid=5678&activitysequence=1

Quando a API for chamada com sucesso, a tela de execução da atividade será aberta no SoftExpert Workflow.

Consulta de informações

GET /se/workflow/api/view_workflow.php

Abre a tela de dados da Instância do SoftExpert Workflow

Query parametersTipoRequeridoDescrição
workflowidStringSimIdentificador da instancia do SoftExpert Workflow

Esta API é usada para abrir a tela de dados de uma instância específica do SoftExpert Workflow. Para usá-la, você precisará fornecer o valor do parâmetro workflowid, que é o identificador único da instância do workflow que deseja consultar.

Para chamar a API, você precisará enviar uma solicitação GET para a URL https://my-domain.softexpert.com/se/workflow/api/view_workflow.php, passando o parâmetro workflowid como parte da string de consulta da URL. Por exemplo: https://my-domain.softexpert.com/se/workflow/api/view_workflow.php?workflowid=1234

Quando a API for chamada com sucesso, a tela de dados da instância do SoftExpert Workflow será aberta, permitindo que você visualize as informações associadas à instância, como o status atual do workflow, as atividades que já foram concluídas e as atividades pendentes, etc.

cuidado

Certifique-se de que o usuário esteja autenticado antes de fazer a chamada para qualquer API documentada nesta seção, caso contrário, a API não poderá ser usada.