kintone API

刪除欄位

從表單中刪除欄位。

目錄

HTTP 方法DELETE
URLhttps://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-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
fields 陣列 必須 要刪除的欄位的欄位代碼清單
您最多可以指定 100 個欄位。
revision 數值或字串 可省略 預期修訂號
如果它與實際修訂號不匹配,則會發生錯誤,並且不會刪除該字段。
如果指定值「-1」或未指定值,則不會驗證修訂號。

應答屬性

屬性名稱 類型 說明
revision 字串 變更應用程式設置后的修訂號

所需存取權限

  • 應用程式管理權限

範例

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
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規格

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
2
3
{
  "revision": "3"
}

有關kintone.api()的說明,請參閱以下頁面。
傳送kintone REST API請求

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
const body = {
  app: kintone.app.getId(),
  revision: 2,
  fields: [
    '單行文字方塊',
    '數值'
  ]
};

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

根據您的環境,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": [
      "單行文字方塊",
      "數值"
    ]
  }'

補充

  • 刪除群組或表格時,也會刪除該群組或表格中的所有欄位。

  • 其值自動填充的如下字段僅從表單中刪除,而不會刪除數據。

    • 記錄號碼
    • 建立人
    • 更新人
    • 建立時間
    • 更新時間
  • 此 API 可變更測試環境中的應用。
    如果要將變更套用到正式環境,請在執行該API之後,執行將應用程式設置反映到正式環境的API。
    將應用程式設置套用到正式環境API

限制事項

  • 以下欄位無法刪除:
    • 狀態
    • 執行者
    • 類別