APIのURLを取得する
固定リンクがコピーされました
ベースURLを含む、APIのURLを生成します。
関数
固定リンクがコピーされました
PC／モバイル
kintone.api.url(path, 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」が自動で付与されます。 |
| isGuestSpace | 真偽値 | 省略可 | ゲストスペース用のURLを取得するかどうか
「true」を指定し、ゲストスペース内で関数を実行した場合のみ、ゲストスペース用のURLを取得します。 |
戻り値
固定リンクがコピーされました
| 型 | 説明 |
|---|---|
| 文字列 | APIのURL |
利用できる画面
固定リンクがコピーされました
PC／モバイル
すべての画面で利用できます。
制限事項
固定リンクがコピーされました
- URLの末尾が
.json以外で終わるAPIでは利用できません。
次のような例があります。
ユーザー情報をエクスポートする