kintone API文件

獲取應用的一般設定

information

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

目錄

獲取應用的一般設定

連結已複製

獲取應用的一般設定。

URL

連結已複製

獲取正式環境的設置時，URL 與獲取測試環境的設置時不同。

如果要獲取正式環境的設置
常規應用程式
https://sample.cybozu.com/k/v1/app/settings.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/settings.json
獲取操作測試環境的設置
常規應用程式
https://sample.cybozu.com/k/v1/preview/app/settings.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/settings.json

HTTP 方法

連結已複製

GET

所需存取權限

連結已複製

如果要獲取正式環境的設置

您必須具有以下權限之一：

  • 應用程式中記錄的查看權限
  • 應用程式中新增記錄的權限
獲取操作測試環境的設置
  • 應用程式管理權限

請求

連結已複製

參數
參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
lang 字串 可省略 要選取的名稱的語言
如果為應用程式名稱或說明設置了多語言對應，請指定。
多語言對應 (External link)
  • ja：日文
  • en：英語
  • zh：中文
  • user：執行 API 的使用者設置為顯示語言的語言
    如果語言設置為「與網路瀏覽器設定相同」，則要獲取的語言取決於是否存在「Accept-Language」標頭。
    • 帶標題：帶標頭：「Accept-Language」標頭中指定的語言
    • 無標頭：在cybozu.com通用管理的地區設定中設置的語言
      地區設定 (External link)
  • default：預設
如果省略，則獲取預設名稱。
範例請求（如果要在網址中包含參數 ）
URL

https://sample.cybozu.com/k/v1/app/settings.json?app=8&lang=ja

標頭
1
2
3

{
  "X-Cybozu-API-Token": "API_TOKEN"
}

有關請求頭的詳細資訊，請參閱通用規格。
kintone REST API通用規範

要求範例（如果要在要求正文中包含參數）
URL

https://sample.cybozu.com/k/v1/app/settings.json

標頭
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}
正文
1
2
3
4

{
  "app": 8,
  "lang": "ja"
}

回應

連結已複製

屬性
屬性名稱 類型 說明
name 字串 應用程式名稱
description 字串 應用程序的說明
它以 HTML 格式輸出。
icon 物件 應用圖示資訊
icon.type 字串 圖示的類型
  • PRESET： kintone內置的圖示
  • FILE：上傳頭像
icon.key 字串 圖示鍵（識別元）
使用內置kintone圖示時，將顯示此輸出。
icon.file 物件 圖示文件資訊
這是使用上傳的圖像時輸出的。
icon.file.contentType 字串 圖示MIME類型
icon.file.fileKey 字串 圖示的檔鍵
icon.file.name 字串 圖示名稱
icon.file.size 字串 圖示檔案大小（以位元組為單位）
theme 字串 設計主題
  • WHITE：初始設定
  • RED：紅
  • GREEN：綠
  • BLUE：藍
  • YELLOW：黃
  • BLACK：黑
對於在 2017 年 2 月維護之前創建的應用，可能會出現以下情況：
  • CLIPBOARD：剪貼簿
  • BINDER：活頁夾
  • PENCIL：鉛筆
  • CLIPS：迴紋針
titleField 物件 記錄標題
titleField.selectionMode 字串 作為記錄標題的欄位
  • AUTO：使用自動設定
  • MANUAL：選擇欄位
titleField.code 字串 要用於顯示標題的欄位的欄位代碼
這取決於titleField.selectionMode值。
  • 在「使用自動設置」的情況下：自動設置欄位的欄位代碼
  • 在「選擇欄位」的情況下：設置的欄位的欄位代碼
enableThumbnails 布爾值 顯示縮圖
enableBulkDeletion 布爾值 大量刪除記錄
enableComments 布爾值 可對記錄填寫回覆
enableDuplicateRecord 布爾值 允許「允許重複利用記錄」
numberPrecision 物件 數值和計算的精準度
kintone幫助：數值與計算精度 (External link)
numberPrecision.digits 字串 總位數
返回一個介於 1 和 30 之間的整數。
numberPrecision.decimalPlaces 字串 小數位的位數
返回一個介於 0 和 10 之間的整數。
numberPrecision.roundingMode 字串 如何對數字進行四捨五入
  • HALF_EVEN：四捨五入為最相近的偶數
  • UP：無條件進位
  • DOWN：無條件捨去
firstMonthOfFiscalYear 字串 第一季度的開始月份
返回一個介於 1 和 12 之間的整數。
revision 字串 應用設置的修訂號
應答範例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
  "name": "案件管理",
  "description": "它用於銷售部門的案例管理。",
  "icon": {
    "type": "PRESET",
    "key": "APP60"
  },
  "theme": "WHITE",
  "titleField": {
    "selectionMode": "MANUAL",
    "code": "單行文字方塊_0"
  },
  "enableThumbnails": true,
  "enableBulkDeletion": false,
  "enableComments": true,
  "enableDuplicateRecord": true,
  "numberPrecision": {
    "digits": "16",
    "decimalPlaces": "4",
    "roundingMode": "HALF_EVEN"
  },
  "firstMonthOfFiscalYear": "4",
  "revision": "24"
}

示例代碼

連結已複製

使用 curl 的請求
1
2

curl -X GET 'https://sample.cybozu.com/k/v1/app/settings.json?app=8&lang=ja' \
  -H 'X-Cybozu-API-Token: API_TOKEN'
使用kintone.api()發送請求

有關詳細的kintone.api()，請參閱以下頁面。
發送kintone REST API請求 

1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

await kintone.api(kintone.api.url('/k/v1/app/settings.json', true), 'GET', body);