kintone APIドキュメント

クエリ文字列付きの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／モバイル

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

制限事項

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