Garoon API

Garoon APIドキュメントトップへ
Garoon APIドキュメントのアイコン

Garoon APIドキュメント

Garoon APIの仕様公開と仕様変更の方針
スケジュールオブジェクト
ワークフローオブジェクト
メールオブジェクト
Garoonコーディングガイドライン
Garoonセキュアコーディングガイドライン
Garoon REST APIの概要
認証
1件の予定を取得する
複数の予定を取得する
予定を登録する
予定を更新する
予定を削除する
空き予定を検索する
予定のカスタム項目（Schedule datastore）を取得する
予定のカスタム項目（Schedule datastore）を登録する
予定のカスタム項目（Schedule datastore）を更新する
予定のカスタム項目（Schedule datastore）を削除する
施設の一覧を取得する
管理者権限で施設を取得する
管理者権限で施設を登録する
管理者権限で施設を更新する
管理者権限で施設を削除する
施設グループの一覧を取得する
管理者権限で施設グループを取得する
管理者権限で施設グループを登録する
管理者権限で施設グループを更新する
管理者権限で施設グループを削除する
施設グループに所属する施設を取得する
申請データを取得する
申請データに添付されたファイルを取得する
申請フォームを構成している項目を取得する
メッセージを取得する
メッセージを作成する
メッセージ一覧を取得する
メッセージの添付ファイルを取得する
メッセージの添付ファイル一覧を取得する
メッセージの添付ファイルを削除する
スペースの一覧を取得する
ディスカッションを取得する
ディスカッションを作成する
コメントを作成する
スペースの添付ファイルを取得する
スペースの添付ファイル一覧を取得する
ディスカッションの添付ファイル一覧を取得する
スペースの添付ファイルを削除する
ユーザーの一覧を取得する
組織の一覧を取得する
組織に所属するユーザーの一覧を取得する
在席情報を取得する（GaroonユーザーIDを指定）
在席情報を取得する（ログイン名を指定）
在席情報を更新する（GaroonユーザーIDを指定）
在席情報を更新する（ログイン名を指定）
ToDoを取得する
ToDoを登録する
ToDoリストのカテゴリーを取得する
通知を取得する
通知を登録する
掲示板の本文を取得する
掲示板の下書きを取得する
掲示板のカテゴリー一覧を取得する
掲示板のカテゴリー内の掲示一覧を取得する
プロキシAPIの設定を取得する
プロキシAPIの設定を登録する
プロキシAPIの設定を更新する
プロキシAPIの設定を削除する
プラグインの基本設定を取得する
Garoon JavaScript APIの共通仕様
イベント処理の記述方法
ログインユーザーの情報を取得する
スケジュールのイベントオブジェクトで実行できる操作
予定の登録画面を表示した後のイベント
予定を登録するときのイベント
予定の登録に成功したときのイベント
「予定の調整」で予定の登録が成功したときのイベント
ポップアップウィンドウで予定の登録に成功したときのイベント
仮の予定を確定したときのイベント
予定の変更画面を表示した後のイベント
予定を変更するときのイベント
予定の変更に成功したときのイベント
ドラッグ＆ドロップで予定の変更に成功したときのイベント
予定を削除するときのイベント
予定の削除に成功したときのイベント
予定の詳細画面を表示した後のイベント
グループ日表示画面を表示した後のイベント
グループ週画面を表示したときのイベント
日表示画面を表示した後のイベント
週表示画面を表示したときのイベント
月表示画面を表示したときのイベント
予定の参加に成功したときのイベント
予定から抜けることに成功したときのイベント
予定の値を取得する
予定の値をセットする
カスタム項目（Schedule datastore）の値を取得する
カスタム項目（Schedule datastore）の値をセットする
予定枠最上部の要素を取得する
予定の詳細／登録／変更画面のヘッダー部分の要素を取得する
予定の詳細画面のテーブルに行を追加する
プロフィールのポップアップダイアログを表示した後のイベント
プロフィールのポップアップダイアログの下側の要素を取得する
メッセージのイベントオブジェクトで実行できる操作
メッセージの作成画面を表示したときのイベント
メッセージの宛先変更画面を表示したときのイベント
メッセージの値をセットする
メッセージの「宛先」下の要素を取得する
メールのイベントオブジェクトで実行できる操作
メールの作成画面を表示したときのイベント
メールの詳細画面を表示したときのイベント
メールの返信画面を表示したときのイベント
メールを送信する前のイベント
メールの値を取得する
メールの値をセットする
メールの「標題」下の空白要素を取得する
ワークフローのイベントオブジェクトで実行できる操作
ワークフロー申請の作成画面を表示したときのイベント
ワークフロー申請の詳細画面を表示したときのイベント
ワークフロー申請を提出したときのイベント
ワークフロー申請の承認画面を表示したときのイベント
ワークフロー申請を承認したときのイベント
ワークフロー申請を確認したときのイベント
ワークフロー申請の印刷用画面を表示したときのイベント
申請データの値を取得する
申請データに値をセットする
JavaScriptカスタマイズ用項目の要素を取得する
申請フォーム項目の編集可／不可を切り替える
プラグインの詳細設定を取得する
プラグインの詳細設定を保存する
ファイルキーから画像URLを取得する
garoon.Promiseを使用する
Garoon REST APIリクエストを送信する
外部のAPIを実行する
CSRFトークンを取得する
kintone連携用トークンを取得する
Garoon SOAP APIの概要
Garoon SOAP APIの共通仕様
ベースAPIで使用するデータの構造
ユーザー情報を取得する
組織情報を取得する
最近選択したユーザーを取得する
Myグループを取得する
リージョン、タイムゾーンを取得する
アプリケーションの有効／無効を切り替える
アプリケーションの使用状況を取得する
ファイルをダウンロードする
カレンダーのイベントを取得する
掲示板APIで使用するデータの構造
掲示板を検索する
掲示板を取得する
掲示板を作成、更新、または削除する
カテゴリーを取得する
コメントを取得、追加、または削除する
ファイルをダウンロードする
スケジュールAPIで使用するデータの構造
予定を検索する
予定を取得する
予定を登録、更新、または削除する
予定に参加する／予定から抜ける
予定のコメントを追加または削除する
仮予定を確定または削除する
ファイルをダウンロードする
予定のアクセス権を確認する
施設情報を取得する
設定情報を取得または設定する
メッセージAPIで使用するデータの構造
メッセージを検索する
メッセージを取得する
メッセージを送信、更新または削除する
コメントを取得、追加、または削除する
ファイルをダウンロードする
フォルダを取得する
閲覧状況を確認状態にする
設定情報を取得または変更する
メールAPIで使用するデータの構造
メールを検索する
メールを取得する
メールを送信、または削除する
メールを移動する
フォルダを追加、更新、または削除する
ファイルをダウンロードする
メールサーバーを追加、更新、または削除する
メールアカウントを取得、追加、更新、または削除する
設定情報を取得または設定する
マルチレポートAPIで使用するデータの構造
レポートを検索する
レポートを取得する
レポートを削除する
レポートの更新情報を取得する
コメントを取得、追加、または削除する
ファイルをダウンロードする
ワークフローAPIで使用するデータの構造
カテゴリを取得する
ファイルを取得する
フォーム情報を取得する
自分が代理承認者になっているユーザーを取得する
申請を処理する
申請情報を取得する
代理承認者と代理申請者を取得または設定する
利用権限を取得する
設定情報を取得する
ファイル管理APIで使用するデータの構造
ファイルを取得する
ファイルを追加、更新、または削除する
フォルダ情報を取得する
通知APIで使用するデータの構造
通知を取得する
通知を確認済みにする
設定情報を取得または変更する
ログイン処理を行う
ログアウト処理を行う
リクエストトークンを取得する
APIを実行するユーザーのGaroonユーザーIDを取得する
アドレス帳APIで使用するデータの構造
アドレスまたはアドレス帳を取得する
アドレスを検索する
アドレスを登録／更新／削除する
Myアドレスグループを取得／登録／更新／削除する
ファイルをダウンロードする
アドレス帳のアクセス権を確認する
システム管理APIで使用するデータの構造
ユーザー情報を取得する
ユーザーを追加、更新、または削除する
組織情報を取得する
組織を追加、更新、または削除する
お気に入りAPIで使用するデータの構造
お気に入りを取得する
お気に入りを追加または削除する
設定情報を取得する

イベント

Garoonメールのイベントです。

メールのイベントオブジェクトで実行できる操作

メールのイベントオブジェクトで実行できる操作を説明します。

メールの作成画面を表示したときのイベント

メールの作成画面を表示したときに発生するイベントです。

メールの詳細画面を表示したときのイベント

メールの詳細画面を表示したときに発生するイベントです。

メールの返信画面を表示したときのイベント

メールの返信画面を表示したときに発生するイベントです。

メールを送信する前のイベント

メールの作成画面で【送信する】をクリックしたときに発生するイベントです。