テスト環境のアプリの設定を、運用環境に反映します。
この操作は、アプリの設定画面で[アプリを更新]をクリックする操作に相当します。
アプリの設定を変更する場合、この操作を行うまでは、変更後の設定は運用環境のアプリに反映されません。
テスト環境のアプリで行った設定の変更をキャンセルし、運用環境のアプリと同じ設定に戻すこともできます。この操作は、アプリの設定画面で[変更を中止]をクリックする操作に相当します。
このAPIは、複数のアプリを一括して処理できます。
なお、一括処理するアプリのうち、処理が失敗したアプリが1つでもあれば、処理対象のすべてのアプリが、APIを実行する前の時点の設定に戻ります。
URI
https://(サブドメイン名).cybozu.com/k/v1/preview/app/deploy.json
ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/deploy.json
HTTPメソッド
POST
必要な権限
- アプリに管理権限が必要です。
- このAPIの実行には、APIトークンは使用できません。
リクエスト
パラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| apps | 配列 | 必須 | アプリを配列形式で指定します。300件まで指定できます。 ゲストスペースのアプリを指定する場合、同じゲストスペースのアプリのみ指定できます。 |
| apps[].app | 数値又は文字列 | 必須 | アプリのIDを指定します。 |
| apps[].revision | 数値又は文字列 | 運用環境に反映する設定のリビジョンを指定します。指定したリビジョンが最新ではない場合、リクエストは失敗します。 リビジョンの指定を省略、または「-1」を指定すると、リビジョンのチェックは行われません。 |
|
| revert | 真偽値又は文字列 | アプリの設定の変更をキャンセルする場合、「true」を指定します。テスト環境のアプリが、運用環境のアプリと同じ設定に戻ります。 |
リクエストの例
ヘッダ
POST /k/v1/preview/app/deploy.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
ボディ
レスポンス
レスポンスはありません。
制限事項
アプリの設定の反映(キャンセル)中、アプリの設定を変更するAPIが実行されるとエラーが返されます。
JavaScriptサンプル
XMLHttpRequest
プラグインの設定保存時（kintone.plugin.app.setConfig(config);）、
kintone.api(kintone.api.url('/k/v1/preview/app/deploy', true), 'POST', body, function(resp)
を実行するとエラーがでます。
エラーはアプリ設定画面に戻ったときに表示されます。
エラ→ GAIA_APD01: 処理中にアプリの設定が変更されたため、処理がキャンセルされました。
以前はエラーにならずに運用環境に反映することができていました。
プラグインでこのAPIは使用できなくなりましたでしょうか？
jiji様
4月リリースにおいてこのAPIに関する仕様変更は、当サイトで把握している限りありませんでした。
kintoneのAPIの仕様に関する正式な問い合わせは以下のページを参考に行うことができますので、
お手数をおかけしますが、念のためそちらもご確認ください。
https://faq.cybozu.info/alphascope/cybozu/web/kintone/Detail.aspx?id=1763&isCrawler=1