lgcosta/paperless-ngx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add custom_fields to docs

Browse Source
This commit is contained in:
shamoon
2023-11-03 02:30:00 -07:00
parent 59a08ff2a2
commit 511ffbf2b7
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api.md
View File

@@ -20,6 +20,7 @@ The API provides the following main endpoints:
- `/api/users/`: Full CRUD support. - `/api/users/`: Full CRUD support.
- `/api/groups/`: Full CRUD support. - `/api/groups/`: Full CRUD support.
- `/api/share_links/`: Full CRUD support. - `/api/share_links/`: Full CRUD support.
- `/api/custom_fields/`: Full CRUD support.
All of these endpoints except for the logging endpoint allow you to All of these endpoints except for the logging endpoint allow you to
fetch (and edit and delete where appropriate) individual objects by fetch (and edit and delete where appropriate) individual objects by
@@ -51,6 +52,8 @@ fields:
- `notes`: Array of notes associated with the document. - `notes`: Array of notes associated with the document.
- `set_permissions`: Allows setting document permissions. Optional, - `set_permissions`: Allows setting document permissions. Optional,
write-only. See [below](#permissions). write-only. See [below](#permissions).
- `custom_fields`: Array of custom fields & values, specified as
{ field: CUSTOM_FIELD_ID, value: VALUE }
## Downloading documents ## Downloading documents