SOAPResponseV2 - スコープ指定、グローバル

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間:5分
  • SOAPResponseV2 API は、送信 SOAP メッセージによって返されたデータを JavaScript コードで使用するメソッドを提供します。

    SOAPResponseV2 オブジェクトは SOAPMessageV2メソッド execute() および executeAsync() によって返されます。

    この API は、スコープ対象のアプリケーションまたはグローバルスコープで使用できます。

    この API は sn_ws 名前空間で実行されます。

    SOAPResponseV2 - getAllHeaders()

    応答に含まれるすべてのヘッダーを返します (重複するヘッダーも含む)。

    表 : 1. パラメーター
    名前 タイプ 説明
    なし
    表 : 2. 返される内容
    タイプ 説明
    List<GlideHTTPHeader> 応答に含まれるヘッダーのリスト。各ヘッダーは、ヘッダーの名前を含む GlideHTTPHeader オブジェクトとして表されます。
    var r = new sn_ws.SOAPMessageV2('<A SOAP message>', 'get');
    var response = r.execute();
    var headers = response.getAllHeaders();
    for(var i in headers){
      gs.info(headers[i].name + ': ' + headers[i].value);
    }

    SOAPResponseV2 - getBody()

    SOAP 応答本文のコンテンツを取得します。

    表 : 3. パラメーター
    名前 タイプ 説明
    なし
    表 : 4. 返される内容
    タイプ 説明
    文字列 SOAP 応答本文。
    var body = response.getBody();

    SOAPResponseV2 - getCookies()

    応答に含まれるすべての cookie を返します。

    表 : 5. パラメーター
    名前 タイプ 説明
    なし
    表 : 6. 返される内容
    タイプ 説明
    オブジェクト cookie を表す文字列のアレイ。アレイを反復処理して、各 cookie に対して操作を実行します。

    応答から個々の cookie を表示します。

    var cookies = response.getCookies();
    for (var i = 0; i < cookies.length; i++) {
      gs.info('cookie: ' + cookies.get(i));
    }
    出力:
    cookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly
    cookie: SABASESSIONID=370152970.36895.0000; path=/

    SOAPResponseV2 - getErrorCode()

    SOAP トランザクション中にエラーが発生した場合に、数字のエラーコードを取得します。

    このエラーコードは Now Platform に固有であり、HTTP エラーコードではありません。カスタマーサービス & サポート からのサポートが必要な場合は、このエラーコードを連絡してください。

    表 : 7. パラメーター
    名前 タイプ 説明
    なし
    表 : 8. 返される内容
    タイプ 説明
    数字 数値のエラーコード (ソケットタイムアウトの場合は 1)。
    var errorCode = response.getErrorCode();

    SOAPResponseV2 - getErrorMessage()

    SOAP トランザクション中にエラーが発生した場合に、エラーメッセージを取得します。

    表 : 9. パラメーター
    名前 タイプ 説明
    なし
    表 : 10. 返される内容
    タイプ 説明
    文字列 エラーメッセージ
    var errorMsg = response.getErrorMessage();

    SOAPResponseV2 - getHeader(文字列 name)

    指定した HTTP ヘッダーの値を取得します。

    表 : 11. パラメーター
    名前 タイプ 説明
    name 文字列 値を設定するヘッダー (Set-Cookie など) の名前。
    表 : 12. 返される内容
    タイプ 説明
    文字列 指定されたヘッダーの値。
    var headerVal = response.getHeader("Accept");

    SOAPResponseV2 - getHeaders()

    SOAP 応答で返されたすべての HTTP ヘッダーと関連する値を取得します。

    注:
    Set-Cookie ヘッダーなど、1 つのヘッダーが応答に複数回存在する場合、この関数は重複するヘッダーの最後のもののみを返します。重複を含むすべてのヘッダーを返すには、getAllHeaders() 関数を使用します。
    表 : 13. パラメーター
    名前 タイプ 説明
    なし
    表 : 14. 返される内容
    タイプ 説明
    オブジェクト 各ヘッダーの名前を関連する値にマッピングするオブジェクト。
    var headers = response.getHeaders();

    SOAPResponseV2 - getStatusCode()

    SOAP プロバイダーによって返された数字の HTTP ステータスコードを取得します。

    表 : 15. パラメーター
    名前 タイプ 説明
    なし
    表 : 16. 返される内容
    タイプ 説明
    数字 成功した応答の場合は 200 など、SOAP プロバイダーによって返される数字のステータスコード。
    var statusCode = response.getStatusCode();

    SOAPResponseV2 - haveError()

    SOAP トランザクション中にエラーが発生したかどうかを示します。

    表 : 17. パラメーター
    名前 タイプ 説明
    なし
    表 : 18. 返される内容
    タイプ 説明
    ブーリアン エラーがあった場合は true を返し、なかった場合は false を返します。
    var error = response.haveError();

    SOAPResponseV2 - waitForResponse(数字 timeoutSecs)

    インスタンスが Web サービスプロバイダーからの応答を待機する時間を設定します。

    このメソッドは、この SOAP 応答のプロパティ glide.soap.outbound.ecc_response.timeout を上書きします。

    表 : 19. パラメーター
    名前 タイプ 説明
    timeoutSecs 数字 この応答を待機する時間 (秒)。
    表 : 20. 返される内容
    タイプ 説明
    なし
    response.waitForResponse(60);