Commands  ›   ›  Create Filter

Create Filter

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. At least one valid BuiltInCategory must be provided. For parameter filters, the BuiltInParameter must exist on the target categories.

After it runs

A new ParameterFilterElement is created in the document. Result JSON stored in LastQueryResult with success flag, filterId, filterName.

When to use this

Don't use this when

Applying filters to views (use ApplyFilterToViewCommand). Deleting or modifying existing filters. Creating sheet filters or schedule filters.

Inputs

NameKindTypeRequiredDefaultDescription
filterName config string no New filter name
categories config string no Comma-separated BuiltInCategory names
parameter config string no Optional BuiltInParameter name for string rule
value config string no Optional string value for parameter rule
rule config string no Optional rule: equals|contains|beginswith|endswith|notequals

Returns

NameTypeDescription
ResultJSONFilter creation result with success, filterId, filterName

What you'll see in the chat

on start
Creating a new view filter...
Setting up the filter now...
thinking
Parsing category list...
Checking parameter rule configuration...
Creating filter element in document...
on success
Filter "{filterName}" created successfully (ID: {filterId}).
on failure
Filter creation failed: {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_filter
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

create filter · create view filter · create parameter filter · view filter · MEP filter
Patterns: create * filter · create * view filter · make * filter · new * filter

Related commandsApplyFilterToViewCommand · ListFiltersCommand
Pillar