ワークフロー実行の開始

指定されたワークフロー定義のワークフローの実行を開始するには、workflowAutomationStartWorkflowRunミューテーションを使用します。

重要

ワークフローの同時実行数および1回の実行あたりのステップ数の制限については、「ワークフローシステムの制限」を参照してください。

入力

このAPIでは、以下のパラメーターを利用できます。

パラメータ	データ型	説明
`scope.id`	弦	（必須）アカウントID。
`scope.type`	イナム	（オプション）スコープタイプ（`ACCOUNT`）。
`definition.name`	弦	（必須）実行するワークフロー定義の名前です。
`definition.scopeType`	弦	（オプション）ワークフロー定義のスコープタイプ（`ACCOUNT`または`ORGANIZATION`）。
`definition.version`	Int	（オプション）実行するワークフロー定義のバージョン。
`workflowInputs`	配列	（任意）ワークフローへの入力として渡すキーの値のペアです。
`idempotencyKey`	弦	（オプション）リクエストのべき等性を保証するUUID。サーバーは非UUID値（たとえば、`f47ac10b-58cc-4372-a567-0e02b2c3d479`）を拒否します。
`options.logLevel`	イナム	（オプション）実行中のログ記録を制御します。値：`NONE`（デフォルト）、`INFO`、`DEBUG`、`TRACE`。

logLevelオプション

logLevelオプションは、実行中にワークフローが生成する情報の量を制御します。

NONE （デフォルト）：ログ出力を生成しません。
INFO：ステップレベルの情報を出力します。
DEBUG：workflowAutomation.inputs.<inputName>: <inputValue>の形式を使用して、すべてのアクションステップの入力を含む属性をステップ開始ログに追加します。
TRACE：DEBUGの出力に加えて、すべてのアクションステップの出力を含む属性を、workflowAutomation.outputs.<outputName>: <outputValue>の形式を使用してステップ開始ログに追加します。

サンプルリクエスト

ワークフローの作成・編集には、書き込みビルダーを使用します。 NerdGraph API エクスプローラーを参照してください。

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
  }
}

サンプル回答

突然変異により以下が返されます:

runId: ワークフロー実行の一意の識別子。この ID はWorkflowRunInfo 、 SignalWorkflowRun 、またはStopWorkflowRun API で使用します。

ワークフロー実行情報

ワークフロー実行のステータスとログを監視します

シグナルワークフローの実行

入力を待機している実行中のワークフローに信号を送信する

ワークフローの実行を停止

実行中のワークフローインスタンスをキャンセルする

ワークフロー定義を取得する

実行前にワークフロー定義を表示する

この機械翻訳は、参考として提供されています。

重要

入力 .css-21sua1{background:none;border:none;width:0;padding:0;}