Command reference

Groups

• airflow 2
• arc 1
• arch 2
• array 2
• assembly 2
• batch 2
• block 32
• boundary 1
• branch 4
• breakline 1
• calc 12
• canopy 4
• catalogue 6
• centreline 1
• centremark 1
• changes 1
• chart 5
• chimney 3
• circle 1
• clash 3
• codes 1
• connection 1
• continuation 2
• contour 5
• contract_mark 3
• curtain_wall 3
• damper 1
• detail 2
• diagram 25
• dimension 15
• document 12
• donut 1
• draft 6
• drafting 1
• drain_fall 1
• duct 33
• edit 2
• elec 28
• ellipse 1
• enclosure 2
• entity 30
• export 11
• fabrication 4
• facade 3
• feedback 10
• fire_boundary 2
• fitting 6
• flow_arrow 2
• foundation 2
• furnish 3
• grid_axis 1
• group 5
• guide 5
• hatch 2
• history 2
• ifc 1
• import 11
• labels 1
• layer 12
• layers 5
• layerstate 5
• leader 7
• legend 10
• level_datum 1
• library 10
• line 1
• linetype 3
• machine 16
• measure 23
• media 5
• mode 3
• network 1
• object 24
• ocr 5
• offer 24
• office 4
• opening 10
• page_setup 8
• pattern 3
• pipe 47
• plan 3
• point 1
• polygon 1
• polyline 4
• preferences 21
• primitive 2
• print 14
• problems 1
• project 23
• properties 2
• quantities 19
• query 1
• rainwater 1
• rectangle 1
• reference 10
• region 4
• render 1
• report 1
• responsibility 3
• revcloud 1
• revision 6
• roof 2
• roof_item 3
• roof_line 3
• roof_plane 2
• room 6
• run 6
• section_marker 3
• selection 15
• sensor 1
• service_zone 3
• sheet 29
• site 8
• site_object 4
• siteplan 16
• slab_opening 3
• snap 5
• span_mark 1
• spatial 4
• spell 6
• spline 2
• stair 2
• storey 5
• structure_type 4
• support 5
• symbols 2
• system 2
• table 26
• tag 10
• tags 5
• terminal 12
• text 10
• text_style 1
• titleblock 6
• tool 9
• trade 2
• ui 4
• underlay 50
• valve 2
• vent 5
• view 43
• view3d 8
• view_level 2
• visibility 1
• wall 18
• wipeout 1
• zone 4

airflow 2 commands

Command	Name	Required parameters	Drawing
airflow.measured.clear	Clear measured airflows	terminals	May change the drawing
airflow.measured.set	Set a measured airflow	terminal, l_s	May change the drawing

arc 1 command

Command	Name	Required parameters	Drawing
arc.create	Create an arc	none required	May change the drawing

arch 2 commands

Command	Name	Required parameters	Drawing
arch.rainwater.remove	Remove old gutters and downpipes	ids	May change the drawing
arch.trim.set	Set the facade trims of a wall or an opening	id	May change the drawing

array 2 commands

Command	Name	Required parameters	Drawing
array.explode	Explode an associative array into plain copies	none required	May change the drawing
array.set	Edit an associative array	none required	May change the drawing

assembly 2 commands

Command	Name	Required parameters	Drawing
assembly.catalogue	List the assemblies of the library	none required	Does not change the drawing
assembly.place	Place an assembly of library items	code, position_mm	May change the drawing

batch 2 commands

Command	Name	Required parameters	Drawing
batch	Execute command batch	commands, mode	May change the drawing
batch.results	Read paged batch outcomes	token	Does not change the drawing

block 32 commands

Command	Name	Required parameters	Drawing
block.attribute.define	Define a block attribute	block, name	May change the drawing
block.attribute.delete	Delete a block attribute	block, name	May change the drawing
block.attributes.display	Set the attribute display	mode	May change the drawing
block.attributes.set	Edit attributes	values	May change the drawing
block.catalogue	List the architectural catalogue	none required	Does not change the drawing
block.catalogue.set	Edit the size of a placed catalogue item	id, params	May change the drawing
block.catalogue.tool	Choose the catalogue item to place	kind	Does not change the drawing
block.copy_nested	Copy a nested object out of a block	id, at_mm	May change the drawing
block.define	Create a block	name	May change the drawing
block.delete	Delete a block definition	block	May change the drawing
block.edit.begin	Edit a block	none required	Does not change the drawing
block.edit.end	Finish editing the block	none required	Does not change the drawing
block.element.add	Add elements to a block	block	May change the drawing
block.element.delete	Delete elements from a block	block, indices	May change the drawing
block.element.transform	Transform elements of a block	block, indices, matrix	May change the drawing
block.explode	Explode a block	none required	May change the drawing
block.import	Import blocks from a DWG or DXF drawing	path	May change the drawing
block.insert	Insert a block	block, position_mm	May change the drawing
block.insert.set	Edit a block insert	none required	May change the drawing
block.inspect	Inspect a block or a block insert	none required	Does not change the drawing
block.library.list	List the company block library	none required	Does not change the drawing
block.library.load	Load blocks from a library file	none required	May change the drawing
block.library.save	Save blocks to a library file	none required	Does not change the drawing
block.library.set_folder	Set the company library folder	none required	Does not change the drawing
block.list	List blocks	none required	Does not change the drawing
block.paste	Paste as block	none required	May change the drawing
block.place	Place a catalogue item	id, position_mm	May change the drawing
block.purge	Purge unused blocks	none required	May change the drawing
block.redefine	Redefine a block	block	May change the drawing
block.rename	Rename a block	block, to	May change the drawing
block.set_base	Set the block base point	block	May change the drawing
block.tool	Choose the block to insert	block	Does not change the drawing

boundary 1 command

Command	Name	Required parameters	Drawing
boundary.create	Create closed polylines around a picked area	points	May change the drawing

branch 4 commands

Command	Name	Required parameters	Drawing
branch.set_angle	Set the branch angle of a Y-branch	id, angle_deg, operation_uuid	May change the drawing
branch.set_direction	Turn a branch around its round main	id, direction_deg, operation_uuid	May change the drawing
branch.set_face	Switch a branch take-off to another face	id, face, operation_uuid	May change the drawing
branch.set_kind	Change a branch between a tee and a saddle	id, kind, operation_uuid	May change the drawing

breakline 1 command

Command	Name	Required parameters	Drawing
breakline.create	Create a break line	start, end	May change the drawing

calc 12 commands

Command	Name	Required parameters	Drawing
calc.apply	Write calculated valve settings and damper pressures into the tags	none required	May change the drawing
calc.eval	Evaluate an expression	expression	Does not change the drawing
calc.fan	Fan duty points and specific fan power	none required	Does not change the drawing
calc.inspect	Inspect the calculation result of one part	id	Does not change the drawing
calc.options.set	Set the calculation options	min_terminal_dp_pa	May change the drawing
calc.report	Place the calculation report on a sheet	none required	May change the drawing
calc.requirements	Propose room airflows from the requirements	none required	Does not change the drawing
calc.requirements.apply	Apply the proposed room airflows	none required	May change the drawing
calc.run	Run the duct network calculation	none required	Does not change the drawing
calc.values	List the calculation values and where each comes from	none required	Does not change the drawing
calc.values.reset	Reset own calculation values to the next level	none required	May change the drawing
calc.values.set	Set an own calculation value	none required	May change the drawing

canopy 4 commands

Command	Name	Required parameters	Drawing
canopy.inspect	Inspect a commercial kitchen canopy hood	id	Does not change the drawing
canopy.place	Place a commercial kitchen canopy hood	position_mm, operation_uuid	May change the drawing
canopy.products	List commercial kitchen canopy hood products	none required	Does not change the drawing
canopy.set	Edit a commercial kitchen canopy hood	id	May change the drawing

catalogue 6 commands

Command	Name	Required parameters	Drawing
catalogue.data_notice	Read product data notice	none required	Does not change the drawing
catalogue.import	Import a local catalogue	path	May change the drawing
catalogue.inspect	Inspect machine reference data	none required	Does not change the drawing
catalogue.list	Browse machine catalogue	none required	Does not change the drawing
catalogue.products	Browse product library	none required	Does not change the drawing
catalogue.terminals	Browse terminal catalogue	none required	Does not change the drawing

centreline 1 command

Command	Name	Required parameters	Drawing
centreline.create	Create a centre line	entities	May change the drawing

centremark 1 command

Command	Name	Required parameters	Drawing
centremark.create	Create centre marks	none required	May change the drawing

changes 1 command

Command	Name	Required parameters	Drawing
changes.get	Read command changes	token	Does not change the drawing

chart 5 commands

Command	Name	Required parameters	Drawing
chart.create	Insert a chart	kind	May change the drawing
chart.delete	Delete a chart	none required	May change the drawing
chart.import	Import chart points from CSV text	id, name, csv	May change the drawing
chart.series.set	Set a chart series	id, name, points	May change the drawing
chart.set	Edit a chart	id	May change the drawing

chimney 3 commands

Command	Name	Required parameters	Drawing
chimney.connect	Connect a stove or fireplace to a chimney flue	chimney, block	May change the drawing
chimney.create	Draw a chimney	position_mm	May change the drawing
chimney.set	Edit a chimney	id	May change the drawing

circle 1 command

Command	Name	Required parameters	Drawing
circle.create	Create a circle	none required	May change the drawing

clash 3 commands

Command	Name	Required parameters	Drawing
clash.check	Check clashes between ducts, structure and equipment	none required	Does not change the drawing
clash.resolve	Move an object clear of the object it clashes with	id, other, mode	May change the drawing
clash.settings	Set clash clearance and crossing rules	none required	May change the drawing

codes 1 command

Command	Name	Required parameters	Drawing
codes.renumber	Renumber the project codes with the office code pattern	none required	May change the drawing

connection 1 command

Command	Name	Required parameters	Drawing
connection.reconnect	Reconnect an object whose duct could not follow a move	id	May change the drawing

continuation 2 commands

Command	Name	Required parameters	Drawing
continuation.place	Place a continuation note	target, sheet_ref, position_mm	May change the drawing
continuation.set	Edit a continuation note	id	May change the drawing

contour 5 commands

Command	Name	Required parameters	Drawing
contour.add_point	Add a contour vertex	edge	May change the drawing
contour.bend_edge	Bend a contour edge	edge, sweep_deg	May change the drawing
contour.edit	Enter or finish contour editing	none required	Does not change the drawing
contour.move_point	Move a contour vertex	index, point	May change the drawing
contour.remove_point	Remove a contour vertex	index	May change the drawing

contract_mark 3 commands

Command	Name	Required parameters	Drawing
contract_mark.inspect	Inspect a contract boundary mark	id	Does not change the drawing
contract_mark.place	Place a contract boundary mark on a pipe or duct	host, at	May change the drawing
contract_mark.set	Edit a contract boundary mark	id	May change the drawing

curtain_wall 3 commands

Command	Name	Required parameters	Drawing
curtain_wall.create	Create a curtain wall on a wall run or a path	none required	May change the drawing
curtain_wall.inspect	Read a curtain wall and its bays	none required	Does not change the drawing
curtain_wall.set	Edit a curtain wall	none required	May change the drawing

damper 1 command

Command	Name	Required parameters	Drawing
damper.size_setting	Calculate balancing damper pressure drops from the network	none required	May change the drawing

detail 2 commands

Command	Name	Required parameters	Drawing
detail.list	List the LVI details	none required	Does not change the drawing
detail.place	Place an LVI detail on a sheet	id	May change the drawing

diagram 25 commands

Command	Name	Required parameters	Drawing
diagram.boundary.add	Add a device outline or a limit line	kind, points	May change the drawing
diagram.connect	Connect diagram ports with a line	from, to	May change the drawing
diagram.delete	Delete diagram objects	ids	May change the drawing
diagram.dimension.create	Add a dimension to a diagram sheet	a, b	May change the drawing
diagram.export	Export a diagram sheet as PDF	path	Does not change the drawing
diagram.generate.electrical	Generate an electrical diagram sheet	kind	May change the drawing
diagram.inspect	Inspect a diagram object	id	Does not change the drawing
diagram.io.add	Add a controller I/O bar	at	May change the drawing
diagram.io.point	Add an I/O point to a bar	bar, band, x	May change the drawing
diagram.legend.set	Set the diagram sheet legends	none required	May change the drawing
diagram.list	List diagram sheets and objects	none required	Does not change the drawing
diagram.move	Move diagram objects	ids, by	May change the drawing
diagram.open	Show a diagram sheet	sheet	Does not change the drawing
diagram.place	Place a diagram symbol	at	May change the drawing
diagram.points	Read the point list	none required	Does not change the drawing
diagram.points.export	Export the point list	path	Does not change the drawing
diagram.set	Edit a diagram object	id	May change the drawing
diagram.settings	Set the diagram tool defaults	none required	Does not change the drawing
diagram.sheet.create	Create a diagram sheet	none required	May change the drawing
diagram.sheet.delete	Delete a diagram sheet	sheet	May change the drawing
diagram.sheet.set	Edit a diagram sheet	none required	May change the drawing
diagram.symbol.inspect	Show one diagram symbol with its named ports	id	Does not change the drawing
diagram.symbol.list	List the diagram symbols of the Diagrams trade	none required	Does not change the drawing
diagram.tag.renumber	Renumber diagram tags	none required	May change the drawing
diagram.text.add	Add a function text or labels	at	May change the drawing

dimension 15 commands

Command	Name	Required parameters	Drawing
dimension.auto_insert	Insert automatic dimensions	none required	May change the drawing
dimension.auto_remove	Remove automatic dimensions	none required	May change the drawing
dimension.baseline	Add baseline dimensions	points	May change the drawing
dimension.chain	Create a dimension chain in a side view	view, axis, points	May change the drawing
dimension.continue	Continue a dimension chain	points	May change the drawing
dimension.create	Create an associative dimension	p1, p2, offset	May change the drawing
dimension.grip	Drag a dimension end or offset handle	point, handle	May change the drawing
dimension.inspect	Inspect resolved dimension geometry	none required	Does not change the drawing
dimension.reassociate	Reattach a dimension to objects	none required	May change the drawing
dimension.release	Release dimensions from their objects	none required	May change the drawing
dimension.set	Edit dimension Size, underlying objects and appearance	none required	May change the drawing
dimension.settings	Set the room-interior and unit-suffix dimension rules	none required	May change the drawing
dimension.space	Equalise dimension spacing	none required	May change the drawing
dimension.text	Place dimension text	none required	May change the drawing
dimension.value	Type a dimension's value: the right or upper end and what it measures move	value	May change the drawing

document 12 commands

Command	Name	Required parameters	Drawing
document.block.add	Add a document block	document, block	May change the drawing
document.block.move	Move a document block	document, from, to	May change the drawing
document.block.remove	Remove a document block	document, index	May change the drawing
document.block.set	Change a document block	document, index, block	May change the drawing
document.clauses.from_library	Add clauses from the office library	document, trade, ids	May change the drawing
document.clauses.library	List the office clause library	none required	Does not change the drawing
document.create	Create a work specification	kind	May change the drawing
document.delete	Delete a written document	document	May change the drawing
document.export	Export a written document	document, format, path	Does not change the drawing
document.inspect	Inspect document	none required	Does not change the drawing
document.layout	Show the document pages and contents	document	Does not change the drawing
document.set	Rename a written document	document, title	May change the drawing

donut 1 command

Command	Name	Required parameters	Drawing
donut.create	Create a donut	centre, outside_diameter	May change the drawing

draft 6 commands

Command	Name	Required parameters	Drawing
draft.cancel	Cancel the command-line command	none required	Does not change the drawing
draft.command	Start a command-line command	none required	Does not change the drawing
draft.complete	Complete a command name	text	Does not change the drawing
draft.history	List the command-line history	none required	Does not change the drawing
draft.input	Answer the command-line prompt	none required	Does not change the drawing
draft.state	Read the command-line prompt and preview	none required	Does not change the drawing

drafting 1 command

Command	Name	Required parameters	Drawing
drafting.settings	Set polar tracking, ortho and edit defaults	none required	Does not change the drawing

drain_fall 1 command

Command	Name	Required parameters	Drawing
drain_fall.draw	Draw roof drain falls	none required	May change the drawing

duct 33 commands

Command	Name	Required parameters	Drawing
duct.add_fire_damper	Add a fire damper to a duct	id, operation_uuid	May change the drawing
duct.crossing	Cross a duct under or over another duct	moving, obstacle, operation_uuid	May change the drawing
duct.custom_pieces	List custom sheet-metal pieces	none required	Does not change the drawing
duct.defaults	Set duct drawing options	none required	Does not change the drawing
duct.demolish_marks	Set demolition X size, spacing and pen	none required	May change the drawing
duct.draw	Draw a duct run	start, points, operation_uuid	May change the drawing
duct.height_from	Duct height under or over another object	one_of(source|point)	Does not change the drawing
duct.height_preview	Preview duct piece or run centre height	id, centre_height_mm	Does not change the drawing
duct.inspect	Inspect a duct run	id	Does not change the drawing
duct.joints	Set automatic standard-length inner joints	none required	May change the drawing
duct.node.move	Move a duct joint; the network follows	id	May change the drawing
duct.partial_demolition	Cut a duct, remove one side and cap the kept end	part, remove, operation_uuid	May change the drawing
duct.preview	Preview a duct run	start, points	Does not change the drawing
duct.properties	Inspect duct piece or run properties	id	Does not change the drawing
duct.property_scope	Set duct property edit scope	none required	Does not change the drawing
duct.rect_code_settings	Set the LK/KK aspect-ratio threshold	lk_ratio	May change the drawing
duct.rect_codes	List rectangular tag codes in use	none required	Does not change the drawing
duct.rect_joints	Set rectangular duct joints (kanttikanavan liitokset)	none required	May change the drawing
duct.resize	Resize a duct	to, operation_uuid	May change the drawing
duct.resize.preview	Preview a duct size change	to	Does not change the drawing
duct.resize.set	Change a duct size in Properties, for the piece or the whole run	id	May change the drawing
duct.riser	Continue a run on another storey	run, to_floor, centre_height_mm, points, operation_uuid	May change the drawing
duct.run.resize	Resize a duct run	part	May change the drawing
duct.set_height	Set duct piece or run centre height	id, centre_height_mm	May change the drawing
duct.set_system	Change a connected duct system	id, system	May change the drawing
duct.settings	Set duct plan drawing style	none required	May change the drawing
duct.size_helper	Suggest a rectangular duct size	none required	Does not change the drawing
duct.size_system	Size a system's round ducts	system	May change the drawing
duct.size_system.preview	Preview sizing a system's round ducts	system	Does not change the drawing
duct.sizing.set	Set a duct's sizing input	ids	May change the drawing
duct.suggest_size	Suggest a duct size for an airflow	q_l_s, family	Does not change the drawing
duct.system_preview	Preview a connected system change	id, system	Does not change the drawing
duct.update	Edit duct piece or run properties	id	May change the drawing

edit 2 commands

Command	Name	Required parameters	Drawing
edit.redo	Redo	none required	Does not change the drawing
edit.undo	Undo	none required	Does not change the drawing

elec 28 commands

Command	Name	Required parameters	Drawing
elec.board.place	Place a distribution board	at	May change the drawing
elec.board.set	Edit a distribution board	id	May change the drawing
elec.circuit.assign	Put electrical points on a circuit	ids	May change the drawing
elec.circuit.check	Check circuits: design current, cable capacity, device and voltage drop	none required	Does not change the drawing
elec.circuit.create	Create a circuit on a board	board	May change the drawing
elec.circuit.delete	Delete a circuit	board, circuit	May change the drawing
elec.circuit.set	Edit a circuit	board, circuit	May change the drawing
elec.circuit.size	Apply the circuit check's larger cable sizes	none required	May change the drawing
elec.circuit.size.preview	Preview applying the circuit check's larger cable sizes	none required	Does not change the drawing
elec.circuit.split	Split a circuit in two	board, circuit	May change the drawing
elec.device.clear_of	Move a smoke alarm clear of supply terminals	id	May change the drawing
elec.device.height_tag	Show or hide the mounting height of electrical points	ids	May change the drawing
elec.device.place	Place an electrical point	at	May change the drawing
elec.device.set	Edit electrical points	none required	May change the drawing
elec.hvac_points	Add the supply points of the HVAC and piping equipment	none required	May change the drawing
elec.inspect	Inspect an electrical object	id	Does not change the drawing
elec.loads	Read the electrical loads of the HVAC equipment	none required	Does not change the drawing
elec.products	List the products of an electrical object, generic first	none required	Does not change the drawing
elec.route.draw	Draw a cable route	none required	May change the drawing
elec.route.set	Edit a cable route	id	May change the drawing
elec.schedule	Read a board's group schedule	board	Does not change the drawing
elec.settings	Set the electrical drawing defaults	none required	Does not change the drawing
elec.switch.link	Link a switch to its luminaires	id	May change the drawing
elec.wire.draw	Draw a wire	none required	May change the drawing
elec.wire.feeders	Draw the feeders between boards	none required	May change the drawing
elec.wire.inspect	Inspect a wire	id	Does not change the drawing
elec.wire.set	Edit wires	none required	May change the drawing
elec.wire.switch	Draw the switch wires of a switching group	id	May change the drawing

ellipse 1 command

Command	Name	Required parameters	Drawing
ellipse.create	Create an ellipse	none required	May change the drawing

enclosure 2 commands

Command	Name	Required parameters	Drawing
enclosure.draw	Draw a duct enclosure or an access panel	part, points	May change the drawing
enclosure.set	Edit an enclosure or an access panel	id	May change the drawing

entity 30 commands

Command	Name	Required parameters	Drawing
entity.align_points	Align the selection by point pairs	pairs	May change the drawing
entity.array	Copy the selection in a rectangular or polar array	none required	May change the drawing
entity.array_path	Copy the selection along a path	path, count	May change the drawing
entity.blend	Join two curve ends with a smooth spline	ids, points	May change the drawing
entity.break	Break a drafting object	id, point	May change the drawing
entity.chamfer	Chamfer two lines or polyline corners	none required	May change the drawing
entity.copy	Copy selection	none required	May change the drawing
entity.delete	Delete selection	none required	May change the drawing
entity.divide	Place points or blocks dividing an object into equal parts	id, count	May change the drawing
entity.explode	Explode polylines into lines and arcs	none required	May change the drawing
entity.extend	Extend drafting objects	none required	May change the drawing
entity.fillet	Fillet two objects or polyline corners	none required	May change the drawing
entity.grip	Move a control point	id, point, handle	May change the drawing
entity.grip_dims	Read the length and angle a grip is measured by	id, handle	Does not change the drawing
entity.join	Join drafting objects	ids	May change the drawing
entity.lengthen	Lengthen or shorten an open object	id, point	May change the drawing
entity.measure	Place points or blocks at a spacing along an object	id, spacing	May change the drawing
entity.mirror	Mirror selection	pivot, axis	May change the drawing
entity.move	Move selection	delta	May change the drawing
entity.offset	Offset a drafting object	id	May change the drawing
entity.overkill	Delete duplicate and overlapping drafting objects	none required	May change the drawing
entity.preview	Preview selection edit	operation	Does not change the drawing
entity.repeat_transform	Repeat the last selection transform	none required	May change the drawing
entity.reverse	Reverse the direction of curves	none required	May change the drawing
entity.rotate	Rotate selection	pivot, angle_deg	May change the drawing
entity.scale	Resize selection about an anchor	pivot, factors	May change the drawing
entity.stretch	Stretch points inside a crossing area or several grips	delta	May change the drawing
entity.transform	Apply a composed selection transform	matrix	May change the drawing
entity.trim	Trim drafting objects	none required	May change the drawing
entity.trim_side	Trim everything on one side of a cutting edge	edge, side	May change the drawing

export 11 commands

Command	Name	Required parameters	Drawing
export.dwg	Export DWG	path	Does not change the drawing
export.dxf	Export DXF (plan, section or sheet)	path	Does not change the drawing
export.fbx	Export 3D model as FBX	path	Does not change the drawing
export.gltf	Export 3D model as glTF (GLB/glTF)	path	Does not change the drawing
export.ifc	Export a copy as IFC 4.3 (.ifc or .ifczip)	path	Does not change the drawing
export.image	Export plan image (PNG/SVG)	path	Does not change the drawing
export.image_batch	Export several plan images in one call	jobs	Does not change the drawing
export.isometric	Export an isometric view as PDF	path, view	Does not change the drawing
export.obj	Export 3D model as OBJ	path	Does not change the drawing
export.pdf	Export vector PDF	path	Does not change the drawing
export.step	Export 3D model as STEP	path	Does not change the drawing

fabrication 4 commands

Command	Name	Required parameters	Drawing
fabrication.list	List the sheet-metal shop order (peltipajan tilauslista)	none required	Does not change the drawing
fabrication.marks	List the piece marks (osamerkit)	none required	Does not change the drawing
fabrication.marks.set	Show piece marks and set their prefix	none required	May change the drawing
fabrication.piece	Show one transition piece's shop geometry	id	Does not change the drawing

facade 3 commands

Command	Name	Required parameters	Drawing
facade.material.list	List the facade materials	none required	Does not change the drawing
facade.material.remove	Remove a facade material	key	May change the drawing
facade.material.set	Set a facade material	key	May change the drawing

feedback 10 commands

Command	Name	Required parameters	Drawing
feedback.capture	Set feedback window capture	png, drawing_px	Does not change the drawing
feedback.close	Close feedback	none required	Does not change the drawing
feedback.crash.inspect	Inspect pending crash feedback	none required	Does not change the drawing
feedback.crash.respond	Answer the crash feedback offer	choice	Does not change the drawing
feedback.edit	Edit feedback draft	draft	Does not change the drawing
feedback.inspect	Inspect feedback draft or attachment	none required	Does not change the drawing
feedback.open	Send feedback	none required	Does not change the drawing
feedback.package	Save local feedback package	none required	Does not change the drawing
feedback.prepare	Prepare exact feedback previews	none required	Does not change the drawing
feedback.system	Set feedback system details	info	Does not change the drawing

fire_boundary 2 commands

Command	Name	Required parameters	Drawing
fire_boundary.draw	Draw a fire compartment boundary	points, minutes	May change the drawing
fire_boundary.set	Set the fire compartment class	id	May change the drawing

fitting 6 commands

Command	Name	Required parameters	Drawing
fitting.defaults	Set fitting placement options	none required	Does not change the drawing
fitting.insert	Insert a fitting	kind, operation_uuid	May change the drawing
fitting.inspect	Inspect a fitting	id	Does not change the drawing
fitting.preview	Preview a fitting	none required	Does not change the drawing
fitting.remove	Remove a fitting and heal the duct	id, operation_uuid	May change the drawing
fitting.set_product	Change the product of a damper or silencer	id, product	May change the drawing

flow_arrow 2 commands

Command	Name	Required parameters	Drawing
flow_arrow.place	Add a flow direction arrow	one_of(target|start_mm+end_mm)	May change the drawing
flow_arrow.set	Edit a flow direction arrow	id	May change the drawing

foundation 2 commands

Command	Name	Required parameters	Drawing
foundation.create	Place a foundation (footing and plinth)	none required	May change the drawing
foundation.set	Edit a foundation	id	May change the drawing

furnish 3 commands

Command	Name	Required parameters	Drawing
furnish.inspect	Inspect a library item	id	Does not change the drawing
furnish.model	Choose the 3D model of a catalogue item	id, model	May change the drawing
furnish.set	Edit a library item	id	May change the drawing

grid_axis 1 command

Command	Name	Required parameters	Drawing
grid_axis.create	Create a grid axis	start_mm, end_mm	May change the drawing

group 5 commands

Command	Name	Required parameters	Drawing
group.add	Add objects to a group	none required	May change the drawing
group.enter	Edit a group	none required	Does not change the drawing
group.exit	Leave group editing	none required	Does not change the drawing
group.remove	Remove objects from their group	none required	May change the drawing
group.rename	Rename a group	name	May change the drawing

guide 5 commands

Command	Name	Required parameters	Drawing
guide.construct	Create an infinite construction line at any angle	none required	May change the drawing
guide.create	Insert horizontal or vertical layout guide	axis, position_mm	May change the drawing
guide.draw	Draw construction line	start, end	May change the drawing
guide.inspect	Inspect layout guide coordinate	none required	Does not change the drawing
guide.set	Set layout guide position	position_mm	May change the drawing

hatch 2 commands

Command	Name	Required parameters	Drawing
hatch.create	Create a hatch	none required	May change the drawing
hatch.set	Edit a hatch	none required	May change the drawing

history 2 commands

Command	Name	Required parameters	Drawing
history.inspect	Inspect history	none required	Does not change the drawing
history.jump	Jump in history	index	Does not change the drawing

ifc 1 command

Command	Name	Required parameters	Drawing
ifc.validate	Check an IFC file against the IFC 4.3 schema	path	Does not change the drawing

import 11 commands

Command	Name	Required parameters	Drawing
import.dgn	Import MicroStation DGN as underlay or reference	path	May change the drawing
import.dwg	Import DWG drawing as underlay	path	May change the drawing
import.dxf	Import DXF drawing as underlay	path	May change the drawing
import.fbx	Import FBX reference model	path	May change the drawing
import.gltf	Import glTF reference model	path	May change the drawing
import.ifc	Import an IFC file as a locked reference (walls, openings)	path	May change the drawing
import.ifc_model	Import IFC as 3D reference model	path	May change the drawing
import.obj	Import OBJ reference model	path	May change the drawing
import.site_model	Import site model reference	path	May change the drawing
import.skp	Import SketchUp reference model	path	May change the drawing
import.step	Import STEP machine model as a reference	path	May change the drawing

labels 1 command

Command	Name	Required parameters	Drawing
labels.auto	Automatic labels	none required	May change the drawing

layer 12 commands

Command	Name	Required parameters	Drawing
layer.create	Create a user layer	none required	May change the drawing
layer.delete	Delete a user layer	id	May change the drawing
layer.from_object	Make an object's layer the active layer	none required	Does not change the drawing
layer.isolate	Show only one layer	id	May change the drawing
layer.list	List storey layers with object counts	none required	Does not change the drawing
layer.merge	Merge user layers into a layer	ids, into	May change the drawing
layer.previous	Restore the previous layer switches	none required	May change the drawing
layer.purge	Delete unused layers	none required	May change the drawing
layer.rename	Rename a user layer	id, name	May change the drawing
layer.select	Select layer	id	Does not change the drawing
layer.unisolate	End layer isolation	none required	May change the drawing
layer.update	Edit layer	id	May change the drawing

layers 5 commands

Command	Name	Required parameters	Drawing
layers.auto	Switch automatic layer management on a page	enabled	May change the drawing
layers.group	Create, rename or delete a layer group on a page	op	May change the drawing
layers.list	List a page's Layers panel rows	none required	Does not change the drawing
layers.move	Move a row of a page's Layers panel	id	May change the drawing
layers.set	Show, hide, lock or unlock rows on a page	none required	May change the drawing

layerstate 5 commands

Command	Name	Required parameters	Drawing
layerstate.delete	Delete a layer state	name	May change the drawing
layerstate.list	List layer states	none required	Does not change the drawing
layerstate.rename	Rename a layer state	name, new_name	May change the drawing
layerstate.restore	Restore a layer state	name	May change the drawing
layerstate.save	Save a layer state	name	May change the drawing

leader 7 commands

Command	Name	Required parameters	Drawing
leader.add_line	Add a leader line	id, points	May change the drawing
leader.align	Align multileader notes	none required	May change the drawing
leader.collect	Collect multileader notes	none required	May change the drawing
leader.create	Create a multileader note	points	May change the drawing
leader.remove_line	Remove a leader line	id	May change the drawing
leader.set	Edit a multileader note	none required	May change the drawing
leader.update	Edit a multileader note	none required	May change the drawing

legend 10 commands

Command	Name	Required parameters	Drawing
legend.door_types	List the door type legend	none required	Does not change the drawing
legend.door_types.set	Set the meaning of door type letters	letters, meaning	May change the drawing
legend.library	List the general-note library	none required	Does not change the drawing
legend.notes.from_library	Set the general notes from the library	notes	May change the drawing
legend.notes.reset	Restore the project general notes	none required	May change the drawing
legend.notes.set	Set the general notes	none required	May change the drawing
legend.regenerate	Regenerate the sheet legend	none required	Does not change the drawing
legend.row.reset	Restore a generated legend row	key	May change the drawing
legend.row.update	Edit a legend row	key	May change the drawing
legend.set_line_type_table	Show the line-type table in the legend	on	May change the drawing

level_datum 1 command

Command	Name	Required parameters	Drawing
level_datum.set	Set the absolute level of the project zero	datum_mm	May change the drawing

library 10 commands

Command	Name	Required parameters	Drawing
library.corrections.export	Export data corrections for aeris-mittari	path	Does not change the drawing
library.facts	Read a product's data with sources	item	Does not change the drawing
library.install	Install a product data pack	path	Does not change the drawing
library.overlay.clear	Remove a user value	item, field	Does not change the drawing
library.overlay.list	List user values	none required	Does not change the drawing
library.overlay.set	Set a user value for product data	item, field, value	Does not change the drawing
library.pack.install	Install a construction library pack	path	Does not change the drawing
library.pack.list	List the construction library packs	none required	Does not change the drawing
library.packs	List the product data packs	none required	Does not change the drawing
library.reresolve	Refresh placed products from the current packs	none required	May change the drawing

line 1 command

Command	Name	Required parameters	Drawing
line.create	Create a line	start, end	May change the drawing

linetype 3 commands

Command	Name	Required parameters	Drawing
linetype.delete	Delete a line type of the project	name	May change the drawing
linetype.import	Import line types from a .lin file	path	May change the drawing
linetype.list	List the line types	none required	Does not change the drawing

machine 16 commands

Command	Name	Required parameters	Drawing
machine.customize	Edit a project machine	id	May change the drawing
machine.defaults	Set machine placement options	none required	Does not change the drawing
machine.inspect	Inspect a ventilation machine	id	Does not change the drawing
machine.place	Place a ventilation machine	position_mm, operation_uuid	May change the drawing
machine.plate.accept	Write an accepted type plate record to the machine-db file	review	Does not change the drawing
machine.plate.close	Close a type plate review	review	Does not change the drawing
machine.plate.read	Read a type plate photo into a machine-db proposal	path	Does not change the drawing
machine.ports	Inspect machine ports	id	Does not change the drawing
machine.set_sections	Set the sections of a machine	id, sections	May change the drawing
machine.set_type	Change a ventilation machine type	id	May change the drawing
machine.type.export	Save machine type to user library	type_id	Does not change the drawing
machine.type.import	Import project machine type	path	May change the drawing
machine.type.list	List project machine types	none required	Does not change the drawing
machine.type.place	Place project machine type	type_id, position_mm, operation_uuid	May change the drawing
machine.type.save	Save project machine type	id, type_id, name	May change the drawing
machine.update	Edit a ventilation machine	id	May change the drawing

measure 23 commands

Command	Name	Required parameters	Drawing
measure.angle	Measure an angle	points	May change the drawing
measure.area	Measure an area and perimeter	points	May change the drawing
measure.area_fill	Measure a click-inside area	point	May change the drawing
measure.clearance	Measure a clearance	none required	May change the drawing
measure.convert	Convert a measurement	id, to	May change the drawing
measure.count	Count marks	points	May change the drawing
measure.delete	Delete measurements	ids	May change the drawing
measure.distance	Measure a distance	points	May change the drawing
measure.inspect	Inspect a measurement	id	Does not change the drawing
measure.level	Measure a level and height	none required	May change the drawing
measure.list	List measurements	none required	Does not change the drawing
measure.move_points	Move measurement points	id, edits	May change the drawing
measure.path	Measure a path length	points	May change the drawing
measure.point	Measure a point	points	May change the drawing
measure.quick	Read the clear distances across the cursor along X and Y	none required	Does not change the drawing
measure.radius	Measure a radius	points	May change the drawing
measure.reevaluate	Re-evaluate measurements after recalibration	none required	May change the drawing
measure.set	Edit a measurement	id	May change the drawing
measure.slope	Measure a slope	none required	May change the drawing
measure.to_duct	Turn a traced path into a duct	id	May change the drawing
measure.tool	Activate a measurement tool	kind	Does not change the drawing
measure.tool_options	Set the measurement tool options	none required	Does not change the drawing
measure.volume	Measure a volume	points	May change the drawing

media 5 commands

Command	Name	Required parameters	Drawing
media.attach	Attach project or object media	path	May change the drawing
media.inspect	Inspect media and asset availability	none required	Does not change the drawing
media.poster	Set or clear a media poster	id, path	May change the drawing
media.preview	Render a media thumbnail	id	Does not change the drawing
media.remove	Remove a media attachment	id	May change the drawing

mode 3 commands

Command	Name	Required parameters	Drawing
mode.inspect	Inspect an optional mode	mode	Does not change the drawing
mode.list	List optional modes	none required	Does not change the drawing
mode.set	Switch an optional mode on or off	mode, on	Does not change the drawing

network 1 command

Command	Name	Required parameters	Drawing
network.validate	Validate the duct network	none required	Does not change the drawing

object 24 commands

Command	Name	Required parameters	Drawing
object.align	Align editable objects	mode	May change the drawing
object.bounds	Inspect object bounds including hidden objects	none required	Does not change the drawing
object.connections	List the connection points of objects, open or joined	none required	Does not change the drawing
object.copy	Copy selected objects	none required	Does not change the drawing
object.cut	Cut selected objects	none required	May change the drawing
object.delete	Delete selected objects	none required	May change the drawing
object.distribute	Distribute editable objects	mode	May change the drawing
object.draw_similar	Start drawing an object like the selected one	id	Does not change the drawing
object.duplicate	Duplicate selected objects	none required	May change the drawing
object.flip	Flip each object about its own centre	none required	May change the drawing
object.group	Group selected objects	none required	May change the drawing
object.hide	Hide or show objects	none required	May change the drawing
object.inspect	Inspect one plan or diagram object	none required	Does not change the drawing
object.isolate	Isolate objects	none required	Does not change the drawing
object.list	List storey objects	none required	Does not change the drawing
object.lock	Lock or unlock objects	none required	May change the drawing
object.order	Change drawing order	mode	May change the drawing
object.paste	Paste copied objects	none required	May change the drawing
object.paste_in_place	Paste copied objects in place	none required	May change the drawing
object.set_layer	Move objects to a layer	none required	May change the drawing
object.show_all	Show all active-storey objects and layers	none required	May change the drawing
object.ungroup	Ungroup selected groups	none required	May change the drawing
object.unisolate	End object isolation	none required	Does not change the drawing
object.unlock_all	Unlock all active-storey objects and layers	none required	May change the drawing

ocr 5 commands

Command	Name	Required parameters	Drawing
ocr.job.apply	Apply completed text recognition	job	May change the drawing
ocr.job.cancel	Cancel background text recognition	job	Does not change the drawing
ocr.job.start	Start background text recognition	command, params	Does not change the drawing
ocr.job.status	Read background text recognition progress	job	Does not change the drawing
ocr.status	Show this computer's built-in text recognition	none required	Does not change the drawing

offer 24 commands

Command	Name	Required parameters	Drawing
offer.draft	Show the priced offer draft	none required	Does not change the drawing
offer.export	Export the offer draft	format, path	Does not change the drawing
offer.line.set	Set a line's category, supplier, work kind or code link	line	May change the drawing
offer.lines	List the offer lines and their categories	none required	Does not change the drawing
offer.norms.export	Export the labour norm table file	path	Does not change the drawing
offer.norms.get	Show the labour norm table	none required	Does not change the drawing
offer.norms.import	Import a labour norm table file	path	May change the drawing
offer.norms.set	Replace the labour norm table	norms	May change the drawing
offer.pricelist.delete	Delete an imported price list	id	May change the drawing
offer.pricelist.import	Import a supplier price list	path, supplier	May change the drawing
offer.pricelist.list	List imported price lists	none required	Does not change the drawing
offer.pricelist.preview	Preview a supplier price list file	path	Does not change the drawing
offer.problems	List offer problems	none required	Does not change the drawing
offer.rfq	Show the supplier order lists (kilpailutus)	none required	Does not change the drawing
offer.rfq.export	Export supplier order lists	format, path	Does not change the drawing
offer.rfq.settings	Set the request dates, delivery and reference	none required	May change the drawing
offer.roster.export	Export the supplier roster file	path	Does not change the drawing
offer.roster.get	Show the supplier roster	none required	Does not change the drawing
offer.roster.import	Import a supplier roster file	path	May change the drawing
offer.roster.set	Replace the supplier roster	roster	May change the drawing
offer.settings.set	Set VAT, markups, extra costs and the household line	none required	May change the drawing
offer.subcontract.set	Set a received subcontract total	category	May change the drawing
offer.supplier.delete	Delete a roster supplier	id	May change the drawing
offer.supplier.set	Add or change a roster supplier	supplier	May change the drawing

office 4 commands

Command	Name	Required parameters	Drawing
office.profile	Read the office drawing standard	none required	Does not change the drawing
office.profile.apply_office	Use the office's drawing standard in this project	none required	May change the drawing
office.profile.office_set	Set the office's drawing standard for new projects	none required	Does not change the drawing
office.profile.set	Set this project's office drawing standard values	none required	May change the drawing

opening 10 commands

Command	Name	Required parameters	Drawing
opening.defaults	Set opening creation defaults	none required	Does not change the drawing
opening.family.set	Switch an opening to a family or back to generic	none required	May change the drawing
opening.flip	Flip opening hinge, swing or both	none required	May change the drawing
opening.grip	Resize an opening along its wall	none required	May change the drawing
opening.measure	Measure opening distances and handles	none required	Does not change the drawing
opening.move	Slide an opening along its wall	none required	May change the drawing
opening.place	Place a wall-attached door, window or opening	none required	May change the drawing
opening.preview	Preview a wall-attached opening	none required	Does not change the drawing
opening.products	List the products of an opening, generic first	none required	Does not change the drawing
opening.set	Edit opening size and distances	none required	May change the drawing

page_setup 8 commands

Command	Name	Required parameters	Drawing
page_setup.apply	Apply a page setup to sheets	none required	May change the drawing
page_setup.delete	Delete a page setup	name	May change the drawing
page_setup.export	Export page setups to a file	none required	Does not change the drawing
page_setup.import	Import page setups from a file	none required	May change the drawing
page_setup.list	List page setups	none required	Does not change the drawing
page_setup.rename	Rename a page setup	name, to	May change the drawing
page_setup.save	Save a page setup	name	May change the drawing
page_setup.set_default	Make a page setup the default	name	May change the drawing

pattern 3 commands

Command	Name	Required parameters	Drawing
pattern.delete	Delete a hatch pattern of the project	name	May change the drawing
pattern.import	Import hatch patterns from a .pat file	path	May change the drawing
pattern.list	List the hatch patterns	none required	Does not change the drawing

pipe 47 commands

Command	Name	Required parameters	Drawing
pipe.bundle.create	Put pipe runs into one pre-insulated pipe element	pipes, casing_mm	May change the drawing
pipe.bundle.inspect	Inspect a pipe element	id	Does not change the drawing
pipe.bundle.set	Edit a pipe element	id	May change the drawing
pipe.circulation	Hot water circulation flow from the heat loss	none required	Does not change the drawing
pipe.crossing	Cross a pipe under or over another pipe or a duct	moving, obstacle	May change the drawing
pipe.draw	Draw a pipe run	none required	May change the drawing
pipe.draw_pair	Draw a supply and return pipe pair	none required	May change the drawing
pipe.fixture_type	Define a fixture or accessory type	code	May change the drawing
pipe.fixture_type.part_add	Add a part to a fixture type	code, name	May change the drawing
pipe.fixture_type.part_remove	Remove a part from a fixture type	code, index	May change the drawing
pipe.fixture_type.part_set	Edit a part of a fixture type	code, index	May change the drawing
pipe.generic.set	Edit the generic product of a pipe or pipe item	id	May change the drawing
pipe.heat_load	Calculate the room heat loads	none required	Does not change the drawing
pipe.heat_load.room.set	Set a room's heat load inputs	id	May change the drawing
pipe.heat_load.set	Set the project's heat load inputs	none required	May change the drawing
pipe.heating	Calculate the heating network rows	none required	Does not change the drawing
pipe.heating.set	Set the heating source and temperatures	none required	May change the drawing
pipe.inspect	Inspect a pipe run	id	Does not change the drawing
pipe.insulation.apply	Apply the pipe insulation rules	none required	May change the drawing
pipe.item.connect	Connect a fixture to the nearest pipe	id	May change the drawing
pipe.item.inspect	Inspect a pipe fixture, valve or accessory	id	Does not change the drawing
pipe.item.place	Place a pipe fixture, valve or accessory	kind, at	May change the drawing
pipe.item.set	Edit a pipe fixture, valve or accessory	id	May change the drawing
pipe.loop.create	Lay a floor heating loop from a manifold outlet	manifold, spacing_mm	May change the drawing
pipe.loop.inspect	Inspect a floor heating loop	id	Does not change the drawing
pipe.loop.set	Edit a floor heating loop	id	May change the drawing
pipe.outlets.set	Set the outlets of a manifold	id, outlets	May change the drawing
pipe.preset.inspect	Inspect the preset tag of a balancing valve	id	Does not change the drawing
pipe.preset.set	Set the preset tag of a balancing valve	id	May change the drawing
pipe.product_pack	Load the piping and electrical product pack	none required	Does not change the drawing
pipe.products	List the products of a pipe or pipe item, generic first	none required	Does not change the drawing
pipe.riser	Continue a pipe as a riser through storeys	to_floor, to_height_mm	May change the drawing
pipe.set	Edit a pipe run	id	May change the drawing
pipe.settings	Set the pipe drawing defaults	none required	Does not change the drawing
pipe.size_drains	Size the sewer and storm water pipes from their fixtures	none required	May change the drawing
pipe.size_heating	Size the heating pipes	none required	May change the drawing
pipe.size_heating.preview	Preview sizing the heating pipes	none required	Does not change the drawing
pipe.size_water	Size the domestic water pipes from their water points	none required	May change the drawing
pipe.style	Set the office pipe drawing style	none required	May change the drawing
pipe.summary	Water and sewer summary from the sizing	none required	Does not change the drawing
pipe.summary.set	Set the pressure inputs of the water and sewer summary	none required	May change the drawing
pipe.summary.table	Insert a live water and sewer summary table	none required	May change the drawing
pipe.tool_height	Change the height of the pipe being drawn	none required	May change the drawing
pipe.type_bubbles	Place fixture type bubbles in a row	none required	May change the drawing
pipe.water_pressure	Water pressure on the route to each fixture	none required	Does not change the drawing
pipe.well.inspect	Inspect the levels of a well or municipal connection	id	Does not change the drawing
pipe.well.set	Set the levels of a well or municipal connection	id	May change the drawing

plan 3 commands

Command	Name	Required parameters	Drawing
plan.preview	Preview an architectural edit	command, args	Does not change the drawing
plan.problems	Inspect floor-plan problems	none required	Does not change the drawing
plan.view.rotate	Rotate plan view	none required	Does not change the drawing

point 1 command

Command	Name	Required parameters	Drawing
point.create	Create a point	at	May change the drawing

polygon 1 command

Command	Name	Required parameters	Drawing
polygon.create	Create a regular polygon	sides	May change the drawing

polyline 4 commands

Command	Name	Required parameters	Drawing
polyline.create	Create a polyline	none required	May change the drawing
polyline.segment	Make a polyline segment straight or an arc	id	May change the drawing
polyline.vertex_add	Add a polyline vertex	id, point	May change the drawing
polyline.vertex_remove	Remove a polyline vertex	id	May change the drawing

preferences 21 commands

Command	Name	Required parameters	Drawing
preferences.aliases.import	Import a command alias file	path	Does not change the drawing
preferences.aliases.list	List command aliases	none required	Does not change the drawing
preferences.aliases.remove	Remove a command alias	alias	Does not change the drawing
preferences.aliases.set	Set a command alias	alias, command	Does not change the drawing
preferences.antialiasing.set	Set window antialiasing	mode	Does not change the drawing
preferences.colours.inspect	Inspect new-project colour preference	none required	Does not change the drawing
preferences.colours.set	Set new-project colour preference	none required	Does not change the drawing
preferences.export	Export the settings to a file	path	Does not change the drawing
preferences.fonts.inspect	Inspect SHX font folders	none required	Does not change the drawing
preferences.fonts.set	Set SHX font folders	none required	Does not change the drawing
preferences.history.inspect	Inspect undo history limit	none required	Does not change the drawing
preferences.history.set	Set undo history limit	none required	Does not change the drawing
preferences.import	Import the settings from a file	path	Does not change the drawing
preferences.interface.set	Set the interface scale	none required	Does not change the drawing
preferences.language.set	Set interface language	language	Does not change the drawing
preferences.nudge.set	Set arrow-key nudge steps	none required	Does not change the drawing
preferences.opening_family.set	Set the default family of an opening product group	group, family	Does not change the drawing
preferences.save.set	Set the save format and the DWG copy	none required	Does not change the drawing
preferences.tool_family.set	Set the family a placing tool starts on	scope, family	Does not change the drawing
preferences.tool_hints.set	Show or hide the tool hints	show	Does not change the drawing
preferences.wheel.set	Set the mouse wheel	mode	Does not change the drawing

primitive 2 commands

Command	Name	Required parameters	Drawing
primitive.inspect	Inspect a drafting object	id	Does not change the drawing
primitive.set	Edit a drafting object	none required	May change the drawing

print 14 commands

Command	Name	Required parameters	Drawing
print.display_list	Inspect the print display list	none required	Does not change the drawing
print.paper.check	Check the paper against the sheets	none required	Does not change the drawing
print.presets.list	List the pen-table presets	none required	Does not change the drawing
print.printers.list	List the printers	none required	Does not change the drawing
print.run	Print sheets	none required	Does not change the drawing
print.setup.inspect	Inspect the print setup	none required	Does not change the drawing
print.setup.set_colour	Print in colour or black and white	colour	May change the drawing
print.setup.set_demolish_red	Print demolition in red	on	May change the drawing
print.setup.set_layer	Choose whether a layer prints	layer, on	May change the drawing
print.setup.set_paper	Set the printer paper size	paper	May change the drawing
print.setup.set_preset	Choose the pen table	preset	May change the drawing
print.setup.set_rotation	Set the plot page rotation	rotation_deg	May change the drawing
print.setup.set_sheets	Choose the sheets to print	sheets	May change the drawing
print.setup.set_target	Set the print output	target	May change the drawing

problems 1 command

Command	Name	Required parameters	Drawing
problems.object	List the Problems fixes of an object	id	Does not change the drawing

project 23 commands

Command	Name	Required parameters	Drawing
project.audit	Check a project file for errors and list repairs	none required	Does not change the drawing
project.autosave	Autosave recovery snapshot	none required	Does not change the drawing
project.building_use	Set the building use	building_use	May change the drawing
project.colours.inspect	Inspect project colour standard	none required	Does not change the drawing
project.colours.set	Set project colour standard	none required	May change the drawing
project.datum.inspect	Inspect the project height system	none required	Does not change the drawing
project.datum.set	Set the project height system	none required	May change the drawing
project.fire_compartment	Set whether the building is one fire compartment	one_compartment	May change the drawing
project.lock.inspect	Inspect who has the project open	none required	Does not change the drawing
project.lock.take	Take over editing of a project open elsewhere	none required	Does not change the drawing
project.new	New project	none required	May change the drawing
project.new_from_template	New project from a template	template	May change the drawing
project.new_sample	Open the sample project	uuid, operation_uuid	May change the drawing
project.one_dwelling	Set whether the water installation serves one dwelling	one_dwelling	May change the drawing
project.open	Open project	path	May change the drawing
project.recover	Recover project snapshot	none required	May change the drawing
project.recovery	Inspect recovery snapshot	none required	Does not change the drawing
project.rules_import	Load project rules	path	May change the drawing
project.save	Save project	path	Does not change the drawing
project.swatches.inspect	Inspect project swatch order	none required	Does not change the drawing
project.swatches.set	Set project swatch order	order	May change the drawing
project.templates.list	List the project templates	none required	Does not change the drawing
project.text_style	Set project technical text style	none required	May change the drawing

properties 2 commands

Command	Name	Required parameters	Drawing
properties.match	Match properties onto the selection's objects of the source kind	one_of(source|point)	May change the drawing
properties.sample	Sample an object's properties into tool defaults	one_of(source|point)	Does not change the drawing

quantities 19 commands

Command	Name	Required parameters	Drawing
quantities.assembly.delete	Delete an assembly rule	id	May change the drawing
quantities.assembly.list	List assembly rules	none required	Does not change the drawing
quantities.assembly.set	Add or replace an assembly rule	rule	May change the drawing
quantities.baseline.delete	Delete a take-off baseline	name	May change the drawing
quantities.baseline.list	List take-off baselines	none required	Does not change the drawing
quantities.baseline.save	Save a take-off baseline	name	May change the drawing
quantities.casing	Casing area of the selected duct components	ids	Does not change the drawing
quantities.diff	Compare quantities with a baseline	from	Does not change the drawing
quantities.diff.export	Export a quantity compare	from, format, path	Does not change the drawing
quantities.export	Export the quantity take-off	format, path	Does not change the drawing
quantities.highlight	Highlight counted and uncounted objects	on	Does not change the drawing
quantities.list	List the Material take-off of one trade tab	tab	Does not change the drawing
quantities.manual.add	Add a manual quantity row	item_key, qty, unit	May change the drawing
quantities.manual.delete	Delete a manual quantity row	index	May change the drawing
quantities.preset.delete	Delete a take-off filter preset	name	May change the drawing
quantities.preset.list	List take-off filter presets	none required	Does not change the drawing
quantities.preset.save	Save a take-off filter preset	name	May change the drawing
quantities.problems	List take-off problems	none required	Does not change the drawing
quantities.report	Report the quantity take-off	none required	Does not change the drawing

query 1 command

Command	Name	Required parameters	Drawing
query	Query drawing objects	none required	Does not change the drawing

rainwater 1 command

Command	Name	Required parameters	Drawing
rainwater.accept	Accept converted gutters and downpipes	ids	Does not change the drawing

rectangle 1 command

Command	Name	Required parameters	Drawing
rectangle.create	Create a rectangle	corner1, corner2	May change the drawing

reference 10 commands

Command	Name	Required parameters	Drawing
reference.align	Align a 3D reference model	id, mode	May change the drawing
reference.element	Show a reference model element	point_mm	Does not change the drawing
reference.elements	List reference model elements	id	Does not change the drawing
reference.inspect	Inspect 3D reference models	none required	Does not change the drawing
reference.layer_visibility	Show or hide 3D reference model layers	id, visible	May change the drawing
reference.layers	List 3D reference model layers	id	Does not change the drawing
reference.remove	Remove a 3D reference model	id	May change the drawing
reference.rotate	Rotate a 3D reference model	id, angle_deg	May change the drawing
reference.slices	Show 3D reference plan slices	none required	Does not change the drawing
reference.update	Update a 3D reference model	id	May change the drawing

region 4 commands

Command	Name	Required parameters	Drawing
region.intersect	Keep the overlap of closed outlines	none required	May change the drawing
region.properties	Area, centroid and perimeter of closed outlines	none required	Does not change the drawing
region.subtract	Subtract closed outlines from others	remove	May change the drawing
region.union	Unite closed outlines	none required	May change the drawing

render 1 command

Command	Name	Required parameters	Drawing
render	Render plan in session	none required	Does not change the drawing

report 1 command

Command	Name	Required parameters	Drawing
report.quantities	Report the quantity take-off (alias)	none required	Does not change the drawing

responsibility 3 commands

Command	Name	Required parameters	Drawing
responsibility.list	List supply and installation responsibilities	none required	Does not change the drawing
responsibility.own_contract	Set the project's own contract	code	May change the drawing
responsibility.set	Set supply and installation responsibility	none required	May change the drawing

revcloud 1 command

Command	Name	Required parameters	Drawing
revcloud.create	Create a revision cloud	none required	May change the drawing

revision 6 commands

Command	Name	Required parameters	Drawing
revision.add	Add a revision	none required	May change the drawing
revision.delete	Delete a revision row	ordinal	May change the drawing
revision.delta.create	Create a revision delta	at	May change the drawing
revision.delta.set	Change a revision delta	id	May change the drawing
revision.set_series	Set the revision ID series	series	May change the drawing
revision.update	Update a revision row	ordinal	May change the drawing

roof 2 commands

Command	Name	Required parameters	Drawing
roof.covering.set	Set the roof covering	roofs, material	May change the drawing
roof.settings	Set the roof tool defaults	none required	Does not change the drawing

roof_item 3 commands

Command	Name	Required parameters	Drawing
roof_item.groups	List the roof-safety product groups	none required	Does not change the drawing
roof_item.place	Place a roof-safety product	group, position_mm	May change the drawing
roof_item.set	Edit a roof-safety product	id	May change the drawing

roof_line 3 commands

Command	Name	Required parameters	Drawing
roof_line.derive	Derive the roof lines from the roof planes	none required	May change the drawing
roof_line.draw	Draw a roof line	points, line	May change the drawing
roof_line.set	Edit a roof line label	id	May change the drawing

roof_plane 2 commands

Command	Name	Required parameters	Drawing
roof_plane.draw	Draw a roof plane	points, slope	May change the drawing
roof_plane.set	Edit a roof plane	id	May change the drawing

room 6 commands

Command	Name	Required parameters	Drawing
room.defaults	Set manual room creation defaults	none required	Does not change the drawing
room.delete	Delete room or clear auto room fields	none required	May change the drawing
room.manual	Draw a manual room	polygon	May change the drawing
room.move	Move a room	delta	May change the drawing
room.set	Edit room fields	none required	May change the drawing
room.types	List the room types of the table	none required	Does not change the drawing

run 6 commands

Command	Name	Required parameters	Drawing
run.branch	Branch a duct, pipe, cable route, wire or line from a point on it	id, points	May change the drawing
run.continue	Continue a duct, pipe, cable route, wire or line from its free end	id, points	May change the drawing
run.ends	List the free ends of a duct, pipe, cable route, wire or line	id	Does not change the drawing
run.preview	Preview continuing or branching a duct, pipe, cable route, wire or line	id, points	Does not change the drawing
run.segment.move	Move a straight segment of a run sideways; what is joined to it follows	id	May change the drawing
run.size.step	Step the size of a duct run, pipe or cable route	step	May change the drawing

section_marker 3 commands

Command	Name	Required parameters	Drawing
section_marker.inspect	Inspect a section mark and its section view	id	Does not change the drawing
section_marker.place	Place a section mark on the plan	cut_mm	May change the drawing
section_marker.set	Edit a section mark	id	May change the drawing

selection 15 commands

Command	Name	Required parameters	Drawing
selection.action_state	Inspect whether a selection action has an effect	command, args	Does not change the drawing
selection.all	Select all on active storey	none required	Does not change the drawing
selection.deselect	Deselect	none required	Does not change the drawing
selection.direct	Pick a leaf object, wall node or contour vertex	point	Does not change the drawing
selection.fence	Fence selection	points	Does not change the drawing
selection.groups	Select groups as a whole	enabled	Does not change the drawing
selection.invert	Invert active-storey selection	none required	Does not change the drawing
selection.marquee	Window or crossing selection	p1, p2	Does not change the drawing
selection.mirror	Mirror selection about its common centre	none required	May change the drawing
selection.pick	Pick an entity	point	Does not change the drawing
selection.polygon	Window or crossing polygon selection	points	Does not change the drawing
selection.query	Select by properties	where	Does not change the drawing
selection.reselect	Reselect the previous selection	none required	Does not change the drawing
selection.set	Set selection	none required	Does not change the drawing
selection.similar	Select similar kind and properties	none required	Does not change the drawing

sensor 1 command

Command	Name	Required parameters	Drawing
sensor.place	Place a control sensor	owner_ref, code, position_mm	May change the drawing

service_zone 3 commands

Command	Name	Required parameters	Drawing
service_zone.draw	Draw a machine service zone	points	May change the drawing
service_zone.from_machine	Add the service zone in front of a machine	machine	May change the drawing
service_zone.set	Edit a service zone	id	May change the drawing

sheet 29 commands

Command	Name	Required parameters	Drawing
sheet.add	Add a drawing sheet	none required	May change the drawing
sheet.bring_inside	Move the views outside the drawing area back inside	none required	May change the drawing
sheet.delete	Delete a page	sheet	May change the drawing
sheet.duplicate	Duplicate a sheet with its views	none required	May change the drawing
sheet.from_3d_view	Create sheet of this view in 3D: a new page with the 3D system view at the camera's angle	azimuth_deg, elevation_deg	May change the drawing
sheet.from_view	Create a sheet of the current plan view	model_bounds	May change the drawing
sheet.image.place	Place an image on the sheet	path	May change the drawing
sheet.image.remove	Remove a sheet image	id	May change the drawing
sheet.image.set	Move or resize a sheet image	id, rect_mm	May change the drawing
sheet.inspect	Inspect sheets, layout and fit	none required	Does not change the drawing
sheet.issue	Mark sheets as issued (julkaistu)	none required	May change the drawing
sheet.issue_status	Show which sheets changed since their issue	none required	Does not change the drawing
sheet.margin_text.set	Set the sheet margin texts (file path line, issue stage)	none required	May change the drawing
sheet.pages	List the document's pages per trade	none required	Does not change the drawing
sheet.place_content	Place the drawing with a generous margin	none required	May change the drawing
sheet.render	Render a sheet as SVG	none required	Does not change the drawing
sheet.set_active	Make a sheet the working sheet	sheet	May change the drawing
sheet.set_guides	Show or hide non-printing guides	on	May change the drawing
sheet.set_layout	Set a sheet's title block layout	layout	May change the drawing
sheet.set_scale	Set the sheet or view scale	scale	May change the drawing
sheet.set_size	Set the sheet size	size	May change the drawing
sheet.set_switches	Set the per-sheet switches	none required	May change the drawing
sheet.view.clip	Clip a view	none required	May change the drawing
sheet.view.inspect	Inspect the view settings	none required	Does not change the drawing
sheet.view.layer.set	Set a layer in this view only	layer, mode	May change the drawing
sheet.view.lock_scale	Lock the view scale	locked	May change the drawing
sheet.view.only_layers	Show only these layers in this view	none required	May change the drawing
sheet.view.set_title	Set the view title style	none required	May change the drawing
sheet.zone.resize	Resize a sheet zone	handle, value_mm	May change the drawing

site 8 commands

Command	Name	Required parameters	Drawing
site.deviations	Compare measured and design airflows	none required	Does not change the drawing
site.discard	Discard rows from the measurement review	none required	May change the drawing
site.export	Export the design for aeris-mittari (.aeris)	path, date	Does not change the drawing
site.import	Import site measurements (.aeris)	none required	May change the drawing
site.match	Match a measured row to a terminal	row, terminal	May change the drawing
site.north.set	Set true north	north_deg	May change the drawing
site.overlay	Show the airflow deviation overlay	visible	Does not change the drawing
site.tolerance	Set the airflow tolerance	none required	May change the drawing

site_object 4 commands

Command	Name	Required parameters	Drawing
site_object.create	Place a terrace, canopy, railing, spot level or facade sign	kind	May change the drawing
site_object.inspect	Inspect a terrace, canopy, railing, spot level or facade sign	id	Does not change the drawing
site_object.set	Edit a terrace, canopy, railing, spot level or facade sign	id	May change the drawing
site_object.settings	Set the terrace, canopy, railing and spot level tool defaults	none required	Does not change the drawing

siteplan 16 commands

Command	Name	Required parameters	Drawing
siteplan.assign	Give a drawn object a site plan meaning	id, kind	May change the drawing
siteplan.building.place	Place a building from the model on the site plan	storey	May change the drawing
siteplan.building.refresh	Read building outlines from the model again	none required	May change the drawing
siteplan.connection.place	Place a municipal connection point	position_mm, utility	May change the drawing
siteplan.create	Create the site plan	none required	May change the drawing
siteplan.draw	Draw a site plan line or area	kind, points	May change the drawing
siteplan.edit	Edit a site plan object	id	May change the drawing
siteplan.entrance.place	Place an entrance mark	position_mm	May change the drawing
siteplan.inspect	List the site plan objects	none required	Does not change the drawing
siteplan.north.place	Place the north arrow	position_mm	May change the drawing
siteplan.parking.row	Lay a row of parking places	position_mm, count	May change the drawing
siteplan.scalebar.place	Place the scale bar	position_mm	May change the drawing
siteplan.set	Edit the site plan settings	none required	May change the drawing
siteplan.survey.place	Place a base-map survey point	position_mm, level_m	May change the drawing
siteplan.terrain.place	Place a terrain point	position_mm, level_m	May change the drawing
siteplan.well.place	Place a yard well or manhole	position_mm, code, lid_m	May change the drawing

slab_opening 3 commands

Command	Name	Required parameters	Drawing
slab_opening.create	Create a slab opening or shaft	polygon	May change the drawing
slab_opening.defaults	Set slab opening creation defaults	none required	Does not change the drawing
slab_opening.set	Edit a slab opening or shaft	none required	May change the drawing

snap 5 commands

Command	Name	Required parameters	Drawing
snap.modifier	Build the next point from other points	none required	Does not change the drawing
snap.override	Use one snap kind, or none, for the next point	none required	Does not change the drawing
snap.query	Snap a point	point	Does not change the drawing
snap.settings	Set snapping	none required	Does not change the drawing
snap.track	Acquire or release a smart-guide tracking point	none required	Does not change the drawing

span_mark 1 command

Command	Name	Required parameters	Drawing
span_mark.create	Create a span mark	start, end	May change the drawing

spatial 4 commands

Command	Name	Required parameters	Drawing
spatial.batch	Apply spatial records atomically	operations	May change the drawing
spatial.inspect	Inspect spatial model records	none required	Does not change the drawing
spatial.remove	Remove a spatial model record	kind, id	May change the drawing
spatial.upsert	Set a spatial model record	kind, value	May change the drawing

spell 6 commands

Command	Name	Required parameters	Drawing
spell.add_word	Add a word to the project spelling dictionary	word	May change the drawing
spell.check	Check the spelling of the drawing texts	none required	Does not change the drawing
spell.ignore	Ignore a word in spelling checks until the project is closed	word	Does not change the drawing
spell.remove_word	Remove a word from the project spelling dictionary	word	May change the drawing
spell.replace	Replace a misspelled word with the chosen spelling	kind, place, id, at, word, replacement	May change the drawing
spell.status	Show the spelling languages, their checkers and the project dictionary	none required	Does not change the drawing

spline 2 commands

Command	Name	Required parameters	Drawing
spline.create	Create a spline through fit points or on control vertices	none required	May change the drawing
spline.edit	Edit a spline: fit points or control vertices, close, add or remove a point	id	May change the drawing

stair 2 commands

Command	Name	Required parameters	Drawing
stair.create	Create a stair	position_mm	May change the drawing
stair.set	Edit a stair	id, params	May change the drawing

storey 5 commands

Command	Name	Required parameters	Drawing
storey.activate	Activate a storey	one_of(id|storey)	Does not change the drawing
storey.add	Add storey above or below	none required	May change the drawing
storey.delete	Delete a storey after reviewing its object counts	none required	May change the drawing
storey.inspect	Inspect storey fields and object counts	none required	Does not change the drawing
storey.set	Edit storey levels and heights	none required	May change the drawing

structure_type 4 commands

Command	Name	Required parameters	Drawing
structure_type.assign	Assign a structure type	code	May change the drawing
structure_type.list	List the structure types	none required	Does not change the drawing
structure_type.remove	Remove a structure type	code	May change the drawing
structure_type.set	Set a structure type	code	May change the drawing

support 5 commands

Command	Name	Required parameters	Drawing
support.add	Add a support	run	May change the drawing
support.delete	Delete a support	id	May change the drawing
support.list	List supports	none required	Does not change the drawing
support.move	Move a support	id	May change the drawing
support.place	Show supports on this storey	none required	May change the drawing

symbols 2 commands

Command	Name	Required parameters	Drawing
symbols.inspect	Inspect a drawing symbol	id	Does not change the drawing
symbols.list	List drawing symbols	none required	Does not change the drawing

system 2 commands

Command	Name	Required parameters	Drawing
system.add	Add a ventilation system	kind, name	May change the drawing
system.set	Set a ventilation system's design airflow, exhaust air class or tightness class	id	May change the drawing

table 26 commands

Command	Name	Required parameters	Drawing
table.cell.set	Edit a table cell	id, row, column	May change the drawing
table.cells.set	Fill table cells	id, values	May change the drawing
table.columns.delete	Delete table columns	id, at	May change the drawing
table.columns.insert	Insert table columns	id, at	May change the drawing
table.create	Insert a table	rows, columns	May change the drawing
table.delete	Delete a table	none required	May change the drawing
table.drawing_list	Insert a drawing list	none required	May change the drawing
table.equipment_list	Insert an equipment list	none required	May change the drawing
table.export	Export a table to CSV or Excel	id, path	Does not change the drawing
table.fixture_schedule	Insert the fixture and accessory schedule	none required	May change the drawing
table.import	Import a table from a CSV or Excel file	path	May change the drawing
table.inspect	Inspect tables	none required	Does not change the drawing
table.link	Link a table to the quantity take-off	id	May change the drawing
table.luminaire_list	Insert a luminaire list	none required	May change the drawing
table.machine_card	Insert a machine card	device	May change the drawing
table.merge	Merge cells	id, row, column, rows, columns	May change the drawing
table.move	Move tables on the sheet	delta_mm	May change the drawing
table.product_list	Insert a product list	none required	May change the drawing
table.refresh	Refresh linked tables	none required	May change the drawing
table.room_airflows	Insert a room airflow table	none required	May change the drawing
table.rows.delete	Delete table rows	id, at	May change the drawing
table.rows.insert	Insert table rows	id, at	May change the drawing
table.set	Format a table	id	May change the drawing
table.style	Apply a table style	id	May change the drawing
table.unmerge	Unmerge cells	id, row, column	May change the drawing
table.zone_terminals	Insert a zone terminal box	zone	May change the drawing

tag 10 commands

Command	Name	Required parameters	Drawing
tag.create	Create tag	targets, style	May change the drawing
tag.delete	Delete tags	ids	May change the drawing
tag.move	Move tag	id	May change the drawing
tag.place	Place tag	one_of(target|point)	May change the drawing
tag.reset	Reset tag placement	ids	May change the drawing
tag.set	Set tag	id	May change the drawing
tag.stack	Stack tags	targets	May change the drawing
tag.text	Type a tag's text: a new size resizes the duct, free text after it is kept	id, text	May change the drawing
tag.update	Update tag	id	May change the drawing
tag.values	Set tag values of an element	element	May change the drawing

tags 5 commands

Command	Name	Required parameters	Drawing
tags.settings	Tag settings	none required	May change the drawing
tags.sheet	Inspect the tags of a storey	none required	Does not change the drawing
tags.template.remove	Remove a tag template	id	May change the drawing
tags.template.set	Add or replace a tag template	template	May change the drawing
tags.templates	List the tag templates	none required	Does not change the drawing

terminal 12 commands

Command	Name	Required parameters	Drawing
terminal.change_model	Change an air terminal model	id, operation_uuid	May change the drawing
terminal.connect	Connect an air terminal	terminal, operation_uuid	May change the drawing
terminal.connect_all	Connect all air terminals	operation_uuid	May change the drawing
terminal.connection_preview	Preview an air terminal connection	terminal	Does not change the drawing
terminal.connection_report	Inspect terminal connections	none required	Does not change the drawing
terminal.defaults	Set terminal placement options	none required	Does not change the drawing
terminal.inspect	Inspect an air terminal	id	Does not change the drawing
terminal.place	Place an air terminal	position_mm, operation_uuid	May change the drawing
terminal.preview	Preview an air terminal	position_mm	Does not change the drawing
terminal.set	Edit an air terminal	id	May change the drawing
terminal.size_setting	Calculate the valve setting from the K-curve	none required	May change the drawing
terminal.update	Edit an air terminal	id	May change the drawing

text 10 commands

Command	Name	Required parameters	Drawing
text.case	Change text case	mode	May change the drawing
text.create	Create a text annotation box	position_mm, size_mm	May change the drawing
text.defaults	Set or reset text creation defaults	none required	Does not change the drawing
text.find	Find text in the drawing	query	Does not change the drawing
text.inspect	Inspect a text box and effective text layout	none required	Does not change the drawing
text.number	Number texts in sequence	none required	May change the drawing
text.readable	Make texts readable	none required	May change the drawing
text.replace	Replace text in the drawing	query, replacement	May change the drawing
text.run.set	Set the style of one text line	line	May change the drawing
text.set	Edit a text annotation	none required	May change the drawing

text_style 1 command

Command	Name	Required parameters	Drawing
text_style.inspect	Inspect project text style and bundled font choices	none required	Does not change the drawing

titleblock 6 commands

Command	Name	Required parameters	Drawing
titleblock.extra_fields	Set the named title block fields	extra_fields	May change the drawing
titleblock.extra_value	Set a named title block field on one sheet	name	May change the drawing
titleblock.image.set	Set a title block image	slot	May change the drawing
titleblock.reset_override	Restore the project value on a sheet	field	May change the drawing
titleblock.set	Set a title block field	field, value	May change the drawing
titleblock.set_options	Set the optional title block items	none required	May change the drawing

tool 9 commands

Command	Name	Required parameters	Drawing
tool.activate	Activate editor tool	tool	May change the drawing
tool.back	Remove last drawing point	none required	Does not change the drawing
tool.cancel	Cancel active drawing	none required	May change the drawing
tool.defaults	Set wall creation defaults	none required	Does not change the drawing
tool.families	List a placing tool's families	none required	Does not change the drawing
tool.finish	Finish active drawing	none required	May change the drawing
tool.input	Accept drawing point	point	May change the drawing
tool.preview	Preview drawing input	point	Does not change the drawing
tool.set_mode	Set standard or permanent tool mode	tool, permanent	May change the drawing

trade 2 commands

Command	Name	Required parameters	Drawing
trade.slot	Choose a trade's quick slot	trade	Does not change the drawing
trade.slots	List a trade's quick slots	trade	Does not change the drawing

ui 4 commands

Command	Name	Required parameters	Drawing
ui.help.guide	User guide…	none required	Does not change the drawing
ui.pick_answer	Answer the open pick request	request	Does not change the drawing
ui.pick_result	Read the answer to a pick request	request	Does not change the drawing
ui.request_pick	Ask the person at the window to pick objects or a point	kind, prompt	Does not change the drawing

underlay 50 commands

Command	Name	Required parameters	Drawing
underlay.adjust	Adjust underlay brightness, contrast and fade	none required	May change the drawing
underlay.align	Align underlay by point pairs	p1, p2	May change the drawing
underlay.cad.layer_visibility	Show or hide DWG/DXF underlay layers	visible	May change the drawing
underlay.cad.layers	List DWG/DXF underlay layers	none required	Does not change the drawing
underlay.calibrate	Calibrate underlay	p1, p2, distance_mm	May change the drawing
underlay.clip	Clip underlay to a boundary	none required	May change the drawing
underlay.compare	Compare an underlay with its previous issue	old, new	May change the drawing
underlay.compare.clear	Clear the revision compare	none required	Does not change the drawing
underlay.compare.clouds	Revision clouds and change list from the compare	none required	May change the drawing
underlay.detect_rooms	Detect rooms on an underlay	none required	Does not change the drawing
underlay.deviations	Find deviations between two drawings	b	Does not change the drawing
underlay.deviations.clear	Clear the drawing deviations	none required	Does not change the drawing
underlay.find_similar	Find symbols like the picked one	window_mm	Does not change the drawing
underlay.find_text	Find text on an underlay	text	Does not change the drawing
underlay.fit	Fit an underlay to the master by points	id, pairs	May change the drawing
underlay.grip	Drag underlay transform handle	id, handle, point	May change the drawing
underlay.grip_preview	Preview underlay transform handle	id, handle, point	Does not change the drawing
underlay.import	Import underlay	path	May change the drawing
underlay.layer.hide	Hide the underlay layer picked on the plan	none required	May change the drawing
underlay.legend	Count the legend's symbols on the underlay	window_mm	Does not change the drawing
underlay.ocr	Read the text of a scan or photo underlay (OCR)	none required	May change the drawing
underlay.ocr.clear	Remove the OCR text layer of an underlay	none required	May change the drawing
underlay.page	Choose PDF/TIFF page	page	May change the drawing
underlay.preview	Save preview PNG	path	Does not change the drawing
underlay.read_list	Read an equipment or fixture list from an underlay	none required	Does not change the drawing
underlay.read_tags	Read tags on an underlay back into data	none required	Does not change the drawing
underlay.recognise_text	Recognise line-drawn SHX text on a PDF underlay	none required	May change the drawing
underlay.reconcile.suggest	Suggest objects from the master drawing	none required	Does not change the drawing
underlay.rectify	Correct underlay perspective	none required	May change the drawing
underlay.relink	Relink original asset	path	May change the drawing
underlay.review.accept	Accept underlay review proposals	review	May change the drawing
underlay.review.close	Close an underlay review	review	Does not change the drawing
underlay.review.list	List underlay review proposals	none required	Does not change the drawing
underlay.review.place	Place a product at symbol matches	review	May change the drawing
underlay.review.reject	Reject underlay review proposals	review	Does not change the drawing
underlay.rotate_align	Rotate underlay to horizontal	p1, p2	May change the drawing
underlay.scale_check	Check an underlay scale	q1, q2, stated_mm	May change the drawing
underlay.scale_text	Scale an underlay from its own scale text	none required	May change the drawing
underlay.send_back	Send underlay to back	none required	May change the drawing
underlay.set_master	Make an underlay the master drawing	id	May change the drawing
underlay.set_trade	Set the trade of an underlay	id, trade	May change the drawing
underlay.shift	Shift an underlay	id, offset_mm	May change the drawing
underlay.swap	Replace the underlay file, keeping its settings	path	May change the drawing
underlay.to_drawing	Convert a DWG or DXF underlay into drawing objects	id	May change the drawing
underlay.trace	Trace walls, openings, rooms and ducts from an underlay	none required	Does not change the drawing
underlay.trade_display	Show or fade every drawing of a trade	trade	May change the drawing
underlay.unlock	Open a password-protected PDF underlay	password	Does not change the drawing
underlay.update	Edit underlay	none required	May change the drawing
underlay.vectors	Inspect what tracing reads from an underlay	none required	Does not change the drawing
underlay.view_align	Place a side view underlay by a level line and a grid axis	id, level_point, level_mm, axis_point, axis_mm	May change the drawing

valve 2 commands

Command	Name	Required parameters	Drawing
valve.airflow_at	Valve airflow at a setting and a pressure	id, setting, dp_pa	Does not change the drawing
valve.setting_for	Valve setting for an airflow and a pressure	id, dp_pa	Does not change the drawing

vent 5 commands

Command	Name	Required parameters	Drawing
vent.generic.fit_duct	Insert reducers between a product and its duct	id, operation_uuid	May change the drawing
vent.generic.place	Place a generic ventilation product	generic, operation_uuid	May change the drawing
vent.generic.set	Name a generic ventilation product	id	May change the drawing
vent.products	List the products of a ventilation object, generic first	id	Does not change the drawing
vent.room_airflows	Read the room airflows of the three operating modes	none required	Does not change the drawing

view 43 commands

Command	Name	Required parameters	Drawing
view.add	Add a view to a sheet	none required	May change the drawing
view.align	Align a view with a view on another sheet	view, to_view	May change the drawing
view.apply	Apply a saved view	id	Does not change the drawing
view.colours	Show colour settings	none required	Does not change the drawing
view.delete	Remove a view from a sheet	view	May change the drawing
view.fade_locked	Fade locked objects	none required	Does not change the drawing
view.fit	Fit plan to canvas	canvas_width_px, canvas_height_px	Does not change the drawing
view.ghost_room_labels	Show room labels on adjacent storeys	none required	Does not change the drawing
view.go_to	Go to a problem location	point_mm	Does not change the drawing
view.grid	Show drawing grid	visible	Does not change the drawing
view.guides	Set layout-guide visibility, lock and smart guides	none required	Does not change the drawing
view.home	Show start view	visible	Does not change the drawing
view.inspect	Inspect a saved view or workspace	none required	Does not change the drawing
view.isometric	Add or change an isometric view on a sheet	none required	May change the drawing
view.isometric.inspect	Inspect an isometric view	view	Does not change the drawing
view.library	Show Library or Systems in the dock	none required	Does not change the drawing
view.list	List saved views	none required	Does not change the drawing
view.move	Move a view on its sheet	view, dx_mm, dy_mm	May change the drawing
view.next	Next view	none required	Does not change the drawing
view.pan	Pan canvas	dx, dy	Does not change the drawing
view.preset	Apply a derived view preset	preset, canvas_width_px, canvas_height_px	Does not change the drawing
view.previous	Previous view	none required	Does not change the drawing
view.remove	Remove a saved view	id	May change the drawing
view.reset	Home view	canvas_width_px, canvas_height_px	Does not change the drawing
view.room_labels	Show room labels	none required	Does not change the drawing
view.rulers	Show or hide rulers	visible	Does not change the drawing
view.save	Save a complete view	view	May change the drawing
view.scenario	Show an airflow scenario	id	Does not change the drawing
view.side.inspect	Inspect side view	view	Does not change the drawing
view.side.pick	Pick in side view	view, at	Does not change the drawing
view.side.save	Save side view	spec	May change the drawing
view.side_place	Place a section or an elevation on a sheet	none required	May change the drawing
view.side_remove	Remove a section or elevation view from a sheet	view	May change the drawing
view.symbols	Browse drawing symbols	none required	Does not change the drawing
view.system	Select active ventilation system	none required	Does not change the drawing
view.system.cycle	Cycle active system swatches	none required	Does not change the drawing
view.system.swap	Swap active system swatches	none required	Does not change the drawing
view.text_style	Show project text style in Properties	none required	Does not change the drawing
view.trade	Show a trade's tools	trade	Does not change the drawing
view.units	Set ruler units, precision and extent markers	none required	Does not change the drawing
view.update	Update a view on a sheet	view	May change the drawing
view.visibility	Set workspace visibility	settings	Does not change the drawing
view.zoom	Zoom canvas	factor	Does not change the drawing

view3d 8 commands

Command	Name	Required parameters	Drawing
view3d.camera.axis	Look from a direction	axis	Does not change the drawing
view3d.camera.home	3D overview	none required	Does not change the drawing
view3d.camera.set	Set 3D camera	eye_mm, target_mm	Does not change the drawing
view3d.render_image	Render image	path, width, height	Does not change the drawing
view3d.view.delete	Delete 3D view	id	May change the drawing
view3d.view.recall	Recall 3D view	id	Does not change the drawing
view3d.view.rename	Rename 3D view	id, name	May change the drawing
view3d.view.save	Save 3D view	name	May change the drawing

view_level 2 commands

Command	Name	Required parameters	Drawing
view_level.place	Place side-view level	view, at	May change the drawing
view_level.remove	Remove side-view level	view, id	May change the drawing

visibility 1 command

Command	Name	Required parameters	Drawing
visibility.defaults.set	Set project visibility defaults	settings	May change the drawing

wall 18 commands

Command	Name	Required parameters	Drawing
wall.arc	Draw a true arc wall	start, end, through	May change the drawing
wall.chain	Draw a wall chain	points	May change the drawing
wall.delete	Delete a wall	none required	May change the drawing
wall.detach	Detach a wall	none required	May change the drawing
wall.facade.set	Set the facade of walls	walls, bands	May change the drawing
wall.flip_sides	Flip wall sides	none required	May change the drawing
wall.make_arc	Bend a wall	sweep	May change the drawing
wall.make_straight	Make a wall straight	none required	May change the drawing
wall.measure	Measure a wall inside face	none required	Does not change the drawing
wall.move	Move a wall	delta	May change the drawing
wall.move_corner	Move a joined corner	node, to	May change the drawing
wall.move_end	Move a wall end	end, to	May change the drawing
wall.presets	List project wall presets	none required	Does not change the drawing
wall.room_rect	Draw a rectangular room	p1, p2	May change the drawing
wall.set_length	Set anchored wall length	value	May change the drawing
wall.set_properties	Set wall type and style	none required	May change the drawing
wall.set_thickness	Set anchored wall thickness	value	May change the drawing
wall.split	Split a wall	none required	May change the drawing

wipeout 1 command

Command	Name	Required parameters	Drawing
wipeout.create	Create a mask	none required	May change the drawing

zone 4 commands

Command	Name	Required parameters	Drawing
zone.create	Create a location zone	name	May change the drawing
zone.delete	Delete a location zone	id	May change the drawing
zone.list	List location zones	none required	Does not change the drawing
zone.set	Edit a location zone	id	May change the drawing

Back: AI and automation