kintone Customization Gallery

變更應用程式的設定

information

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

目錄

變更應用程式的設定

連結已複製

打開應用程式的設定進行變更。

此 API 在測試環境中修改應用。
如果要將更改傳播到生產環境，請運行此 API，然後 運行將應用設置傳播到生產環境的 API 。

URL

連結已複製

常規應用
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 方法

連結已複製

PUT

所需許可權

連結已複製

  • 應用程式管理

請求

連結已複製

參數

請求的參數清單。省略的參數設置不會更新。

參數名稱 型 必須 說明
app 數位或字串 必須 應用ID
name 字串 自選 應用的名稱
該值可以介於 1 到 64 個字元之間。
description 字串 自選 應用程式的說明：
最多指定 10,000 個字元。您可以使用 HTML 標記。
icon 物件 自選 應用圖示資訊
icon.type 字串 條件必填項 變更圖示
指定以下值之一：
  • PRESET：何時使用kintone內置圖示
  • FILE：上傳圖片
icon 如果指定，則為必填項。
icon.key 字串 條件必填項 要使用的圖示的標識碼
icon.type 如果為 指定"PRESET"，則為必填項。
對於使用kintone內置圖示的應用 ，請使用獲取常規設置API 獲取 icon.key 的值。
icon.file 物件 條件必填項 圖示文件資訊
icon.type 如果在 中指定了"FILE"，則為必填項。
icon.file.fileKey 字串 條件必填項 檔上傳 API 上傳的檔案金鑰
可指定最大的檔案。
icon.type 如果在 中指定了"FILE"，則為必填項。
theme 字串 自選 設計主題
  • WHITE：初始設定
  • READ：紅
  • GREEN：綠
  • BLUE：藍
  • YELLOW：黃
  • BLACK：黑
如果指定了 2017 年 2 月維護之前可用的以下主題，它們將顯示為預設主題。
  • CLIPBOARD
  • BINDER
  • PENCIL
  • CLIPS
revision 數位或字串 自選 預期修訂號
如果與實際修訂號不匹配，則會發生錯誤，並且不會更改設置。
如果指定值"-1"或未指定值，則不會驗證修訂號。
示例請求
頁眉
1
2
3
4

{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

關於請求頭，請參見 kintone REST API的通用規範 。

身體
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "app": 21,
  "name": "案件管理",
  "description": "這是用於管理問題的應用程式。",
  "icon": {
    "type": "PRESET",
    "key": "APP72"
  },
  "theme": "WHITE",
  "revision": 1
}

回應

連結已複製

財產
屬性名稱 型 說明
revision 字串 更改應用設置后的修訂號
示例回應
1
2
3

{
  "revision": "2"
}

示例代碼

連結已複製

使用 curl 的請求
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/settings.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": kintone.app.getId(),
    "name": "案件管理",
    "description": "這是用於管理問題的應用程式。",
    "icon": {
      "type": "PRESET",
      "key": "APP72"
    },
    "theme": "WHITE"
  }'
發送kintone REST API請求 使用API 發送請求
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

const body = {
  app: kintone.app.getId(),
  name: '案件管理',
  description: '這是用於管理問題的應用程式。',
  icon: {
    type: 'PRESET',
    key: 'APP72'
  },
  theme: 'WHITE'
};

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