Table Operation: Retrieve Attachments

# Base64 encoding/decoding library
import base64

# Library for regular expressions
import re

# Library for file path operations
from pathlib import Path

# Library for HTTP requests
import requests

# Settings
BASE_URI = "【URL】"
API_KEY = "【API key】"
SITE_ID = 【Site ID】
API_VERSION = 1.1

# Attachment column to get
ATTACHMENT_ITEM = "AttachmentsA"
# Destination directory
OUT_DIR = Path(r"C:\work\download")

# Replace characters that cannot be used in file names and convert to a safe name
safe = lambda s: re.sub(r'[\\/:*?"<>|\x00-\x1F]', "_", str(s or "")).strip()

# Search condition (narrow down to records whose Status is 100)
VIEW = {
    "ColumnFilterHash": {
        "Status": '["100"]',
    }
}

post = lambda s, url, payload: (lambda r: (r.raise_for_status(), r.json())[1])(
    s.post(
        url, json=payload, headers={"Content-Type": "application/json; charset=utf-8"}
    )
)

# Main process
OUT_DIR.mkdir(parents=True, exist_ok=True)

# Variables for totaling the results
record_count = 0  # Number of records retrieved
records_with_attachments = 0  # Number of records with attachments
seen_files = 0  # Total number of attachments
downloaded_files = 0  # Number of files actually downloaded

with requests.Session() as s:
    # Get the records
    items = (
        post(
            s,
            f"{BASE_URI}/api/items/{SITE_ID}/get",
            {"ApiVersion": API_VERSION, "ApiKey": API_KEY, "View": VIEW},
        )
        .get("Response", {})
        .get("Data", [])
    )

    record_count = len(items)

    for rec in items:
        rec_id = rec.get("ResultId") or rec.get("IssueId")
        atts = (rec.get("AttachmentsHash") or {}).get(ATTACHMENT_ITEM) or []
        if not rec_id or not atts:
            continue  # No attachments -> do not create a folder

        records_with_attachments += 1
        rec_dir = OUT_DIR / str(rec_id)
        rec_dir.mkdir(parents=True, exist_ok=True)

        # Loop to get the attachments
        for a in atts:
            guid, name = a.get("Guid"), a.get("Name")
            if not guid or not name:
                continue

            seen_files += 1
            b64 = (
                post(
                    s,
                    f"{BASE_URI}/api/binaries/{guid}/get",
                    {"ApiVersion": API_VERSION, "ApiKey": API_KEY},
                )
                .get("Response", {})
                .get("Base64")
            )

            if not b64:
                continue
            # Save the file
            (rec_dir / safe(name)).write_bytes(base64.b64decode(b64))
            downloaded_files += 1

# Output the processing results
print("=== Download Result ===")
print(f"SiteId                : {SITE_ID}")
print(f"Attachment Item       : {ATTACHMENT_ITEM}")
print(f"Records (matched)     : {record_count}")
print(f"Records with files    : {records_with_attachments}")
print(f"Attachments found     : {seen_files}")
print(f"Attachments downloaded: {downloaded_files}")
print(f"Output directory      : {OUT_DIR}")

>python api_binaries_p1.py

=== Download Result ===
SiteId                : 6412
Attachment Item       : AttachmentsA
Records (matched)     : 1
Records with files    : 0
Attachments found     : 0
Attachments downloaded: 0
Output directory      : C:\work\download