カテゴリー内の他の記事

Garoon REST API リクエスト

フォローする

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

Garoon REST APIで利用できます。

  • 本APIは非同期リクエストとなります。同期的に処理したい場合はこちらのTipsをご参照ください。

関数

garoon.api(pathOrUrl, method, params, callback, opt_errback)

使用可能なガルーンバージョン

  • クラウド版 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に渡すパラメータをオブジェクトで指定します。
省略する場合は、"{}"を指定します。
callback 関数 省略可

APIの呼び出しが成功したら実行されるコールバック関数です。
引数にはレスポンスJSONが渡されます。
省略した場合はgaroon.Promiseオブジェクトが返され、callbackに渡す引数で解決されます。

opt_errback 関数 省略可

APIの呼び出しが失敗したら実行されるコールバック関数です。
引数にはレスポンスJSONが渡されます。
レスポンスがJSONとしてパースできなかった場合は、パース前の文字列が渡されます。
callbackを省略した場合はgaroon.Promiseオブジェクトが返され、errbackに渡す引数で棄却されます。

この関数を使用してGaroon REST APIを実行する場合、HTTPメソッドに関わらずCSRFトークンが不要となります。
CSRFトークン利用の詳細については、Garoon CSRFトークン利用例を確認ください。

返り値

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

利用できる画面

  • 全ての画面(ポップアップ画面を除く)

サンプル

コールバックを使用した記述方法

garoon.Promiseオブジェクトを使った記述方法

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。