Iniciar ejecución del flujo de trabajo

Esta API inicia la ejecución de un flujo de trabajo para una definición de flujo de trabajo específica.

Importante

El número de ejecuciones simultáneas del flujo de trabajo y el número de pasos ejecutados en una ejecución determinada se definen en Límites del sistema de flujo de trabajo.

Parámetros

Parámetro	Tipo	Requerido	Descripción
`scope.id`	Cadena	Sí	Su ID de cuenta.
`scope.type`	Enumeración	Sí	El tipo de alcance (CUENTA).
`definition.name`	Cadena	Sí	El nombre de la definición del flujo de trabajo a ejecutar.
`workflowInputs`	Matriz	No	Pares clave-valor opcionales para pasar como entradas al flujo de trabajo.
`options.logLevel`	Enumeración	No	Controla el logging durante la ejecución. Valores: `NONE` (predeterminado), `INFO` , `DEBUG` .

opción logLevel

La opción logLevel controla la cantidad de información de logging generada durante la ejecución del flujo de trabajo.

Valores disponibles:

NONE (predeterminado): no se generarán salidas de log.
INFO:Emite información de nivel de paso.
DEBUG:Agrega atributo a los logs de inicio del paso con todas las entradas del paso de acción.

Ejemplo

Emplee el generador de consultas para crear y editar un flujo de trabajo. Consulte el explorador de la API de 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
  }
}

Respuesta

La mutación devuelve:

runId: El identificador único para la ejecución del flujo de trabajo. Use este ID con las API WorkflowRunInfo, SignalWorkflowRun o StopWorkflowRun.