Skip to content

Nautobot Trax API Package

nautobot_trax.api

REST API module for nautobot_trax app.

serializers

API serializers for nautobot_trax.

TraxMissionPlanSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

TraxMissionPlan serializer.

Source code in nautobot_trax/api/serializers.py
class TraxMissionPlanSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """TraxMissionPlan serializer."""

    class Meta:
        model = models.TraxMissionPlan
        fields = "__all__"

TraxMissionTransportOptionSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

TraxMissionTransportOption serializer.

Source code in nautobot_trax/api/serializers.py
class TraxMissionTransportOptionSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """TraxMissionTransportOption serializer."""

    class Meta:
        model = models.TraxMissionTransportOption
        fields = "__all__"

TraxOperationSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

TraxOperation serializer.

Source code in nautobot_trax/api/serializers.py
class TraxOperationSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """TraxOperation serializer."""

    class Meta:
        model = models.TraxOperation
        fields = "__all__"

urls

Django API urlpatterns declaration for nautobot_trax app.

views

API views for nautobot_trax.

TraxMissionPlanViewSet

Bases: NautobotModelViewSet

TraxMissionPlan viewset.

Source code in nautobot_trax/api/views.py
class TraxMissionPlanViewSet(NautobotModelViewSet):
    """TraxMissionPlan viewset."""

    queryset = models.TraxMissionPlan.objects.all()
    serializer_class = serializers.TraxMissionPlanSerializer
    filterset_class = filters.TraxMissionPlanFilterSet

TraxMissionTransportOptionViewSet

Bases: NautobotModelViewSet

TraxMissionTransportOption viewset.

Source code in nautobot_trax/api/views.py
class TraxMissionTransportOptionViewSet(NautobotModelViewSet):
    """TraxMissionTransportOption viewset."""

    queryset = models.TraxMissionTransportOption.objects.select_related(
        "mission_plan",
        "mission_frequency_set",
        "circuit",
        "device",
        "provider",
    )
    serializer_class = serializers.TraxMissionTransportOptionSerializer
    filterset_class = filters.TraxMissionTransportOptionFilterSet

TraxOperationViewSet

Bases: NautobotModelViewSet

TraxOperation viewset.

Source code in nautobot_trax/api/views.py
class TraxOperationViewSet(NautobotModelViewSet):
    """TraxOperation viewset."""

    queryset = models.TraxOperation.objects.prefetch_related("mission_plans")
    serializer_class = serializers.TraxOperationSerializer
    filterset_class = filters.TraxOperationFilterSet