How to Export Asset Metadata from Orange Logic

Orange Logic UI Metadata Download

Search API

import requests
import csv
import json

# Replace with your Orange Logic instance URL and credentials
BASE_URL = "https://your-instance.orangelogic.com"
AUTH_TOKEN = "your_bearer_token"

HEADERS = {
    "Authorization": f"Bearer {AUTH_TOKEN}",
    "Accept": "application/json",
}

def search_assets(query="*", limit=50, offset=0):
    """Search assets via the Orange Logic Search API."""
    resp = requests.post(
        f"{BASE_URL}/webapi/Search",
        headers=HEADERS,
        json={
            "query": query,
            "fields": "*",         # All populated fields
            "format": "JSON",
            "limit": limit,
            "offset": offset,
        },
    )
    resp.raise_for_status()
    return resp.json()

# Paginate through all results
all_assets = []
offset = 0
limit = 50
while True:
    data = search_assets(query="*", limit=limit, offset=offset)
    items = data.get("APIResponse", {}).get("Items", [])
    if not items:
        break
    all_assets.extend(items)
    total = data.get("APIResponse", {}).get("TotalCount", 0)
    offset += limit
    if offset >= total:
        break

# Write to CSV
with open("orangelogic_metadata.csv", "w", newline="") as f:
    writer = csv.writer(f)
    writer.writerow([
        "Record ID", "System Identifier", "Title",
        "Media Type", "Keywords", "Caption",
        "Media Date", "Create Date", "Edit Date",
        "Width", "Height", "MIME Type",
    ])
    for asset in all_assets:
        writer.writerow([
            asset.get("RecordID", ""),
            asset.get("SystemIdentifier", ""),
            asset.get("Title", ""),
            asset.get("MediaType", ""),
            asset.get("Keywords", ""),
            asset.get("CaptionShort", ""),
            asset.get("MediaDate", ""),
            asset.get("CreateDate", ""),
            asset.get("EditDate", ""),
            asset.get("MaxWidth", ""),
            asset.get("MaxHeight", ""),
            asset.get("MIMEtype", ""),
        ])

print(f"Exported {len(all_assets)} assets to orangelogic_metadata.csv")

DataTable API

import requests
import csv

BASE_URL = "https://your-instance.orangelogic.com"
AUTH_TOKEN = "your_bearer_token"
HEADERS = {
    "Authorization": f"Bearer {AUTH_TOKEN}",
    "Accept": "application/json",
}

# Step 1: List all available metadata fields
def list_fields(doc_type="Documents.All"):
    """Discover all metadata fields for a document type."""
    resp = requests.get(
        f"{BASE_URL}/API/DataTable/V2.2/{doc_type}:ListFields",
        headers=HEADERS,
    )
    resp.raise_for_status()
    return resp.json()

fields = list_fields()
print(f"Found {len(fields)} metadata fields")

# Step 2: Read metadata for a specific asset
def read_asset(doc_type, record_id):
    """Get full metadata for a single asset."""
    resp = requests.get(
        f"{BASE_URL}/API/DataTable/V2.2/{doc_type}:Read",
        headers=HEADERS,
        params={"RecordID": record_id},
    )
    resp.raise_for_status()
    return resp.json()

# Step 3: Export field definitions to CSV (useful for metadata audits)
with open("orangelogic_field_definitions.csv", "w", newline="") as f:
    writer = csv.writer(f)
    writer.writerow([
        "Field Name", "Namespace", "Data Type",
        "Max Length", "Multi-Valued", "Required",
        "Read Only", "Searchable", "Security Enabled",
    ])
    for field in fields:
        writer.writerow([
            field.get("NameSpaceFieldName", ""),
            field.get("NameSpace", ""),
            field.get("DataType", ""),
            field.get("DataLength", ""),
            field.get("IsMultiValued", ""),
            field.get("IsRequired", ""),
            field.get("ReadOnly", ""),
            field.get("SearchableIndividually", ""),
            field.get("SecurityEnabled", ""),
        ])

print("Exported field definitions to orangelogic_field_definitions.csv")