paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add tasks endpoint to list, clarify use

Browse Source
This commit is contained in:
shamoon 2023-04-10 09:38:14 -07:00
parent 23e7ccb543
commit f7cea2f92e
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api.md
View File

@ -14,14 +14,15 @@ The API provides 7 main endpoints:
- `/api/document_types/`: Full CRUD support. - `/api/document_types/`: Full CRUD support.
- `/api/logs/`: Read-Only. - `/api/logs/`: Read-Only.
- `/api/tags/`: Full CRUD support. - `/api/tags/`: Full CRUD support.
- `/api/tasks/`: Read-only.
- `/api/mail_accounts/`: Full CRUD support. - `/api/mail_accounts/`: Full CRUD support.
- `/api/mail_rules/`: Full CRUD support. - `/api/mail_rules/`: Full CRUD support.
- `/api/users/`: Full CRUD support. - `/api/users/`: Full CRUD support.
- `/api/groups/`: Full CRUD support. - `/api/groups/`: 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, edit and delete individual objects by appending their primary key fetch (and edit and delete where appropriate) individual objects by
to the path, for example `/api/documents/454/`. appending their primary key to the path, e.g. `/api/documents/454/`.
The objects served by the document endpoint contain the following The objects served by the document endpoint contain the following
fields: fields:
@ -261,10 +262,11 @@ The endpoint supports the following optional form fields:
The endpoint will immediately return HTTP 200 if the document consumption The endpoint will immediately return HTTP 200 if the document consumption
process was started successfully, with the UUID of the consumption task process was started successfully, with the UUID of the consumption task
as the data. No additional status information about as the data. No additional status information about the consumption process
the consumption process itself is available immediately, since that happens in a itself is available immediately, since that happens in a different process.
different process. Querying the tasks endpoint with the returned UUID will However, querying the tasks endpoint with the returned UUID e.g.
provide information on the state of the consumption. `/api/tasks/?task_id={uuid}` will provide information on the state of the
consumption including the ID of a created document if consumption succeeded.
## API Versioning ## API Versioning