REST API¶
REST APIとは、Webシステムを外部から呼び出すためのAPIの一種です。 HTTPの技術をベースとしたAPIのため、開発言語に依存することなく利用することができます。 リソースの操作はHTTPメソッドから指定し、結果はJSONフォーマットのデータとして受け取ることができます。 また、HTTPのステータスコードによって処理の状態を判断します。
REST APIでは、外部のシステムと連携するための次のような機能を提供しています。
- ユーザーの一覧の取得、更新、削除
- 申請フォームの一覧の取得
- 案件の一覧の取得
- ワークフローの各種操作 (申請、承認、差戻しなど)
- ルート上のユーザーの一覧の取得
- 承認履歴の取得
- 添付ファイル、ドキュメント、入力データの取得
注意
- REST APIではワークフローシステムのセッション情報を利用します。
REST APIの実行後はセッション情報を破棄する仕様のため、ブラウザーからの利用とREST APIを組み合わせでは使用できません。 - PDF貼り付けフォームを利用した申請は行えません。
使用例や仕様の詳細については、以下を参照ください。