Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to make a PATCH request using DJANGO REST framework

I am not very experience with Django REST framework and have been trying out many things but can not make my PATCH request work.

I have a Model serializer. This is the same one I use to add a new entry and ideally I Would want to re-use when I update an entry.

class TimeSerializer(serializers.ModelSerializer):     class Meta:         model = TimeEntry         fields = ('id', 'project', 'amount', 'description', 'date')      def __init__(self, user, *args, **kwargs):         # Don't pass the 'fields' arg up to the superclass         super(TimeSerializer, self).__init__(*args, **kwargs)         self.user = user      def validate_project(self, attrs, source):         """         Check that the project is correct         """         .....      def validate_amount(self, attrs, source):         """         Check the amount in valid         """         ..... 

I tried to use a class based view :

class UserViewSet(generics.UpdateAPIView):     """     API endpoint that allows timeentries to be edited.     """     queryset = TimeEntry.objects.all()     serializer_class = TimeSerializer 

My urls are:

url(r'^api/edit/(?P<pk>\d+)/$', UserViewSet.as_view(), name='timeentry_api_edit'), 

My JS call is:

var putData = { 'id': '51', 'description': "new desc" } $.ajax({     url: '/en/hours/api/edit/' + id + '/',     type: "PATCH",     data: putData,     success: function(data, textStatus, jqXHR) {         // ....     } } 

In this case I would have wanted my description to be updated, but I get errors that the fields are required(for 'project'and all the rest). The validation fails. If add to the AJAX call all the fields it still fails when it haves to retrieve the 'project'.

I tried also to make my own view:

@api_view(['PATCH']) @permission_classes([permissions.IsAuthenticated]) def edit_time(request):      if request.method == 'PATCH':         serializer = TimeSerializer(request.user, data=request.DATA, partial=True)         if serializer.is_valid():             time_entry = serializer.save()         return Response(status=status.HTTP_201_CREATED)      return Response(status=status.HTTP_400_BAD_REQUEST)  

This did not work for partial update for the same reason(the validation for the fields were failing) and it did not work even if I've sent all the fields. It creates a new entry instead of editing the existing one.

I would like to re-use the same serializer and validations, but I am open to any other suggestions. Also, if someone has a piece of working code (ajax code-> api view-> serializer) would be great.

like image 797
Vlad Avatar asked Jan 15 '14 20:01

Vlad


People also ask

What is request in Django REST framework?

Django REST framework introduces a Request object that extends the regular HttpRequest, this new object type has request. data to access JSON data for 'POST', 'PUT' and 'PATCH' requests. However, I can get the same data by accessing request. body parameter which was part of original Django HttpRequest type object.


1 Answers

class DetailView(APIView):     def get_object(self, pk):         return TestModel.objects.get(pk=pk)      def patch(self, request, pk):         testmodel_object = self.get_object(pk)         serializer = TestModelSerializer(testmodel_object, data=request.data, partial=True) # set partial=True to update a data partially         if serializer.is_valid():             serializer.save()             return JsonResponse(code=201, data=serializer.data)         return JsonResponse(code=400, data="wrong parameters") 

Documentation
You do not need to write the partial_update or overwrite the update method. Just use the patch method.

like image 73
ramwin Avatar answered Oct 07 '22 09:10

ramwin