Closes #17793: Introduce a REST API endpoint for tagged objects (#18679)

* Closes #17793: Introduce a REST API endpoint for tagged objects

* Add missing object_id filter to TaggedItemFilterSet

netbox/extras/api/serializers_/tags.py

@@ -1,10 +1,16 @@
+from drf_spectacular.utils import extend_schema_field
+from rest_framework import serializers
+
 from core.models import ObjectType
-from extras.models import Tag
+from extras.models import Tag, TaggedItem
+from netbox.api.exceptions import SerializerNotFound
 from netbox.api.fields import ContentTypeField, RelatedObjectCountField
-from netbox.api.serializers import ValidatedModelSerializer
+from netbox.api.serializers import BaseModelSerializer, ValidatedModelSerializer
+from utilities.api import get_serializer_for_model
 
 __all__ = (
     'TagSerializer',
+    'TaggedItemSerializer',
 )
 
 
@@ -25,3 +31,37 @@ class TagSerializer(ValidatedModelSerializer):
             'tagged_items', 'created', 'last_updated',
         ]
         brief_fields = ('id', 'url', 'display', 'name', 'slug', 'color', 'description')
+
+
+class TaggedItemSerializer(BaseModelSerializer):
+    object_type = ContentTypeField(
+        source='content_type',
+        read_only=True
+    )
+    object = serializers.SerializerMethodField(
+        read_only=True
+    )
+    tag = TagSerializer(
+        nested=True,
+        read_only=True
+    )
+
+    class Meta:
+        model = TaggedItem
+        fields = [
+            'id', 'url', 'display', 'object_type', 'object_id', 'object', 'tag',
+        ]
+        brief_fields = ('id', 'url', 'display', 'object_type', 'object_id', 'object', 'tag')
+
+    @extend_schema_field(serializers.JSONField())
+    def get_object(self, obj):
+        """
+        Serialize a nested representation of the tagged object.
+        """
+        try:
+            serializer = get_serializer_for_model(obj.content_object)
+        except SerializerNotFound:
+            return obj.object_repr
+        data = serializer(obj.content_object, nested=True, context={'request': self.context['request']}).data
+
+        return data

netbox/extras/api/urls.py

@@ -19,6 +19,7 @@ router.register('notifications', views.NotificationViewSet)
 router.register('notification-groups', views.NotificationGroupViewSet)
 router.register('subscriptions', views.SubscriptionViewSet)
 router.register('tags', views.TagViewSet)
+router.register('tagged-objects', views.TaggedItemViewSet)
 router.register('image-attachments', views.ImageAttachmentViewSet)
 router.register('journal-entries', views.JournalEntryViewSet)
 router.register('config-contexts', views.ConfigContextViewSet)

netbox/extras/api/views.py

@@ -6,6 +6,7 @@ from rest_framework import status
 from rest_framework.decorators import action
 from rest_framework.exceptions import PermissionDenied
 from rest_framework.generics import RetrieveUpdateDestroyAPIView
+from rest_framework.mixins import ListModelMixin, RetrieveModelMixin
 from rest_framework.renderers import JSONRenderer
 from rest_framework.response import Response
 from rest_framework.routers import APIRootView
@@ -20,7 +21,7 @@ from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired
 from netbox.api.features import SyncedDataMixin
 from netbox.api.metadata import ContentTypeMetadata
 from netbox.api.renderers import TextRenderer
-from netbox.api.viewsets import NetBoxModelViewSet
+from netbox.api.viewsets import BaseViewSet, NetBoxModelViewSet
 from utilities.exceptions import RQWorkerNotRunningException
 from utilities.request import copy_safe_request
 from . import serializers
@@ -172,6 +173,12 @@ class TagViewSet(NetBoxModelViewSet):
     filterset_class = filtersets.TagFilterSet
 
 
+class TaggedItemViewSet(RetrieveModelMixin, ListModelMixin, BaseViewSet):
+    queryset = TaggedItem.objects.prefetch_related('content_type', 'content_object', 'tag')
+    serializer_class = serializers.TaggedItemSerializer
+    filterset_class = filtersets.TaggedItemFilterSet
+
+
 #
 # Image attachments
 #