將應用程式設置套用到正式環境

連結已複製

將測試環境中的設置反映到正式環境中。

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

請求參數

連結已複製

參數名稱	類型	必須	說明
apps	陣列	必須	應用程式ID清單您最多可以指定300個應用程式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": 8,
      "revision": 13
    },
    {
      "app": 9,
      "revision": 5
    },
    {
      "app": 10,
      "revision": 11
    }
  ],
  "revert": false
}

範例程式碼

使用kintone.api()傳送請求

有關kintone.api()的說明，請參閱以下頁面。
傳送kintone REST 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);

使用curl傳送請求

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

 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
  }'

補充

連結已複製

運行此API時，測試環境中應用程式的所有設置都會反映在正式環境中的應用中。這相當於點擊應用程式設置畫面上的[更新應用程式]或[停止變更]。
此API是異步API。
請使用確認應用程式設定在正式環境中的反映狀態API確認反映狀態。
確認應用程式設置在正式環境中的反映狀態
此API允許一次處理多個應用程式的套用。
如果任何應用程式失敗，則所有指定應用程式的設置將恢復為執行API之前的設置。
如果運行的API在執行完畢之前變更了應用程式的設置，則會返回錯誤。
變更存取權的設定時，先完成變更處理的先套用至正式環境。
詳情請參閱以下頁面。
顯示「正在將存取權限設定的變更結果反映至各記錄」時
關於如何在測試環境中建立應用程式、更改設定，以及套用至正式環境應用程式，請參考以下頁面。
創建應用和變更設置的流程

kintone API

kintone API文件

將應用程式設置套用到正式環境

目錄

請求參數

應答屬性

所需存取權限

範例

補充