變更JavaScript/CSS自訂設定

連結已複製

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

HTTP 方法	PUT
URL	https://sample.cybozu.com/k/v1/preview/app/customize.json
URL（訪客空間）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/customize.json
認證	密碼驗證 , 會話認證 , OAuth認證
Content-Type	application/json

請求參數

連結已複製

參數名稱	類型	必須	說明
app	數值或字串	必須	應用ID
scope	字串	可省略	自訂的套用範圍 `ALL`：所有使用者 `ADMIN`：僅限應用管理員 `NONE`：停用
desktop	物件	可省略	有關電腦上載入的檔案的資訊
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自訂設定（獲取測試環境的設置）上傳檔案的 API 獲取JavaScript/CSS自訂設定的API（獲取操作測試環境的設定）
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自訂設定（獲取測試環境的設置）上傳檔案的 API 獲取JavaScript/CSS自訂設定的API（獲取操作測試環境的設定）
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自訂設定（獲取測試環境的設置）上傳檔案的 API 獲取JavaScript/CSS自訂設定的API（獲取操作測試環境的設定）
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`為「FILE」時可指定。除了`mobile.css[].url`之外，您最多可以指定 30 個。
mobile.css[].file.fileKey	字串	可省略	上傳檔案API獲取的檔鍵如果要保留現有檔案，請指定相同參數的 key 以選取JavaScript/CSS自訂設定（獲取測試環境的設置）上傳檔案的 API 獲取JavaScript/CSS自訂設定的API（獲取操作測試環境的設定）
revision	數值或字串	可省略	預期修訂號如果與實際修訂號不匹配，則會發生錯誤，並且不會變更設置。如果指定值「-1」或未指定值，則不會驗證修訂號。

應答屬性

連結已複製

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

所需存取權限

連結已複製

kintone系統管理
應用程式管理權限

範例

連結已複製

請求範例

請求標頭

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
}

範例回應

1
2
3


{
  "revision": "3"
}

範例程式碼

使用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
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);

使用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
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": 1,
    "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": []
    }
  }'

補充

連結已複製

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

限制事項

連結已複製

不能使用 API 權杖。

kintone API

kintone API文件

變更JavaScript/CSS自訂設定

目錄

請求參數

應答屬性

所需存取權限

範例

補充

限制事項