---
url: "https://vueda.dev/v3/reference/api/py/vueda.workflow.filtersets.md"
title: "workflow.filtersets"
---

# workflow.filtersets

## Overview

Django-filter FilterSets for workflow state filtering.

## Classes

- [WorkflowFilterSet](/v3/reference/api/py/vueda.workflow.filtersets/WorkflowFilterSet.md)

## `narrow_workflow_state_filter` {#narrow_workflow_state_filter}

Limit the workflow state filter's choices to states that rows in ``filterset.queryset`` are in.

Only the filter ``workflow_state_filter`` built is narrowed. A filterset that declares its own
``workflow_state`` filter keeps the choices it declared.

### Signature {#narrow_workflow_state_filter-signature}

`narrow_workflow_state_filter(filterset)`

#### Parameters {#narrow_workflow_state_filter-parameters}

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| <span id="narrow_workflow_state_filter-param-filterset">filterset</span> |  | yes |  |  |

### Source {#narrow_workflow_state_filter-source}

`server/vueda/workflow/filtersets.py:35`

## `workflow_state_filter` {#workflow_state_filter}

Return a new filter on the object's current workflow state.

``VuedaFilterSet.get_filters`` adds it to a filterset whose model enables ``class Vueda.Workflow``
and does not declare a filter of the same name.

### Signature {#workflow_state_filter-signature}

`workflow_state_filter()`

### Source {#workflow_state_filter-source}

`server/vueda/workflow/filtersets.py:20`

## Source

`server/vueda/workflow/filtersets.py`
