更改 JavaScript/CSS 自訂設置

information

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

目錄

更改 JavaScript/CSS 自訂設置

更改應用的 JavaScript/CSS 自訂設置。

此 API 在測試環境中修改應用。
如果要將更改傳播到正式環境,執行該 運行將應用設置傳播到正式環境的API

URL

常規應用程式
https://sample.cybozu.com/k/v1/preview/app/customize.json
訪客空間的應用程式
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/customize.json

HTTP 方法

PUT

所需存取權限

  • kintone系統管理
  • 應用程式管理

請求

參數
參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
scope 字串 可省略 自訂的套用範圍
  • ALL:所有使用者
  • ADMIN:僅限應用管理員
  • NONE:停用
desktop 物件 可省略 有關PC上載入的檔案的資訊
desktop.js 陣列 可省略 JavaScript檔案清單
desktop.js[].type 字串 可省略 如何指定檔
  • URL:按 URL 指定時
  • FILE:上傳和指定時
desktop.js[].url 字串 可省略 檔案的 URL
指定desktop.js[].type為“URL”的時間。
除了desktop.js[].file 之外,您最多可以指定 30 個。
desktop.js[].file 物件 可省略 附件資訊
指定desktop.js[].type為“FILE”的時間。
除了desktop.js[].url之外,您最多可以指定 30 個。
desktop.js[].file.fileKey 字串 可省略 上傳檔案API獲取的檔鍵
如果要保留現有檔案,請指定相同參數的 key 以 選取JavaScript/CSS自訂設定(獲取測試環境的設置)
desktop.css 陣列 可省略 CSS 檔案清單
desktop.css[].type 字串 可省略 如何指定檔
  • URL:按 URL 指定時
  • FILE:上傳和指定時
desktop.css[].url 字串 可省略 檔案的 URL
指定desktop.css[].type為“URL”的時間。
除了desktop.css[].file之外,您最多可以指定 30 個。
desktop.css[].file 物件 可省略 附件資訊
指定desktop.css[].type為“FILE”的時間。
除了desktop.css[].url之外,您最多可以指定 30 個。
desktop.css[].file.fileKey 字串 可省略 上傳檔案API獲取的檔鍵
如果要保留現有檔案,請指定相同參數的 key 以 選取JavaScript/CSS自訂設定(獲取測試環境的設置)
mobile 物件 可省略 有關在行動裝置上載入的檔案的資訊
mobile.js 陣列 可省略 JavaScript檔案清單
mobile.js[].type 字串 可省略 如何指定檔
  • URL:按 URL 指定時
  • FILE:上傳和指定時
mobile.js[].url 字串 可省略 檔案的 URL
指定mobile.js[].type為“URL”的時間。
除了mobile.js[].file之外,您最多可以指定 30 個。
mobile.js[].file 物件 可省略 附件資訊
指定mobile.js[].type為“FILE”的時間。
除了mobile.js[].url之外,您最多可以指定 30 個。
mobile.js[].file.fileKey 字串 可省略 上傳檔案API獲取的檔鍵
如果要保留現有檔案,請指定相同參數的 key 以 選取JavaScript/CSS自訂設定(獲取測試環境的設置)
mobile.css 陣列 可省略 CSS 檔案清單
mobile.css[].type 字串 可省略 如何指定檔
  • URL:按 URL 指定時
  • FILE:上傳和指定時
mobile.css[].url 字串 可省略 檔案的 URL
指定mobile.css[].type為“URL”的時間。
除了mobile.css[].file之外,您最多可以指定 30 個。
mobile.css[].file 物件 可省略 附件資訊
指定mobile.css[].type為“URL”的時間。
除了mobile.css[].url之外,您最多可以指定 30 個。
mobile.css[].file.fileKey 字串 可省略 上傳檔案API獲取的檔鍵
如果要保留現有檔案,請指定相同參數的 key 以 選取JavaScript/CSS自訂設定(獲取測試環境的設置)
revision 數值或字串 可省略 預期修訂號
如果與實際修訂號不匹配,則會發生錯誤,並且不會更改設置。
如果指定值“-1”或未指定值,則不會驗證修訂號。
示例請求
標頭
1
2
3
4
{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "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
27
28
29
30
31
32
33
34
35
{
  "app": 21,
  "scope": "ALL",
  "desktop": {
    "js": [
      {
        "type": "URL",
        "url": "https://www.example.com/example.js"
      },
      {
        "type": "FILE",
        "file": {
          "fileKey": "ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3"
        }
      }
    ],
    "css": []
  },
  "mobile": {
    "js": [
      {
        "type": "FILE",
        "file": {
          "fileKey": "20150519023802B3EB762E870645F889B22F9D4F1F3059023"
        }
      },
      {
        "type": "URL",
        "url": "https://www.example.com/example-mobile.js"
      }
    ],
    "css": []
  },
  "revision": 2
}

回應

屬性
屬性名稱 值類型 說明
revision 字串 更改應用設置后的修訂號
示例回應
1
2
3
{
  "revision": "3"
}

樣本

使用 curl 的請求
 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
29
30
31
32
33
34
35
36
37
curl -X PUT 'https://sample.cybozu.com/k/v1/preview/app/customize.json' \
  -H 'X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": kintone.app.getId(),
    "scope": "ALL",
    "desktop": {
      "js": [
        {
          "type": "URL",
          "url": "https://www.example.com/example.js"
        },
        {
          "type": "FILE",
          "file": {
            "fileKey": "ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3"
          }
        }
      ],
      "css": []
    },
    "mobile": {
      "js": [
        {
          "type": "FILE",
          "file": {
            "fileKey": "20150519023802B3EB762E870645F889B22F9D4F1F3059023"
          }
        },
        {
          "type": "URL",
          "url": "https://www.example.com/example-mobile.js"
        }
      ],
      "css": []
    }
  }'
使用 發送kintone REST API請求的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
29
30
31
32
33
34
35
36
const body = {
  app: kintone.app.getId(),
  scope: 'ALL',
  desktop: {
    js: [
      {
        type: 'URL',
        url: 'https://www.example.com/example.js'
      },
      {
        type: 'FILE',
        file: {
          fileKey: 'ddfc8e89-7aa3-4350-b9ab-3a75c9cf46b3'
        }
      }
    ],
    css: []
  },
  mobile: {
    js: [
      {
        type: 'FILE',
        file: {
          fileKey: '20150519023802B3EB762E870645F889B22F9D4F1F3059023'
        }
      },
      {
        type: 'URL',
        url: 'https://www.example.com/example-mobile.js'
      }
    ],
    css: []
  }
};

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

限制

  • 不能使用 API 權杖。