SOAP API 仕様¶
ヒント
本ページでは、SOAP APIの仕様概要について説明しています。
詳細な仕様は、 SOAP API仕様書 を参照ください。
サービス名について¶
SOAP APIとして公開されているサービス名を以下に示します。
| サービス名 | 概要 | エンドポイントURL |
| wsAuthenticationManager | SOAP APIのアカウント認証用サービス | (ワークフローシステムURL)/services/wsAuthenticationManager.wsAuthenticationManagerHttpSoap12Endpoint/ |
| wsApplyAgent | 申請用サービス | (ワークフローシステムURL)/services/wsApplyAgent.wsApplyAgentHttpSoap12Endpoint/ |
| wsApproveAgent | 承認用サービス | (ワークフローシステムURL)/services/wsApproveAgent.wsApproveAgentHttpSoap12Endpoint/ |
| wsReturnAgent | 差戻し（否認・再申請請求・再承認請求）用サービス | (ワークフローシステムURL)/services/wsReturnAgent.wsReturnAgentHttpSoap12Endpoint/ |
| wsBdfManager | 申請フォーム情報取得用サービス | (ワークフローシステムURL)/services/wsBdfManager.wsBdfManagerHttpSoap12Endpoint/ |
| wsUserInfomationManager | ユーザー情報の取得・更新用サービス | (ワークフローシステムURL)/services/wsUserInfomationManager.wsUserInfomationManagerHttpSoap12Endpoint/ |
| wsReceiveManager | ワークフローの処理待ち案件一覧情報取得用サービス | (ワークフローシステムURL)/services/wsReceiveManager.wsReceiveManagerHttpSoap12Endpoint/ |
| wsWorkflowStatusManager | ワークフローの案件情報を検索用サービス | (ワークフローシステムURL)/services/wsWorkflowStatusManager.wsWorkflowStatusManagerHttpSoap12Endpoint/ |
パッケージ構成¶
SOAP APIは、[jp.co.itarchitects.xFlow.soap.server]以下のサブパッケージに、機能ごとに分類されています。
以下で各サブパッケージの概要について説明します。
| パッケージ名 | 概要 |
| action | 申請／承認／差戻しを実行するためのインターフェースを提供します。 |
| list | ワークフローシステムの一覧に関するインターフェースを提供します。 特定のユーザーの処理待ちとなっている案件の一覧を取得できます。 |
| define.bdf | ワークフロー コンテンツ管理で登録した申請フォームに関するインターフェースを提供します。 主に、APIを使用して申請する際に利用されます。 |
| define.user | 組織／ユーザー情報に関するインターフェースを提供します。 |
| status | ワークフローシステムでこれまでに申請された案件情報に関するインターフェースを提供します。 |
定数値について¶
SOAP APIでは、処理の種別や状態を表す定数が定義されています。
以下では、SOAP APIで使用される定数を機能ごとに説明します。
actionパッケージ¶
- WsApplyAgent クラス
申請の処理種別は以下のコードで定義されています。
用途に応じて execute、execute_option の引数に指定してください。
処理種別 定数値 申請 1 保存 2
- WsApplyOptionクラス
申請時の「メール送信オプション」、「コメントと添付ファイルの公開情報」は以下のコードで定義されています。
用途に応じて setMailOption、setCommentAndAttachedFilePublish の引数に指定してください。[メール送信オプションを表す定数]
処理種別 定数値（文字列） 次の承認者 1 全承認者 2 送信しない 3 [コメント・添付ファイルの公開情報を表す定数]
処理種別 定数値（文字列） ルートの全員に公開 0 公開しない 1 公開先を指定 2
- WsApproveAgent クラス
承認の処理種別は以下のコードで定義されています。
承認のコードを execute、execute_option の引数に指定します。
処理種別 定数値 承認 1
- WsOptionクラス
承認・差戻し時の「メール送信オプション」、「コメントと添付ファイルの公開情報」は以下のコードで定義されています。
用途に応じて setMailOption、setCommentAndAttachedFilePublish の引数に指定してください。[メール送信オプションを表す定数]
処理種別 定数値（文字列） 次の承認者 1 以降の承認者全員 2 送信しない 3 [コメント・添付ファイルの公開情報を表す定数]
処理種別 定数値（文字列） ルートの全員に公開 0 公開しない 1 公開先を指定する 2
- WsReturnAgent クラス
差戻しの処理種別は以下のコードで定義されています。
用途に応じて execute、execute_option の引数に指定してください。
処理種別 定数値 否認 1 再申請請求 2 再承認請求 3
statusパッケージ¶
- WsWorkflowStatusManager クラス
検索条件を指定して案件情報を取得する場合に、以下の項目を検索条件として指定できます。
doSelectWorkflowStatusWithSearch などでは、検索する項目の定数値と検索する値をセットで指定します。
検索する項目 定数値（文字列） 申請件名 APPLY_SUBJECT 申請フォーム名 DOCUMENT_NAME 申請時採番 APPLY_NUMBER 決裁時採番 DECIDE_NUMBER 完了時採番 COMPLETE_NUMBER 申請者のID APPLYER_MEMBER_ID 申請者氏名（姓） APPLYER_LAST_NAME 申請者氏名（名） APPLYER_FIRST_NAME 役職コード APPLYER_AUTH_CODE 役職名 APPLYER_AUTH_NAME グループコード APPLYER_GROUP_CODE グループ名 APPLYER_GROUP_NAME 案件状態 WORKFLOW_STATUS 申請日期間（開始日） START_APPLY_DATE 申請日期間（終了日） END_APPLY_DATE 決裁日期間（開始日） START_DECIDE_DATE 決裁日期間（終了日） END_DECIDE_DATE 案件ID WORKFLOW_ID
- WsWorkflowStatusBean クラス
フォーム形式は、以下のコードで定義されています。
該当のワークフロー案件が使用するフォームのフォーム区分は、getDocumentType を利用して取得します。
フォーム形式 定数値（文字列） 入力JSPフォーム／Ver5形式のフォーム 22 入力PDFフォーム 12 ファイル（Word） 00 ファイル（Excel） 01 ファイル（その他） 99
- WsWorkflowMemberStatusBean クラス
[ルート上のユーザーの役割を表す定数]
ルート上のユーザーの役割は、以下のコードで定義されています。
該当ユーザーの役割は、getMemberType を利用して取得します。
ユーザーの役割 定数値 申請者 0 承認者 1 決裁者 2 閲覧者 3 [案件の処理状態を表す定数]
ユーザーの案件の処理状態は、以下のコードで定義されています。
該当ユーザーの案件の処理状態は、getMemberStatus を利用して取得します。
案件の状態 定数値 未受信（予定一覧に含まれる案件） 0 処理待ち（承認待ち・閲覧待ち） 1 処理済み（申請済み・承認済みなど） 2 [承認グループの種類を表す定数]
ルート上の承認グループの種類は、以下のコードで定義されています。
該当ユーザーが含まれる承認グループの種類は、getMemberGroupOption を利用して取得します。
承認グループ種類 定数値 申請者／単独の承認者 0 AND承認グループ 1 OR承認グループ 2 [承認処理の対象／対象外の状態を表す定数]
ルート上のユーザーが承認処理の対象となるかは、以下のコードで定義されています。
該当ユーザーが承認処理の対象となるかは、getMemberApprovedCode を利用して取得します。
スキップ種類 定数値 承認するユーザー 0 該当ユーザー不在でスキップされるユーザー 1 承認不要でスキップされるユーザー 2 注釈
該当ユーザー不在や承認不要の場合は、承認がスキップされます。