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

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

アプリの設定の運用環境への反映状況を確認します。

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/preview/app/deploy.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/deploy.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

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

パラメーター名	型	必須	説明
apps	配列（数値または文字列）	必須	アプリIDの一覧最大で300のアプリIDを指定できます。ゲストスペースのアプリを指定する場合、同じゲストスペースのアプリのみ指定できます。

レスポンスプロパティ

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

プロパティ名	型	説明
apps	配列	処理の状況を表すオブジェクトの配列
apps[].app	文字列	アプリID
apps[].status	文字列	処理の進捗 `PROCESSING`：処理中 `SUCCESS`：処理の完了 `FAIL`：処理の失敗 `CANCEL`：他のアプリで処理が失敗したことによる、処理のキャンセル

必要なアクセス権

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

アプリ管理権限

サンプル

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

サンプルリクエスト

リクエストヘッダー

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は共通仕様を参照してください。
kintone REST APIの共通仕様

リクエストボディ

1
2
3


{
  "apps": [8, 9, 10]
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "apps": [
    {
      "app": "8",
      "status": "PROCESSING"
    },
    {
      "app": "9",
      "status": "PROCESSING"
    },
    {
      "app": "10",
      "status": "PROCESSING"
    }
  ]
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  apps: [8, 9, 10]
};

await kintone.api(kintone.api.url('/k/v1/preview/app/deploy.json'), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/preview/app/deploy.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "apps": [8, 9, 10]
  }'

補足

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

アプリの設定を運用環境へ反映するAPIでの処理の進捗を確認できます。
アプリの設定を運用環境へ反映するAPI

kintone API

kintone APIドキュメント

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

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足