kintone API ドキュメント

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

目次

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

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

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

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 メソッド

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

GET

必要なアクセス権

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

  • アプリ管理権限

リクエスト

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

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

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

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

ボディ
1
2
3

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

レスポンス

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

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

サンプルコード

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

curl を使ったリクエスト
1
2
3
4
5
6

curl -X GET 'https://sample.cybozu.com/k/v1/preview/app/deploy.json' \
  -H 'X-Cybozu-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "apps": [8, 9, 10]
  }'
kintone REST API リクエストを送信する 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);