Garoon APIドキュメント

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);
}