將應用設置傳播到正式環境

information

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

目錄

將應用設置傳播到正式環境

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

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": 8,
      "revision": 13
    },
    {
      "app": 9,
      "revision": 5
    },
    {
      "app": 10,
      "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);