biz-StreamマニュアルWebサービスサーバ ガイド第7章 biz-Stream Web サービス SOAP インターフェイス概要7.2 オペレーション一覧

7.2 オペレーション一覧

Webサービスサーバでは、以下のオペレーションを提供しています。


コンテンツ生成

  • generateOutput オペレーション

    レイアウト定義から指定したファイル( PDF ファイル/ Excel ファイル/ CSV ファイル)を生成しリポジトリへ登録、またはPDFファイルをバッチ印刷機能を利用して印刷します。リクエストした処理の結果として、ファイル生成の場合はファイルの保存場所をURLとして返します。バッチ印刷した場合は、印刷結果を返します。
    バッチ印刷機能で実行できる処理内容に関しては、「バッチ印刷ガイド」と、11.11 PDFを生成しバッチ印刷するサンプル(JAX-WS)を参照してください。



  • generateData オペレーション

    レイアウト定義から指定したファイル( PDF ファイル/ Excel ファイル/ CSV ファイル)を生成し、生成したファイルのバイナリデータをクライアントに返します。リクエストした処理の結果として、生成したファイルはMIMEに変換され SOAP メッセージに添付され取得します。



  • generateOutputData オペレーション

    generateOutputオペレーションとgenerateData オペレーションを両方実行します。



  • getBatchStatus オペレーション

    バッチ印刷機能で印刷リクエストを出した結果の印刷状態の取得を要求します。印刷ジョブIDを与えることで、特定の印刷状態の取得要求ができます。リクエストした処理の結果として、バッチ印刷の印刷状態を返します。バッチ印刷の印刷状態取得に関しては、「バッチ印刷ガイド」を参照してください。


コンテンツ管理

  • delete オペレーション

    Webサービスサーバのリポジトリから指定のディレクトリ/ファイルを削除します。リクエストした処理の結果として、処理の成功(success)または失敗(SOAP Fault)を返します。
    SOAP Faultに関しては後述「第13章 例外処理」をご参照ください。



  • list オペレーション

    Webサービスサーバのリポジトリ上指定ディレクトリにあるディレクトリ/ファイルの一覧を取得します。リクエストした処理の結果として、指定ディレクトリ内に存在するディレクトリ/ファイルの一覧を返します。一覧取得先のディレクトリとしてリポジトリのルートを指定した場合、ルート以下サブディレクトリも含めリポジトリ内の全てのディレクトリ/ファイルの一覧が取得できます。



  • move オペレーション

    Webサービスサーバのリポジトリの指定ディレクトリ/ファイルを、指定のディレクトリ配下に移動します。リクエストした処理の結果として、処理の成功(success)または失敗(SOAP Fault)を返します。



  • rename オペレーション

    Webサービスサーバのリポジトリの指定ディレクトリ/ファイルの名称を変更します。リクエストした処理の結果として、処理の成功(success)または失敗(SOAP Fault)を返します。



  • mkdir オペレーション

    Webサービスサーバのリポジトリに、新規にディレクトリを作成します。リクエストした処理の結果として、処理の成功(success)または失敗(SOAP Fault)を返します。



  • put オペレーション

    Webサービスサーバのリポジトリルート直下へ、ファイルをアップロードします。リクエストした処理の結果として、処理の成功(success)または失敗(SOAP Fault)を返します。



  • get オペレーション

    Webサービスサーバのリポジトリの指定ディレクトリから、ファイルをダウンロードします。リクエストした処理の結果として、取得対象のファイルがSOAP メッセージとして返信されます。



ファイルの転送

各オペレーションのうち、ファイル転送を行うもの(getGenerateDataオペレーションのレスポンスメッセージ、putオペレーションのリクエストメッセージ、getオペレーションのレスポンスメッセージ)については、ファイルデータが格納される部分(fileData要素子要素であるcontentData要素の値)ではMTOMをつかった最適化を利用することが出来ます(サーバ側ではデフォルトで有効になっています)。