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

Document prefilling custom script variables via URL parameters #11739

New Issue
Closed
opened 2025-12-29 21:49:18 +01:00 by adam · 2 comments
adam commented 2025-12-29 21:49:18 +01:00
Owner
Copy Link

Originally created by @pheus on GitHub (Oct 16, 2025).

Originally assigned to: @pheus on GitHub.

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 GitHub (Oct 16, 2025). Originally assigned to: @pheus on GitHub. ### 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.
adam added the status: acceptedtype: documentation labels 2025-12-29 21:49:18 +01:00
adam closed this issue 2025-12-29 21:49:18 +01:00
adam commented 2025-12-29 21:49:19 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Oct 16, 2025):

This docs issue stems from the discussion on #20593, where a user asked about prefilling custom script variables via URL query parameters. The behavior works today but isn’t documented. If this addition is accepted, I’d be happy to contribute a PR to add a short “Prefilling variables via URL parameters” section under Custom Scripts.

@pheus commented on GitHub (Oct 16, 2025): This docs issue stems from the discussion on #20593, where a user asked about prefilling custom script variables via URL query parameters. The behavior works today but isn’t documented. If this addition is accepted, I’d be happy to contribute a PR to add a short “Prefilling variables via URL parameters” section under Custom Scripts.
adam commented 2025-12-29 21:49:19 +01:00
Author
Owner
Copy Link

@jnovinger commented on GitHub (Oct 18, 2025):

Thanks, @pheus .

@jnovinger commented on GitHub (Oct 18, 2025): Thanks, @pheus .
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 status: accepted type: documentation
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#11739
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?