フローデザイナー への API アクセス

  • リリースバージョン: Washingtondc
  • 更新日 2024年02月01日
  • 読む3読むのに数分
  • の機能にアクセスできます。フローデザイナーフローデザイナーは、個々のフロー、サブフロー、およびアクションを設計中にクライアントコール可能にすることができます。

    利用可能な フローデザイナー API

    サーバースクリプトまたはクライアントスクリプトから次の API を使用し、フロー、サブフロー、アクションをトリガーします。

    サーバー側
    FlowAPI:同期メソッドまたは非同期メソッドを使用し、実行の詳細があるかないかに関係なく、フロー、サブフロー、またはアクションをトリガーします。
    クライアント側
    GlideFlow:アクション、フロー、サブフローでクライアント側インタラクションを実行します。Flow Designer は、クライアントから呼び出すフロー、サブフロー、アクションを有効にする必要があります。

    FlowAPI クイックメソッド

    FlowAPI クラスのクイックメソッドを使用すると、実行の詳細やその他の関連レコードを作成せずに、サーバー側のスクリプトからアクション、フロー、またはサブフローを実行できます。これらのメソッドを使用すると、本番環境での大量処理の速度を高め、記録保持のオーバーヘッドをなくすことでパフォーマンスを向上させることができます。メソッドは次のとおりです。

    • executeActionQuick()executeFlowQuick()executeSubflowQuick():現在のユーザーセッションから同期的に、サーバー側スクリプトからアクション、フロー、またはサブフローを実行します。
    • startActionQuick()startFlowQuick()startSubflowQuick():サーバー側スクリプトから非同期的に、アクション、フロー、またはサブフローを実行します。

    XML および JSON ストリーミング API

    大規模なストリーミングまたは非ストリーミング JSON または XML ペイロードを構築し、それを REST または SOAP 要求で使用して大量のデータをサードパーティ API に送信します。たとえば、これらの API を使用して ServiceNow® フローデザイナー スクリプトステップで JSON ペイロードを作成し、戻り値を REST ステップに渡して、要求をサードパーティサービスに送信できます。詳細については、「 JSONStreamingBuilder 」と「 XMLStreamingBuilder 」を参照してください。

    クライアントコール可能 API

    デフォルトでは、フロー、サブフロー、およびアクションは、サーバースクリプト内の FlowAPI からのみ呼び出すことができます。フローデザイナーおよびアクションデザイナーは、設計プロセス中に [クライアントコール可能] オプションを有効にすることで、個々のフロー、サブフロー、またはアクションをクライアントコール可能にできます。

    実行方法のサポート

    フローとサブフローはシステムユーザーまたはセッションを開始したユーザーとして実行できます。この動作は、[フロープロパティ] から設定します。すべての API クイックメソッドは実行方法プロパティを無視し、常にシステムユーザーとして実行されます。

    アクションは常にセッションを開始するユーザーとして実行されます。

    コードスニペット

    アプリケーション開発者は、[コードスニペット] オプションにより、特定のフロー、サブフロー、アクションを呼び出す JavaScript 関数を生成できます。ビジネスルールなどのスクリプト、または特定の フローデザイナー 要素を呼び出す [スクリプト - バックグラウンド] モジュールで、コードスニペットを使用します。コードスニペットが生成されるのは、公開済みのフロー、サブフロー、アクションのみです。ドラフトステータスまたは変更ステータスの フローデザイナー 要素では、コードスニペットは生成されません。