Commands  ›  General  ›  Create Floorplan

Create Floorplan

General writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. Target level must exist in the model.

After it runs

A new ViewPlan (FloorPlan) is created on the given level with optional scope box and template applied.

When to use this

Don't use this when

Creating reflected ceiling plans (use CreateReflectedCeilingPlanCommand). Creating section views (use CreateSectionFromGridlineCommand).

Inputs

NameKindTypeRequiredDefaultDescription
levelName config string no — Target level name (required if levelId not provided).
levelId config integer no — Target level id (optional).
viewName config string no — Optional view name.
scopeBoxName config string no — Optional scope box name to apply.
templateName config string no — Optional template name to apply.
scale config integer no — Optional view scale (default 100).

Returns

NameTypeDescription
ResultobjectCreated view id, name, level, type.

What you'll see in the chat

on start
Creating floor plan view...
Setting up a new floor plan...
thinking
Resolving target level...
Creating floor plan view...
Applying scope box and template...
on success
Floor plan created: {viewName}
on failure
Could not create floor plan: {error}

REST API

Not yet exposed

This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:

  • POST /api/v1/commands/create_floorplan
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

create floor plan · create floorplan · new floor plan · floor plan view
Patterns: create * floor plan · new * floor plan · floor plan * level

Related commandsCreateReflectedCeilingPlanCommand · CopyMonitorLevelsCommand
PillarGeneral