變更應用程式的一般設定

連結已複製

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

HTTP 方法	PUT
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
name	字串	可省略	應用的名稱該值可以介於 1 到 64 個字元之間。
description	字串	可省略	應用程序的說明最多指定 10,000 個字元。您可以使用 HTML 標記。
icon	物件	可省略	應用圖示資訊
icon.type	字串	條件必填項	圖示的類型指定以下值之一： `PRESET`：使用kintone內置圖示 `FILE`：上傳圖片如果`icon`指定，則為必填項。
icon.key	字串	條件必填項	要使用的圖示的標識碼如果為`icon.type`指定「PRESET」，則為必填項。圖示標識符方面，使用`獲取一般設定API獲取的用於使用kintone內置圖示的應用的值。獲取一般設定API
icon.file	物件	條件必填項	圖示文件資訊如果在`icon.type`中指定了「FILE」，則為必填項。
icon.file.fileKey	字串	部分條件下必須	上傳檔案API上傳的檔案按鍵可指定最大800KB的檔案。上傳檔案的 API 如果在`icon.type`中指定了「FILE」，則為必填項。
theme	字串	可省略	設計主題 `WHITE`：初始設定 `RED`：紅 `GREEN`：綠 `BLUE`：藍 `YELLOW`：黃 `BLACK`：黑如果指定了 2017 年 2 月維護之前可用的以下主題，它們將顯示為預設主題。 `CLIPBOARD` `BINDER` `PENCIL` `CLIPS`
titleField	物件	可省略	記錄標題
titleField.selectionMode	字串	部分條件下必須	作為記錄標題的欄位指定以下值之一： `AUTO`：使用自動設定 `MANUAL`：選擇欄位如果`titleField`指定，則為必填項。
titleField.code	字串	部分條件下必須	要用於顯示標題的欄位的欄位代碼 `titleField.selectionMode`如果指定了「MANUAL」，則為必填項。 `titleField.selectionMode`如果為指定「AUTO」，則忽略此參數。
enableThumbnails	布爾值或字串	可省略	顯示縮圖
enableBulkDeletion	布爾值或字串	可省略	大量刪除記錄
enableComments	布爾值或字串	可省略	可對記錄填寫回覆
enableDuplicateRecord	布爾值或字串	可省略	允許「允許重複利用記錄」
enableInlineRecordEditing	布爾值或字串	可省略	是否啟用記錄清單的內聯編輯
numberPrecision	物件	可省略	數值和計算的精準度數值和計算的精準度
numberPrecision.digits	布爾值或字串	可省略	總位數指定一個介於 1 和 30 之間的整數。
numberPrecision.decimalPlaces	布爾值或字串	可省略	小數位的位數指定一個介於 1 和 10 之間的整數。
numberPrecision.roundingMode	字串	可省略	如何對數字進行四捨五入指定以下值之一： `HALF_EVEN`：四捨五入為最相近的偶數 `UP`：無條件進位 `DOWN`：無條件捨去
firstMonthOfFiscalYear	布爾值或字串	可省略	第一季度的開始月份指定一個介於 1 和 12 之間的整數。
revision	數值或字串	可省略	預期修訂號如果與實際修訂號不匹配，則會發生錯誤，並且不會變更設置。如果指定值「-1」或未指定值，則不會驗證修訂號。

回應屬性

連結已複製

屬性名稱	類型	說明
revision	字串	變更應用程式設置后的修訂號

所需存取權限

連結已複製

應用程式管理權限

範例

連結已複製

請求範例

請求標頭

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
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26


{
  "app": 21,
  "name": "案件管理",
  "description": "這是用於管理問題的應用程式。",
  "icon": {
    "type": "PRESET",
    "key": "APP72"
  },
  "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": 1
}

範例回應

1
2
3


{
  "revision": "2"
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST API請求

 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
26
27


const body = {
  app: kintone.app.getId(),
  name: '案例管理',
  description: '這是用於管理問題的應用程式。',
  icon: {
    type: 'PRESET',
    key: 'APP72'
  },
  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'
};

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

使用curl傳送請求

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

 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
26
27
28


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": 1,
    "name": "案件管理",
    "description": "這是用於管理問題的應用程式。",
    "icon": {
      "type": "PRESET",
      "key": "APP72"
    },
    "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"
  }'

補充

連結已複製

此API可變更測試環境中的應用程式。
如果要將變更套用到正式環境，請在執行該API之後，執行將應用程式設置反映到正式環境的API。
將應用程式設置套用到正式環境API

kintone API

kintone API文件

變更應用程式的一般設定

目錄

請求參數

回應屬性

所需存取權限

範例

補充