Table Operation: Bulk Delete Record

# Library for communicating with websites and APIs
import requests

# Library for JSON operations
import json

# Server name and API key
BASE_URL = (
    "【URL】"
)
API_KEY = "【API key】"

# Site ID to start the search from
START_SITE_ID = 【Site ID】

# Target site name and status to delete
TARGET_SITE_NAME = "Project Management"
TARGET_STATUS = '["910"]'  # On hold (910)

# Set to True to delete physically (including history and the recycle bin)
PHYSICAL_DELETE = False

# Share the session
session = requests.Session()
session.headers.update({"Content-Type": "application/json"})

# Common function for JSON POST requests
def post_json(url: str, payload: dict) -> dict:
    r = session.post(url, data=json.dumps(payload))
    if not r.ok:
        raise RuntimeError(f"HTTP {r.status_code} {url}\n{r.text}")
    return r.json()

# 1) Get the SiteId from the site name
getclosest_url = f"{BASE_URL}/api/items/{START_SITE_ID}/getclosestsiteid"
closest_payload = {
    "ApiVersion": 1.1,
    "ApiKey": API_KEY,
    "FindSiteNames": [TARGET_SITE_NAME],
}

closest_res = post_json(getclosest_url, closest_payload)
data_list = closest_res.get("Data", [])
if not data_list:
    print(f"{TARGET_SITE_NAME} Failed to get the site information")
    raise SystemExit()

site_id = data_list[0].get("SiteId")
if not isinstance(site_id, int) or site_id <= 0:
    print(f"{TARGET_SITE_NAME} Invalid site ID: {site_id}")
    raise SystemExit()

print(f"Got the target site ID: {site_id}")

# 2) Get the records with Status=910 (to check the records to delete)
get_url = f"{BASE_URL}/api/items/{site_id}/get"
get_payload = {
    "ApiVersion": 1.1,
    "ApiKey": API_KEY,
    "View": {
        "ColumnFilterHash": {
            "Status": TARGET_STATUS,
        }
    },
}

get_res = post_json(get_url, get_payload)

rows = []
if isinstance(get_res, dict):
    rows = (get_res.get("Response", {}) or {}).get("Data", []) or []
elif isinstance(get_res, list):
    rows = get_res

if not rows:
    print("No data to delete")
    raise SystemExit()

# 3) Bulk delete the retrieved record IDs together (with Selected)
record_ids = []
for row in rows:
    rid = row.get("ResultId") or row.get("Id")
    if isinstance(rid, int) and rid > 0:
        record_ids.append(rid)

# Remove duplicates just in case
record_ids = sorted(set(record_ids))

if not record_ids:
    print("Could not get the IDs to delete")
    raise SystemExit()

bulkdelete_url = f"{BASE_URL}/api/items/{site_id}/bulkdelete"
bulkdelete_payload = {
    "ApiVersion": 1.1,
    "ApiKey": API_KEY,
    "Selected": record_ids,  # <- Specify an array of IDs to bulk delete
    "PhysicalDelete": PHYSICAL_DELETE,
}

try:
    bulk_res = post_json(bulkdelete_url, bulkdelete_payload)
    # Example of the bulkdelete response: { Id: <siteId>, StatusCode: 200, Message: "..." }
    print("bulkdelete result:", bulk_res)
except Exception as e:
    print("bulkdelete failed")
    print(e)

# Library for communicating with websites and APIs
import requests

# Library for JSON operations
import json

# Server name and API key
BASE_URL = "【URL】"
API_KEY = "【API key】"

# Site ID to start the search from
START_SITE_ID = 6429

# Target site name and status to delete
TARGET_SITE_NAME = "Project Management"
TARGET_STATUS = '["910"]'  # On hold (910)

# Set to True to delete physically (cannot be restored)
PHYSICAL_DELETE = False

# Share the session
session = requests.Session()
session.headers.update({"Content-Type": "application/json"})

def post_json(url: str, payload: dict) -> dict:
    r = session.post(url, data=json.dumps(payload))
    if not r.ok:
        raise RuntimeError(f"HTTP {r.status_code} {url}\n{r.text}")
    return r.json()

# 1) Get the SiteId from the site name
getclosest_url = f"{BASE_URL}/api/items/{START_SITE_ID}/getclosestsiteid"
closest_payload = {
    "ApiVersion": 1.1,
    "ApiKey": API_KEY,
    "FindSiteNames": [TARGET_SITE_NAME],
}

closest_res = post_json(getclosest_url, closest_payload)
data_list = closest_res.get("Data", [])
if not data_list:
    print(f"{TARGET_SITE_NAME} Failed to get the site information")
    raise SystemExit()

site_id = data_list[0].get("SiteId")
if not isinstance(site_id, int) or site_id <= 0:
    print(f"{TARGET_SITE_NAME} Invalid site ID: {site_id}")
    raise SystemExit()

print(f"Got the target site ID: {site_id}")

# 2) Specify View conditions and run bulkdelete
bulkdelete_url = f"{BASE_URL}/api/items/{site_id}/bulkdelete"
bulkdelete_payload = {
    "ApiVersion": 1.1,
    "ApiKey": API_KEY,
    "View": {"ColumnFilterHash": {"Status": TARGET_STATUS}},
    "PhysicalDelete": PHYSICAL_DELETE,
}

try:
    res = post_json(bulkdelete_url, bulkdelete_payload)
    print("bulkdelete result:", res)
except Exception as e:
    print("bulkdelete failed")
    print(e)