クエリ文字列付きの API の URL を取得する

目次

クエリ文字列付きの API の URL を取得する

ベースURLを含む、クエリ文字列付きのAPIのURLを生成します。

関数

PC/モバイル

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

引数

パラメータ名 指定する値 必須 説明
path 文字列 必須 kintone REST API または User API のパス
ベース URL を省略して指定します。
たとえば、API の URL が「https://sample.cybozu.com/k/v1/records.json」の場合は、「/k/v1/records.json」を指定します。
末尾の「.json」を省略しても、生成される URL では「.json」が自動で付与されます。
params オブジェクト 省略可 API リクエストパラメータ
例:
{
"app": "4",
"fields": ["record_no"]
}
isGuestSpace 真偽値 省略可 ゲストスペース用の URL を取得するかどうか
  • true:ゲストスペース用の URL を取得する
  • false:通常の URL を取得する
省略すると「false」が設定されます。
「true」を指定し、ゲストスペース内で関数を実行した場合のみ、ゲストスペース用の URL を取得します。

戻り値

説明
文字列 クエリ文字列付きの API の URL
パラメーターは、URL エンコードされます。

サンプルコード

1
2
3
4
5
6
const params = {
  app: 4,
  fields: ['recordId']
};
kintone.api.urlForGet('/k/v1/records.json', params, false);
// https://sample.cybozu.com/k/v1/records.json?app=4&fields[0]=recordId

利用できる画面

PC/モバイル

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

制限事項