Skip to content

Circuit Maintenance API Package

nautobot_circuit_maintenance.api

REST API module for circuit maintenance plugin.

serializers

Serializer for Circuit Maintenance API.

CircuitMaintenanceCircuitImpactSerializer

Bases: serializers.ModelSerializer

Serializer for API.

Source code in nautobot_circuit_maintenance/api/serializers.py 
 8
 9
10
11
12
13
14
15
16
17
class CircuitMaintenanceCircuitImpactSerializer(serializers.ModelSerializer):
    """Serializer for API."""

    circuit = CircuitSerializer

    class Meta:
        """Meta class for MaintenanceCircuitImpactSerializer."""

        model = CircuitImpact
        fields = ["id", "maintenance", "circuit", "impact"]
Meta

Meta class for MaintenanceCircuitImpactSerializer.

Source code in nautobot_circuit_maintenance/api/serializers.py 
13
14
15
16
17
class Meta:
    """Meta class for MaintenanceCircuitImpactSerializer."""

    model = CircuitImpact
    fields = ["id", "maintenance", "circuit", "impact"]

CircuitMaintenanceSerializer

Bases: serializers.ModelSerializer

Serializer for API.

Source code in nautobot_circuit_maintenance/api/serializers.py 
20
21
22
23
24
25
26
27
28
29
class CircuitMaintenanceSerializer(serializers.ModelSerializer):
    """Serializer for API."""

    circuits = CircuitMaintenanceCircuitImpactSerializer

    class Meta:
        """Meta class for MaintenanceSerializer."""

        model = CircuitMaintenance
        fields = ["id", "name", "start_time", "end_time", "description", "status", "ack"]
Meta

Meta class for MaintenanceSerializer.

Source code in nautobot_circuit_maintenance/api/serializers.py 
25
26
27
28
29
class Meta:
    """Meta class for MaintenanceSerializer."""

    model = CircuitMaintenance
    fields = ["id", "name", "start_time", "end_time", "description", "status", "ack"]

NoteSerializer

Bases: serializers.ModelSerializer

Serializer for API.

Source code in nautobot_circuit_maintenance/api/serializers.py 
32
33
34
35
36
37
38
39
40
41
class NoteSerializer(serializers.ModelSerializer):
    """Serializer for API."""

    maintenance = CircuitMaintenanceSerializer

    class Meta:
        """Meta class for MaintenanceNoteSerializer."""

        model = Note
        fields = ["id", "maintenance", "title", "comment"]
Meta

Meta class for MaintenanceNoteSerializer.

Source code in nautobot_circuit_maintenance/api/serializers.py 
37
38
39
40
41
class Meta:
    """Meta class for MaintenanceNoteSerializer."""

    model = Note
    fields = ["id", "maintenance", "title", "comment"]

NotificationSourceSerializer

Bases: serializers.ModelSerializer

Serializer for NotificationSource records.

Source code in nautobot_circuit_maintenance/api/serializers.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
class NotificationSourceSerializer(serializers.ModelSerializer):
    """Serializer for NotificationSource records."""

    url = serializers.HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_circuit_maintenance-api:notificationsource-detail"
    )
    providers = NestedProviderSerializer(many=True)

    class Meta:
        """Meta class for NotificationSourceSerializer."""

        model = NotificationSource
        fields = ["id", "url", "name", "slug", "providers", "attach_all_providers"]
Meta

Meta class for NotificationSourceSerializer.

Source code in nautobot_circuit_maintenance/api/serializers.py 
52
53
54
55
56
class Meta:
    """Meta class for NotificationSourceSerializer."""

    model = NotificationSource
    fields = ["id", "url", "name", "slug", "providers", "attach_all_providers"]

urls

URLS for Circuit Maintenance API.

views

Views for API.

MaintenanceCircuitImpactTaskView

Bases: CustomFieldModelViewSet

API view for Circuit Impact CRUD operations.

Source code in nautobot_circuit_maintenance/api/views.py 
32
33
34
35
36
37
class MaintenanceCircuitImpactTaskView(CustomFieldModelViewSet):
    """API view for Circuit Impact CRUD operations."""

    queryset = CircuitImpact.objects.prefetch_related()
    serializer_class = CircuitMaintenanceCircuitImpactSerializer
    filterset_class = filters.CircuitImpactFilterSet

MaintenanceNoteTaskView

Bases: CustomFieldModelViewSet

API view for Circuit Note CRUD operations.

Source code in nautobot_circuit_maintenance/api/views.py 
25
26
27
28
29
class MaintenanceNoteTaskView(CustomFieldModelViewSet):
    """API view for Circuit Note CRUD operations."""

    queryset = Note.objects.prefetch_related()
    serializer_class = NoteSerializer

MaintenanceTaskView

Bases: CustomFieldModelViewSet

API view for Circuit Maintenance CRUD operations.

Source code in nautobot_circuit_maintenance/api/views.py 
17
18
19
20
21
22
class MaintenanceTaskView(CustomFieldModelViewSet):
    """API view for Circuit Maintenance CRUD operations."""

    queryset = CircuitMaintenance.objects.prefetch_related()
    serializer_class = CircuitMaintenanceSerializer
    filterset_class = filters.CircuitMaintenanceFilterSet

NotificationSourceTaskView

Bases: viewsets.ReadOnlyModelViewSet

API view for Notification Source CRUD operations.

Source code in nautobot_circuit_maintenance/api/views.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class NotificationSourceTaskView(viewsets.ReadOnlyModelViewSet):
    """API view for Notification Source CRUD operations."""

    queryset = NotificationSource.objects.prefetch_related()
    serializer_class = NotificationSourceSerializer
    filterset_class = filters.NotificationSourceFilterSet

    def get_serializer_context(self):
        """Add custom fields to the serializer context, as in nautobot.extras.api.views.CustomFieldModelViewSet."""
        # Gather all custom fields for the model
        content_type = ContentType.objects.get_for_model(self.queryset.model)
        custom_fields = content_type.custom_fields.all()

        context = super().get_serializer_context()
        context.update(
            {
                "custom_fields": custom_fields,
            }
        )
        return context
get_serializer_context()

Add custom fields to the serializer context, as in nautobot.extras.api.views.CustomFieldModelViewSet.

Source code in nautobot_circuit_maintenance/api/views.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
def get_serializer_context(self):
    """Add custom fields to the serializer context, as in nautobot.extras.api.views.CustomFieldModelViewSet."""
    # Gather all custom fields for the model
    content_type = ContentType.objects.get_for_model(self.queryset.model)
    custom_fields = content_type.custom_fields.all()

    context = super().get_serializer_context()
    context.update(
        {
            "custom_fields": custom_fields,
        }
    )
    return context