Garoon REST API リクエストを送信する

目次

Garoon REST API リクエストを送信する

Garoon 上で Garoon REST API を実行します。

  • この API は、非同期関数です。
    同期的に処理したい場合は、 Promise と async/await を参照してください。
  • この API を使用して Garoon REST API を実行する場合には、CSRF トークンを指定する必要はありません。
    CSRF トークン利用の詳細は、 Garoon CSRF トークン利用例 を確認してください。

関数

garoon.api(pathOrUrl, method, params, successCallback, failureCallback)

利用できるバージョン

  • クラウド版 Garoon
  • パッケージ版 Garoon 5.0 以降

引数

パラメーター名 必須 説明
pathOrUrl 文字列 必須 Garoon REST API のパス
たとえば、API の URL が https://sample.cybozu.com/g/api/v1/schedule/events/1 の場合は、そのまま記載するか「/api/v1/schedule/events/1」を指定します。
method 文字列 必須 HTTP メソッド
次のいずれかの値を指定できます。
  • GET
  • POST
  • PUT
  • PATCH
  • DELETE
params オブジェクト 必須 API に渡すパラメーターを表したオブジェクト
何も指定しない場合は {} を指定します。
successCallback 関数 省略可 API の呼び出しが成功したら実行されるコールバック関数
省略すると、 garoon.Promise オブジェクト が返り、successCallback に渡す引数で解決されます。
コールバック関数の引数には、次のプロパティをもつオブジェクトが渡されます。
  • data:レスポンスボディ
  • statusCode:レスポンスのステータスコード
  • statusText:ステータスコードに対応するリーズンフレーズ
  • headers:レスポンスヘッダー
failureCallback 関数 省略可 API の呼び出しが失敗したら実行されるコールバック関数
省略すると、 garoon.Promise オブジェクト が返り、failureCallback に渡す引数で棄却されます。
コールバック関数の引数には JSON 形式でエラー内容が渡されます。
エラーの内容が JSON として解析できない場合は、解析前の文字列が渡されます。

戻り値

successCallback を指定した場合、戻り値はありません。
引数の successCallback を省略した場合、 garoon.Promise オブジェクト が返ります。

利用できる画面

  • ポップアップ画面を除くすべての画面

サンプルコード

コールバックを使用した記述方法
1
2
3
4
5
6
7
garoon.api('/api/v1/schedule/events/1', 'GET', {}, (resp) => {
  // success
  console.log(resp);
}, (err) => {
  // error
  console.log(err);
});
garoon.Promise オブジェクトを使った記述方法
1
2
3
4
5
6
7
8
try {
  const resp = await garoon.api('/api/v1/schedule/events/1', 'GET', {});
  // success
  console.log(resp);
} catch (error) {
  // error
  console.log(error);
}