12.2. APIの仕様を確認する¶

12.2.1.1. Swagger Specificationを表示する¶

1. Swagger Specificationを利用するための intra-mart Accel Platform の環境を構築します。

   • 以下のモジュールをインストールした環境を構築してください。

     • IM-FormaDesigner for Accel Platform

   • IM-BIS ワークフロー案件処理Web APIについては、以下のモジュールをインストールした環境を構築してください。

     • IM-BIS for Accel Platform

2. メニューから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を実行する¶

1. URLの一覧から実行したAPIを押下します。

   • APIのURLを押下すると、APIの詳細ページが表示されます。

     

2. 表示されたAPIの詳細画面からパラメータ情報を押下します。

   • パラメータ情報のJSON Schemaの部分を押下すると、Valueフィールドにパラメータ情報のひな形のJSONが編集可能な状態で表示されます。

     

3. 表示されたパラメータ情報のひな形を編集します。

   

   • ひな形のJSONを編集し、案件の処理が実行できるパラメータを作成します。

     • パラメータ例

     {
       "applyBaseDate": "2015/07/28",
       "matterName": "sample_matter",
       "applyExecuteUserCode": "aoyagi",
       "userParam": {},
       "formaUserParam": {
        "items" : {
           "textbox1" : "あいうえお"
        }
       },
       "applyAuthUserCode": "aoyagi",
       "flowId": "web_api_test"
     }
     

4. Web APIの実行ボタンを押下します。

   • 必要なパラメータを入力した上で「Try it out!」ボタンを押下します。

     

5. Web APIの実行結果を確認します。

   • Web APIの実行に成功した場合は、Response情報が表示されます。

     Response情報

     Response Headers	HTTP通信のレスポンスヘッダとしてメタ情報が表示されます。
     Response Code	HTTP通信のレスポンスコードが表示されます。 APIの呼び出しに成功した場合は 200 が返却されます。 認可制御でエラーになった場合は 403 が返却されます。
     Response Body	APIの実行結果の詳細が表示されます。

     

12.2.1.3. 提供APIのURL一覧¶

12.2.2.1. ワークフローデータ¶

12.2.2.2. アプリケーションデータ¶

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. アプリケーションデータ（ファイルアップロードアイテムデータ）¶

1. ファイルアップロード用のWeb APIを実行します。

   リクエスト情報は、以下のように送信します。

   リクエストヘッダ

   フィールド名	値
   Content-Type	multipart/form-data
   Accept	application/json

   リクエストパラメータ

   フィールド名	値
   file	ファイルデータ

   コラム

   ファイルのアップロードに成功すると、トークンとファイル名が返却されます。

   複数のファイルをアップロードする場合は、複数回リクエストを発行し、トークンを取得してください。
2. 取得したトークンをアプリケーションデータ（ファイルアップロードアイテムデータ）のJSONに指定します。

   • （例）JSON

     "formaUserParam": {
         "items": {
           ...
         },
         "files": [
                     {
                         "token": "8e9vzec9jacb1cy",
                         "fileName": "sample_file.txt",
                         "uploadItemId": "attach_fileupload_item1",
                         "notes": "サンプル備考１"
                     },
                     {
                         "token": "8e9vzikscacfwcy",
                         "fileName": "sample_file.jpg",
                         "uploadItemId": "attach_fileupload_item1",
                         "notes": "サンプル備考２"
                     }
                 ]
     }