12.2. APIの仕様を確認する¶
12.2.1. Web上からAPI仕様を参照し実行する¶
12.2.1.1. Swagger Specificationを表示する¶
- Swagger Specificationを利用するための intra-mart Accel Platform の環境を構築します。
- 以下のモジュールをインストールした環境を構築してください。
- IM-FormaDesigner for Accel Platform
- IM-BIS ワークフロー案件処理Web APIについては、以下のモジュールをインストールした環境を構築してください。
- IM-BIS for Accel Platform
- メニューからSwagger Specificationへアクセスします。
- IM-FormaDesigner ワークフロー案件処理Web API
- 「サイトマップ」-「Forma開発者」-「Webサービス APIドキュメント」-「ワークフロー」をクリックし、Swagger Specificationを表示します。
- IM-BIS ワークフロー案件処理Web API
- 「サイトマップ」-「IM-BIS開発者」-「Webサービス APIドキュメント」-「ワークフロー」をクリックし、Swagger Specificationを表示します。
12.2.1.2. Swagger SpecificationからWeb APIを実行する¶
- URLの一覧から実行したAPIを押下します。
APIのURLを押下すると、APIの詳細ページが表示されます。
- 表示されたAPIの詳細画面からパラメータ情報を押下します。
パラメータ情報のJSON Schemaの部分を押下すると、Valueフィールドにパラメータ情報のひな形のJSONが編集可能な状態で表示されます。
- 表示されたパラメータ情報のひな形を編集します。
- ひな形のJSONを編集し、案件の処理が実行できるパラメータを作成します。
- パラメータ例
{ "applyBaseDate": "2015/07/28", "matterName": "sample_matter", "applyExecuteUserCode": "aoyagi", "userParam": {}, "formaUserParam": { "items" : { "textbox1" : "あいうえお" } }, "applyAuthUserCode": "aoyagi", "flowId": "web_api_test" }
- Web APIの実行ボタンを押下します。
必要なパラメータを入力した上で「Try it out!」ボタンを押下します。
- Web APIの実行結果を確認します。
Web APIの実行に成功した場合は、Response情報が表示されます。
注意
注意
12.2.1.3. 提供APIのURL一覧¶
12.2.1.3.1. IM-FormaDesigner¶
メソッド | パス | 説明 |
---|---|---|
POST | /api/forma/imw/selectUnprocessActvMatterNodeList | 未処理ノード一覧を取得します。 |
POST | /api/forma/imw/selectUnprocessActvMatterNodeListCount | 未処理ノード一覧件数を取得します。 |
POST | /api/forma/imw/selectProcessedActvMatterList | 処理済一覧(未完了)を取得します。 |
POST | /api/forma/imw/selectProcessedActvMatterListCount | 処理済一覧(未完了)件数を取得します。 |
POST | /api/forma/imw/selectRefActvMatterList | 参照一覧(未完了)を取得します。 |
POST | /api/forma/imw/selectRefActvMatterListCount | 参照一覧(未完了)件数を取得します。 |
POST | /api/forma/imw/selectRefActvMatterAdminHandleLevelList | 参照一覧(未完了)管理マネージャ(操作レベルを含む)を取得します。 |
POST | /api/forma/imw/selectRefActvMatterAdminHandleLevelListCount | 参照一覧(未完了)管理マネージャ(操作レベルを含む)件数を取得します。 |
メソッド | パス | 説明 |
---|---|---|
POST | /api/forma/imw/apply | 申請処理を実行します。 |
POST | /api/forma/imw/applyFromUnapply | 未申請状態の案件の申請処理を実行します。 |
POST | /api/forma/imw/approve | 承認処理を実行します。 |
POST | /api/forma/imw/approveEnd | 承認終了処理を実行します。 |
POST | /api/forma/imw/createTempSave | 一時保存案件を新規登録します。
申請・起票前に一時保存を行った案件が対象です。
|
POST | /api/forma/imw/updateTempSave | 一時保存案件を更新します。
申請・起票前に一時保存を行った案件が対象です。
|
POST | /api/forma/imw/deleteTempSave | 一時保存案件を削除します。
申請・起票前に一時保存を行った案件が対象です。
|
POST | /api/forma/imw/deny | 否認処理を実行します。 |
POST | /api/forma/imw/discontinue | 取止め処理を実行します。 |
POST | /api/forma/imw/draft | 起票案件を新規登録します。 |
POST | /api/forma/imw/fileupload | ファイルをアップロードします。 |
POST | /api/forma/imw/reapply | 再申請処理を実行します。 |
POST | /api/forma/imw/reserve | 保留処理を実行します。 |
POST | /api/forma/imw/reserveCancel | 保留解除処理を実行します。 |
POST | /api/forma/imw/pullBack | 引戻し処理を実行します。 |
POST | /api/forma/imw/sendBack | 差戻し処理を実行します。 |
POST | /api/forma/imw/transfer | 振替処理を実行します。 |
メソッド | パス | 説明 |
---|---|---|
POST | /api/forma/imw/fileupload | ファイルアップロード用のWeb API |
12.2.1.3.2. IM-BIS¶
メソッド | パス | 説明 |
---|---|---|
POST | /api/bis/imw/selectUnprocessActvMatterNodeList | 未処理ノード一覧を取得します。 |
POST | /api/bis/imw/selectUnprocessActvMatterNodeListCount | 未処理ノード一覧件数を取得します。 |
POST | /api/bis/imw/selectProcessedActvMatterList | 処理済一覧(未完了)を取得します。 |
POST | /api/bis/imw/selectProcessedActvMatterListCount | 処理済一覧(未完了)件数を取得します。 |
POST | /api/bis/imw/selectRefActvMatterList | 参照一覧(未完了)を取得します。 |
POST | /api/bis/imw/selectRefActvMatterListCount | 参照一覧(未完了)件数を取得します。 |
POST | /api/bis/imw/selectRefActvMatterAdminHandleLevelList | 参照一覧(未完了)管理マネージャ(操作レベルを含む)を取得します。 |
POST | /api/bis/imw/selectRefActvMatterAdminHandleLevelListCount | 参照一覧(未完了)管理マネージャ(操作レベルを含む)件数を取得します。 |
メソッド | パス | 説明 |
---|---|---|
POST | /api/bis/imw/apply | 申請処理を実行します。 |
POST | /api/bis/imw/applyFromUnapply | 未申請状態の案件の申請処理を実行します。 |
POST | /api/bis/imw/approve | 承認処理を実行します。 |
POST | /api/bis/imw/approveEnd | 承認終了処理を実行します。 |
POST | /api/bis/imw/createTempSave | 一時保存案件を新規登録します。
申請・起票前に一時保存を行った案件が対象です。
|
POST | /api/bis/imw/updateTempSave | 一時保存案件を更新します。
申請・起票前に一時保存を行った案件が対象です。
|
POST | /api/bis/imw/deleteTempSave | 一時保存案件を削除します。
申請・起票前に一時保存を行った案件が対象です。
|
POST | /api/bis/imw/deny | 否認処理を実行します。 |
POST | /api/bis/imw/discontinue | 取止め処理を実行します。 |
POST | /api/bis/imw/draft | 起票案件を新規登録します。 |
POST | /api/bis/imw/fileupload | ファイルをアップロードします。 |
POST | /api/bis/imw/reapply | 再申請処理を実行します。 |
POST | /api/bis/imw/reserve | 保留処理を実行します。 |
POST | /api/bis/imw/reserveCancel | 保留解除処理を実行します。 |
POST | /api/bis/imw/pullBack | 引戻し処理を実行します。 |
POST | /api/bis/imw/sendBack | 差戻し処理を実行します。 |
POST | /api/bis/imw/transfer | 振替処理を実行します。 |
メソッド | パス | 説明 |
---|---|---|
POST | /api/bis/imw/fileupload | ファイルアップロード用のWeb API |
12.2.2. パラメータ情報の仕様を確認する¶
ワークフロー案件処理APIと同様に、パラメータはワークフローデータ・アプリケーションデータの2つが必要です。パラメータは、リクエストボディからJSON形式で送信します。
12.2.2.1. ワークフローデータ¶
12.2.2.2. アプリケーションデータ¶
12.2.3. パラメータ(アプリケーションデータ)¶
- 日付型
- タイムスタンプ型
- ファイル
12.2.3.1. アプリケーションデータ(入力アイテムデータ)¶
- 日付型・タイムスタンプ型
- ISO 8601 の規格に従った文字列(YYYYMMDDThhmmss+0900)にて指定します。
(例)JSON
"formaUserParam": { "items": { "textbox1": "あいうえお", "number1": 1000, "calendar1": "2010-07-28T22:25:51Z" } }
12.2.3.2. アプリケーションデータ(テーブルアイテムデータ)¶
- 日付型・タイムスタンプ型
- ISO 8601 の規格に従った文字列(YYYYMMDDThhmmss+0900)にて指定します。
(例)JSON
"formaUserParam": { "items": { "tb1": [ { "tb1_textbox1": "明細1 - りんご", "tb1_textbox2": "明細1 - バナナ" }, { "tb1_textbox1": "明細1 - ぶどう", "tb1_textbox2": "明細1 - 苺" } ], "tb2": [ { "tb2_number1": 345.678, "tb2_calendar1": "2010-07-28T22:25:51Z" }, { "tb2_number1": 99999, "tb2_calendar1": "2015-07-23T22:25:51Z" } ] } }
12.2.3.3. アプリケーションデータ(ファイルアップロードアイテムデータ)¶
- ファイルアップロード用のWeb APIを実行します。リクエスト情報は、以下のように送信します。
リクエストヘッダ フィールド名 値 Content-Type multipart/form-data Accept application/json リクエストパラメータ フィールド名 値 file ファイルデータ コラム
ファイルのアップロードに成功すると、トークンとファイル名が返却されます。複数のファイルをアップロードする場合は、複数回リクエストを発行し、トークンを取得してください。 - 取得したトークンをアプリケーションデータ(ファイルアップロードアイテムデータ)のJSONに指定します。
(例)JSON
"formaUserParam": { "items": { ... }, "files": [ { "token": "8e9vzec9jacb1cy", "fileName": "sample_file.txt", "uploadItemId": "attach_fileupload_item1", "notes": "サンプル備考1" }, { "token": "8e9vzikscacfwcy", "fileName": "sample_file.jpg", "uploadItemId": "attach_fileupload_item1", "notes": "サンプル備考2" } ] }
12.2.4. 注意事項¶
注意
Web APIはワークフロー案件処理Web APIを拡張した機能であり、ワークフロー案件処理Web APIの同様の制限が存在します。
Web APIのContent-Type・Acceptは、application/jsonのみの対応となり、application/xmlには対応していません。
formaUserParamの文字列型のパラメータに対して、ISO 8601 の規格に従った日付文字列が送信された場合は、日付型・タイムスタンプ型として処理されます。
- Web APIを利用してワークフローの申請を行う場合、パラメータ(アプリケーションデータ)に指定できるアイテムは、申請ノードに設定されている画面遷移のフォームに含まれるものに限定されます。Web APIを利用してワークフローの承認を行う場合、パラメータ(アプリケーションデータ)に指定できるアイテムは、承認ノードに設定されている画面遷移のフォームに含まれるものに限定されます。
以下のWeb APIを実行した場合は、現状、formaUserParamパラメータを指定してもアプリケーションデータは更新されません。
メソッド | パス | 説明 |
---|---|---|
POST | /api/forma/imw/deny | 否認処理を実行します。 |
POST | /api/forma/imw/discontinue | 取止め処理を実行します。 |
POST | /api/forma/imw/reserve | 保留処理を実行します。 |
POST | /api/forma/imw/reserveCancel | 保留解除処理を実行します。 |
POST | /api/forma/imw/pullBack | 引戻し処理を実行します。 |
POST | /api/forma/imw/sendBack | 差戻し処理を実行します。 |
メソッド | パス | 説明 |
---|---|---|
POST | /api/bis/imw/deny | 否認処理を実行します。 |
POST | /api/bis/imw/discontinue | 取止め処理を実行します。 |
POST | /api/bis/imw/reserve | 保留処理を実行します。 |
POST | /api/bis/imw/reserveCancel | 保留解除処理を実行します。 |
POST | /api/bis/imw/pullBack | 引戻し処理を実行します。 |
POST | /api/bis/imw/sendBack | 差戻し処理を実行します。 |