starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

GraphQL: Return full object for custom fields instead of only ID #11907

New Issue
Open
opened 2025-12-29 21:51:23 +01:00 by adam · 0 comments
adam commented 2025-12-29 21:51:23 +01:00
Owner
Copy Link

Originally created by @jagter on GitHub (Dec 8, 2025).

NetBox version

v4.4.6

Feature type

Change to existing functionality

Proposed functionality

Currently, when querying custom fields of type object/foreign key via the GraphQL API, only the ID of the related object is returned. The REST API, on the other hand, returns the full object with all its fields.

Current output

"custom_fields": {
    "bgp_asn": [
        776,
        783
    ],

Use case

It would be great if the GraphQL API could also return the full object for custom fields, similar to how the REST API does, instead of only the ID. This would make it easier to consume related objects directly in GraphQL queries without requiring additional lookups.

Database changes

None

External dependencies

None

Originally created by @jagter on GitHub (Dec 8, 2025). ### NetBox version v4.4.6 ### Feature type Change to existing functionality ### Proposed functionality Currently, when querying custom fields of type object/foreign key via the GraphQL API, only the ID of the related object is returned. The REST API, on the other hand, returns the full object with all its fields. **Current output** ``` "custom_fields": { "bgp_asn": [ 776, 783 ], ``` ### Use case It would be great if the GraphQL API could also return the full object for custom fields, similar to how the REST API does, instead of only the ID. This would make it easier to consume related objects directly in GraphQL queries without requiring additional lookups. ### Database changes None ### External dependencies None
adam added the type: featurenetboxstatus: backlogcomplexity: high labels 2025-12-29 21:51:23 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label complexity: high netbox status: backlog type: feature
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#11907
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?