Set Up Room Objects through API

➡️ See the API Reference documentation 🔗 for detailed information.

Set Up the Dimensions

Parameter	Type	Possible values	Default value
width	real	[50;1500]	500 mm
depth	real	[50;1500]	500 mm
height	real	[50;5000]	3000 mm

Width of a Column

"width": {
    "max": 1500,
    "min": 50,
    "step": 1,
    "typeID": 1,
    "editable": "RW",
    "translation": {
             "name": {
                     "1": "Longueur",
                     "2": "Width",
                     "3": "Anchura",
                     "4": "Breite"
        }
    },
    "defaultValue": 500
},

Width of a Water Pipe

"width": {
    "max": null,
    "min": null,
    "step": 1,
    "typeID": 1,
    "editable": "RW",
    "translation": {
             "name": {
                     "1": "Longueur",
                     "2": "Width",
                     "3": "Anchura",
                     "4": "Breite"
        }
    },
    "defaultValue": 1200
},

---

Set Up the Behavior in the Planner

Set isObstacle to true.

Parameter	Type	Possible values	Default value
isObstacle	boolean	true/false	true

"floorplan": [
		{
		"picto": "objects",
		"categories": [
			{
			"categories": [
				{
				  "freeTags": [],
				  "closedTags": [
					286
				  ],
				  "translationKey": "columns"
				},
				{
				  "freeTags": [],
				  "closedTags": [
					138
				  ],
				  "translationKey": "freeShapes"
				},
				{
				  "freeTags": [],
				  "closedTags": [
					184
				  ],
				  "translationKey": "radiators"
			  }
		        ],
		        "translationKey": "objects"
	             }
                  ],
		     "isObstacle": true,
                  "translationKey": "objects"
               },
]