Document prefilling custom script variables via URL parameters #1045

New Issue

MrUnknownDE · 2026-04-05T20:02:50+02:00

MrUnknownDE commented

2026-04-05 20:02:50 +02:00

Originally created by @pheus on 10/16/2025

Change Type

Addition

Area

Customization

Proposed Changes

Clarify that custom script form fields can be initialized from URL query parameters whose names match the script variable names. Include examples for scalar types (e.g., StringVar, IntegerVar) and ObjectVar.

Affected page: docs/customization/custom-scripts.md

Details / Acceptance Criteria:

Add a subsection, “Prefilling variables via URL parameters.”
Explain that query parameters with names matching script variables are used as initial form values (editable before execution).
Document how to prefill ObjectVar using the object’s primary key.
Note behavior when the provided object ID is invalid or not visible due to permissions (field remains unprefilled).
Provide a concrete example:
- Example script defining name = StringVar(), count = IntegerVar(), and device = ObjectVar(model=Device).
- Example URL(s) showing ...?name=Branch42&count=3 and ...?device=1.

Rationale: This capability exists but is currently undocumented; users have asked how to prefill script fields from the URL.

*Originally created by @pheus on 10/16/2025* ### Change Type Addition ### Area Customization ### Proposed Changes Clarify that custom script form fields can be initialized from URL query parameters whose names match the script variable names. Include examples for scalar types (e.g., `StringVar`, `IntegerVar`) and `ObjectVar`. **Affected page:** `docs/customization/custom-scripts.md` **Details / Acceptance Criteria:** - Add a subsection, **“Prefilling variables via URL parameters.”** - Explain that query parameters with names matching script variables are used as initial form values (editable before execution). - Document how to prefill `ObjectVar` using the object’s primary key. - Note behavior when the provided object ID is invalid or not visible due to permissions (field remains unprefilled). - Provide a concrete example: - Example script defining `name = StringVar()`, `count = IntegerVar()`, and `device = ObjectVar(model=Device)`. - Example URL(s) showing `...?name=Branch42&count=3` and `...?device=1`. **Rationale:** This capability exists but is currently undocumented; users have asked how to prefill script fields from the URL.

MrUnknownDE closed this issue

2026-04-05 20:02:50 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation type: documentation

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#1045