Commands  ›  General  ›  Create Sheet

Create Sheet

General writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. At least one titleblock family must be loaded in the project.

After it runs

A new ViewSheet is created in the document with the specified number and name. Titleblock is placed on the sheet. Sheet is ready for views to be placed.

When to use this

Don't use this when

Placing views on an existing sheet (use PlaceViewOnSheetCommand). Creating multiple sheets in batch (use SheetSetUpCommand).

Inputs

NameKindTypeRequiredDefaultDescription
titleblockId config int no Element ID of titleblock to use
titleblockName config string no Name of titleblock family to use
sheetNumber config string no "auto" Sheet number (auto-generated if not provided)
sheetName config string no "General Arrangement" Sheet name

Returns

NameTypeDescription
CreatedSheetViewSheetThe created sheet
SheetNumberstringThe assigned sheet number

What you'll see in the chat

on start
Creating a new drawing sheet...
Setting up your sheet...
thinking
Finding available titleblocks...
Generating next sheet number...
Creating sheet with titleblock...
on success
Sheet {SheetNumber} created: {SheetName}
on failure
Couldn't create sheet: {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_sheet
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

create sheet · make sheet · new sheet · add sheet · drawing sheet
Patterns: create * sheet · make * sheet · new * sheet · add * sheet

Related commandsCreateViewsCommand · PlaceViewOnSheetCommand
PillarGeneral