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

Script Rest API has no results #8273

New Issue
Closed
opened 2025-12-29 20:34:34 +01:00 by adam · 6 comments
adam commented 2025-12-29 20:34:34 +01:00
Owner
Copy Link

Originally created by @jiuka on GitHub (Jun 30, 2023).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.5.4

Python version

3.11

Steps to Reproduce

  1. Save this script into a file called bug.py
from extras.scripts import *


class Bug13061(Script):

    class Meta:
        name = "Demo for Bug13061"
        description = "Demo for Bug13061"

    def run(self, data, commit):
        self.log_success(f"Demo for Bug13061")
  1. Go to https://netbox.example.com/extras/scripts/add/
  2. Upload the bug.py file.
  3. Got to https://netbox.example.com/extras/scripts/bug/Bug13061/
  4. Click on Run Script
  5. Go to https://netbox.example.com/api/extras/scripts/bug.Bug13061/

Expected Behavior

The result should be job result like in the reports endpoint.

Observed Behavior

It is always null.

The job.name is just the name of the script class. When search for the result the script.name
 is used and not the class_name therefore no results are found, unless the name ist set to the same value as the class_name.

Originally created by @jiuka on GitHub (Jun 30, 2023). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.5.4 ### Python version 3.11 ### Steps to Reproduce 1. Save this script into a file called `bug.py` ``` from extras.scripts import * class Bug13061(Script): class Meta: name = "Demo for Bug13061" description = "Demo for Bug13061" def run(self, data, commit): self.log_success(f"Demo for Bug13061") ``` 2. Go to https://netbox.example.com/extras/scripts/add/ 3. Upload the `bug.py` file. 4. Got to https://netbox.example.com/extras/scripts/bug/Bug13061/ 5. Click on `Run Script` 6. Go to https://netbox.example.com/api/extras/scripts/bug.Bug13061/ ### Expected Behavior The `result` should be job result like in the reports endpoint. ### Observed Behavior It is always `null`. The [job.name](https://github.com/netbox-community/netbox/blob/develop/netbox/extras/api/views.py#L293C13-L293C21) is just the name of the script class. When search for the result the [script.name ](https://github.com/netbox-community/netbox/blob/develop/netbox/extras/api/views.py#L306C41-L306C52) is used and not the `class_name` therefore no results are found, unless the `name` ist set to the same value as the `class_name`.
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 20:34:34 +01:00
adam closed this issue 2025-12-29 20:34:35 +01:00
adam commented 2025-12-29 20:34:35 +01:00
Author
Owner
Copy Link

@abhi1693 commented on GitHub (Jun 30, 2023):

Thank you for opening a bug report. Unfortunately, the information you have provided is not sufficient for someone else to attempt to reproduce the reported behavior. Remember, each bug report must include detailed steps that someone else can follow on a clean, empty NetBox installation to reproduce the exact problem you're experiencing. These instructions should include the creation of any involved objects, any configuration changes, and complete accounting of the actions being taken. Also be sure that your report does not reference data on the public NetBox demo, as that is subject to change at any time by an outside party and cannot be relied upon for bug reports.

@abhi1693 commented on GitHub (Jun 30, 2023): Thank you for opening a bug report. Unfortunately, the information you have provided is not sufficient for someone else to attempt to reproduce the reported behavior. Remember, each bug report must include detailed steps that someone else can follow on a clean, empty NetBox installation to reproduce the exact problem you're experiencing. These instructions should include the creation of any involved objects, any configuration changes, and complete accounting of the actions being taken. Also be sure that your report does not reference data on the public NetBox demo, as that is subject to change at any time by an outside party and cannot be relied upon for bug reports.
adam commented 2025-12-29 20:34:36 +01:00
Author
Owner
Copy Link

@jiuka commented on GitHub (Jun 30, 2023):

I hope it is detailed enough.

@jiuka commented on GitHub (Jun 30, 2023): I hope it is detailed enough.
adam commented 2025-12-29 20:34:36 +01:00
Author
Owner
Copy Link

@bitcollector1 commented on GitHub (Jul 5, 2023):

I have the same issue. Here you can see an example of just (1) of my scripts reported correctly, even though all of them completed successfully.

Screenshot 2023-07-05 at 09 28 52

@bitcollector1 commented on GitHub (Jul 5, 2023): I have the same issue. Here you can see an example of just (1) of my scripts reported correctly, even though all of them completed successfully. ![Screenshot 2023-07-05 at 09 28 52](https://github.com/netbox-community/netbox/assets/50723251/9df5650c-e361-45c5-8cba-2c1530afcbf1)
adam commented 2025-12-29 20:34:37 +01:00
Author
Owner
Copy Link

@jiuka commented on GitHub (Jul 11, 2023):

Hi @jeremystretch

This fixed the GUI but not the Rest API I made bug about. Should I create a new bug report or do you want to reopen this one?

Regards and many thanks for Netbox

Marius

@jiuka commented on GitHub (Jul 11, 2023): Hi @jeremystretch This fixed the GUI but not the Rest API I made bug about. Should I create a new bug report or do you want to reopen this one? Regards and many thanks for Netbox Marius
adam commented 2025-12-29 20:34:37 +01:00
Author
Owner
Copy Link

@cholyoak commented on GitHub (Jul 12, 2023):

That's right. There are still inconsistencies in calling .name instead of .class_name in netbox/extras/api/views.py and netbox/extras/management/commands/runscript.py (this affects running scripst from the command line too). I can share a patch if you like.

@cholyoak commented on GitHub (Jul 12, 2023): That's right. There are still inconsistencies in calling `.name` instead of `.class_name` in `netbox/extras/api/views.py` and `netbox/extras/management/commands/runscript.py` (this affects running scripst from the command line too). I can share a patch if you like.
adam commented 2025-12-29 20:34:37 +01:00
Author
Owner
Copy Link

@jsenecal commented on GitHub (Jul 12, 2023):

This fixed the GUI but not the Rest API I made bug about. Should I create a new bug report or do you want to reopen this one?

Regards and many thanks for Netbox

Marius

@jiuka Please open a new bug report with a reference to this issue as this has been merged into a release.
Thanks,

@cholyoak you could chime in that other issue should your comment be relevant to that issue as well.

@jsenecal commented on GitHub (Jul 12, 2023): > This fixed the GUI but not the Rest API I made bug about. Should I create a new bug report or do you want to reopen this one? > > Regards and many thanks for Netbox > > Marius @jiuka Please open a new bug report with a reference to this issue as this has been merged into a release. Thanks, @cholyoak you could chime in that other issue should your comment be relevant to that issue as well.
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 severity: low status: accepted type: bug
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#8273
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?