Django REST Framework filter multiple fields

Question

Models

class Task(Model):
    employee_owner = ForeignKey(Employee, on_delete=CASCADE)
    employee_doer = ForeignKey(Employee, on_delete=CASCADE)

Views

class TaskViewSet(ModelViewSet):
    serializer_class = TaskSerializer
    queryset = Task.objects.all()
    filter_class = TaskFilter

Filter

class TaskFilter(FilterSet):
    owner_id = NumberFilter(name='employee_owner__id')
    doer_id = NumberFilter(name='employee_doer__id')

    class Meta:
        model = Task
        fields = {
            'owner_id',
            'doer_id'
        }

Endpoints

http://localhost:8000/api/tasks?owner_id=1&doer_id=1

(Gives only those tasks where owner and doer are the same employee)

http://localhost:8000/api/tasks?owner_id=1

(Gives only those tasks where owner is specific employee and doer is anyone)

http://localhost:8000/api/tasks?doer_id=1

(Gives only those tasks where doer is specific employee and owner is anyone)

What I want

I want an endpoint like:

http://localhost:8000/api/tasks?both_id=1

(Which would give me all results from above 3 endpoints)

I want django-filter to do filtering exactly like:

Task.objects.filter(
    Q(employee_owner__id=1) | Q(employee_doer__id=1)
)

How can I achieve that ? Thank you.

neverwalkaloner · Accepted Answer · 2018-04-23 04:59:18Z

17

You can customize filter using method argument like this:

class TaskFilter(FilterSet):
    owner_id = NumberFilter(name='employee_owner__id')
    doer_id = NumberFilter(name='employee_doer__id')
    both_id = NumberFilter(method='filter_both')

    class Meta:
        model = Task
        fields = {
            'owner_id',
            'doer_id',
            'both_id' 
        }

    def filter_both(self, queryset, name, value):
        return queryset.filter(
            Q(employee_owner__id=value) | Q(employee_doer__id=value)
        )

edited Apr 23, 2018 at 4:59

answered Apr 23, 2018 at 4:54

neverwalkaloner

47.6k7 gold badges101 silver badges103 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

inmate37 Over a year ago

Perfect answer from neverwalkaloner as usual :)

Routhinator Over a year ago

You have a Q() in there, but neither your answer or the docs linked seem to explain where it is imported from or what it represents.

Routhinator Over a year ago

Ah, found it finally with the right search against model.objects.filter - it's from django.db.models import Q

denise Over a year ago

I have a similar case and for me this doesn't work as both_id is not a field within the Task model (if I understood the question correctly). The provided solution returns 'Meta.fields' must not contain non-model field names: both_id

Khubaib Raza · Accepted Answer · 2019-07-29 17:28:45Z

5

Personally I would like to suggest use DjangoFilterBackend for filtration

from django_filters.rest_framework import DjangoFilterBackend

After that

class TaskViewSet(ModelViewSet):
    serializer_class = TaskSerializer
    queryset = Task.objects.all()
    filter_backends = (DjangoFilterBackend,)
    filterset_fields = ['owner_id', 'doer_id']# pass query through params

answered Jul 29, 2019 at 17:28

Khubaib Raza

5937 silver badges10 bronze badges

Collectives™ on Stack Overflow

Django REST Framework filter multiple fields

2 Answers 2

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related