動作テスト環境にアプリを作成する

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

動作テスト環境にアプリを作成します。

HTTPメソッド	POST
URL（動作テスト環境の通常のアプリ）	https://sample.cybozu.com/k/v1/preview/app.json
URL（動作テスト環境のゲストスペスのアプリ）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

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

パラメーター名	型	必須	説明
name	文字列	必須	アプリの名前 64文字以内で指定します。
space	数値	省略可	スペースID スペースのスレッドにアプリを作成する場合に指定します。
thread	数値	省略可	スレッドID スペースのスレッドにアプリを作成する場合に指定します。

レスポンスプロパティ

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

プロパティ名	型	説明
app	文字列	作成されたアプリのID
revision	文字列	作成されたアプリのリビジョン番号

必要なアクセス権

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

アプリの作成権限

サンプル

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

サンプルリクエスト

リクエストヘッダー

1
2
3
4


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

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

リクエストボディ

1
2
3
4
5


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

サンプルレスポンス

1
2
3
4


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

サンプルコード

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);

curlを使ったリクエスト

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

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
  }'

補足

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

動作テスト環境とは、アプリをデプロイする前に一時的にアプリの情報が保存される場所です。
本番環境に変更を反映する場合、このAPIを実行した後に、アプリ設定を運用環境へ反映するAPIを実行してください。
アプリ設定を運用環境へ反映するAPI
このAPIを実行しても、APIリクエスト数にはカウントされません。
自動で作成される次のフィールドは、APIを実行するユーザーが設定している表示言語の名称になります。
- レコード番号
- 作成者
- 更新者
- 作成日時
- 更新日時
- ステータス
- 作業者
- カテゴリー
言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。
- ヘッダーあり：「Accept-Language」ヘッダーで指定した言語
- ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語
  ロケールの設定
APIトークンは使用できません。
動作テスト環境におけるアプリの作成および設定の変更、運用環境アプリへの反映の手順は次のページを参考してください。
アプリの作成と設定変更の流れ

kintone API

kintone APIドキュメント

動作テスト環境にアプリを作成する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足