NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-16 12:38:17 -06:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Add a phrase referencing where the non-fixed fields are

Browse Source
This commit is contained in:
lf 2019-08-16 16:22:13 -06:00 committed by GitHub
parent 7fc60cd667
commit 9e73858147
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/overview.md
View File

@ -297,6 +297,8 @@ The choices available for fixed choice fields such as `status` are exposed in th
], ],
``` ```
A full list of non-fixed field filters can be found in the netbox source in `filters.py` in the subdirectory for the desired module, for example, `dcim` or `ipam`.
For most fields, when a filter is passed multiple times, objects matching _any_ of the provided values will be returned. For example, `GET /api/dcim/sites/?name=Foo&name=Bar` will return all sites named "Foo" _or_ "Bar". The exception to this rule is ManyToManyFields which may have multiple values assigned. Tags are the most common example of a ManyToManyField. For example, `GET /api/dcim/sites/?tag=foo&tag=bar` will return only sites tagged with both "foo" _and_ "bar". For most fields, when a filter is passed multiple times, objects matching _any_ of the provided values will be returned. For example, `GET /api/dcim/sites/?name=Foo&name=Bar` will return all sites named "Foo" _or_ "Bar". The exception to this rule is ManyToManyFields which may have multiple values assigned. Tags are the most common example of a ManyToManyField. For example, `GET /api/dcim/sites/?tag=foo&tag=bar` will return only sites tagged with both "foo" _and_ "bar".
## Custom Fields ## Custom Fields