kintone REST API リクエスト

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

kintone REST API および User APIで利用できます。

関数

kintone.api(pathOrUrl, method, params, opt_callback, opt_errback)

引数

返り値

引数のcallbackを省略した時、kintone.Promiseオブジェクトを返します。
※ このkintone.Promise オブジェクトを return することで、kintone.api() の実行を待ってから次の処理を実行できるイベントがあります。
対応しているイベントはこちらをご参照ください。

callbackを指定した場合返り値はありません。

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

サンプル

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

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

URL を取得する（クエリ文字列無し）

省略した形式の API のパスから、URL を生成します。

関数

kintone.api.url(path,opt_detectGuestSpace)

引数

返り値

URL 文字列。

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

サンプル

URL を取得する（クエリ文字列付き）

API のパスとパラメータを受け取ってクエリ文字列付きの URL を生成します。

関数

kintone.api.urlForGet(path, params,opt_detectGuestSpace)

引数

返り値

クエリ文字列が付与され、パラメータが URL エンコードされた URL 文字列。

// パラメータにオブジェクトや配列が渡された場合、クエリ文字列は以下のように展開されます。
// params = {foo: 'bar', record: {key: ['val1', 'val2']}}
foo=bar&record.key[0]=val1&record.key[1]=val2

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

サンプル

CSRFトークンの取得

HTTPメソッドが POST, PUT, DELETE である APIすべてにおいて利用できます。

関数

kintone.getRequestToken()

引数

なし

返り値

文字列

利用できる画面

• 全ての画面（アプリ、スペースも含まれます）

有効期間

最終アクセス時間から 86400秒(1日)

サンプル

APIがパラメータをクエリで受け付ける場合の例

https://(サブドメイン名).cybozu.com/k/v1/records.json?__REQUEST_TOKEN__=72A0C9714B6E1C086D24BBC11A5C3508

APIがパラメータをリクエストボディで受け付ける場合の例

以下のリクエストヘッダをAPI実行時に指定します。