Error unsetting or updating custom field (multi-)object via API #7323

New Issue

adam · 2025-12-29T20:21:45+01:00

adam commented

2025-12-29 20:21:45 +01:00

Originally created by @alegru on GitHub (Dec 5, 2022).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.3.9

Python version

3.9

Steps to Reproduce

Create a custom field object and multiobject (here: for dcim.device)
Edit a device and fill the new custom fields via UI.
Try unsetting the custom fields via REST API, for example:

curl -X 'PATCH'
'http://localhost:8000/api/dcim/devices/1/'
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H 'Authorization: Token token'
-d '{
"custom_fields": {
"object_field": null
}
}'

and

curl -X 'PATCH'
'http://localhost:8000/api/dcim/devices/1/'
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H 'Authorization: Token token'
-d '{
"custom_fields": {
"multiobject_field": null
}
}'

Also, try updating the object with the full payload received when querying the API:

curl -X 'PATCH'
'http://localhost:8000/api/dcim/devices/1/'
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H 'Authorization: Token token'
-d '{
"custom_fields": {
"object_field": {"id": 2, "url": "http://localhost:8000/api/dcim/devices/2/", "display": "testdevice", "name": "testdevice"}
}
}'

curl -X 'PATCH'
'http://localhost:8000/api/dcim/devices/1/'
-H 'accept: application/json'
-H 'Content-Type: application/json'
-H 'Authorization: Token token'
-d '{
"custom_fields": {
"multiobject_field": [{"id": 2, "url": "http://localhost:8000/api/dcim/devices/2/", "display": "testdevice", "name": "testdevice"}]
}
}'

Expected Behavior

The custom fields of the object should be cleared in the first example, and updated in the second.

Observed Behavior

The examples yield variations of an "Unknown related object" error message.
Unsetting custom fields:
{"custom_fields":["Unknown related object(s): None"]}

Updating custom field object as received from the API:
{"custom_fields":["Unknown related object(s): {'id': 1, 'url': 'http://localhost:8000/api/dcim/devices/1/', 'display': 'testdevice', 'name': 'testdevice'}"]}

Updating custom field multiobject as received from the API:
{"custom_fields":["Unknown related object(s): [{'id': 1, 'url': 'http://localhost:8000/api/dcim/devices/1/', 'display': 'testdevice', 'name': 'testdevice'}]"]}

Originally created by @alegru on GitHub (Dec 5, 2022). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.3.9 ### Python version 3.9 ### Steps to Reproduce Create a custom field object and multiobject (here: for dcim.device) Edit a device and fill the new custom fields via UI. Try unsetting the custom fields via REST API, for example: curl -X 'PATCH' \ 'http://localhost:8000/api/dcim/devices/1/' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Token token' \ -d '{ "custom_fields": { "object_field": null } }' and curl -X 'PATCH' \ 'http://localhost:8000/api/dcim/devices/1/' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Token token' \ -d '{ "custom_fields": { "multiobject_field": null } }' Also, try updating the object with the full payload received when querying the API: curl -X 'PATCH' \ 'http://localhost:8000/api/dcim/devices/1/' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Token token' \ -d '{ "custom_fields": { "object_field": {"id": 2, "url": "http://localhost:8000/api/dcim/devices/2/", "display": "testdevice", "name": "testdevice"} } }' curl -X 'PATCH' \ 'http://localhost:8000/api/dcim/devices/1/' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Token token' \ -d '{ "custom_fields": { "multiobject_field": [{"id": 2, "url": "http://localhost:8000/api/dcim/devices/2/", "display": "testdevice", "name": "testdevice"}] } }' ### Expected Behavior The custom fields of the object should be cleared in the first example, and updated in the second. ### Observed Behavior The examples yield variations of an "Unknown related object" error message. Unsetting custom fields: {"custom_fields":["Unknown related object(s): None"]} Updating custom field object as received from the API: {"custom_fields":["Unknown related object(s): {'id': 1, 'url': 'http://localhost:8000/api/dcim/devices/1/', 'display': 'testdevice', 'name': 'testdevice'}"]} Updating custom field multiobject as received from the API: {"custom_fields":["Unknown related object(s): [{'id': 1, 'url': 'http://localhost:8000/api/dcim/devices/1/', 'display': 'testdevice', 'name': 'testdevice'}]"]}

adam added the type: bug status: accepted labels 2025-12-29 20:21:45 +01:00

adam closed this issue

2025-12-29 20:21:45 +01:00

adam commented

2025-12-29 20:21:46 +01:00

@alegru commented on GitHub (Dec 5, 2022):

related commit:
d5538c1ca3

@alegru commented on GitHub (Dec 5, 2022): related commit: d5538c1ca3d7ef7ca2d457ce22bbc645b8b65505

adam referenced this issue

2025-12-29 22:26:10 +01:00

[PR #7393] [MERGED] Release v3.0.4 #13239

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#7323