變更應用程式的一般設定

information

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

目錄

變更應用程式的一般設定

變更應用程式的一般設定。

此 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”,則為必填項。
圖示標識符方面,使用 獲取一般設定API 獲取的用於使用kintone內置圖示的應用的icon.key值。
icon.file 物件 條件必填項 圖示文件資訊
如果在icon.type中指定了“FILE”,則為必填項。
icon.file.fileKey 字串 條件必填項 上傳檔案API上傳的檔案按鍵
可指定最大{0}的檔案。
如果在icon.type中指定了“FILE”,則為必填項。
theme 字串 可省略 設計主題
  • WHITE:初始設定
  • RED:紅
  • 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);