動作テスト環境にアプリを作成します。
動作テスト環境とは、アプリをデプロイする前に一時的にアプリの情報が保存される場所です。
本番環境に変更を反映する場合、このAPIを実行した後に、アプリ設定を運用環境へ反映するAPIを実行してください。
アプリ設定を運用環境へ反映するAPI

このAPIを実行しても、APIリクエスト数にはカウントされません。

通常のアプリ

https://sample.cybozu.com/k/v1/preview/app.json

ゲストスペースのアプリ

https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app.json

POST

• アプリの作成権限

パラメーター

リクエストの例

ヘッダー

1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

ボディ

1
2
3
4
5

{
  "name": "案件管理",
  "space": 10,
  "thread": 11
}

プロパティ

レスポンスの例

1
2
3
4

{
  "app": "23",
  "revision": "1"
}

curlを使ったリクエスト

1
2
3
4
5
6
7
8

curl -X POST 'https://sample.cybozu.com/k/v1/preview/app.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "案件管理",
      "space": 1001,
      "thread": 1001
  }'

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

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

1
2
3
4
5
6
7

const body = {
  name: '案件管理',
  space: 1001,
  thread: 1001
};

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

• 自動で作成される次のフィールドは、APIを実行するユーザーが設定している表示言語の名称になります。

  • レコード番号
  • 作成者
  • 更新者
  • 作成日時
  • 更新日時
  • ステータス
  • 作業者
  • カテゴリー

  言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。

  • ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
  • ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語
    ロケールの設定

• APIトークンは使用できません。

動作テスト環境におけるアプリの作成および設定の変更、運用環境アプリへの反映の手順は次のページを参考してください。
アプリの作成と設定変更の流れ