mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-04-27 21:26:43 +00:00
48baf7e051
* 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
678 B
678 B
title
| 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