Garoon REST API リクエストを送信する
Garoon REST API で利用できます。
- 本 API は非同期リクエストとなります。同期的に処理したい場合はこちらの Tips をご参照ください。
関数
garoon.api(pathOrUrl, method, params, successCallback, failureCallback)
使用可能なガルーンバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
引数
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| pathOrUrl | 文字列 | 必須 | Garoon REST API のパスを指定します。 例）API のURLが https://(サブドメイン名).cybozu.com/g/api/v1/xxx の場合は、そのまま記載するか、"/api/v1/xxx" を指定します。 |
| method | 文字列 | 必須 | 使用する HTTP メソッド。GET, POST, PATCH, DELETE, PUT が指定可能です。 |
| params | オブジェクト | 必須 | API に渡すパラメータをオブジェクトで指定します。 省略する場合は、"{}" を指定します。 |
| successCallback | 関数 | 省略可 |
API の呼び出しが成功したら実行されるコールバック関数です。
省略した場合は garoon.Promise オブジェクトが返され、successCallback に渡す引数で解決されます。 |
| failureCallback | 関数 | 省略可 |
API の呼び出しが失敗したら実行されるコールバック関数です。 |
この関数を使用して Garoon REST API を実行する場合、HTTP メソッドに関わらず CSRF トークンが不要となります。
CSRF トークン利用の詳細については、Garoon CSRF トークン利用例を確認ください。
返り値
引数の successCallback を省略した場合、garoon.Promise オブジェクトを返します。
successCallback を指定した場合、返り値はありません。（null が返されます）
利用できる画面
- 全ての画面（ポップアップ画面を除く）
サンプル
コールバックを使用した記述方法
garoon.Promise オブジェクトを使った記述方法
この関数を使用してGaroonから User API は実行できないのでしょうか？
kintone側で同じ位置づけと思われる「kintone.api()」では実行できた為、少しモヤっとしました。
Garoon側で User API を実行する際は xmlHttpRequest() を使用する想定でしょうか？
（xmlHttpRequestによる実行は確認できました。）
naoki watanabe 様
お世話になっております。cybozu developer network 運営局です。
garoon.api() を使って User API を実行することはできません。
kintone.api() とは使用感が違うというご意見は、Garoon 開発チームにフィードバックさせていただきます。
Garoon から User API を利用するには、ご記載の通り、XMLHttpRequest や、 jQuery.ajax() や Axios などHTTP リクエストを送るライブラリを利用するか、または Garoon JavaScript API ですと garoon.base.proxy.send() を使って実行することを想定しております。
参照：Garoon カスタマイズで外部システムの API を実行する〜打合せコスト算出カスタマイズ〜
よろしくお願いいたします。