kintone API文件

使用查詢字串獲取 API 的 URL

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

使用查詢字串獲取 API 的 URL

連結已複製

使用查詢字串（包括基本 URL）為 API 產生 URL。

函數

連結已複製

電腦/行動裝置

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：獲取普通網址
如果省略，則設置「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

可使用的畫面

連結已複製

電腦/行動裝置

它可在所有畫面上使用。

限制事項

連結已複製