mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Update ObjectVar docs to reflect new filter_fields attribute

Browse Source
This commit is contained in:
thatmattlove
2021-08-26 00:33:17 -07:00
parent 52a1f9ddf0
commit d0208d473d
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/customization/custom-scripts.md
View File

@ -171,6 +171,7 @@ A particular object within NetBox. Each ObjectVar must specify a particular mode
* `model` - The model class * `model` - The model class
* `query_params` - A dictionary of query parameters to use when retrieving available options (optional) * `query_params` - A dictionary of query parameters to use when retrieving available options (optional)
* `filter_fields` - A dictionary or list of dictionaries that define a related field (optional)
* `null_option` - A label representing a "null" or empty choice (optional) * `null_option` - A label representing a "null" or empty choice (optional)
To limit the selections available within the list, additional query parameters can be passed as the `query_params` dictionary. For example, to show only devices with an "active" status: To limit the selections available within the list, additional query parameters can be passed as the `query_params` dictionary. For example, to show only devices with an "active" status:
@ -184,7 +185,9 @@ device = ObjectVar(
) )
``` ```
Multiple values can be specified by assigning a list to the dictionary key. It is also possible to reference the value of other fields in the form by prepending a dollar sign (`$`) to the variable's name. Multiple values can be specified by assigning a list to the dictionary key.
It is also possible to reference the value of other fields in the form by using the `filter_fields` attribute. For example, to only show sites matching the selected region:
```python ```python
region = ObjectVar( region = ObjectVar(
@ -192,12 +195,15 @@ region = ObjectVar(
) )
site = ObjectVar( site = ObjectVar(
model=Site, model=Site,
query_params={ filter_fields={
'region_id': '$region' 'accessor': 'region_id',
'field_name': 'region',
} }
) )
``` ```
In this example, `accessor` refers to the `region_id` field on the `Site` model, and `field_name` refers to form field name of the `Region` model.
### MultiObjectVar ### MultiObjectVar
Similar to `ObjectVar`, but allows for the selection of multiple objects. Similar to `ObjectVar`, but allows for the selection of multiple objects.