Update Site Settings (Partial Add/Update/Delete)

# Library for using OS-related functions
import os

# Library for handling JSON
import json

# Library for path operations
from pathlib import Path

# Library for type hints
from typing import List, Optional

# Library for sending HTTP requests
import requests

# =========
# Settings
# =========
BASE_URL = "【URL】"
API_KEY = "【API key】"

# IDs of the sites to update (multiple)
SITE_IDS: List[int] = [【Site ID】, 【Site ID】]

# Specify the server script information
SERVER_SCRIPT_NAME = "【Server script name】"  # e.g., any server script name
SERVER_SCRIPT_ID = 【Server script ID】
# Specify the server script conditions as an array
# See below for the conditions
SERVER_SCRIPT_CONDITIONS = [
    {
        "Type": "【Server script condition】",
        "Enabled": True,
    },
    {
        "Type": "【Server script condition】",
        "Enabled": True,
    },
]

# Local JS file (the content to put in Body)
JS_FILE_PATH = r"【Path name】\【JavaScript file name】"

# Timeout, etc.
TIMEOUT_SEC = 30

def read_js_file(path: str) -> str:
    p = Path(path)
    if not p.exists():
        raise FileNotFoundError(f"JS file not found: {p}")
    # Read as text so that Pleasanter handles it as is, including line breaks
    return p.read_text(encoding="utf-8")

def build_payload(
    body_js: str, script_name: str, script_id: Optional[int] = None
) -> dict:
    # ServerScripts element (minimum)
    script_obj = {
        "Name": script_name,
        "Title": script_name,
        "Body": body_js,
    }
    if script_id is not None:
        script_obj["Id"] = script_id

    for SERVER_SCRIPT_CONDITION in SERVER_SCRIPT_CONDITIONS:
        script_obj[SERVER_SCRIPT_CONDITION["Type"]] = SERVER_SCRIPT_CONDITION["Enabled"]

    # Pattern A: an array directly
    payload = {
        "ApiVersion": 1,
        "ApiKey": API_KEY,
        "ServerScripts": [script_obj],
    }
    return payload

def update_site_settings(site_id: int, payload: dict) -> requests.Response:
    url = f"{BASE_URL.rstrip('/')}/api/items/{site_id}/updatesitesettings"
    headers = {
        "Content-Type": "application/json",
    }
    return requests.post(
        url, headers=headers, data=json.dumps(payload), timeout=TIMEOUT_SEC
    )

def main():
    body_js = read_js_file(JS_FILE_PATH)
    print(f"body_js={body_js}")

    # e.g., update the same ServerScript name on all sites
    for site_id in SITE_IDS:
        payload = build_payload(
            body_js=body_js, script_name=SERVER_SCRIPT_NAME, script_id=SERVER_SCRIPT_ID
        )

        try:
            resp = update_site_settings(site_id, payload)
        except requests.RequestException as e:
            print(f"[ERROR] site_id={site_id} request failed: {e}")
            continue

        if resp.ok:
            print(f"[OK] site_id={site_id} updated. status={resp.status_code}")
        else:
            # On failure, output the response body so that the cause can be traced
            print(f"[NG] site_id={site_id} status={resp.status_code}")
            print(resp.text)

if __name__ == "__main__":
    main()

SERVER_SCRIPT_CONDITIONS = [
    {
        "Type": "ServerScriptBeforeOpeningPage",
        "Enabled": True,
    },
    {
        "Type": "ServerScriptBeforeOpeningRow",
        "Enabled": True,
    },
]

>python api_site_update_sitesettings.py

body_js=【The content of the body to be inserted is displayed here】

[OK] site_id=9001 updated. status=200
[OK] site_id=9002 updated. status=200