kintone REST API リクエストを送信する
kintone REST API および User API を実行します。
関数
PC/モバイル
kintone.api(pathOrUrl, method, params, successCallback, failureCallback)
引数
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
pathOrUrl | 文字列 | 必須 | kintone API のパスまたは URL たとえば、API の URL が「https://sample.cybozu.com/k/v1/records.json」の場合は、「/k/v1/records.json」を指定します。 末尾の「.json」を省略しても、生成される URL では「.json」が自動で付与されます。 API の URL を取得する API( クエリ文字列なし/ クエリ文字列あり)で取得した値を指定することもできます。 |
method | 文字列 | 必須 | HTTP メソッド 次のいずれかの値を指定します。
|
params | オブジェクト | 必須 | 実行する API のリクエストパラメーター |
successCallback | 関数 | 省略可 | API の呼び出しが成功したときに実行されるコールバック関数 コールバック関数に渡される引数の型は、オブジェクトです。 省略すると kintone.Promise オブジェクト が返り、successCallback に渡す引数で解決されます。 |
failureCallback | 関数 | 省略可 | API の呼び出しが失敗したら実行されるコールバック関数 コールバック関数の引数には JSON 形式でエラー内容が渡されます。 エラーの内容が JSON として解析できない場合は、解析前の文字列が渡されます。 省略すると、 kintone.Promise オブジェクト が返り、failureCallback に渡す引数で棄却されます。 |
戻り値
successCallback
を指定した場合、戻り値はありません。
引数の successCallback
を省略した場合、
kintone.Promise
オブジェクト が返ります。
利用できる画面
PC/モバイル
すべての画面で利用できます。
サンプルコード
コールバックを使った記述方法
|
|
kintone.Promise オブジェクトを使った記述方法
|
|
制限事項
- 次の kintone REST API では利用できません。
アプリに適用したカスタマイズファイルから実行する場合には、ブラウザーの Fetch APIや XMLHttpRequest
を使って実行してください。
- 次の User API では利用できません。
- ファイルをアップロード する
- URL の末尾が
.json
以外で終わる API
例: ユーザー情報をエクスポートする