■□■ 目次 ■□■ １． ＷＥＢサービスについて ... 1 ２． ＷＥＢサービス利用の前に ... 3 ３． ＷＥＢサービス一覧 ... 5 ４． ＡＰＩ利用に関して ... 7 ５． Javadoc利用に関して ... 8
【WEB サービス･API 】1
１．ＷＥＢサービスについて
QuickBinder の WEB サービスを利用すると異なるプラットホーム上のアプリケーションから QuickBinder のデータベース、階層、文書などへアクセスを行うことができます。 ●●業務アプリケーション 【登録画面】 会社共通階層 総務部階層 製造部階層 情報システム部階層：
全社共通公式文書データベース 一般公開文書データベース 登録・更新 検索・参照 部門内固有文書データベース 【参照画面】 ■■ソリューション QuickBinderWEBサービス ・各種情報取得 ・検索 ・文書登録、改版、削除 QuickBinder Point・WEB サービスの開発方法、および、intra-mart 上にデプロイされた WEB サービスの認証・認可機能 など詳細については intra-mart Web サービス・プログラミングガイドをご参照下さい。
【WEB サービス･API 】2 （１）WEB サービス連携例 文書を検索して改版を行う。 ■アプリケーション側の動き ■使用する QB の WEB ｻｰﾋﾞｽ機能 名 ①データベースの一覧を表示する ②データベースに付随するその他 の情報を取得 ③データベースを選択(特定する ④登録先階層を表示する ⑤登録先階層を選択(特定する) ⑥選択階層の詳細情報を表示する ⑦選択階層のデータを検索する ⑧検索結果を一覧で表示する ⑨文書を選択(特定する) ⑩文書の詳細情報を表示する ⑪改版ファイルの添付と情報を入 力する ⑫添付ファイルを送信する。 ⑬文書情報を送信する ⑭処理結果を表示 データベース一覧取得 表示順一覧取得 属性一覧取得 入力補助リスト取得 階層一覧取得 階層情報取得 条件検索(一覧取得) 文書詳細情報取得 文書ファイル登録 文書改版登録 ) ユーザ ID、パスワードなど ﾃﾞｰﾀﾍﾞｰｽ ID、ﾃﾞｰﾀﾍﾞｰｽ名など データベース ID など 表示順 ID、表示順名など 属性名、属性型など リスト情報、初期値設定など データベース ID、階層 ID など 階層 ID、階層名など 階層 ID など 階層詳細情報など 階層 ID、検索条件など 文書 ID、文書情報など 文書 ID など ファイル名、ファイル ID など 文書 ID、添付ファイルなど 文書 ID、文書情報など
【WEB サービス･API 】3
２．ＷＥＢサービス利用の前に
WEB サービスを利用するには事前に WEB サービスへの登録が必要となります。 操作方法 ① ログイングループ管理者で intra-mart にログインし、「ログイングループ管理」－「WEB サービ スアクセス設定」で設定します。 ② ［新規登録］をクリックして、WEB サービスから使用したい WEB サービスを選択します。 ③ オペレーションを選択します。 ④ ロールの［追加］をクリックロール選択画面から使用を許可するロールを設定します。【WEB サービス･API 】4 ⑤ ［登録］をクリックして WEB サービスを登録します。
Point
【WEB サービス･API 】5
３．ＷＥＢサービス一覧
WEB サービスとして以下のものを用意しています。 № カテゴリ 機能名 機能概要 備考（関連 API） 1 2 3 登録/ 更新 文書登録 （DocRegistService） 文書の新規登録を行う。 属性情報、関連文書の設定も可能。 ﾃﾞｰﾀﾍﾞｰｽ一覧情報取得 階層詳細情報取得 ﾕｰｻﾞｰｾｷｭﾘﾃｨ詳細情報取得 文書基本情報登録 文書属性情報登録 関連文書情報登録 版情報登録 文書改版 (DocRevisionService) 文書の改版登録を行う。 属性情報の変更、添付ファイルの 追加、削除、関連文書の設定も可能。 改版開始 改版中止 改版ｽﾃｰﾀｽ取得 ﾃﾞｰﾀﾍﾞｰｽ一覧情報取得 階層詳細情報取得 ﾕｰｻﾞｰｾｷｭﾘﾃｨ詳細情報取得 文書基本情報登録 文書属性情報登録 関連文書情報登録 版情報登録 文書廃棄 （DocDisposeService） 文書の削除を行う。 階層詳細情報取得 ﾃﾞｰﾀﾍﾞｰｽ一覧情報取得 ﾕｰｻﾞｰｾｷｭﾘﾃｨ詳細情報取得 文書廃棄 4 5 フ ァ イ ル 関 連 操 作 文書ファイル登録 （FileUploadService） 添付ファイルのアップロード登録、添付 ファイル関連のデータを登録する。 ﾕｰｻﾞｰｾｷｭﾘﾃｨ詳細情報取得 ﾌｧｲﾙｱｯﾌﾟﾛｰﾄﾞ 文書ファイル取得 (FileDownloadService) 指定ファイルのダウンロードを行う。 ﾌｧｲﾙ実体ﾀﾞｳﾝﾛｰﾄﾞ ﾌｧｲﾙﾀﾞｳﾝﾛｰﾄﾞ 6 7 8 9 10 11 検索/ 一覧取得 条件検索（一覧取得） （DocListService） データベース属性の各項目を条件として 検索を行いその結果の一覧を取得する。 条件検索 データベース一覧取得 （DBListService） データベースの一覧を取得する。 ﾃﾞｰﾀﾍﾞｰｽ一覧情報取得 表示順一覧取得 (OrderOfListService） 指定データベースの表示順一覧を取得す る。 表示順一覧取得 属性一覧取得 （OrderListService） 指定データベースの属性情報・表示順情 報を取得する。 属性一覧取得 入力補助リスト取得 (InputDataListService) 指定属性の入力補助リスト情報を取得す る。 入力補助ﾘｽﾄﾃﾞｰﾀ検索 階層情報一覧取得 （TreeListService） 階層情報（階層名と階層構造）の一覧を 取得する。 階層情報一覧取得 12 13 詳細取得 階層情報取得 （TreeInfoService） 階層情報・セキュリティオプション情報を取 得する。 階層詳細情報取得 文書詳細情報取得 （GetDetailsService） 文書情報（属性値、添付ファイル一覧、 関連文書情報）、権限関係を取得する。 文書詳細情報取得 14 共通 ＩＤ採番 （ExtractNoService） 一意のＩＤを採番取得する。 ＩＤ採番【WEB サービス･API 】6 ・WEB サービスの詳細はインストール CD の WEB／API/WEB サービス-Javadoc フォルダーの
Javadoc をご参照下さい。 ・その他 WEB サービスの詳細はインストール CD の WEB／API/WEB サービス仕様書フォルダーの 各ドキュメントをご参照下さい。 ■制限事項・その他 ・以下の処理は次期以降での対応予定です。 階層作成 階層に対するオプション（DLP 等）対応 全文検索 ・文書アクセス権型のデータベースへ登録時は階層のアクセス権が自動で継承されます。 文書単位でのセキュリティ指定はできません。 ・ＷＦ対象階層への登録・改版・廃棄はできません。 ・認証は intra-mart 内に存在する userID/password を使用しています。
・WEB サービス実行時の API エラーメッセージはインストール先/doc/imart/log/platform/qbs.log に出力されます。
メッセージの詳細はインストール CD の WEB／API/API 仕様書フォルダーの API エラーメッセ ージ一覧をご参照ください。
【WEB サービス･API 】7
４．ＡＰＩ利用に関して
API の詳細はインストール CD の WEB／API/API-Javadoc フォルダーの Javadoc をご参照下さい。 API 実行時の API エラーメッセージはインストール先/doc/imart/log/platform/qbs.log に出力されます。 メッセージの詳細はインストール CD の WEB／API/API 仕様書フォルダーの API エラーメッセージ 一覧をご参照ください。
【WEB サービス･API 】8
５．Javadoc利用に関して
Javadoc の操作方法
① Javadoc フォルダーの直下の index.html をクリックすると起動します。
【WEB サービス･API 】9 ③ クラスをクリックすると各クラスの詳細が参照できます。
■ 商標 ■
Windows は Microsoft 社の商標です。
本書に記載されているソフトウェア及び周辺機器の名称は各メーカーの商標または、登録商標です。
intra-mart QuickBinder Ver7.2 ＷＥＢサービス・ＡＰＩ
2009 年 12 月 4 日 発行 第１版
発行 クイックバインダー株式会社 〒101-0054 東京都千代田区神田錦町 2-4 ダヴィンチ小川町
