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メソッド 次のいずれかの値を指定できます。
|
params | オブジェクト | 必須 | APIに渡すパラメーターを表したオブジェクト 何も指定しない場合は {} を指定します。 |
successCallback | 関数 | 省略可 | APIの呼び出しが成功したら実行されるコールバック関数 省略すると、 garoon.Promise オブジェクトが返り、successCallback に渡す引数で解決されます。コールバック関数の引数には、次のプロパティをもつオブジェクトが渡されます。
|
failureCallback | 関数 | 省略可 | APIの呼び出しが失敗したら実行されるコールバック関数 省略すると、 garoon.Promise オブジェクトが返り、failureCallback に渡す引数で棄却されます。 コールバック関数の引数にはJSON形式でエラー内容が渡されます。 エラーの内容がJSONとして解析できない場合は、解析前の文字列が渡されます。 |
戻り値
successCallback
を指定した場合、戻り値はありません。
引数のsuccessCallback
を省略した場合、
garoon.Promise
オブジェクトが返ります。
利用できる画面
- ポップアップ画面を除くすべての画面
サンプルコード
コールバックを使用した記述方法
|
|
garoon.Promiseオブジェクトを使った記述方法
|
|