Commands › › Select By Workset
Select By Workset
Coming soon
Before you run this
Document must be workshared. Target workset must exist.
After it runs
Revit selection is replaced with elements from the matching workset. Returns JSON summary with count and scope.
When to use this
- User says "select all elements on the drainage workset".
- User wants to isolate a specific workset's elements for review.
- User needs to count or inspect elements assigned to a workset.
Don't use this when
Changing workset assignments (use MoveToWorksetCommand). Creating or deleting worksets. Selecting by category (use SelectByCategoryCommand).
Inputs
| Name | Kind | Type | Required | Default | Description |
|---|---|---|---|---|---|
worksetName |
config | string |
no | — | Workset name to match |
scope |
config | string |
no | "view" | view (default) or model |
Returns
| Name | Type | Description |
|---|---|---|
Selection | ElementId[] | Selected IDs |
Summary | JSON | Selection summary |
What you'll see in the chat
on start
Selecting elements from the requested workset...
Finding elements on that workset...
Finding elements on that workset...
thinking
Resolving workset name...
Collecting elements on workset...
Updating selection...
Collecting elements on workset...
Updating selection...
on success
Selected {totalSelected} elements from workset "{workset}"
on failure
Couldn't select by workset: {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/select_by_workset- Request body schema (from
[RestApiParam]) - Response schema (from
[RestApiResponse]) - curl / JS / Python code examples
Keywords & intent patterns
select by workset · select workset · workset selection · select mep workset
Patterns: select * workset · select by * workset · select elements * workset
Related
| Related commands | SelectByCategoryCommand · FilterSelectionCommand |
|---|---|
| Pillar |