:::warning AUTO-GENERATED — do not edit
This page is generated from the MCP server snapshot content/api-mcp.json.
Edit the source MCP server (not this file), then run npm run generate.
:::
API — Microservices & Gateway
Microservices
| ID | Name | Gateway path | Description |
|---|---|---|---|
coreApiV1 | Core API V1 | /gateway/core/v1 | Primary backend API — users, companies, dashboards (Power BI), documents, products/licenses, events/webinars, lookups, economic models, authorization. |
coreApiV2 | Core API V2 | /gateway/core/v2 | Core API v2 — enhanced authorization endpoints returning structured objects (permissions, products, dashboards, cubes as id+name pairs). |
dynamixApiV1 | Dynamix API V1 | /gateway/dynamix/v1 | DynamiX simulation engine — manages simulation configurations, triggers model runs, tracks execution state, and delivers output datasets for parametric simulation workflows. |
dynamixApiV2 | Dynamix API V2 | /gateway/dynamix/v2 | DynamiX v2 — compressed configs, API-key-based file upload/download, external simulation access, rate-limited endpoints. |
savedEntities | Saved Entities | /gateway/saved-entities | User-saved entities (analytics views, dashboard bookmarks, search filters, models) and hierarchical folder organization. CRUD with auto-root-folder provisioning per user. |
economicModel | Economic Model | /gateway/economic-model | Generates Excel economic model files (.xlsb) — UCube-based and generic dashboard models, dashboard file templates, feature flags, global I/O data generation. Async job pattern with polling. |
userApi | User API | /gateway/user | User accounts, authentication profiles, product licensing, company profiles, product catalog hierarchy (Theme>Suite>Solution>Catalog), security groups, user settings, and subscriptions. |
coreDocument | Core Document | /gateway/documents | Analytics document library — research reports, publications, authors, editors, product updates. GraphQL + REST hybrid. Document downloads, file management, notifications, user access control. |
lookupGlobal | Lookup (Global) | /gateway/lookup | GraphQL reference-data service — companies, products, geography, documents, OLAP dimensions, regions, CRM accounts. 4 schemas: /lookup, /cube/lookup, /resql/lookup, /sugar/lookup. Read-only with offset pagination, filtering, sorting. |
coreDashboard | Core Dashboard (GraphQL) | /gateway/dashboards/graphql | Power BI embedded dashboard management — CRUD, PBI file uploads/versioning, thumbnails, performance monitoring, user access via product licenses. 3 GraphQL APIs (/dashboards public, /internal/dashboards service-to-service, /internal/dashboard admin) + REST admin API. |
Gateway routing pattern
{
"268": {
"ok": true,
"isError": false,
"data": {
"routeId": "268",
"uiRoute": "/268/{*any}",
"apiRoute": "/gateway/api/268/{**catch-all}",
"description": "Frontend at /268/, API calls at /gateway/api/268/",
"viteProxyConfig": {
"target": "<gateway-origin> (set GATEWAY_URL for local dev, e.g. a dev/stage gateway)",
"changeOrigin": true,
"secure": true,
"cookieDomainRewrite": "localhost"
},
"appsettingsEntry": {
"route": {
"RouteId": "268-ui",
"ClusterId": "268",
"Match": {
"Path": "/268/{*any}"
}
},
"apiRoute": {
"RouteId": "268-api",
"ClusterId": "268-api",
"Match": {
"Path": "/gateway/api/268/{**catch-all}"
},
"Transforms": [
{
"PathPattern": "{**catch-all}"
},
{
"PathRemovePrefix": "/gateway/api/268"
}
],
"Metadata": {
"Duende.Bff.Yarp.TokenType": "UserOrNone",
"HealthCheckEndpoint": "/hc"
}
},
"apiCluster": {
"268-api": {
"Destinations": {
"default": {
"Address": "http://<dashboard-backend-host>:<port>/"
}
}
}
}
}
}
},
"300": {
"ok": true,
"isError": false,
"data": {
"routeId": "300",
"uiRoute": "/300/{*any}",
"apiRoute": "/gateway/api/300/{**catch-all}",
"description": "Frontend at /300/, API calls at /gateway/api/300/",
"viteProxyConfig": {
"target": "<gateway-origin> (set GATEWAY_URL for local dev, e.g. a dev/stage gateway)",
"changeOrigin": true,
"secure": true,
"cookieDomainRewrite": "localhost"
},
"appsettingsEntry": {
"route": {
"RouteId": "300-ui",
"ClusterId": "300",
"Match": {
"Path": "/300/{*any}"
}
},
"apiRoute": {
"RouteId": "300-api",
"ClusterId": "300-api",
"Match": {
"Path": "/gateway/api/300/{**catch-all}"
},
"Transforms": [
{
"PathPattern": "{**catch-all}"
},
{
"PathRemovePrefix": "/gateway/api/300"
}
],
"Metadata": {
"Duende.Bff.Yarp.TokenType": "UserOrNone",
"HealthCheckEndpoint": "/hc"
}
},
"apiCluster": {
"300-api": {
"Destinations": {
"default": {
"Address": "http://<dashboard-backend-host>:<port>/"
}
}
}
}
}
}
}
}
Endpoint details
Per-endpoint tool. Requires { service, path, method? }; some services resolve via a live gateway fetch. Enumerated on demand by the renderer, not snapshotted at build time.