Commands  ›   ›  Add Filter To Template

Add Filter To Template

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active document must be open. Both the target view template and the filter must already exist in the project.

After it runs

The specified filter is added to the template's filter list with the given visibility setting. If the filter was already present, it remains (idempotent).

When to use this

Don't use this when

Creating new filters (use a dedicated CreateFilterCommand). Applying templates to views (use ApplyViewTemplateCommand). Removing filters from templates.

Inputs

NameKindTypeRequiredDefaultDescription
templateName config string no Target view template name
filterName config string no Filter name to add
visible config boolean no true Optional visibility flag (default true)

Returns

NameTypeDescription
ResultJSONAdd filter to template result

What you'll see in the chat

on start
Adding filter to the view template...
Assigning the filter to your template now...
thinking
Resolving template by name...
Resolving filter by name...
Adding filter to template with visibility setting...
on success
Filter '{filterName}' added to template '{templateName}' successfully.
on failure
Could not add filter to template: {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/add_filter_to_template
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

add filter to template · apply filter to template · template filter · view filter template · assign filter template

Related commandsApplyViewTemplateCommand
Pillar