Route overrides

This is the official documentation of the forestadmin-agent-django and forestadmin-agent-flask Python agents.

Route overrides ↗ allowed customizing the behavior of the routes exposed by the agent.

This very low-level feature was used to implement many use cases:

  • Attach handlers to events in the UI

  • Customize filtering, search and sort behaviors

  • Other advanced use cases.

Because our new agent API is higher-level, the protocol used to communicate between the agent and the application can no longer be manipulated.

Code cheatsheet

What was the route override used for?How to migrate it?

Add custom permissions

Use .add_hook and throw forbidden errors

Add validation to fields

Add validation to whole records

Use .add_hook and throw validation errors

Run code on UI events

Use .add_hook to perform custom logic

Change the search behavior

Use .replace_search to implement your custom search logic

Change the filtering behavior of fields

Change the sort behavior of fields

Other use case

If you are stuck or think that this guide can be improved, please expose your use case in the community forums ↗ and we will be happy to help you


Add custom permissions

Custom permissions would better be implemented by using the Roles ↗ feature from the UI.

  • Define a new route into your file:

  • Add a new method in your controller.

from django.http import  HttpResponse
from django.views import generic

from app.models import Book

class BooksView(generic.ListView):
    def delete(self, request, pk, *args, **kwargs):

        return HttpResponse(status=204)

Last updated