Skip to content

Consumables Tracking API Package

nautobot_consumables.api

serializers

Serializers for Nautobot Consumables API endpoints.

CheckedOutConsumableSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

API serializer for the CheckedOutConsumable model.

Source code in nautobot_consumables/api/serializers.py
class CheckedOutConsumableSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """API serializer for the CheckedOutConsumable model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:checkedoutconsumable-detail",
    )

    consumable_pool = NestedConsumablePoolSerializer()
    device = NestedDeviceSerializer()

    class Meta:
        """CheckedOutConsumableSerializer model options."""

        model = models.CheckedOutConsumable
        fields = ["id", "url", "consumable_pool", "device", "quantity", "tags"]
Meta

CheckedOutConsumableSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """CheckedOutConsumableSerializer model options."""

    model = models.CheckedOutConsumable
    fields = ["id", "url", "consumable_pool", "device", "quantity", "tags"]

ConsumablePoolSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

API serializer for the ConsumablePool model.

Source code in nautobot_consumables/api/serializers.py
class ConsumablePoolSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """API serializer for the ConsumablePool model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:consumablepool-detail",
    )

    consumable = NestedConsumableSerializer()
    location = NestedLocationSerializer()

    class Meta:
        """ConsumablePoolSerializer model options."""

        model = models.ConsumablePool
        fields = ["id", "url", "name", "consumable", "location", "quantity", "tags"]
Meta

ConsumablePoolSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """ConsumablePoolSerializer model options."""

    model = models.ConsumablePool
    fields = ["id", "url", "name", "consumable", "location", "quantity", "tags"]

ConsumableSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

API serializer for the Consumable model.

Source code in nautobot_consumables/api/serializers.py
class ConsumableSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """API serializer for the Consumable model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:consumable-detail",
    )

    consumable_type = NestedConsumableTypeSerializer()
    manufacturer = NestedManufacturerSerializer()

    class Meta:
        """ConsumableSerializer model options."""

        model = models.Consumable
        fields = [
            "id",
            "url",
            "name",
            "consumable_type",
            "manufacturer",
            "product_id",
            "data",
            "schema",
            "tags",
        ]
Meta

ConsumableSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """ConsumableSerializer model options."""

    model = models.Consumable
    fields = [
        "id",
        "url",
        "name",
        "consumable_type",
        "manufacturer",
        "product_id",
        "data",
        "schema",
        "tags",
    ]

ConsumableTypeSerializer

Bases: NautobotModelSerializer, TaggedModelSerializerMixin

API serializer for the ConsumableType model.

Source code in nautobot_consumables/api/serializers.py
class ConsumableTypeSerializer(NautobotModelSerializer, TaggedModelSerializerMixin):
    """API serializer for the ConsumableType model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:consumabletype-detail",
    )

    class Meta:
        """ConsumableTypeSerializer model options."""

        model = models.ConsumableType
        fields = ["id", "url", "name", "schema", "tags"]
Meta

ConsumableTypeSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """ConsumableTypeSerializer model options."""

    model = models.ConsumableType
    fields = ["id", "url", "name", "schema", "tags"]

NestedCheckedOutConsumableSerializer

Bases: WritableNestedSerializer

Nested API serializer for the CheckedOutConsumable model.

Source code in nautobot_consumables/api/serializers.py
class NestedCheckedOutConsumableSerializer(WritableNestedSerializer):
    """Nested API serializer for the CheckedOutConsumable model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:checkedoutconsumable-detail",
    )

    class Meta:
        """NestedCheckedOutConsumableSerializer model options."""

        model = models.CheckedOutConsumable
        fields = ["id", "url", "quantity"]
Meta

NestedCheckedOutConsumableSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """NestedCheckedOutConsumableSerializer model options."""

    model = models.CheckedOutConsumable
    fields = ["id", "url", "quantity"]

NestedConsumablePoolSerializer

Bases: WritableNestedSerializer

Nested API serializer for the ConsumablePool model.

Source code in nautobot_consumables/api/serializers.py
class NestedConsumablePoolSerializer(WritableNestedSerializer):
    """Nested API serializer for the ConsumablePool model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:consumablepool-detail",
    )

    class Meta:
        """NestedConsumablePoolSerializer model options."""

        model = models.ConsumablePool
        fields = ["id", "url", "name", "quantity"]
Meta

NestedConsumablePoolSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """NestedConsumablePoolSerializer model options."""

    model = models.ConsumablePool
    fields = ["id", "url", "name", "quantity"]

NestedConsumableSerializer

Bases: WritableNestedSerializer

Nested API serializer for the Consumable model.

Source code in nautobot_consumables/api/serializers.py
class NestedConsumableSerializer(WritableNestedSerializer):
    """Nested API serializer for the Consumable model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:consumable-detail",
    )

    class Meta:
        """NestedConsumableSerializer model options."""

        model = models.Consumable
        fields = ["id", "url", "name"]
Meta

NestedConsumableSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """NestedConsumableSerializer model options."""

    model = models.Consumable
    fields = ["id", "url", "name"]

NestedConsumableTypeSerializer

Bases: WritableNestedSerializer

Nested API serializer for the ConsumableType model.

Source code in nautobot_consumables/api/serializers.py
class NestedConsumableTypeSerializer(WritableNestedSerializer):
    """Nested API serializer for the ConsumableType model."""

    url = HyperlinkedIdentityField(
        view_name="plugins-api:nautobot_consumables-api:consumabletype-detail",
    )

    class Meta:
        """NestedConsumableTypeSerializer model options."""

        model = models.ConsumableType
        fields = ["id", "url", "name"]
Meta

NestedConsumableTypeSerializer model options.

Source code in nautobot_consumables/api/serializers.py
class Meta:
    """NestedConsumableTypeSerializer model options."""

    model = models.ConsumableType
    fields = ["id", "url", "name"]

urls

URL routes for Nautobot Consumables API endpoints.

views

API endpoint views for Nautobot Consumables.

CheckedOutConsumableAPIViewSet

Bases: NautobotModelViewSet

API view set for CheckedOutConsumable instances.

Source code in nautobot_consumables/api/views.py
class CheckedOutConsumableAPIViewSet(NautobotModelViewSet):
    """API view set for CheckedOutConsumable instances."""

    queryset = models.CheckedOutConsumable.objects.all()
    serializer_class = serializers.CheckedOutConsumableSerializer
    filterset_class = filters.CheckedOutConsumableFilterSet

ConsumableAPIViewSet

Bases: NautobotModelViewSet

API view set for Consumable instances.

Source code in nautobot_consumables/api/views.py
class ConsumableAPIViewSet(NautobotModelViewSet):
    """API view set for Consumable instances."""

    queryset = models.Consumable.objects.all()
    serializer_class = serializers.ConsumableSerializer
    filterset_class = filters.ConsumableFilterSet

ConsumablePoolAPIViewSet

Bases: NautobotModelViewSet

API view set for ConsumablePool instances.

Source code in nautobot_consumables/api/views.py
class ConsumablePoolAPIViewSet(NautobotModelViewSet):
    """API view set for ConsumablePool instances."""

    queryset = models.ConsumablePool.objects.all()
    serializer_class = serializers.ConsumablePoolSerializer
    filterset_class = filters.ConsumablePoolFilterSet

ConsumableTypeAPIViewSet

Bases: NautobotModelViewSet

API view set for ConsumableType instances.

Source code in nautobot_consumables/api/views.py
class ConsumableTypeAPIViewSet(NautobotModelViewSet):
    """API view set for ConsumableType instances."""

    queryset = models.ConsumableType.objects.all()
    serializer_class = serializers.ConsumableTypeSerializer
    filterset_class = filters.ConsumableTypeFilterSet