---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# ScriptableFlowRunnerResult - スコープ指定

# ScriptableFlowRunnerResult - スコープ指定 {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：11分

ScriptableFlowRunner を使用してフロー、サブフロー、またはアクションを実行した結果をキャプチャします。コンテキスト ID、ドメイン、フロー実行の出力などのデータが含まれます。
これらのメソッドは、サーバー側スクリプトで `sn_fd` 名前空間識別子とともに使用します。

## API 呼び出し順 {#ScriptableFlowRunnerResultScopedAPI__section_idt_q3w_slb}

フロー、サブフロー、およびアクションは、API を次の順番で使用して構築および実行します。  

1. FlowAPI：ビルダーオブジェクトを作成する
:   getRunner() を使用して ScriptableFlowRunner ビルダーオブジェクトをインスタンス化します。

2. ScriptableFlowRunner：実行する ワークフロースタジオ コンテンツを指定する
:   下記のメソッドを次の順番で使用して、ビルダーパターンを作成します。  
    1. action()、datastream()、flow()、subflow() メソッドのいずれかを使用して、ビルドする ワークフロースタジオ オブジェクトのタイプを指定します。
    2. addInput()、inDomain()、quick() などのメソッドを 1 つまたは複数使用して、実行パラメーターを指定します。
    3. run() メソッドを使用して、アクション、フロー、サブフローを指定されたパラメーターで実行し、ScriptableFlowRunnerResult オブジェクトを返します。
    {#ScriptableFlowRunnerResultScopedAPI__ol_hcw_m4s_slb}

3. ScriptableFlowRunnerResult： ワークフロースタジオ 実行の詳細を取得する
:   getContextId()、getOutputs()、getDomainId() などのメソッドを 1 つまたは複数使用して、実行結果の詳細を表示します。

## 例 {#ScriptableFlowRunnerResultScopedAPI__section_afv_mjw_slb}

この例では、ScriptableFlowRunner ビルダーオブジェクトを作成し、それを使用して特定のレコードの承認アクションを実行する方法を示します。ScriptableFlowRunnerResult オブジェクトは、実行の引数とアクションの出力をキャプチャします。  


    (function() {
      try {

        var inputs = {}; 

        inputs['sys_id'] = '57af7aec73d423002728660c4cf6a71c';  // Pass the record's sys_id in as input.  

        var result = sn_fd.FlowAPI.getRunner()  // Create a ScriptableFlowRunner builder object.
          .action('global.markapproved')        // Run the global scope action named markapproved.
          .inForeground()
          .inDomain('TOP/ACME')                 // Run the action from the TOP/ACME domain.                               
          .withInputs(inputs)
          .run();                               // Run the action and return a FlowRunnerResult object.

        var contextId = result.getContextId();  // Retrieve the context ID from the result
        var dateRun = result.getDate();
        var domainUsed = result.getDomainId();  // Retrieve the Domain ID from the result.
        var flowName = result.getFlowObjectName();
        var flowObjectType = result.getFlowObjectType();

        var outputs = result.getOutputs();            // Retrieve any outputs from the action execution.
        var newApprovalStatus = outputs['approval'];  // Echo back the approval status for verification.
    		
      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }
    	
    })();
       
## ScriptableFlowRunnerResult - debug() {#ariaid-title2}

コンテキスト ID、ドメイン ID、実行出力など、実行されたフロー、サブフロー、またはアクションに関する情報を返します。
{#FlowRunnerResult-debug__table_hys_1v5_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#FlowRunnerResult-debug__table_hys_1v5_rlb} {#FlowRunnerResult-debug__table_iys_1v5_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ワークフロースタジオ のアクション、フロー、またはサブフローの実行に関する実行の詳細。 * flow object name：フロー、サブフロー、またはアクションの名前。 * flow object type：フロー、サブフロー、アクション、またはデータストリームアクション。 * domain ID：フロー、サブフロー、またはアクションが実行されたドメインの ID。 * result time：実行にかかった時間。 * context ID：アクション、フロー、またはサブフローに対する ワークフロースタジオ の実行詳細レコードの sys_id。 * output count：アクションまたはサブフローの出力の数。 {#FlowRunnerResult-debug__ul_tcc_dqr_5lb} |
[表 : 2. 返される内容]

{#FlowRunnerResult-debug__table_iys_1v5_rlb}  
この例では、ScriptableFlowRunnerResult オブジェクトから、実行されたフロー、サブフロー、またはアクションに関する情報を取得する方法を示します。

    (function() {
      try {

        var result = sn_fd.FlowAPI.getRunner()
          .flow('global.test_flow')
          .inForeground()
          .timeout(12000)
          .run();

        gs.info(result.debug());

      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }

    })();

出力：

    *** Script: FlowRunnerResult
    Flow Object Name: global.test_flow
    Flow Object Type: flow
    Domain: null
    Result Time: 2020-06-08 18:28:41
    ContextId: null
    Output count: 0

## ScriptableFlowRunnerResult - getContextId() {#ariaid-title3}

フロー、サブフロー、またはアクションのコンテキスト ID を返します。
{#FlowRunnerResult-getContextId__table_dnx_p4p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 3. パラメーター]

{#FlowRunnerResult-getContextId__table_dnx_p4p_rlb} {#FlowRunnerResult-getContextId__table_enx_p4p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | アクション、フロー、またはサブフローに対する ワークフロースタジオ の実行詳細レコードの sys_id。 |
[表 : 4. 返される内容]

{#FlowRunnerResult-getContextId__table_enx_p4p_rlb}  
この例は、ScriptableFlowRunnerResult オブジェクトからコンテキスト ID を取得する方法を示しています。

    var contextId = result.getContextId();

出力：

    4ecead85c4da1110598d0c7d6bf73554

## ScriptableFlowRunnerResult - getDate() {#ariaid-title4}

ワークフロースタジオ のアクション、フロー、またはサブフローが実行された日時を GlideDateTime オブジェクトとして返します。
{#FlowRunnerResult-getDate__table_pwr_r4p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 5. パラメーター]

{#FlowRunnerResult-getDate__table_pwr_r4p_rlb} {#FlowRunnerResult-getDate__table_qwr_r4p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| GlideDateTime | フロー、サブフロー、またはアクションの実行日時。 |
[表 : 6. 返される内容]

{#FlowRunnerResult-getDate__table_qwr_r4p_rlb}  
この例では、ScriptableFlowRunnerResult オブジェクトからフロー実行の日時を取得する方法を示します。

    (function() {
      try {

        var result = sn_fd.FlowAPI.getRunner()
          .flow('global.test_flow')
          .inForeground()
          .timeout(12000)
          .run();

        gs.info(result.getDate());

      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }

    })();

出力：

    2020-05-22 18:45:42

## ScriptableFlowRunnerResult - getDataStream() {#ariaid-title5}

データストリームアクションからデータのストリームを返します。
ScriptableFlowRunner ビルダークラスで datastream() メソッドが使用された場合、データのストリームを ScriptableDataStream オブジェクトとして返します。ストリーム内のアイテムを反復処理するには、ScriptableDataStream クラスを使用します。「[ScriptableDataStream](https://servicenow-prod.fluidtopics.net/Am6spO0jzjjQ~pRu8enokQ#ScriptableDataStreamAPI "ScriptableDataStream API は、データのストリームとやり取りするためのメソッドを提供します。")」を参照してください。

データストリームアクションの詳細については、「 [データストリームアクションとページネーション](https://www.servicenow.com/docs/access?context=data-stream-actions&version=xanadu&pubname=xanadu-integrate-applications&ft:locale=en-US)」を参照してください。
{#FlowRunnerResult-getDataStream__table_vs4_w4p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 7. パラメーター]

{#FlowRunnerResult-getDataStream__table_vs4_w4p_rlb} {#FlowRunnerResult-getDataStream__table_ws4_w4p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| ScriptableDataStream | データストリーム内のアイテムの反復処理に使用できる ScriptableDataStream オブジェクト。ScriptableDataStream クラスのメソッドを使用して、このオブジェクトを操作します。「[ScriptableDataStream](https://servicenow-prod.fluidtopics.net/Am6spO0jzjjQ~pRu8enokQ#ScriptableDataStreamAPI "ScriptableDataStream API は、データのストリームとやり取りするためのメソッドを提供します。")」を参照してください。 |
[表 : 8. 返される内容]

{#FlowRunnerResult-getDataStream__table_ws4_w4p_rlb}  
この例では、ScriptableFlowRunnerResult オブジェクトからデータストリームを取得する方法を示します。

    var datastream = result.getDataStream();

## ScriptableFlowRunnerResult - getDomainId() {#ariaid-title6}

ワークフロースタジオ のアクション、フロー、またはサブフローが実行されたドメインの sys_id を返します。
{#FlowRunnerResult-getDomainId__table_wzw_s4p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 9. パラメーター]

{#FlowRunnerResult-getDomainId__table_wzw_s4p_rlb} {#FlowRunnerResult-getDomainId__table_xzw_s4p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ワークフロースタジオ のアクション、フロー、またはサブフローが実行されたドメインの sys_id。 |
[表 : 10. 返される内容]

{#FlowRunnerResult-getDomainId__table_xzw_s4p_rlb}  
この例は、ScriptableFlowRunnerResult オブジェクトからドメイン ID を取得する方法を示しています。

    (function() {
      try {

        var result = sn_fd.FlowAPI.getRunner()
          .flow('global.test_flow')
          .inForeground()
          .inDomain('TOP/ACME')
          .timeout(12000)
          .run();

        gs.info(result.getDomainId());

      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }

    })();

出力：

    4ecead85a4da1110598d0c7d6bf75554

## ScriptableFlowRunnerResult - getFlowObjectType() {#ariaid-title7}

ワークフロースタジオ のオブジェクト実行のタイプを返します。
{#FlowRunnerResult-getFlowObjectType__table_cmv_54p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 11. パラメーター]

{#FlowRunnerResult-getFlowObjectType__table_cmv_54p_rlb} {#FlowRunnerResult-getFlowObjectType__table_dmv_54p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| FlowObjectType | 実行する ワークフロースタジオ オブジェクトのタイプ。アクション、フロー、またはサブフローのいずれかです。 |
[表 : 12. 返される内容]

{#FlowRunnerResult-getFlowObjectType__table_dmv_54p_rlb}  
この例は、ScriptableFlowRunnerResult API からフローオブジェクトのタイプを取得する方法を示しています。

    (function() {
      try {

        var result = sn_fd.FlowAPI.getRunner()
          .flow('global.test_flow')
          .inForeground()
          .timeout(12000)
          .run();

        gs.info(result.getFlowObjectType());

      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }

    })();

出力：

    flow

## ScriptableFlowRunnerResult - getFlowObjectName() {#ariaid-title8}

ワークフロースタジオ のアクション、フロー、またはサブフロー実行のスコープと内部名を返します。
{#FlowRunnerResult-getFlowObjectName__table_ycz_t4p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 13. パラメーター]

{#FlowRunnerResult-getFlowObjectName__table_ycz_t4p_rlb} {#FlowRunnerResult-getFlowObjectName__table_zcz_t4p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | ワークフロースタジオ のアクション、フロー、またはサブフロー実行のスコープと内部名。たとえば、`global.emailflow` です。 |
[表 : 14. 返される内容]

{#FlowRunnerResult-getFlowObjectName__table_zcz_t4p_rlb}  
この例は、ScriptableFlowRunnerResult オブジェクトからフローやサブフローの名前、またはアクション名を取得する方法を示しています。

    (function() {
      try {

        var result = sn_fd.FlowAPI.getRunner()
          .flow('global.test_flow')
          .inForeground()
          .timeout(12000)
          .run();

        gs.info(result.getFlowObjectName());

      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }

    })();

出力：

    global.test_flow

## ScriptableFlowRunnerResult - getOutputs() {#ariaid-title9}

完了した ワークフロースタジオ のアクション、フロー、またはサブフローの出力を返します。
{#FlowRunnerResult-getOutputs__table_fxw_q4p_rlb__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 15. パラメーター]

{#FlowRunnerResult-getOutputs__table_fxw_q4p_rlb} {#FlowRunnerResult-getOutputs__table_gxw_q4p_rlb__entry__2}

| タイプ | 説明 |
|-|-|
| オブジェクト | 完了した ワークフロースタジオ のアクション、フロー、またはサブフローの出力を含むオブジェクト。 |
[表 : 16. 返される内容]

{#FlowRunnerResult-getOutputs__table_gxw_q4p_rlb}  
この例は、ScriptableFlowRunner API で ワークフロースタジオ のアクション、フロー、またはサブフローから出力を取得する方法を示しています。

    (function() {
      try {

        var result = sn_fd.FlowAPI.getRunner()
          .action('global.test_action')
          .inForeground()
          .timeout(12000)
          .run();

        gs.info(result.getOutputs());

      } catch (ex) {
        var message = ex.getMessage();
        gs.error(message);
      }

    })();

出力：

    Flow Designer: Warning. This is an important log message.