kintone API ドキュメント

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

目次

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

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

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

URL

通常のアプリ
https://sample.cybozu.com/k/v1/preview/app.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/preview/app.json

HTTP メソッド

POST

必要なアクセス権

  • アプリの作成権限

リクエスト

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

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}
ボディ
1
2
3
4
5

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

レスポンス

プロパティ
プロパティ名 型 説明
app 文字列 作成されたアプリの ID
revision 文字列 作成されたアプリのリビジョン番号
レスポンスの例
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 REST API リクエストを送信する 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 共通管理の ロケールの設定 (External link) で設定した言語

制限事項

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