フィールドを削除する

目次

フィールドを削除する

フォームからフィールドを削除します。
グループやテーブルを削除すると、グループ内やテーブル内のフィールドもすべて削除されます。

値が自動入力される次のフィールドは、フォーム上から削除されるだけで、データは削除されません。

  • レコード番号
  • 作成者
  • 更新者
  • 作成日時
  • 更新日時

この API は、動作テスト環境のアプリを変更します。
本番環境に変更を反映する場合、この API を実行した後に アプリ設定を運用環境へ反映する API を実行してください。

URL

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

HTTP メソッド

DELETE

必要なアクセス権

  • アプリ管理権限

リクエスト

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

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

ヘッダー
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

リクエストの例(リクエストボディにパラメーターを含める場合)
URL

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", "数値"]
}

レスポンス

プロパティ
プロパティ名 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号
レスポンスの例
1
2
3
{
  "revision": "3"
}

サンプルコード

curl を使ったリクエスト
 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",
      "数値"
    ]
  }'
kintone REST API リクエストを送信する 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);

制限事項

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