EnergyAtlas Web API Reference¶

• Generated on: 2026-07-13
• Source commit: 565002b6bd4393f149b2cdf348d4401d848e3151
• Source branch: shading-api
• Dirty state: Dirty source state present excluding generated skill/doc paths.
• Note: generated deterministically from current source; older hand-written docs are context only.

Overview¶

This reference is generated from the current ASP.NET controller source and startup configuration. Use it as the source-derived endpoint inventory for agents; hand-written API docs may lag behind source changes.

Related Guides¶

These companion guides explain the voxel-shading math and API workflows referenced by this source-derived API reference.

Running the Backend¶

1
2

dotnet restore EnergyAtlasWeb/EnergyAtlasWeb.csproj
dotnet run --project EnergyAtlasWeb/EnergyAtlasWeb.csproj

The Python connector's invoked backend path uses dotnet run --project EnergyAtlasWeb/EnergyAtlasWeb.csproj --no-launch-profile and may set ASPNETCORE_URLS.

Ports, Swagger, and Hubs¶

Launch profiles:

API Conventions¶

Controller Endpoint Inventory¶

Workflow and Connector Relationship¶

• The Python connector covers project lifecycle, workflow state, fusion, schema matching, geometry preprocessing, archetypes, template assignment, weather, simulation, measures, scenarios, results, data hub, zones, zone schedules, zone simulation, and voxel shading namespaces.
• Compare connector namespace methods with this endpoint inventory before assuming a backend route has a Python wrapper.
• POST /api/schemaMatching/autoMatch is present in the web source inventory; connector coverage should be checked explicitly when needed.

Jobs and Long-Running Operations¶

• Simulation jobs expose polling through /api/simulation/job/{jobId}.
• Zone simulation jobs expose polling through /api/zoneSimulation/job/{jobId}.
• Voxel shading jobs expose polling through /api/voxelShading/job/{jobId} and result retrieval through /api/voxelShading/result/{jobId}.
• SignalR hubs are listed above for progress-aware clients.

Tests and Validation¶

1
2
3

dotnet build EnergyAtlasWeb/EnergyAtlasWeb.csproj
dotnet test EnergyAtlasWeb.ApiTests/EnergyAtlasWeb.ApiTests.csproj --filter "TestCategory=Compulsory&TestCategory!=Expensive"
dotnet test EnergyAtlasWeb.MethodTests/EnergyAtlasWeb.MethodTests.csproj --filter "TestCategory=Compulsory&TestCategory!=Expensive"

Known Limitations and Cautions¶

• Controller source is authoritative for endpoint counts.
• Swagger is enabled, but response metadata may be sparse.
• No authentication or CORS behavior should be claimed unless source patterns are found.
• Existing hand-written docs may lag behind current controllers.
• Swagger output is useful for runtime cross-checks, but this generated document does not require starting the backend.
• Secret-like config values are masked and must not be copied into docs.