kintone APIドキュメント

アプリの設定を運用環境へ反映する

目次

アプリの設定を運用環境へ反映する

固定リンクがコピーされました

動作テスト環境のアプリの設定を、運用環境に反映します。
このAPIを実行すると、動作テスト環境のアプリのすべての設定が運用環境のアプリに反映されます。 アプリの設定画面で【アプリを更新】や【変更を中止】をクリックする操作に相当します。

  • このAPIは非同期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件のアプリ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.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);