ワークフロースタジオ フローへの API アクセス
の機能にアクセスできます。ワークフロースタジオフロー作成者は、個々のフロー、サブフロー、およびアクションを設計中にクライアント呼び出し可能にすることができます。
利用可能な ワークフロースタジオ フロー API
サーバースクリプトまたはクライアントスクリプトから次の API を使用し、フロー、サブフロー、アクションをトリガーします。
FlowAPI クイックメソッド
FlowAPI クラスのクイックメソッドを使用すると、実行の詳細やその他の関連レコードを作成せずに、サーバー側のスクリプトからアクション、フロー、またはサブフローを実行できます。これらのメソッドを使用すると、本番環境での大量処理の速度を高め、記録保持のオーバーヘッドをなくすことでパフォーマンスを向上させることができます。メソッドは次のとおりです。
- executeActionQuick()、executeFlowQuick()、executeSubflowQuick()：現在のユーザーセッションから同期的に、サーバー側スクリプトからアクション、フロー、またはサブフローを実行します。
- startActionQuick()、startFlowQuick()、startSubflowQuick()：サーバー側スクリプトから非同期的に、アクション、フロー、またはサブフローを実行します。
XML および JSON ストリーミング API
大規模なストリーミングまたは非ストリーミング JSON または XML ペイロードをビルドし、それを REST または SOAP 要求で使用して大量のデータをサードパーティ API に送信します。たとえば、これらの API を使用して ワークフロースタジオ スクリプトステップで JSON ペイロードを作成し、戻り値を REST ステップに渡して、要求をサードパーティサービスに送信できます。詳細については、「 JSONStreamingBuilder 」と「 XMLStreamingBuilder 」を参照してください。
クライアント呼び出し可能 API
デフォルトでは、フロー、サブフロー、およびアクションは、サーバースクリプト内の FlowAPI からのみ呼び出すことができます。フローデザイナーおよびアクションデザイナーは、設計プロセス中に [クライアント呼び出し可能] オプションを有効にすることで、個々のフロー、サブフロー、またはアクションをクライアント呼び出し可能にできます。
実行方法のサポート
フローとサブフローはシステムユーザーまたはセッションを開始したユーザーとして実行できます。この動作は、[フロープロパティ] から設定します。すべての API クイックメソッドは実行方法プロパティを無視し、常にシステムユーザーとして実行されます。
アクションは常にセッションを開始するユーザーとして実行されます。
コードスニペット
アプリケーション開発者は、[コードスニペット] オプションにより、特定のフロー、サブフロー、アクションを呼び出す JavaScript 関数を生成できます。ビジネスルールなどのスクリプト、または特定の ワークフロースタジオ 要素を呼び出す [スクリプト - バックグラウンド] モジュールで、コードスニペットを使用します。コードスニペットが生成されるのは、公開済みのフロー、サブフロー、アクションのみです。ドラフト状況または変更ステータスの ワークフロースタジオ 要素では、コードスニペットは生成されません。