Space Docs
Domain Model

Space

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYes—Id
createdAtstring.date-timeYes—Created at
updatedAtstring.date-timeYes—Updated at
siteIdstringYes—ID of the associated site
parentSpaceIdstringNo—ID of the associated parent space
spaceTypeenum(building, floor, wing, room, closet, rack, parking_area, exterior, other)Yes—Space type
namestringYes—Name
floorstringNo—Floor
roomNumberstringNo—Room number
descriptionstringNo—Description
workspaceIdstringYes—ID of the associated workspace
visibilityModeunknownYes—Visibility mode

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
siteIdstringYes—ID of the associated site
parentSpaceIdstringNo—ID of the associated parent space
spaceTypeenum(building, floor, wing, room, closet, rack, parking_area, exterior, other)Yes—Space type
namestringYes—Name
floorstringNo—Floor
roomNumberstringNo—Room number
descriptionstringNo—Description
workspaceIdstringNo—ID of the associated workspace
visibilityModeunknownNo—Visibility mode

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
siteIdstringNo—ID of the associated site
parentSpaceIdstringNo—ID of the associated parent space
spaceTypeenum(building, floor, wing, room, closet, rack, parking_area, exterior, other)No—Space type
namestringNo—Name
floorstringNo—Floor
roomNumberstringNo—Room number
descriptionstringNo—Description

On this page