Skip to main content

Module nav

Module nav 

Source
Expand description

The nav op — navigate a project for entity discovery.

§Overview

POST /api/nav supports hierarchical entity browsing. With no navId it returns top-level sites; with a navId it returns children of that entity (equips under a site, points under an equip, etc.).

§Request Grid Columns

ColumnKindDescription
navIdRef / Str(optional) Parent entity to navigate into. Omit for root.

§Response Grid Columns

ColumnKindDescription
idRefEntity reference
disStrDisplay name
navIdStrNavigation ID for drill-down

§Errors

  • 400 Bad Request — request grid decode failure.
  • 404 Not FoundnavId references a non-existent entity.
  • 500 Internal Server Error — graph query or encoding error.

Functions§

handle
POST /api/nav