フィールドを削除する

kintone API

フィールドを削除する

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

フォームからフィールドを削除します。

HTTPメソッド	DELETE
URL	https://sample.cybozu.com/k/v1/preview/app/form/fields.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/form/fields.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json

リクエストパラメーター

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

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID
fields	配列	必須	削除するフィールドのフィールドコードの一覧最大で100個のフィールドを指定できます。
revision	数値または文字列	省略可	期待しているリビジョン番号実際のリビジョン番号と一致しない場合はエラーとなり、フィールドは削除されません。値に「-1」を指定する、または指定しなかった場合はリビジョン番号は検証されません。

レスポンスプロパティ

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

プロパティ名	型	説明
revision	文字列	アプリの設定を変更したあとのリビジョン番号

必要なアクセス権

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

アプリ管理権限

サンプル

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

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/preview/app/form/fields.json?app=1&fields\[0\]=%E6%96%87%E5%AD%97%E5%88%971%E8%A1%8C\_0&fields\[1\]=%E6%95%B0%E5%80%A4&revision=2

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

リクエストURL（リクエストボディにパラメーターを含める場合）

1

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

リクエストヘッダー（リクエストボディにパラメーターを含める場合）

1
2
3
4


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

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

リクエストボディ

1
2
3
4
5


{
  "app": 1,
  "revision": 2,
  "fields": ["文字列1行_0", "数値"]
}

サンプルレスポンス

1
2
3


{
  "revision": "3"
}

サンプルコード

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

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


const body = {
  app: kintone.app.getId(),
  revision: 2,
  fields: [
    '文字列1行_0',
    '数値'
  ]
};

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

curlを使ったリクエスト

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X DELETE 'https://sample.cybozu.com/k/v1/preview/app/form/fields.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "revision": 2,
    "fields": [
      "文字列1行_0",
      "数値"
    ]
  }'

補足

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

グループやテーブルを削除すると、グループ内やテーブル内のフィールドもすべて削除されます。
値が自動入力される次のフィールドは、フォーム上から削除されるだけで、データは削除されません。
- レコード番号
- 作成者
- 更新者
- 作成日時
- 更新日時
このAPIは、動作テスト環境のアプリを変更します。
本番環境に変更を反映する場合、このAPIを実行した後に、アプリ設定を運用環境へ反映するAPIを実行してください。
アプリ設定を運用環境へ反映するAPI

制限事項

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

次のフィールドは削除できません。
- ステータス
- 作業者
- カテゴリー

kintone API

kintone APIドキュメント

フィールドを削除する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル

補足

制限事項