Garoon API ドキュメント

Garoon REST API

目次

スケジュール

API HTTP メソッド URL クラウド版 パッケージ版
1 件の予定を取得する GET /api/v1/schedule/events/予定 ID 〇 4.10 以降
複数の予定を取得する GET /api/v1/schedule/events 〇 4.10 以降
予定を登録する POST /api/v1/schedule/events 〇 4.10 以降
予定を更新する PATCH /api/v1/schedule/events/予定 ID 〇 4.10 以降
予定を削除する DELETE /api/v1/schedule/events/予定 ID 〇 4.10 以降
空き予定を検索する POST /api/v1/schedule/searchAvailableTimes 〇 5.0 以降
予定のカスタム項目（Schedule datastore）を取得する GET /api/v1/schedule/events/予定 ID/datastore/カスタマイズ名 〇 5.9 以降
予定のカスタム項目（Schedule datastore）を登録する POST /api/v1/schedule/events/予定 ID/datastore/カスタマイズ名 〇 5.9 以降
予定のカスタム項目（Schedule datastore）を更新する PUT /api/v1/schedule/events/予定 ID/datastore/カスタマイズ名 〇 5.9 以降
予定のカスタム項目（Schedule datastore）を削除する DELETE /api/v1/schedule/events/予定 ID/datastore/カスタマイズ名 〇 5.9 以降
施設の一覧を取得する GET /api/v1/schedule/facilities 〇 5.0 以降
管理者権限で施設を取得する GET /api/v1/g/api/v1/schedule/admin/facilities 〇 5.15 以降
管理者権限で施設を登録する POST /api/v1/g/api/v1/schedule/admin/facilities 〇 5.15 以降
管理者権限で施設を更新する PATCH /api/v1/g/api/v1/schedule/admin/facilities/施設 ID 〇 5.15 以降
管理者権限で施設を削除する DELETE /api/v1/g/api/v1/schedule/admin/facilities/施設 ID 〇 5.15 以降
施設グループの一覧を取得する GET /api/v1/schedule/facilityGroups 〇 5.0 以降
管理者権限で施設グループを取得する GET /api/v1/g/api/v1/schedule/admin/facilityGroups 〇 5.15 以降
管理者権限で施設グループを登録する POST /api/v1/g/api/v1/schedule/admin/facilityGroups 〇 5.15 以降
管理者権限で施設グループを更新する PATCH /api/v1/g/api/v1/schedule/admin/facilityGroups/施設グループ ID 〇 5.15 以降
管理者権限で施設グループを削除する DELETE /api/v1/g/api/v1/schedule/admin/facilityGroups/施設グループ ID 〇 5.15 以降
施設グループに所属する施設を取得する GET /api/v1/schedule/facilityGroups/{id}/facilities 〇 5.0 以降

ワークフロー

API HTTP メソッド URL クラウド版 パッケージ版
申請データを取得する GET /api/v1/workflow/admin/requests 〇 5.0 以降
申請データに添付されたファイルを取得する GET /api/v1/workflow/admin/files/ファイル ID 〇 5.0 以降
申請フォームを構成している項目を取得する GET /api/v1/workflow/admin/forms/申請フォーム ID 〇 5.15 以降

ユーザー／組織

API HTTP メソッド URL クラウド版 パッケージ版
ユーザーの一覧を取得する GET /api/v1/base/users 〇 5.0 以降
組織の一覧を取得する GET /api/v1/base/organizations 〇 5.0 以降
組織に所属するユーザーの一覧を取得する GET /api/v1/base/organizations/組織 ID/users 〇 5.0 以降

在席情報

API HTTP メソッド URL クラウド版 パッケージ版
在席情報を取得する（ユーザー ID を指定） GET /api/v1/presence/users/ユーザー ID 〇 5.0 以降
在席情報を取得する（ログイン名を指定） GET /api/v1/presence/users/code/ログイン名 〇 5.0 以降
在席情報を更新する（ユーザー ID を指定） PATCH /api/v1/presence/users/ユーザー ID 〇 5.0 以降
在席情報を更新する（ログイン名を指定） PATCH /api/v1/presence/users/code/ログイン名 〇 5.0 以降

ToDo リスト

API HTTP メソッド URL クラウド版 パッケージ版
ToDo を取得する GET /api/v1/todo/todos/ToDo ID 〇 6.0 以降
ToDo を登録する POST /api/v1/todo/todos 〇 6.0 以降
ToDo リストのカテゴリーを取得する GET /api/v1/todo/categories 〇 6.0 以降

通知

API HTTP メソッド URL クラウド版 パッケージ版
通知を取得する GET /api/v1/notification/items 〇 5.0 以降
通知を登録する POST /api/v1/notification/items 〇 5.0 以降

プロキシ API

API HTTP メソッド URL クラウド版 パッケージ版
プロキシ API 設定を取得する GET /api/v1/system/api/admin/proxies/code/プロキシコード 〇 5.15 以降
プロキシ API 設定を登録する POST /api/v1/system/api/admin/proxies 〇 5.15 以降
プロキシ API 設定を更新する PATCH /api/v1/system/api/admin/proxies/code/プロキシコード 〇 5.15 以降
プロキシ API 設定を削除する DELETE /api/v1/system/api/admin/proxies/code/プロキシコード 〇 5.15 以降

プラグイン

API HTTP メソッド URL クラウド版 パッケージ版
プラグインの基本設定を取得する GET /api/v1/g/api/v1/system/plugin/admin/settings/プラグイン ID 〇 提供なし *1

*1 プラグインはクラウド版でのみ提供している機能です。 ^