inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-12-20 02:53:18 +00:00
Code Activity

API docs (#379)

Browse Source 
* Move API documentation into separate directory

* Rearrange main docs bar

* Split python examples into separate page

* Fix broken links

* Adds page for browseable API

* Fix image links

* Add entrypoint page for barcodes

* Update barcode docs

* Add (empty) pages for internal and external barcods

* Add documentation on "internal" barcode format

* Documentation for external barcode functionality

* Skeleton page for custom barcode information

* Extend docs for custom barcodesplugins

* Add stubs for new API docs

* Add documentation for downloading data via the AP

* API metadata information

* docs for pythonic metadata access

* docs for bulk delete
This commit is contained in:
Oliver
2022-10-29 14:46:06 +11:00
committed by GitHub
parent 415accae21
commit 48baf7e051
30 changed files with 572 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/api/download.md Normal file
View File

@@ -0,0 +1,23 @@
---
title: Data Download
---
## Data Download
Some API endpoints provide a *download* function, whereby the data presented at the API endpoint can be downloaded as a tabulated file.
To export API data to a file, add the `&export=<format>` modifier to the query. The following file formats are supported:
| File Format | Modifier |
| --- | --- |
| csv | `&format=csv` |
| tsv | `&format=tsv` |
| xls | `&format=xls` |
| xlsx | `&format=xlsx` |
### Query Filters
Any other query filters used in the API request are also observed when downloading the data. For example, to download a list of all stock items in a given location:
`<host>/api/stock/?format=csv&location=10`