獲取應用的一般設定

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”標頭中指定的語言
    • 無標頭:在通用管理的” 區域設置 (External link) ”中設置 cybozu.com 語言
  • 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:迴紋針
revision 字串 應用設置的修訂號
示例回應
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "name": "案件管理",
  "description": "営業部の案件管理に使用します。",
  "icon": {
    "type": "PRESET",
    "key": "APP60"
  },
  "theme": "WHITE",
  "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 REST API請求的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);