REST API Add-On

---

WebCTRL is a trademark of Automated Logic Corporation. Any other trademarks mentioned herein are the property of their respective owners.

---

Overview

The REST API Add-On provides secure access to WebCTRL server data and functionality via HTTP endpoints. It is designed for integration with custom clients, automation scripts, and web applications.

---

📖 Full interactive documentation is available from the add-on's main page once installed on your WebCTRL server. This README is meant only to give a brief overview of the capabilities.

---

🚀 Installation

1. If signed add-ons are required, copy the authenticating certificate ACES.cer to the ./programdata/addons directory of your WebCTRL installation folder.
2. Install RestAPI.addon using the WebCTRL interface.

---

📡 Endpoints

The add-on exposes the following endpoints:

• GetSchema — Retrieves the JSON schema used to validate input for an API endpoint.
• ResolveGQL — Resolves a GQL path or DBID and retrieves details about the node.
• SearchGQL — Traverses the node tree starting from one or more root nodes, applying filters at each step to find matching nodes.
• ExecGQL — Retrieves and/or sets attribute values for specified nodes.
• ExecCommand — Executes manual commands on the server.
• CreateOperator — Creates or updates an operator.
• DeleteOperator — Deletes an operator from the system.
• GetTrendData — Retrieves trend data for one or many sources over a specified time range.

---

🛠️ SDKs

• JavaScript SDK: For use in HTML content controls within graphics and other web pages. Provides convenient methods for sending API requests and handling authentication automatically.
• PowerShell SDK: For scripted automation and CLI use cases. Compatible with PowerShell 5.1 and later.

---

🧪 Samples

These sample snippets should be included in an HTML content control within a graphic.

• graphics-error-scraper — Scan graphics for error messages.
• cp-export-import-utility — Export and import control program properties.
  • import.logic-script - Import properties back into EIKON
• global-modify — Provides functionality similar to the native global modify.

---

📦 Third-Party Libraries

This add-on uses the following third-party libraries:

• fastjson2 v2.0.58 — High-performance JSON parser and serializer for Java.
• fontawesome v6.7.2 — Icon toolkit for scalable vector icons.
• highlight.js v11.11.1 — Syntax highlighting for code blocks in documentation.