ROOMSTATUS: Room status
The ROOMSTATUS entity: Operational status values for rooms with colour coding for visual floor plan indicators.
Default definition. This article describes the default
ROOMSTATUS definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches ROOMSTATUS.Entity properties
| Property | Value |
|---|---|
| Entity code | ROOMSTATUS |
| Display name | Room status |
| Plural | Room statuses |
| Level | 250 |
Use cases
ROOMSTATUS is a lookup entity referenced by ROOM (as status) to track the operational state of individual rooms. Values might include active, maintenance, offline, reserved, decommissioned. Includes a color field for visual representation on floor plans and room maps, enabling at-a-glance status assessment.
The description field is shown in the grid. Separate from FLOORSTATUS because rooms on the same floor may have different operational states. Uses a flat definition structure with grid view.
Fields
Room status
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
description | text (multi-line) | Description | |
icon | color | Color |
Relationships
- No declared relationships in the default definition.
Creating a Room status via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "ROOMSTATUS",
"level": 250,
"comboKey": "SUB:|ENT:",
"name": "Example name",
"description": "Example Description",
"icon": "Example value"
} Listing Room statuses records
GET /v1/entities/ROOMSTATUS/SUB