6.1. REST API¶

6.1.1. REST APIについて¶

• 未完了案件情報
• 未完了案件ノード情報
• 申請情報
• 過去案件情報
• 添付ファイル情報
• ワークフロー権限情報
• ブックマーク情報
• 完了案件情報
• フローグループ定義情報
• フローグループ情報
• 一覧表示パターン情報
• メンテナンス
• 管理情報
• 案件情報
• My検索情報
• ワークフロープラグイン情報
• 印影情報
• 一時保存情報
• ワークフローユーザ情報
• 利用者ノード設定情報
• ワークフローパラメータ情報

6.1.2. 認証方式¶

REST APIは以下の認証方式に対応しています。

• Cookieに紐づくセッションの認証状態に依存する方式

  
  

  アプリケーションサーバが発行するセッションIDおよびアカウントコンテキストの状態に依存する方式です。

  コンテキストの状態を確認後、認可によるチェックが行われます。

  認可によるチェックが完了後、セキュアトークンによるトークンチェックが行われます。

  コラム

  セキュアトークンによるトークンチェックは Web API Maker プログラミングガイド を参照してください。

• OAuth認証

  
  

  OAuth2.0の仕様に準拠した認証フローによる認証方式です。

  認証後、ログイン状態として扱われ認可によるチェックが行われます。

6.1.3. 認可¶

• 「IM-Workflow 管理者」ロールに認可が設定されているREST API

  ワークフローシステム管理者向け画面で利用されるREST APIです。

• 「IM-Workflow 運用管理者」ロールに認可が設定されているREST API

  ワークフロー運用管理者向け画面で利用されるREST APIです。

  ログインユーザが、ワークフローシステム管理者から権限を付与された範囲で、ワークフロー情報が取得・操作できます。

• 「IM-Workflow 監査者」ロールに認可が設定されているREST API

  ワークフロー監査者向け画面で利用されるREST APIです。

  ログインユーザが、ワークフローシステム管理者から権限を付与された範囲で、ワークフロー情報が取得できます。

• 「IM-Workflow ユーザ」ロールに認可が設定されているREST API

  ワークフロー利用者向け画面で利用されるREST APIです。

  情報を参照するREST APIでは、ログインユーザが参照可能な申請情報や案件情報が取得できます。

  案件を処理するREST APIでは、ログインユーザが権限を持つ案件に対して、ログインユーザを実行者として案件を処理します。

6.1.4. エンドポイントプレフィックス¶

REST APIは認証方式によって、呼び出し先のエンドポイントが異なります。

• Cookieに紐づくセッションの認証状態に依存する方式

  
  

  http(s)://{HOST}:{PORT}/{CONTEXT_PATH}/api/workflow/....

  プロトコル、ホスト名、ポート番号、コンテキストパスは環境にあわせて置き換えてください。

  例:

  https://example.org/imart/api/workflow/active-matters-comfirm

• OAuth認証

  
  

  http(s)://{HOST}:{PORT}/{CONTEXT_PATH}/api/oauth/workflow/....

  プロトコル、ホスト名、ポート番号、コンテキストパスは環境にあわせて置き換えてください。

  例:

  https://example.org/imart/api/oauth/workflow/active-matters-comfirm

6.1.5. Swagger¶

6.1.6. タスクステータス¶

6.1.7. リクエストパラメータ共通仕様¶

• 仕様に沿わない構造やプロパティ名の情報が含まれる場合、予期せぬ動作になる可能性があります。
• 日付を表す情報には、 yyyy/MM/dd 形式で string 型の値を指定してください。

6.1.8. レスポンスデータ共通仕様¶

• 値が存在しない場合（ブランク文字列やnull）、プロパティそのものが含まれません。
• 日付を表す情報は、 yyyy/MM/dd 形式の string 型の値と、アカウントコンテキストの日付表示形式でフォーマットした値が返却されます。

6.1.9. エンドポイント¶