アプリの設定の運用環境への反映状況確認 – cybozu developer network

アプリへ設定を反映する処理には、時間がかかります。このAPIを使用すると、処理の進捗を確認できます。

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/app/deploy.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/deploy.json

HTTPメソッド

GET

必要な権限

アプリに管理権限が必要です。
このAPIの実行には、APIトークンは使用できません。

リクエスト

パラメータ

パラメータ名	指定する値	必須	説明
apps	配列	必須	アプリを配列形式で指定します。300件まで指定できます。ゲストスペースのアプリを指定する場合、同じゲストスペースのアプリのみ指定できます。

リクエストの例

ヘッダ

GET /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

ボディ

レスポンス

パラメーター

パラメータ名	値の種類	説明
apps	配列	処理の状況を表すオブジェクトの配列です。
apps[].app	文字列	アプリのIDです。
apps[].status	文字列	処理の状況です。 PROCESSING：処理中であることを表します。 SUCCESS：処理が完了したことを表します。 FAIL：処理に失敗したことを表します。 CANCEL：ほかのアプリで処理に失敗したため、処理がキャンセルされたことを表します。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

URI