change ID is returned on API calls that modify data. #3824

Closed
opened 2025-12-29 18:31:22 +01:00 by adam · 1 comment
Owner

Originally created by @baldgeek on GitHub (Jul 1, 2020).

Environment

  • Python version: 3.6.8
  • NetBox version: 2.8.6

Proposed Functionality

Any patch, delete, creation returns the change ID for the change record created so that the object change API can be called to verify or collect data for rollback.

Use Case

Be able to find the change record for the work just done to pull change record for rollback or verification.

Database Changes

I do not believe this would require and database changes. These records already exist.

External Dependencies

I don't think there is any external dependencies, however timing of when the change record is created vs when the results are returned to the API call might make this problematic to implement.

Originally created by @baldgeek on GitHub (Jul 1, 2020). ### Environment * Python version: 3.6.8 * NetBox version: 2.8.6 ### Proposed Functionality Any patch, delete, creation returns the change ID for the change record created so that the object change API can be called to verify or collect data for rollback. ### Use Case Be able to find the change record for the work just done to pull change record for rollback or verification. ### Database Changes I do not believe this would require and database changes. These records already exist. ### External Dependencies I don't think there is any external dependencies, however timing of when the change record is created vs when the results are returned to the API call might make this problematic to implement.
adam closed this issue 2025-12-29 18:31:22 +01:00
Author
Owner

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

It's a neat idea, but unfortunately this would require far too much development effort (and a bit of performance impact) to warrant the minor convenience. The way DRF employs serializers doesn't easily allow for the arbitrary attachment of additional information such as this. However, you can easily fetch the most recent change record for any object by querying the /api/extras/object-changes/ API endpoint.

@jeremystretch commented on GitHub (Jul 1, 2020): It's a neat idea, but unfortunately this would require far too much development effort (and a bit of performance impact) to warrant the minor convenience. The way DRF employs serializers doesn't easily allow for the arbitrary attachment of additional information such as this. However, you can easily fetch the most recent change record for any object by querying the `/api/extras/object-changes/` API endpoint.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3824