kintone API ドキュメント

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

目次

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

kintone REST API および User API を実行します。

  • この API は非同期な API です。同期的に処理したい場合は Tips を参照してください。
  • この 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 に渡す引数で解決されます。
failureCallback 関数 省略可 API の呼び出しが失敗したら実行されるコールバック関数
コールバック関数の引数には JSON 形式でエラー内容が渡されます。
エラーの内容が JSON として解析できない場合は、解析前の文字列が渡されます。
省略すると、 kintone.Promise オブジェクト が返り、failureCallback に渡す引数で棄却されます。

戻り値

successCallback を指定した場合、戻り値はありません。
引数の successCallback を省略した場合、 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);
  }
})();

制限事項