API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · locations

location

Schema-ID
location
Collection
locations
Permissions
  • Lesenlocation_view
  • Anlegenlocation_create
  • Ändernlocation_edit
  • Löschenlocation_delete

Felder

location

locations4 Permissions
namestringerforderlich
1–200 Zeichen
locationTypestringerforderlich
Werte
BUILDINGFLOORROOMZONEWORKSTATIONPARKINGRACK
parentIduuidoptional

Parent location for hierarchy (Building > Floor > Room > Workstation)

Default: nullnullable
pathuuid[]optional

Materialized path for fast hierarchy queries

Default: []read-only
sortOrderintegeroptional
≥ 0Default: 0
partyIduuidoptional

Party this location belongs to (for customer site planning)

Default: nullnullable
partyAddressIduuidoptional

Specific address/site of the party

Default: nullnullable
addressobjectoptional
Default: nullnullable
floorPlanImageUrlstringoptional

SVG or image URL for floor plan

Default: nullnullable
capacityintegeroptional

Person capacity

≥ 0Default: nullnullable
roomTypestringoptional
Werte
OFFICESERVER_ROOMMEETING_ROOMWORKSHOPSTORAGERECEPTIONKITCHENWCOTHERnull
Default: nullnullable
workstationTypestringoptional
Werte
STANDARDSTANDINGHOT_DESKPHONE_BOOTHnull
Default: nullnullable
isBookablebooleanoptional
Default: false
assignedToUserIduuidoptional

Permanently assigned user (not a hot desk)

Default: nullnullable
positionXnumberoptional

X position on floor plan (0-100%)

0 – 100Default: nullnullable
positionYnumberoptional

Y position on floor plan (0-100%)

0 – 100Default: nullnullable
floorPlanLocationIduuidoptional

ID of the FLOOR/ROOM whose floor-plan this workstation is placed on. Decouples position from hierarchy: positionX/Y belong to ONE specific plan, so a workstation under Room can be placed on the parent Floor plan without leaking the pin into the Room plan.

Default: nullnullable
rackVendorstringoptional

Rack manufacturer/vendor

max 200 ZeichenDefault: nullnullable
rackModelstringoptional

Rack model name

max 200 ZeichenDefault: nullnullable
rackDepthMmintegeroptional

Rack depth in millimeters

≥ 0Default: nullnullable
maxWeightKgnumberoptional

Maximum load capacity in kg

≥ 0Default: nullnullable
powerCircuitsintegeroptional

Number of power circuits/feeds

≥ 0Default: nullnullable
ipRangesstring[]optional

Public egress IPs of this site, as CIDR (192.0.2.0/24, 2001:db8::/32) or bare address. Used to detect which site a user is working from — a hint for defaults only, NEVER an authorization input. Not exposed by /print-target/resolve.

Default: []
defaultPrintTargetobjectoptional

Label printer used by default for users detected at this site (ADR 0370)

Default: nullnullable
equipmentstring[]optional

Equipment at this location

Default: []
tagsstring[]optional
Default: []
isActivebooleanoptional
Default: true
notesstringoptional
max 2000 ZeichenDefault: nullnullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/locations — Liste, paginiert + filterbar
  • GET /api/v1/locations/<id> — Einzelne Entity
  • POST /api/v1/locations — Anlegen
  • PATCH /api/v1/locations/<id> — Teil-Update
  • DELETE /api/v1/locations/<id> — Soft-Delete
  • GET /api/v1/locations/<id>/timeline — Audit + Aktivitäten

Suche