kintone APIドキュメント

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

目次

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メソッド
次のいずれかの値を指定します。
  • GET
  • POST
  • PUT
  • DELETE
params オブジェクト 必須 実行するAPIのリクエストパラメーター
successCallback 関数 省略可 APIの呼び出しが成功したときに実行されるコールバック関数
コールバック関数に渡される引数の型は、オブジェクトです。
省略するとkintone.Promiseオブジェクトが返り、successCallbackに渡す引数で解決されます。
kintone.Promiseオブジェクト
failureCallback 関数 省略可 APIの呼び出しが失敗したら実行されるコールバック関数
コールバック関数の引数にはJSON形式でエラー内容が渡されます。
エラーの内容がJSONとして解析できない場合は、解析前の文字列が渡されます。
省略すると、kintone.Promiseオブジェクトが返り、failureCallbackに渡す引数で棄却されます。
kintone.Promiseオブジェクト

戻り値

固定リンクがコピーされました

successCallbackを指定した場合、戻り値はありません。
引数のsuccessCallbackを省略した場合、kintone.Promiseオブジェクトが返ります。
kintone.Promiseオブジェクト

利用できる画面

固定リンクがコピーされました

PC／モバイル

すべての画面で利用できます。

サンプルコード

固定リンクがコピーされました

コールバックを使った記述方法
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const body = {
  app: kintone.app.getId(),
  id: 1
};

kintone.api(kintone.api.url('/k/v1/record.json', true), 'GET', body, (resp) => {
  // success
  console.log(resp);
}, (error) => {
  // error
  console.log(error);
});
kintone.Promiseオブジェクトを使った記述方法
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

(async () => {
  const body = {
    app: kintone.app.getId(),
    id: 1
  };

  try {
    const resp = await kintone.api(kintone.api.url('/k/v1/record.json', true), 'GET', body);
    // success
    console.log(resp);
  } catch (error) {
    // error
    console.log(error);
  }
})();

制限事項

固定リンクがコピーされました

補足

固定リンクがコピーされました

  • URLの長さが4KBを超えるGETリクエストを送信すると、「X-HTTP-Method-Override」ヘッダーが自動的に付与され、POSTリクエストとして送信されます。
    X-HTTP-Method-Override