inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 21:26:43 +00:00
Code

Add example for filtering by parent in the Python API docs (#380)

Browse Source 
* Add example for filtering by parent in the Python API docs

* Add example to query the topmost items
This commit is contained in:
Miklós Márton 2022-10-30 10:18:45 +01:00 committed by GitHub
parent 48baf7e051
commit 0ade52aa3b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/api/python/python.md
View File

@ -95,6 +95,24 @@ items = StockItem.list(api, location=4, part=24)
The `items` variable above provides a list of `StockItem` objects.
#### Filtering by parent
In tree based models the child items could be filtered by using the parent keyword:
```python
from inventree.part import PartCategory
child_categories = PartCategory.list(api, parent=10)
```
The top level items can can be queried by passing empty string as a parent filter:
```python
from inventree.part import PartCategory
parent_categories = PartCategory.list(api, parent='')
```
### Item Attributes
The available model attributes are determined by introspecting [API metadata](../metadata.md). To view the fields (attributes) availabel for a given database model type within the python interface, use the `fieldNames` and `fieldInfo` methods, as below: