この API は、指定されたワークフロー定義のワークフロー実行を開始します。
重要
ワークフローの同時実行の数と、特定の実行で実行されるステップの数は、「ワークフローのシステム制限」で定義されます。
パラメーター
パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| 弦 | はい | あなたのアカウントID。 |
| イナム | はい | スコープの種類 (ACCOUNT)。 |
| 弦 | はい | 実行するワークフロー定義の名前。 |
| 配列 | いいえ | ワークフローへの入力として渡すオプションのキーの値のペア。 |
| イナム | いいえ | 実行中のログ記録を制御します。値:
(デフォルト)、
、
。 |
logLevelオプション
logLevelオプションは、ワークフロー実行中に生成されるログ情報の量を制御します。
利用可能な値:
NONE(デフォルト): ログ出力は生成されません。INFO: ステップレベル情報を出力します。DEBUG: すべてのアクション ステップ入力とともに、開始されたステップのログに属性を追加します。
例
ワークフローの作成・編集には、書き込みビルダーを使用します。 NerdGraph API エクスプローラーを参照してください。
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 }}レスポンス
突然変異により以下が返されます:
runId: ワークフロー実行の一意の識別子。この ID はWorkflowRunInfo、SignalWorkflowRun、またはStopWorkflowRunAPI で使用します。