IniciarExecutarFluxoDeTrabalho

Esta API inicia a execução de um fluxo de trabalho para uma definição de fluxo de trabalho específica.

Importante

O número de execuções simultâneas do fluxo de trabalho e o número de etapas executadas em uma determinada execução são definidos em Limites do sistema de fluxo de trabalho.

Parâmetro

Parâmetro	Tipo	Obrigatório	Descrição
`scope.id`	Corda	Sim	Seu ID da conta.
`scope.type`	Enum	Sim	O tipo de escopo (CONTA).
`definition.name`	Corda	Sim	O nome da definição de fluxo de trabalho a ser executada.
`workflowInputs`	Matriz	Não	Pares chave-valor opcionais para passar como entradas para o fluxo de trabalho.
`options.logLevel`	Enum	Não	Controla o logging durante a execução. Valores: `NONE` (padrão), `INFO` , `DEBUG` .

Opção logLevel

A opção logLevel controla a quantidade de informações de logging geradas durante a execução do fluxo de trabalho.

Valores disponíveis:

NONE (padrão): Nenhum log de saída será gerado.
INFO: Exibe informações em nível de etapa.
DEBUGAdiciona um atributo aos logs de início da etapa com todas as entradas da etapa de ação.

Exemplo

Utilize o criador de consulta para criar e editar um fluxo de trabalho. Consulte o explorador de API do NerdGraph.

mutation {
  workflowAutomationStartWorkflowRun(
    definition: { name: "json-parsing" }
    workflowInputs: [
      { key: "checkOperational", value: "false" }
      { key: "checkNonOperational", value: "true" }
    ]
    scope: { id: "11933347" }
    idempotencyKey: "45e65924-5316-479c-a977-f6adfa17e07a"
    options: { logLevel: INFO }
  ) {
    runId
  }
}

Resposta

A mutação retorna:

runId: O identificador exclusivo para a execução do fluxo de trabalho. Use este ID com as APIs WorkflowRunInfo, SignalWorkflowRun ou StopWorkflowRun.