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

Expose label of custom_field_choice as well as id #11878

New Issue
Open
opened 2025-12-29 21:51:09 +01:00 by adam · 1 comment
adam commented 2025-12-29 21:51:09 +01:00
Owner
Copy Link

Originally created by @n3wtype on GitHub (Nov 27, 2025).

NetBox version

v4.4.5

Feature type

Change to existing functionality

Proposed functionality

Ability to access label of custom field choices of custom field of type "Selection" via api call to object to which custom field is assigned.

Use case

Let's say we have following custom field choices assigned to custom field called "cluster" assigned to DCIM->Device. Values of this choices are managed by system external to netbox in the manner where id is some id internal to the external system (for sake of traceability and further synchronization) and Label is actual meaningful value of the entry.

1:cluster1
2:cluster2
3:cluster3

we would like to access value of this field via API call to dcim/device endpoint for further use within standard automation tools which are pulling data from netbox e.g. standard ansible netbox inventory plugin from netbox.netbox collection.

current behaviour

"custom_fields": {
"cluster": 1
}

expected behaviour

"custom_fields": {
"cluster": 1
"cluster__label": "cluster1"
}

As workouround we keep additional custom_field called "cluster_label" which is populated from value of field "cluster" which works fine but requires additional tooling and is prone to inconsistencies.

Database changes

n/a

External dependencies

n/a

Originally created by @n3wtype on GitHub (Nov 27, 2025). ### NetBox version v4.4.5 ### Feature type Change to existing functionality ### Proposed functionality Ability to access label of custom field choices of custom field of type "Selection" via api call to object to which custom field is assigned. ### Use case Let's say we have following custom field choices assigned to custom field called "cluster" assigned to DCIM->Device. Values of this choices are managed by system external to netbox in the manner where id is some id internal to the external system (for sake of traceability and further synchronization) and Label is actual meaningful value of the entry. 1:cluster1 2:cluster2 3:cluster3 we would like to access value of this field via API call to dcim/device endpoint for further use within standard automation tools which are pulling data from netbox e.g. standard ansible netbox inventory plugin from netbox.netbox collection. #### current behaviour "custom_fields": { "cluster": 1 } #### expected behaviour "custom_fields": { "cluster": 1 "cluster__label": "cluster1" } As workouround we keep additional custom_field called "cluster_label" which is populated from value of field "cluster" which works fine but requires additional tooling and is prone to inconsistencies. ### Database changes n/a ### External dependencies n/a
adam commented 2025-12-29 21:51:10 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 4, 2025):

I think this makes sense to implement if we abide by the same pattern already established for built-in choices fields, which present the selected choice as an object with a value and a label:

    "status": {
        "value": "active",
        "label": "Active"
    },

This object is presented only on read access: The field would be written to by passing the raw value as before.

@jeremystretch commented on GitHub (Dec 4, 2025): I think this makes sense to implement if we abide by the same pattern already established for built-in choices fields, which present the selected choice as an object with a value and a label: ```json "status": { "value": "active", "label": "Active" }, ``` This object is presented only on read access: The field would be written to by passing the raw value as before.
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 breaking change complexity: medium needs milestone 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#11878
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?