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

api custom_field filter with negation #9549

New Issue
Open
opened 2025-12-29 20:51:19 +01:00 by adam · 4 comments
adam commented 2025-12-29 20:51:19 +01:00
Owner
Copy Link

Originally created by @davama on GitHub (Apr 26, 2024).

NetBox version

v3.7.6

Feature type

Change to existing functionality

Proposed functionality

Good day everyone,

Had posted this here and was told to repost as an FR. I can repost the details of that ticket into this one, if that is desired. Hope I'm doing this ticket correctly...

Essentially, just as you can filter negation on regular fields, custom fields should also be possible.

Thank you for your consideration.

Best,
Dave

Use case

We have a custom field with default value null or "empty".

Filter combination of __emtpy=true, __emtpy=1, __ic=null , __nie=null do not work.

Database changes

No response

External dependencies

No response

Originally created by @davama on GitHub (Apr 26, 2024). ### NetBox version v3.7.6 ### Feature type Change to existing functionality ### Proposed functionality Good day everyone, Had posted this [here](https://github.com/netbox-community/netbox/issues/15849) and was told to repost as an FR. I can repost the details of that ticket into this one, if that is desired. Hope I'm doing this ticket correctly... Essentially, just as you can filter negation on regular fields, custom fields should also be possible. Thank you for your consideration. Best, Dave ### Use case We have a custom field with default value `null` or "empty". Filter combination of `__emtpy=true`, `__emtpy=1`, `__ic=null` , `__nie=null` do not work. ### Database changes _No response_ ### External dependencies _No response_
adam added the type: featurecomplexity: mediumnetboxstatus: backlog labels 2025-12-29 20:51:19 +01:00
adam commented 2025-12-29 20:51:20 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Apr 29, 2024):

From previous ticket:

Steps to Reproduce

I am trying to filter for custom fields that are not null or not a string. Saw this ticket but it is closed now.
Created the below cf for testing.

custom_fields 
[
  {
    "id": 35,
    "url": "https://redacted/api/extras/custom-fields/35/",
    "display": "repoempty",
    "content_types": [
      "dcim.device"
    ],
    "type": {
      "value": "text",
      "label": "Text"
    },
    "object_type": null,
    "data_type": "string",
    "name": "repoempty",
    "label": "repoempty",
    "group_name": "",
    "description": "dummy cf - when default value is the literal string \"\"",
    "required": false,
    "search_weight": 1000,
    "filter_logic": {
      "value": "loose",
      "label": "Loose"
    },
    "ui_visible": {
      "value": "always",
      "label": "Always"
    },
    "ui_editable": {
      "value": "yes",
      "label": "Yes"
    },
    "is_cloneable": false,
    "default": "",
    "weight": 100,
    "validation_minimum": null,
    "validation_maximum": null,
    "validation_regex": "",
    "choice_set": null,
    "created": "2024-04-25T14:01:21.196733Z",
    "last_updated": "2024-04-25T14:01:21.196769Z"
  },
  {
    "id": 34,
    "url": "https://redacted/api/extras/custom-fields/34/",
    "display": "repoemptystring",
    "content_types": [
      "dcim.device"
    ],
    "type": {
      "value": "text",
      "label": "Text"
    },
    "object_type": null,
    "data_type": "string",
    "name": "repoemptystring",
    "label": "repoemptystring",
    "group_name": "",
    "description": "dummy cf - when default value is the literal string \"empty\"",
    "required": false,
    "search_weight": 1000,
    "filter_logic": {
      "value": "loose",
      "label": "Loose"
    },
    "ui_visible": {
      "value": "always",
      "label": "Always"
    },
    "ui_editable": {
      "value": "yes",
      "label": "Yes"
    },
    "is_cloneable": false,
    "default": "empty",
    "weight": 100,
    "validation_minimum": null,
    "validation_maximum": null,
    "validation_regex": "",
    "choice_set": null,
    "created": "2024-04-25T14:00:02.456419Z",
    "last_updated": "2024-04-25T14:00:02.456460Z"
  },
  {
    "id": 33,
    "url": "https://redacted/api/extras/custom-fields/33/",
    "display": "reponull",
    "content_types": [
      "dcim.device"
    ],
    "type": {
      "value": "text",
      "label": "Text"
    },
    "object_type": null,
    "data_type": "string",
    "name": "reponull",
    "label": "reponull",
    "group_name": "",
    "description": "dummy cf - when default value is null",
    "required": false,
    "search_weight": 1000,
    "filter_logic": {
      "value": "loose",
      "label": "Loose"
    },
    "ui_visible": {
      "value": "always",
      "label": "Always"
    },
    "ui_editable": {
      "value": "yes",
      "label": "Yes"
    },
    "is_cloneable": false,
    "default": null,
    "weight": 100,
    "validation_minimum": null,
    "validation_maximum": null,
    "validation_regex": "",
    "choice_set": null,
    "created": "2024-04-25T13:57:41.959924Z",
    "last_updated": "2024-04-25T13:57:41.959962Z"
  },
  {
    "id": 36,
    "url": "https://redacted/api/extras/custom-fields/36/",
    "display": "reponullstring",
    "content_types": [
      "dcim.device"
    ],
    "type": {
      "value": "text",
      "label": "Text"
    },
    "object_type": null,
    "data_type": "string",
    "name": "reponullstring",
    "label": "reponullstring",
    "group_name": "",
    "description": "dummy cf - when default value is the literal string \"null\"",
    "required": false,
    "search_weight": 1000,
    "filter_logic": {
      "value": "loose",
      "label": "Loose"
    },
    "ui_visible": {
      "value": "always",
      "label": "Always"
    },
    "ui_editable": {
      "value": "yes",
      "label": "Yes"
    },
    "is_cloneable": false,
    "default": "null",
    "weight": 100,
    "validation_minimum": null,
    "validation_maximum": null,
    "validation_regex": "",
    "choice_set": null,
    "created": "2024-04-25T14:03:07.790615Z",
    "last_updated": "2024-04-25T14:03:07.790651Z"
  }
]

The default values look like this on a device:

                "repoempty": "",
                "repoemptystring": "empty",
                "reponull": null,
                "reponullstring": "null",

The values I changed for one device:

                "repoempty": "data",
                "repoemptystring": "something",
                "reponull": null,
                "reponullstring": "null",

API calls that worked

/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoempty=data
/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoemptystring=something  ( I know it's redundant)

The API calls that did not work. I would still get all my devices for X site.

/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoempty=
/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoempty__nie=data
/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoemptystring__nie=something
/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_reponull__empty=false
/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_reponull__empty=0
/api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_reponullstring=null (got ValueError `Cannot use None as a query value`)
@arthanson commented on GitHub (Apr 29, 2024): From previous ticket: ### Steps to Reproduce I am trying to filter for custom fields that are not `null` or not a string. Saw this [ticket](https://github.com/netbox-community/netbox/issues/11538) but it is closed now. Created the below cf for testing. <details open> <summary>custom_fields</summary> <br> <pre> [ { "id": 35, "url": "https://redacted/api/extras/custom-fields/35/", "display": "repoempty", "content_types": [ "dcim.device" ], "type": { "value": "text", "label": "Text" }, "object_type": null, "data_type": "string", "name": "repoempty", "label": "repoempty", "group_name": "", "description": "dummy cf - when default value is the literal string \"\"", "required": false, "search_weight": 1000, "filter_logic": { "value": "loose", "label": "Loose" }, "ui_visible": { "value": "always", "label": "Always" }, "ui_editable": { "value": "yes", "label": "Yes" }, "is_cloneable": false, "default": "", "weight": 100, "validation_minimum": null, "validation_maximum": null, "validation_regex": "", "choice_set": null, "created": "2024-04-25T14:01:21.196733Z", "last_updated": "2024-04-25T14:01:21.196769Z" }, { "id": 34, "url": "https://redacted/api/extras/custom-fields/34/", "display": "repoemptystring", "content_types": [ "dcim.device" ], "type": { "value": "text", "label": "Text" }, "object_type": null, "data_type": "string", "name": "repoemptystring", "label": "repoemptystring", "group_name": "", "description": "dummy cf - when default value is the literal string \"empty\"", "required": false, "search_weight": 1000, "filter_logic": { "value": "loose", "label": "Loose" }, "ui_visible": { "value": "always", "label": "Always" }, "ui_editable": { "value": "yes", "label": "Yes" }, "is_cloneable": false, "default": "empty", "weight": 100, "validation_minimum": null, "validation_maximum": null, "validation_regex": "", "choice_set": null, "created": "2024-04-25T14:00:02.456419Z", "last_updated": "2024-04-25T14:00:02.456460Z" }, { "id": 33, "url": "https://redacted/api/extras/custom-fields/33/", "display": "reponull", "content_types": [ "dcim.device" ], "type": { "value": "text", "label": "Text" }, "object_type": null, "data_type": "string", "name": "reponull", "label": "reponull", "group_name": "", "description": "dummy cf - when default value is null", "required": false, "search_weight": 1000, "filter_logic": { "value": "loose", "label": "Loose" }, "ui_visible": { "value": "always", "label": "Always" }, "ui_editable": { "value": "yes", "label": "Yes" }, "is_cloneable": false, "default": null, "weight": 100, "validation_minimum": null, "validation_maximum": null, "validation_regex": "", "choice_set": null, "created": "2024-04-25T13:57:41.959924Z", "last_updated": "2024-04-25T13:57:41.959962Z" }, { "id": 36, "url": "https://redacted/api/extras/custom-fields/36/", "display": "reponullstring", "content_types": [ "dcim.device" ], "type": { "value": "text", "label": "Text" }, "object_type": null, "data_type": "string", "name": "reponullstring", "label": "reponullstring", "group_name": "", "description": "dummy cf - when default value is the literal string \"null\"", "required": false, "search_weight": 1000, "filter_logic": { "value": "loose", "label": "Loose" }, "ui_visible": { "value": "always", "label": "Always" }, "ui_editable": { "value": "yes", "label": "Yes" }, "is_cloneable": false, "default": "null", "weight": 100, "validation_minimum": null, "validation_maximum": null, "validation_regex": "", "choice_set": null, "created": "2024-04-25T14:03:07.790615Z", "last_updated": "2024-04-25T14:03:07.790651Z" } ] </pre> </details> The default values look like this on a device: ``` "repoempty": "", "repoemptystring": "empty", "reponull": null, "reponullstring": "null", ``` The values I changed for one device: ``` "repoempty": "data", "repoemptystring": "something", "reponull": null, "reponullstring": "null", ``` API calls that worked ``` /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoempty=data /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoemptystring=something ( I know it's redundant) ``` The API calls that did not work. I would still get all my devices for X site. ``` /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoempty= /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoempty__nie=data /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_repoemptystring__nie=something /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_reponull__empty=false /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_reponull__empty=0 /api/dcim/devices/?exclude=config_context&limit=0&site=usa-ht&cf_reponullstring=null (got ValueError `Cannot use None as a query value`) ```
adam commented 2025-12-29 20:51:20 +01:00
Author
Owner
Copy Link

@davama commented on GitHub (Apr 29, 2024):

@arthanson
Thank you for that

@davama commented on GitHub (Apr 29, 2024): @arthanson Thank you for that
adam commented 2025-12-29 20:51:20 +01:00
Author
Owner
Copy Link

@llamafilm commented on GitHub (Jul 2, 2024):

Filtering custom fields would also be very helpful for me in custom scripts. Is it fair to assume that when this is implemented for Rest API, the same filtering operators will work in Python scripts too?

For example, I can match a specific value like this:

>>> Prefix.objects.filter(custom_field_data__bloxone_id='ff249123-287b-11ec-a803-26abf9fc4e12')
<PrefixQuerySet [<Prefix: [10.56.225.0/24](http://10.56.225.0/24)>]>

But appending __n returns nothing:

>>> Prefix.objects.filter(custom_field_data__bloxone_id__n='something')
<PrefixQuerySet []>
@llamafilm commented on GitHub (Jul 2, 2024): Filtering custom fields would also be very helpful for me in custom scripts. Is it fair to assume that when this is implemented for Rest API, the same filtering operators will work in Python scripts too? For example, I can match a specific value like this: ``` >>> Prefix.objects.filter(custom_field_data__bloxone_id='ff249123-287b-11ec-a803-26abf9fc4e12') <PrefixQuerySet [<Prefix: [10.56.225.0/24](http://10.56.225.0/24)>]> ``` But appending `__n` returns nothing: ``` >>> Prefix.objects.filter(custom_field_data__bloxone_id__n='something') <PrefixQuerySet []> ```
adam commented 2025-12-29 20:51:20 +01:00
Author
Owner
Copy Link

@gs-adn commented on GitHub (May 2, 2025):

I think the reclassification as a feature request was a mistake; this works perfectly fine if the text fields have "exact" filter_logic instead of "loose", using __n=null filter

Filters for values of type text and filtering loose, the lookup_expr given seem to be ignored/overriden here.

Fix seems trivial (20bbe33233), happy to send it as a PR if that seems the right option

@gs-adn commented on GitHub (May 2, 2025): I think the reclassification as a feature request was a mistake; this works perfectly fine if the text fields have "exact" filter_logic instead of "loose", using `__n=null` filter Filters for values of type `text` and filtering `loose`, the `lookup_expr` given seem to be ignored/overriden [here](https://github.com/netbox-community/netbox/blob/aea51df06ccfb880385dc8e92e1ffbe3113bcb55/netbox/extras/models/customfields.py#L614). Fix seems trivial (https://github.com/gs-adn/netbox/commit/20bbe332335a458f3738c7b7ba4f504f862395ea), happy to send it as a PR if that seems the right option
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 complexity: medium netbox status: backlog type: feature
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#9549
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?