Skip to content

Nautobot TRAX API Package

nautobot_trax.api

REST API module for nautobot_trax app.

serializers

API serializers for nautobot_trax.

CommsCardEntrySerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

CommsCardEntry serializer.

Source code in nautobot_trax/api/serializers.py 
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
class CommsCardEntrySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """CommsCardEntry serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.CommsCardEntry
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "channel",
            "keymat",
            "comms_card",
            "frequency_set",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.CommsCardEntry
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "channel",
        "keymat",
        "comms_card",
        "frequency_set",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

CommsCardSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

CommsCard serializer.

Source code in nautobot_trax/api/serializers.py 
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
class CommsCardSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """CommsCard serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.CommsCard
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "operation",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.CommsCard
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "operation",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

FrequencyBandSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

FrequencyBand serializer (read-only reference data).

Source code in nautobot_trax/api/serializers.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class FrequencyBandSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """FrequencyBand serializer (read-only reference data)."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.FrequencyBand
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "description",
            "lower_frequency_mhz",
            "upper_frequency_mhz",
            "created",
            "last_updated",
            "tags",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
        read_only_fields = ["lower_frequency_mhz", "upper_frequency_mhz"]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.FrequencyBand
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "description",
        "lower_frequency_mhz",
        "upper_frequency_mhz",
        "created",
        "last_updated",
        "tags",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]
    read_only_fields = ["lower_frequency_mhz", "upper_frequency_mhz"]

FrequencySerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Frequency serializer.

Source code in nautobot_trax/api/serializers.py 
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
class FrequencySerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Frequency serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.Frequency
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "frequency_mhz",
            "description",
            "band",
            "status",
            "tenant",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.Frequency
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "frequency_mhz",
        "description",
        "band",
        "status",
        "tenant",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

FrequencySetSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

FrequencySet serializer.

Source code in nautobot_trax/api/serializers.py 
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class FrequencySetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):  # pylint: disable=nb-sub-class-name
    """FrequencySet serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.MissionFrequencySet
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "tx_frequency_mhz",
            "rx_frequency_mhz",
            "tx_bandwidth_mhz",
            "rx_bandwidth_mhz",
            "transport_type",
            "transport_subtype",
            "access_method",
            "modulation",
            "polarization",
            "notes",
            "satellite",
            "band",
            "provider",
            "status",
            "tenant",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.MissionFrequencySet
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "tx_frequency_mhz",
        "rx_frequency_mhz",
        "tx_bandwidth_mhz",
        "rx_bandwidth_mhz",
        "transport_type",
        "transport_subtype",
        "access_method",
        "modulation",
        "polarization",
        "notes",
        "satellite",
        "band",
        "provider",
        "status",
        "tenant",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

MapTileSetSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

MapTileSet serializer.

Source code in nautobot_trax/api/serializers.py 
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
class MapTileSetSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """MapTileSet serializer."""

    def to_representation(self, instance):
        """Return the object-authorized REST download route for uploaded archives."""
        data = super().to_representation(instance)
        if instance.mbtiles_file:
            url = reverse("plugins-api:nautobot_trax-api:maptileset-download", kwargs={"pk": instance.pk})
            request = self.context.get("request")
            data["mbtiles_file"] = request.build_absolute_uri(url) if request else url
        return data

    class Meta:
        """Define atlas metadata and read-only derived values."""

        model = models.MapTileSet
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "description",
            "mbtiles_file",
            "is_active",
            "tile_format",
            "attribution",
            "min_zoom",
            "max_zoom",
            "zoom_levels",
            "bounds_west",
            "bounds_south",
            "bounds_east",
            "bounds_north",
            "created",
            "last_updated",
            "tags",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
        read_only_fields = [
            "tile_format",
            "attribution",
            "min_zoom",
            "max_zoom",
            "zoom_levels",
            "bounds_west",
            "bounds_south",
            "bounds_east",
            "bounds_north",
        ]
Meta

Define atlas metadata and read-only derived values.

Source code in nautobot_trax/api/serializers.py 
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
class Meta:
    """Define atlas metadata and read-only derived values."""

    model = models.MapTileSet
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "description",
        "mbtiles_file",
        "is_active",
        "tile_format",
        "attribution",
        "min_zoom",
        "max_zoom",
        "zoom_levels",
        "bounds_west",
        "bounds_south",
        "bounds_east",
        "bounds_north",
        "created",
        "last_updated",
        "tags",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]
    read_only_fields = [
        "tile_format",
        "attribution",
        "min_zoom",
        "max_zoom",
        "zoom_levels",
        "bounds_west",
        "bounds_south",
        "bounds_east",
        "bounds_north",
    ]
to_representation(instance)

Return the object-authorized REST download route for uploaded archives.

Source code in nautobot_trax/api/serializers.py 
318
319
320
321
322
323
324
325
def to_representation(self, instance):
    """Return the object-authorized REST download route for uploaded archives."""
    data = super().to_representation(instance)
    if instance.mbtiles_file:
        url = reverse("plugins-api:nautobot_trax-api:maptileset-download", kwargs={"pk": instance.pk})
        request = self.context.get("request")
        data["mbtiles_file"] = request.build_absolute_uri(url) if request else url
    return data

MissionPlanSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

MissionPlan serializer.

Source code in nautobot_trax/api/serializers.py 
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class MissionPlanSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """MissionPlan serializer."""

    def validate(self, attrs):
        """Validate the final kit selections, including partial updates."""
        tenant = attrs.get("tenant", self.instance.tenant if self.instance else None)
        supporting_kits = attrs.get("supporting_kits")
        if supporting_kits is None:
            supporting_kits = self.instance.supporting_kits.all() if self.instance else []
        if tenant and tenant in supporting_kits:
            raise serializers.ValidationError(
                {"supporting_kits": "Do not include the deployed kit in supporting kits."}
            )
        return super().validate(attrs)

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.MissionPlan
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "mission_name",
            "tenant",
            "supporting_kits",
            "status",
            "start_date",
            "end_date",
            "location",
            "deployment_mgrs",
            "deployment_latitude",
            "deployment_longitude",
            "deployment_altitude_m",
            "description",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.MissionPlan
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "mission_name",
        "tenant",
        "supporting_kits",
        "status",
        "start_date",
        "end_date",
        "location",
        "deployment_mgrs",
        "deployment_latitude",
        "deployment_longitude",
        "deployment_altitude_m",
        "description",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]
validate(attrs)

Validate the final kit selections, including partial updates.

Source code in nautobot_trax/api/serializers.py 
146
147
148
149
150
151
152
153
154
155
156
def validate(self, attrs):
    """Validate the final kit selections, including partial updates."""
    tenant = attrs.get("tenant", self.instance.tenant if self.instance else None)
    supporting_kits = attrs.get("supporting_kits")
    if supporting_kits is None:
        supporting_kits = self.instance.supporting_kits.all() if self.instance else []
    if tenant and tenant in supporting_kits:
        raise serializers.ValidationError(
            {"supporting_kits": "Do not include the deployed kit in supporting kits."}
        )
    return super().validate(attrs)

MissionTransportOptionSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

MissionTransportOption serializer.

Source code in nautobot_trax/api/serializers.py 
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
class MissionTransportOptionSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """MissionTransportOption serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.MissionTransportOption
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "transport_type",
            "transport_subtype",
            "role",
            "polarization",
            "status",
            "notes",
            "mission_plan",
            "circuit",
            "device",
            "provider",
            "mission_frequency_set",
            "satellite",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.MissionTransportOption
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "transport_type",
        "transport_subtype",
        "role",
        "polarization",
        "status",
        "notes",
        "mission_plan",
        "circuit",
        "device",
        "provider",
        "mission_frequency_set",
        "satellite",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

OperationSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Operation serializer.

Source code in nautobot_trax/api/serializers.py 
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
class OperationSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Operation serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.Operation
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "status",
            "start_date",
            "end_date",
            "poc",
            "unit_tasked",
            "aor",
            "description",
            "mission_plans",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.Operation
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "status",
        "start_date",
        "end_date",
        "poc",
        "unit_tasked",
        "aor",
        "description",
        "mission_plans",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

SatelliteSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

Satellite serializer.

Source code in nautobot_trax/api/serializers.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class SatelliteSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """Satellite serializer."""

    class Meta:
        """Declare the model and fields exposed through the API."""

        model = models.Satellite
        fields = [
            "id",
            "object_type",
            "display",
            "url",
            "natural_slug",
            "name",
            "orbit",
            "description",
            "provider",
            "created",
            "last_updated",
            "tags",
            "notes_url",
            "custom_fields",
            "computed_fields",
            "relationships",
        ]
Meta

Declare the model and fields exposed through the API.

Source code in nautobot_trax/api/serializers.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class Meta:
    """Declare the model and fields exposed through the API."""

    model = models.Satellite
    fields = [
        "id",
        "object_type",
        "display",
        "url",
        "natural_slug",
        "name",
        "orbit",
        "description",
        "provider",
        "created",
        "last_updated",
        "tags",
        "notes_url",
        "custom_fields",
        "computed_fields",
        "relationships",
    ]

urls

Django API urlpatterns declaration for nautobot_trax app.

views

API views for nautobot_trax.

CommsCardEntryViewSet

Bases: NautobotModelViewSet

CommsCardEntry viewset.

Source code in nautobot_trax/api/views.py 
142
143
144
145
146
147
class CommsCardEntryViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """CommsCardEntry viewset."""

    queryset = models.CommsCardEntry.objects.select_related("comms_card", "frequency_set")
    serializer_class = serializers.CommsCardEntrySerializer
    filterset_class = filters.CommsCardEntryFilterSet

CommsCardViewSet

Bases: NautobotModelViewSet

CommsCard viewset.

Source code in nautobot_trax/api/views.py 
134
135
136
137
138
139
class CommsCardViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """CommsCard viewset."""

    queryset = models.CommsCard.objects.select_related("operation")
    serializer_class = serializers.CommsCardSerializer
    filterset_class = filters.CommsCardFilterSet

FrequencyBandViewSet

Bases: ReadOnlyModelViewSet

Read-only FrequencyBand viewset.

Source code in nautobot_trax/api/views.py 
18
19
20
21
22
23
class FrequencyBandViewSet(ReadOnlyModelViewSet):  # pylint: disable=too-many-ancestors
    """Read-only FrequencyBand viewset."""

    queryset = models.FrequencyBand.objects.all()
    serializer_class = serializers.FrequencyBandSerializer
    filterset_class = filters.FrequencyBandFilterSet

FrequencySetViewSet

Bases: NautobotModelViewSet

FrequencySet viewset.

Source code in nautobot_trax/api/views.py 
34
35
36
37
38
39
class FrequencySetViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """FrequencySet viewset."""

    queryset = models.MissionFrequencySet.objects.select_related("satellite", "band", "provider", "status", "tenant")
    serializer_class = serializers.FrequencySetSerializer
    filterset_class = filters.FrequencySetFilterSet

FrequencyViewSet

Bases: NautobotModelViewSet

Frequency viewset.

Source code in nautobot_trax/api/views.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
class FrequencyViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """Frequency viewset."""

    queryset = models.Frequency.objects.select_related("band", "status", "tenant")
    serializer_class = serializers.FrequencySerializer
    filterset_class = filters.FrequencyFilterSet

    @action(detail=False, methods=["get"], url_path="available", filterset_class=None)
    def available(self, request):  # pylint: disable=too-many-locals
        """Return catalog frequencies not currently in use by scoped Frequency Sets."""
        band_id = request.query_params.get("band")
        if not band_id:
            return Response({"detail": "Query parameter 'band' is required."}, status=400)

        satellite_id = request.query_params.get("satellite")
        tenant_id = request.query_params.get("tenant")
        provider_id = request.query_params.get("provider")
        exclude_name = request.query_params.get("exclude_name")

        status_ids_param = request.query_params.get("mission_set_status_id", "")
        status_ids = [s.strip() for s in status_ids_param.split(",") if s.strip()]
        status_param = request.query_params.get("mission_set_status", "active")
        status_names = [s.strip() for s in status_param.split(",") if s.strip()]

        catalog_qs = self.get_queryset().filter(band_id=band_id, status__name="Active")
        if tenant_id:
            catalog_qs = catalog_qs.filter(django_models.Q(tenant_id=tenant_id) | django_models.Q(tenant__isnull=True))

        occupied = models.MissionFrequencySet.objects.filter(band_id=band_id)
        if satellite_id:
            occupied = occupied.filter(satellite_id=satellite_id)
        if tenant_id:
            occupied = occupied.filter(django_models.Q(tenant_id=tenant_id) | django_models.Q(tenant__isnull=True))
        if provider_id:
            occupied = occupied.filter(provider_id=provider_id)
        if exclude_name:
            occupied = occupied.exclude(name=exclude_name)
        if status_ids:
            occupied = occupied.filter(status_id__in=status_ids)
        elif status_names:
            q = django_models.Q()
            for name in status_names:
                q |= django_models.Q(status__name__iexact=name)
            occupied = occupied.filter(q)

        occupied_freqs = set(occupied.values_list("tx_frequency_mhz", flat=True))
        occupied_freqs.update(occupied.values_list("rx_frequency_mhz", flat=True))

        available_qs = catalog_qs.exclude(frequency_mhz__in=occupied_freqs).order_by("frequency_mhz")

        page = self.paginate_queryset(available_qs)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        return Response(self.get_serializer(available_qs, many=True).data)
available(request)

Return catalog frequencies not currently in use by scoped Frequency Sets.

Source code in nautobot_trax/api/views.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
@action(detail=False, methods=["get"], url_path="available", filterset_class=None)
def available(self, request):  # pylint: disable=too-many-locals
    """Return catalog frequencies not currently in use by scoped Frequency Sets."""
    band_id = request.query_params.get("band")
    if not band_id:
        return Response({"detail": "Query parameter 'band' is required."}, status=400)

    satellite_id = request.query_params.get("satellite")
    tenant_id = request.query_params.get("tenant")
    provider_id = request.query_params.get("provider")
    exclude_name = request.query_params.get("exclude_name")

    status_ids_param = request.query_params.get("mission_set_status_id", "")
    status_ids = [s.strip() for s in status_ids_param.split(",") if s.strip()]
    status_param = request.query_params.get("mission_set_status", "active")
    status_names = [s.strip() for s in status_param.split(",") if s.strip()]

    catalog_qs = self.get_queryset().filter(band_id=band_id, status__name="Active")
    if tenant_id:
        catalog_qs = catalog_qs.filter(django_models.Q(tenant_id=tenant_id) | django_models.Q(tenant__isnull=True))

    occupied = models.MissionFrequencySet.objects.filter(band_id=band_id)
    if satellite_id:
        occupied = occupied.filter(satellite_id=satellite_id)
    if tenant_id:
        occupied = occupied.filter(django_models.Q(tenant_id=tenant_id) | django_models.Q(tenant__isnull=True))
    if provider_id:
        occupied = occupied.filter(provider_id=provider_id)
    if exclude_name:
        occupied = occupied.exclude(name=exclude_name)
    if status_ids:
        occupied = occupied.filter(status_id__in=status_ids)
    elif status_names:
        q = django_models.Q()
        for name in status_names:
            q |= django_models.Q(status__name__iexact=name)
        occupied = occupied.filter(q)

    occupied_freqs = set(occupied.values_list("tx_frequency_mhz", flat=True))
    occupied_freqs.update(occupied.values_list("rx_frequency_mhz", flat=True))

    available_qs = catalog_qs.exclude(frequency_mhz__in=occupied_freqs).order_by("frequency_mhz")

    page = self.paginate_queryset(available_qs)
    if page is not None:
        serializer = self.get_serializer(page, many=True)
        return self.get_paginated_response(serializer.data)
    return Response(self.get_serializer(available_qs, many=True).data)

MapTileSetViewSet

Bases: NautobotModelViewSet

MapTileSet viewset.

Source code in nautobot_trax/api/views.py 
155
156
157
158
159
160
161
162
163
164
165
166
class MapTileSetViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """MapTileSet viewset."""

    parser_classes = [*NautobotModelViewSet.parser_classes, MultiPartParser, FormParser]
    queryset = models.MapTileSet.objects.all()
    serializer_class = serializers.MapTileSetSerializer
    filterset_class = filters.MapTileSetFilterSet

    @action(detail=True, methods=["get"])
    def download(self, request, pk=None):  # pylint: disable=unused-argument
        """Allow token/session authenticated archive downloads with object restrictions."""
        return map_archive_download(self.get_object())
download(request, pk=None)

Allow token/session authenticated archive downloads with object restrictions.

Source code in nautobot_trax/api/views.py 
163
164
165
166
@action(detail=True, methods=["get"])
def download(self, request, pk=None):  # pylint: disable=unused-argument
    """Allow token/session authenticated archive downloads with object restrictions."""
    return map_archive_download(self.get_object())

MissionPlanViewSet

Bases: NautobotModelViewSet

MissionPlan viewset.

Source code in nautobot_trax/api/views.py 
104
105
106
107
108
109
class MissionPlanViewSet(NautobotModelViewSet):
    """MissionPlan viewset."""

    queryset = models.MissionPlan.objects.select_related("tenant", "location").prefetch_related("supporting_kits")
    serializer_class = serializers.MissionPlanSerializer
    filterset_class = filters.MissionPlanFilterSet

MissionTransportOptionViewSet

Bases: NautobotModelViewSet

MissionTransportOption viewset.

Source code in nautobot_trax/api/views.py 
120
121
122
123
124
125
126
127
128
129
130
131
class MissionTransportOptionViewSet(NautobotModelViewSet):
    """MissionTransportOption viewset."""

    queryset = models.MissionTransportOption.objects.select_related(
        "mission_plan",
        "mission_frequency_set",
        "circuit",
        "device",
        "provider",
    )
    serializer_class = serializers.MissionTransportOptionSerializer
    filterset_class = filters.MissionTransportOptionFilterSet

OperationViewSet

Bases: NautobotModelViewSet

Operation viewset.

Source code in nautobot_trax/api/views.py 
112
113
114
115
116
117
class OperationViewSet(NautobotModelViewSet):
    """Operation viewset."""

    queryset = models.Operation.objects.prefetch_related("mission_plans")
    serializer_class = serializers.OperationSerializer
    filterset_class = filters.OperationFilterSet

SatelliteViewSet

Bases: NautobotModelViewSet

Satellite viewset.

Source code in nautobot_trax/api/views.py 
26
27
28
29
30
31
class SatelliteViewSet(NautobotModelViewSet):  # pylint: disable=too-many-ancestors
    """Satellite viewset."""

    queryset = models.Satellite.objects.all()
    serializer_class = serializers.SatelliteSerializer
    filterset_class = filters.SatelliteFilterSet