platform-biomes-web
Operations of the Biome Host API. Paths are relative to your deployment's API host.
GET /api/biome-host-api/platform/biomes/web
List web biomes for the runtime registry. The org is the one the kernel ADMITS for the caller (X-Xema-Org-Id and/or ?org=, which must agree and be proven by the caller's own token). By default returns ONLY loadable rows (effectiveState 'ENABLED' AND surfaceMode 'web_and_server') for that org — the SPA bootstrap loads exactly this set without filtering. Pass ?includeInactive=true to also receive DISABLED/ORPHANED rows with their per-org state (a person holding the installations read permission, which org admins hold by default).
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
includeInactive | query | boolean | no | When true, include non-loadable rows (DISABLED, ORPHANED) with their resolved per-org state; refused for a person without the installations read permission, and for a presented caller below org admin. Default false: only loadable ENABLED rows are returned (runtime bootstrap contract). |
includeWebArtifacts | query | boolean | no | When true, also return WEB_ARTIFACT rows (descriptor web artifacts), for a caller that can load that kind. Default false: only HOST_BUNDLED and REMOTE_FEDERATED rows are returned, on both the default and the includeInactive path, so a caller that does not know WEB_ARTIFACT never receives one. |
org | query | string | no | Names the org the caller works for; it is a declared org source of the route, not a selector. When the request also carries X-Xema-Org-Id the two MUST agree — a disagreement is refused, never silently preferred — and the org must be one the caller's own proof backs. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json WebBiomeRegistrationResponseDtoDataArrayEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/biome-host-api/platform/biomes/web/{id}
Get a single web biome by id
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | |
org | query | string | no |
| Status | Description | Body |
|---|---|---|
| 200 | application/json WebBiomeRegistrationResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |