Rename JobResult to Job and move to core

netbox/core/api/nested_serializers.py

@@ -1,12 +1,16 @@
 from rest_framework import serializers
 
+from core.choices import JobStatusChoices
 from core.models import *
+from netbox.api.fields import ChoiceField
 from netbox.api.serializers import WritableNestedSerializer
+from users.api.nested_serializers import NestedUserSerializer
 
-__all__ = [
+__all__ = (
     'NestedDataFileSerializer',
     'NestedDataSourceSerializer',
-]
+    'NestedJobSerializer',
+)
 
 
 class NestedDataSourceSerializer(WritableNestedSerializer):
@@ -23,3 +27,15 @@ class NestedDataFileSerializer(WritableNestedSerializer):
     class Meta:
         model = DataFile
         fields = ['id', 'url', 'display', 'path']
+
+
+class NestedJobSerializer(serializers.ModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='core-api:job-detail')
+    status = ChoiceField(choices=JobStatusChoices)
+    user = NestedUserSerializer(
+        read_only=True
+    )
+
+    class Meta:
+        model = Job
+        fields = ['url', 'created', 'completed', 'user', 'status']

netbox/core/api/serializers.py

@@ -2,12 +2,15 @@ from rest_framework import serializers
 
 from core.choices import *
 from core.models import *
-from netbox.api.fields import ChoiceField
-from netbox.api.serializers import NetBoxModelSerializer
+from netbox.api.fields import ChoiceField, ContentTypeField
+from netbox.api.serializers import BaseModelSerializer, NetBoxModelSerializer
+from users.api.nested_serializers import NestedUserSerializer
 from .nested_serializers import *
 
 __all__ = (
+    'DataFileSerializer',
     'DataSourceSerializer',
+    'JobSerializer',
 )
 
 
@@ -49,3 +52,21 @@ class DataFileSerializer(NetBoxModelSerializer):
         fields = [
             'id', 'url', 'display', 'source', 'path', 'last_updated', 'size', 'hash',
         ]
+
+
+class JobSerializer(BaseModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='core-api:job-detail')
+    user = NestedUserSerializer(
+        read_only=True
+    )
+    status = ChoiceField(choices=JobStatusChoices, read_only=True)
+    object_type = ContentTypeField(
+        read_only=True
+    )
+
+    class Meta:
+        model = Job
+        fields = [
+            'id', 'url', 'display', 'status', 'created', 'scheduled', 'interval', 'started', 'completed', 'name',
+            'object_type', 'user', 'data', 'job_id',
+        ]

netbox/core/api/urls.py

@@ -9,5 +9,8 @@ router.APIRootView = views.CoreRootView
 router.register('data-sources', views.DataSourceViewSet)
 router.register('data-files', views.DataFileViewSet)
 
+# Jobs
+router.register('job-results', views.JobViewSet)
+
 app_name = 'core-api'
 urlpatterns = router.urls

netbox/core/api/views.py

@@ -4,6 +4,7 @@ from rest_framework.decorators import action
 from rest_framework.exceptions import PermissionDenied
 from rest_framework.response import Response
 from rest_framework.routers import APIRootView
+from rest_framework.viewsets import ReadOnlyModelViewSet
 
 from core import filtersets
 from core.models import *
@@ -20,10 +21,6 @@ class CoreRootView(APIRootView):
         return 'Core'
 
 
-#
-# Data sources
-#
-
 class DataSourceViewSet(NetBoxModelViewSet):
     queryset = DataSource.objects.annotate(
         file_count=count_related(DataFile, 'source')
@@ -50,3 +47,12 @@ class DataFileViewSet(NetBoxReadOnlyModelViewSet):
     queryset = DataFile.objects.defer('data').prefetch_related('source')
     serializer_class = serializers.DataFileSerializer
     filterset_class = filtersets.DataFileFilterSet
+
+
+class JobViewSet(ReadOnlyModelViewSet):
+    """
+    Retrieve a list of job results
+    """
+    queryset = Job.objects.prefetch_related('user')
+    serializer_class = serializers.JobSerializer
+    filterset_class = filtersets.JobFilterSet