Skip to content

Server API references

Alex Miarsky edited this page Nov 10, 2026 · 1 revision

Sources by product and execution environment

Read only the relevant section. References do not authorize execution. Verify live capabilities and permissions; historical evidence applies to its baseline.

Intended work Owner and entry
Create a project/template or change persistent project configuration TS server: operations, API, structures.
Automate a running Handler or a standalone script using its session TH client: object API and structures.
Understand browser behavior or Stream Help TS configuration and UI.
Understand native desktop behavior or Handler Help TH client references.
Work on portable UI descriptions Shared Tactic Frame; each product retains native controls/transport.
Trace original TACTIC semantics Original server reference; storage under TH does not make it a client-object schema.

TH/TS links require sibling checkouts or authorized host retrieval. Report missing references. Keep credentials and private configuration out of model context.

Existing-project workflows, entity fields and attached files: EDITING.

Project page URLs: TS config/url contract. These are page addresses, not anonymous API access or agent credentials. Use existing table/layout definitions; configured REST/Python URL handlers remain unavailable.

External host: MCP, Codex setup and acceptance.

TS server API

These URLs belong to the selected Stream server: {server_url}/api/documentation, {server_url}/api/compatibility, {server_url}/docs. Discover one method at a time. The Python TACTIC SDK is a server client; it is not tactic_handler_api.

Reference What to read / when
API compatibility guide Wire formats, native operations, ordinary-account permissions, journals and limitations. Start here for an API integration.
Live reference builder api_documentation: how runtime signatures, examples and help are assembled.
Method help Method-specific EN/RU help.
Original method manifest Select methods[method_name]; captured signatures/status are subordinate to live discovery.
Server API Relevant Api method and dispatch boundary, not the captured manifest text.
HTTP routes Exact route, allowed fields/actions, authorization and response/error envelope. Editor routes are not all exposed in OpenAPI.
Python SDK The chosen client method, argument normalization and result decoding. Raw XML-RPC and SDK return shapes differ.
HTML / server JavaScript Existing HTML/JS integration, separate from modern renderer support.

TS server structures

Server Search/SObject/Command owns persistent data, permissions and transactions. Handler wrappers are client objects with different methods and lifetimes.

Reference What to read / when
Current core model guide Server objects, project resolution, pending writes and transactions.
Stream project schema capture Select a physical spt_* table. Initial schema data, not the final upgraded/live schema.
Bootstrap registry and bootstrap DDL Initial system definitions; compare upgrades and live registry before designing a new type.
Predefined schema relationships Select simple, admin, config, etc.; then compare the project's actual resolved schema.
Business upgrades and schema upgrades Changes after capture; live metadata remains authoritative.

TS configuration and UI

Reference What to read / when
Administration guide Search Types, Project schema, Workflow, groups/rules and naming subsections. Includes source maps and feature boundaries.
Table view and table contract Column/view operations, typed cells, nested tables and actual migration scope.
Widget reference, examples, checklist Handler configuration/examples; historical statuses are not execution guarantees.
Current shared widget catalogue Filter by class, value or aliases; inspect adapter. Registration alone does not prove every option works.
Actual cell support and interface resolver describe_cell / describe_composition support for the requested option.
XML configuration operations Source/layer revisions, check/preview/save and conflict handling.
Default configuration XML and blank object layout Default table/object syntax; preserve the project's actual inheritance.
Object layout contract Bounded widgets/actions/conditions and describe_item_layout validation; use for declarative object layouts only.
Sidebar editor and search filters Navigation, default results, nested/saved searches.

TS workflows, files and scripts

External model connections and credentials: PROVIDERS. TS owns encrypted profile storage and request authorization; TH owns its native settings view; the external host owns model inference and tool orchestration.

Stream/server guides; desktop files and DCC require TH capabilities.

Reference What to read / when
Tasks, task contract, schedule contract Parent/process/status, workspace, dates and scheduling.
Object reports and object contract Parents, reports, forms, links, snapshots and object operations.
Naming command FIELDS, naming_request, preview_naming: exact rule/sample fields and execution boundary.
Workflow command workflow_request: XML/process settings, current revision and managed bindings.
Script Editor guide, script contract, Shelf guide Languages, context, storage/history and execution differences.
File contract, Commit Queue, repositories Upload/check-in ownership, file groups, previews, naming and repository assumptions.

Projects, templates and executable evidence

Project/template/plugin operations run on the server, including calls from TH.

Reference What to read / when
Project creation guide Wizard choices, project modes and template selection.
Project creation command check, execute, create_search_types: code/type/database bootstrap and rollback boundaries.
Template commands Installer, exporter, remapped references, actual export scope and unsupported updater.
Plugin commands Manifest/SPT/includes, trusted code, file effects and supported import/export behavior.
CG manifest, schema example, view examples Selected template records; SPT is executable input, not passive JSON.
Original VFX manifest and Scrum manifest Template composition and include paths. Original examples may contain excluded/unsupported elements; inspect the installed configuration.
Transport tests test_*_editor_commands / test_schema_editor_command_and_creation_revision: requests, results, denial/conflict.
Creation lifecycle test, template contract, export contract Project rollback, template/schema and export assertions; run only on authorized isolated data.

TH client API and structures

Use tactic_handler_api for Handler automation, its existing controllers for UI, and native File/Snapshot methods for desktop files. get_api() uses the running application; submit blocking data work through its documented executor. local() uses configured Handler authentication and needs explicit lifetime cleanup. Neither a TH handle nor its Python SObject is a server pyasm.search.SObject. A shared search key does not make their APIs or return shapes interchangeable.

Reference What to read / when
Handler object API get_api / local, object tree, background work, handles and files. Client API, not Stream HTTP.
Handler administration contract Native editor documents, discovery, schema capabilities, workflow dependencies and concurrency.
Legacy view semantics Definitions, layers, display/edit/action options and lossless XML round trips. Original/Handler contract; check Stream support separately.
Communication contract and cache policy Notifications/activity effects and propagation of changes between clients.
TH application architecture Native controllers/models, state ownership, worker boundaries and module map.
TH API exports, runtime, objects get_api borrows the running API; local() owns a headless session. Query results, pending edits and object lifetimes are client contracts.
TH native objects, queries, file API Native object/path/preview methods and queued transfers; do not reconstruct server paths or call network work on the GUI thread.
TH built-in Help, administration Help Native <topic>.<language>.md, metadata and English fallback; separate from TS Help.
TH integration service Local/desktop routing, not the Stream server. DCC/Maya is out of scope.
TH documentation index Remaining native UI, integration and verification contracts.

Shared Tactic Frame

Portable .mjs descriptions/state rules have independent copies in TH and TS. QML and Vue render with their own native controls. Transport, file capabilities, threading and persistent writes stay with their product owners. Paired UI parity must be checked; it cannot be inferred from an identical description.

Reference What to read / when
Shared UI contract, control catalogue, source map Renderer/control boundaries, not instructions to edit QML/Vue.

Original TACTIC server reference

These files reside in TH for reference but describe original TACTIC 5.0 server schemas, not Handler's in-memory objects or current Stream DDL. Filter catalogues by the exact table. Compare live registry, upgrades and permissions before use. Removed file_access / snapshot_type tables and deprecated pyasm.prod paths are historical. Stream uses pyasm.biz.ProjectSetting for config/prod_setting.

Reference What to read / when
Database reference introduction Original 5.0 scope; custom studio types are not enumerated. Backup examples concern that environment.
Database rules Logical types, polymorphic parents, project scope and native write paths.
Core table catalogue Fields, owning classes and relations for one original table (task, snapshot, file, etc.).
Project config catalogue spt_widget_config, spt_naming, spt_process, scripts, triggers and settings. Includes historical class names.
Relationships and flows Follow the relevant object/task/check-in/workflow flow before designing another relationship.
Write policy matrix Which subsystem owns a derived/system record; do not manually fabricate its rows.
Live schema comparison and evidence limits Source DDL versus registry/behavior evidence; diagnostic SQL is not a normal write path.
Machine-readable original catalogue Filter by table; read columns, relations, preferred_write_path, confidence.
Original system DDL and config DDL Original PostgreSQL field/constraint provenance; not a migration to apply.

TS Help, delivery and evidence

Clone this wiki locally