獲取應用的一般設定

連結已複製

獲取應用的一般設定。

HTTP 方法	GET
URL	https://sample.cybozu.com/k/v1/app/settings.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/settings.json
URL（操作測試環境）	https://sample.cybozu.com/k/v1/preview/app/settings.json
URL（測試環境中的訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/settings.json
認證	密碼驗證 , API令牌認證 , 會話認證 , OAuth認證
Content-Type	application/json（透過查詢字串指定查詢時不需指定此項）

請求參數

連結已複製

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

應答屬性

連結已複製

屬性名稱	類型	說明
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	布爾值	允許「允許重複利用記錄」
enableInlineRecordEditing	布爾值	是否啟用記錄清單的內聯編輯
numberPrecision	物件	數值和計算的精準度數值和計算的精準度
numberPrecision.digits	字串	總位數返回一個介於 1 和 30 之間的整數。
numberPrecision.decimalPlaces	字串	小數位的位數返回一個介於 0 和 10 之間的整數。
numberPrecision.roundingMode	字串	如何對數字進行四捨五入 `HALF_EVEN`：四捨五入為最相近的偶數 `UP`：無條件進位 `DOWN`：無條件捨去
firstMonthOfFiscalYear	字串	第一季度的開始月份返回一個介於 1 和 12 之間的整數。
revision	字串	應用設置的修訂號

所需存取權限

連結已複製

取得正式環境的設定

連結已複製

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

應用程式中記錄的查看權限
應用程式的記錄添加權限

取得操作測試環境的設定

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求URL（在URL中包含參數的情況）

1

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

請求標頭（在URL中包含參數的情況）

1
2
3


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

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

請求URL（在請求主體中包含參數的情況）

1

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"
}

範例回應

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25


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

範例程式碼

使用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);

使用curl傳送請求

根據您的環境，curl的格式可能會有所不同。
有關說明，請參閱以下頁面。
使用curl命令執行kintone REST API/3.執行API

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文件

獲取應用的一般設定

目錄

請求參數

應答屬性

所需存取權限

取得正式環境的設定

取得操作測試環境的設定

範例