Symbols¶

Browse and search the PLC symbol tree. Requires feature flag Symbols enabled.

Browse Root Symbols¶

Endpoint: Browse Root Symbols API_SYMBOLS_BROWSE

status: implemented

component: Symbols

method: GET

route: /api/plcs/{plcId}/symbols

policy: ReadAccess

implements: FEAT_SYMBOLS

Returns top-level symbols with their children (recursive tree).

curl http://localhost:5000/api/plcs/Line1/symbols

Get Symbol Info¶

Endpoint: Get Symbol Info API_SYMBOLS_INFO

status: implemented

component: Symbols

method: GET

route: /api/plcs/{plcId}/symbols/{symbolPath}

policy: ReadAccess

implements: FEAT_SYMBOLS

Returns the symbol’s type, size, comment and children.

curl http://localhost:5000/api/plcs/Line1/symbols/MAIN.stMotor

{
  "data": {
    "instancePath": "MAIN.stMotor",
    "typeName": "ST_Motor",
    "size": 16,
    "comment": "Main drive motor",
    "children": [
      { "instancePath": "MAIN.stMotor.bEnabled", "typeName": "BOOL", "size": 1, "comment": "", "children": null },
      { "instancePath": "MAIN.stMotor.nSpeed", "typeName": "INT", "size": 2, "comment": "", "children": null }
    ]
  },
  "error": null
}

Search Symbols¶

Endpoint: Search Symbols API_SYMBOLS_SEARCH

status: implemented

component: Symbols

method: GET

route: /api/plcs/{plcId}/symbols?search={pattern}&flat={bool}

policy: ReadAccess

implements: FEAT_SYMBOLS

Filters the symbol tree by a case-insensitive substring.

Parameter	Description
`search`	Substring filter (case-insensitive)
`flat`	`true` returns flat list without children, `false` (default) includes children