アプリの設定を運用環境へ反映する
動作テスト環境のアプリの設定を、運用環境に反映します。
この API を実行すると、動作テスト環境のアプリのすべての設定が運用環境のアプリに反映されます。
アプリの設定画面で【アプリを更新】や【変更を中止】をクリックする操作に相当します。
- この API は非同期 API です。
反映状況は、 アプリの設定の運用環境への反映状況を確認する API を使って確認してください。 - この API では、複数のアプリの反映を一括して処理できます。
ひとつでも処理に失敗したアプリがあれば、指定したすべてのアプリの設定が、API を実行する前の設定に戻ります。 - この API の実行が完了する前に、アプリの設定を変更する API を実行すると、エラーが返ります。
- アクセス権の設定変更の結果は、処理が完了したものから、順次アプリに反映されます。詳細は
「各レコードにアクセス権設定の変更結果を反映中です」と表示される場合
を確認してください。
URL
- 通常のアプリ
- https://sample.cybozu.com/k/v1/preview/app/deploy.json
- ゲストスペースのアプリ
- https://sample.cybozu.com/k/guest/
ゲストスペース ID
/v1/preview/app/deploy.json
HTTPメソッド
POST
必要なアクセス権
- アプリ管理権限
リクエスト
パラメーター
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
apps | 配列 | 必須 | アプリ ID の一覧 最大で 300 件のアプリ ID を指定できます。 ゲストスペースのアプリを指定する場合、同じゲストスペースのアプリのみ指定できます。 |
apps[].app | 数値または文字列 | 必須 | アプリ ID |
revision | 数値または文字列 | 省略可 | 期待しているリビジョン番号 実際のリビジョン番号と一致しない場合はエラーとなり、設定は変更されません。 値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。 |
revert | 真偽値または文字列 | 省略可 | アプリの設定の変更をキャンセルするかどうか
|
リクエストの例
ヘッダー
|
|
リクエストヘッダーの詳細は kintone REST API の共通仕様 を参照してください。
ボディ
|
|
レスポンス
レスポンスはありません。
サンプルコード
curl を使ったリクエスト
|
|
kintone REST API リクエストを送信する API を使ったリクエスト
|
|