kintone Customization Gallery

將應用設置傳播到生產環境

information

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

目錄

將應用設置傳播到生產環境

連結已複製

將應用在測試環境中的設置反映到生產環境中。
運行此 API 時，測試環境中應用的所有設置都會反映在生產環境中的應用中。 這相當於按兩下應用程式設置螢幕上的[更新應用程式]或[停止更改]。

  • 此 API 是一個異步 API。
    您可以通過 API 檢查生產環境中應用設置的反射狀態來檢查反射狀態。
  • 此 API 允許您一次處理多個應用程式的傳播。
    如果任何應用失敗，則所有指定應用的設置將恢復為執行API之前的設置。
  • 如果運行的 API 在執行完畢之前更改了應用的設置，則會返回錯誤。
  • 更改許可權設置的結果將按順序反映在應用程式中，從該過程完成開始。有關詳細資訊， 請檢查是否顯示 (External link) "更改許可權設置的結果正在反映在每條記錄中"。

URL

連結已複製

常規應用
https://sample.cybozu.com/k/v1/preview/app/deploy.json
建立訪客空間
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/deploy.json

HTTP 方法

連結已複製

POST

所需許可權

連結已複製

  • 應用程式管理

請求

連結已複製

參數
參數名稱 型 必須 說明
apps 陣列 必須 應用ID清單
您最多可以指定 300 個 App ID。
如果在訪客空間中指定應用程式，則只能在同一訪客空間中指定應用程式。
apps[].app 數位或字串 必須 應用ID
revision 數位或字串 自選 預期修訂號
如果與實際修訂號不匹配，則會發生錯誤，並且不會更改設置。
如果指定值"-1"或未指定值，則不會驗證修訂號。
revert 布爾值或字串 自選 是否取消對應用設置的更改
  • true：取消對應用程式設置的更改，並使測試環境中的應用程式設置與生產環境中的設置相同。
  • false：將應用設置中的更改反映到生產環境中
如果省略，則設置"false"。
示例請求
頁眉
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

{
  "apps": [
    {
      "app": 1,
      "revision": 13
    },
    {
      "app": 1,
      "revision": 5,
    },
    {
      "app": 1,
      "revision": 11,
    }
  ],
  "revert": false
}

回應

連結已複製

沒有回應。

示例代碼

連結已複製

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

curl -X POST 'https://sample.cybozu.com/k/v1/preview/app/deploy.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "apps": [
      {
        "app": 1,
        "revision": 57
      },
      {
        "app": 1001,
        "revision": 22
      }
    ],
    "revert": false
  }'
發送kintone REST API請求 使用API 發送請求
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

const body = {
  apps: [
    {
      app: 1,
      revision: 57
    },
    {
      app: 1001,
      revision: 22
    }
  ],
  revert: false
};

await kintone.api(kintone.api.url('/k/v1/preview/app/deploy.json'), 'POST', body);