Linked custom objects should show up in the API response for related objects

[mrmrcoleman]

Plugin Version

commit 954d1fa (HEAD -> object-type-picker, origin/object-type-picker) Date: Fri Apr 25 19:09:04 2025 -0400

NetBox Version

NetBox v4.2.8-Docker-3.2.0

Python Version

Python 3.12.3

Steps to Reproduce

• Create a custom object type X
• Create a custom object type field on X called "device" which points to dcim.device
• Create a device Y
• create a custom object Z which point to Y
• Do a get on dcim.devices/

Expected Behavior

The related custom object is reported in the payload

Observed Behavior

The related custom object is not reported in the payload

[linear]

NPL-356 Linked custom objects do not show up in the API response for related objects

Plugin Version

commit 954d1fa (HEAD -> object-type-picker, origin/object-type-picker) Date: Fri Apr 25 19:09:04 2025 -0400

NetBox Version

NetBox v4.2.8-Docker-3.2.0

Python Version

Python 3.12.3

Steps to Reproduce

• Create a custom object type X
• Create a custom object type field on X called "device" which points to dcim.device
• Create a device Y
• create a custom object Z which point to Y
• Do a get on dcim.devices/

Expected Behavior

The related custom object is reported in the payload

Observed Behavior

The related custom object is not reported in the payload

[adparis99]

I was thinking of opening up an issue related to this. My use case is modeling switch/router ACLs using custom objects for use in configuration templates. My original plan was to create a custom field of type object on the device model called ACL, with a related object type of my new ACL custom object. This is currently not possible. That said, if this issue is addressed, I could add an extra field to my ACL custom object called assigned_devices and then access them via the device object anyway.

[jonasnieberle]

I have the same usecase. For my point I use the device interfaces to assign an SFP Module with a custom object.
I mentioned my suggestion in #267 to introduce "custom-objects" in the API to handle referenced custom objects.