IniciarExecutarFluxoDeTrabalho

Use a mutação workflowAutomationStartWorkflowRun para iniciar uma execução de workflow para uma definição de workflow especificada.

Importante

Para limites de execuções simultâneas de workflow e etapas por execução, consulte Limites do sistema de workflow.

Parâmetro de entrada

Os seguintes parâmetros estão disponíveis para esta API.

Parâmetro	Tipo de dados	Descrição
`scope.id`	Corda	(Obrigatório) Seu ID da conta.
`scope.type`	Enum	(Opcional) O tipo de escopo (`ACCOUNT`).
`definition.name`	Corda	(Obrigatório) O nome da definição de workflow a ser executada.
`definition.scopeType`	Corda	(Opcional) O tipo de escopo da definição de workflow (`ACCOUNT` ou `ORGANIZATION`).
`definition.version`	Interno	(Opcional) A versão da definição de workflow a ser executada.
`workflowInputs`	Matriz	(Opcional) Pares de valor principal para passar como entradas para o workflow.
`idempotencyKey`	Corda	(Opcional) Um UUID que garante a idempotência da solicitação. O servidor rejeita valores que não são UUID (por exemplo, `f47ac10b-58cc-4372-a567-0e02b2c3d479`).
`options.logLevel`	Enum	(Opcional) Controla o logging durante a execução. Valores: `NONE` (padrão), `INFO`, `DEBUG`, `TRACE`.

Opção logLevel

A opção logLevel controla a quantidade de informações que o workflow gera durante a execução.

NONE (padrão): não gera saídas de log.
INFO: gera informações no nível da etapa.
DEBUG: adiciona um atributo aos logs de início da etapa com todas as entradas da etapa de ação, usando o formato workflowAutomation.inputs.<inputName>: <inputValue>.
TRACE: além da saída de DEBUG, adiciona um atributo aos logs de início da etapa com todas as saídas da etapa de ação, usando o formato workflowAutomation.outputs.<outputName>: <outputValue>.

Solicitação de amostra

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", version: 1 }
    workflowInputs: [
      { key: "checkOperational", value: "false" }
      { key: "checkNonOperational", value: "true" }
    ]
    scope: { id: "12345678" }
    idempotencyKey: "45e65924-5316-479c-a977-f6adfa17e07a"
    options: { logLevel: INFO }
  ) {
    runId
  }
}

Resposta de amostra

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.

Informações da execução do fluxo de trabalho

Monitore o status e os logs da execução do seu fluxo de trabalho

Sinalizar execução do fluxo de trabalho

Enviar sinais para fluxos de trabalho em execução aguardando entrada

Parar execução do fluxo de trabalho

Cancelar uma instância de fluxo de trabalho em execução

Obter definição do fluxo de trabalho

Visualizar a definição do fluxo de trabalho antes de executar

Esta tradução de máquina é fornecida para sua comodidade.