Dynamic form fields based on user input for custom scripts #3807

New Issue

adam · 2025-12-29T18:31:18+01:00

adam commented

2025-12-29 18:31:18 +01:00

Originally created by @Ikke on GitHub (Jun 25, 2020).

Environment

Python version: Example: 3.6.9
NetBox version: Example: 2.8.5

Proposed Functionality

This is a continuation of #3766, which asked about being able to filter form fields based on the input of other form fields.

One point that was not addressed as this comment. From what I could find, it is not possible to dynamically adjust the query used for a field based on what value is selected in another field.

I found that APISelect widget has a parameter called conditional_query_params, which seems to come pretty close, but as far as I can see you cannot use that to adjust the actual query values, only add static conditions based on another condition.

So it would be nice if we could refer to the selected value from another field, and use that value in the query params.

Something like

site = ObjectVar(
    description = "Site",
    queryset = Site.objects.all()
)

prefix = ObjectVar(
    queryset = Prefix.objects.all(),
    widget = APISelect(
        api_url="/api/ipam/prefixes/",
        dynamic_query_params={
            'site': 'site_id={{id}}'
        },
        display_field='prefix'
    )
)

Use Case

Same as #3766

For example: Have a form where you first select a site, and then select a prefix within that site.

Database Changes

None

External Dependencies

None

Originally created by @Ikke on GitHub (Jun 25, 2020). ### Environment * Python version: Example: 3.6.9 * NetBox version: Example: 2.8.5 ### Proposed Functionality This is a continuation of #3766, which asked about being able to filter form fields based on the input of other form fields. One point that was not addressed as [this comment](https://github.com/netbox-community/netbox/issues/3766#issuecomment-570544562). From what I could find, it is not possible to dynamically adjust the query used for a field based on what value is selected in another field. I found that `APISelect` widget has a parameter called `conditional_query_params`, which seems to come pretty close, but as far as I can see you cannot use that to adjust the actual query values, only add static conditions based on another condition. So it would be nice if we could refer to the selected value from another field, and use that value in the query params. Something like ```python site = ObjectVar( description = "Site", queryset = Site.objects.all() ) prefix = ObjectVar( queryset = Prefix.objects.all(), widget = APISelect( api_url="/api/ipam/prefixes/", dynamic_query_params={ 'site': 'site_id={{id}}' }, display_field='prefix' ) ) ``` ### Use Case Same as #3766 For example: Have a form where you first select a site, and then select a prefix within that site. ### Database Changes None ### External Dependencies None

adam closed this issue

2025-12-29 18:31:18 +01:00

adam commented

2025-12-29 18:31:18 +01:00

@jeremystretch commented on GitHub (Jun 25, 2020):

APISelect is not part of NetBox's public API, and is not intended for consumption outside the core code base. It is subject to change at any time, without warning, and your scripts which use it are very likely to break when upgrading to a future release.

Please revise your issue to on the specific functionality you are proposing, without invoking components from outside the documented API for custom scripts.

@jeremystretch commented on GitHub (Jun 25, 2020): APISelect is not part of NetBox's public API, and is not intended for consumption outside the core code base. It is subject to change at any time, without warning, and your scripts which use it are very likely to break when upgrading to a future release. Please revise your issue to on the specific **functionality** you are proposing, without invoking components from outside the [documented API for custom scripts](https://netbox.readthedocs.io/en/stable/additional-features/custom-scripts/).

adam commented

2025-12-29 18:31:18 +01:00

@jeremystretch commented on GitHub (Jul 6, 2020):

Closed due to inactivity.

@jeremystretch commented on GitHub (Jul 6, 2020): Closed due to inactivity.

adam referenced this issue

2025-12-29 22:22:48 +01:00

[PR #3807] [MERGED] Fixes 3712 #12643

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3807