Démarrer le workflow

Cette API lance l'exécution d'un workflow pour une définition workflow spécifiée.

Important

Le nombre d'exécutions workflow simultanées et le nombre d'étapes exécutées dans une exécution donnée sont définis dans les limites du système de workflow.

Paramètres

paramètres	Type	Requis	Description
`scope.id`	Chaîne	Oui	Votre ID de compte.
`scope.type`	Énumération	Oui	Le type de portée (ACCOUNT).
`definition.name`	Chaîne	Oui	Le nom de la définition de workflow à exécuter.
`workflowInputs`	Array	Non	Paires clé-valeur facultatives à transmettre en tant qu'entrées au workflow.
`options.logLevel`	Énumération	Non	Contrôle le logging pendant l’exécution. Valeurs : `NONE` (par défaut), `INFO` , `DEBUG` .

option logLevel

L'option logLevel contrôle la quantité d'informations de logging générées pendant l'exécution du workflow.

Valeurs disponibles :

NONE (par défaut) : aucune sortie de log ne sera générée.
INFO: Fournit des informations au niveau de l'étape.
DEBUG: Ajoute un attribut aux logs de l'étape démarrée avec toutes les entrées de l'étape d'action.

Exemple

Utilisez le générateur de requêtes pour créer et éditer un workflow. Voir l'explorateur d'API 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
  }
}

Réponse

La mutation retourne :

runId: L'identifiant unique de l'exécution du workflow. Utilisez cet ID avec les API WorkflowRunInfo, SignalWorkflowRun ou StopWorkflowRun.