REST API
Introduction
Important
Our commitment to providing a top-notch document management system and resources remain stronger than ever.
As part of this journey, this chapter has been expanded and migrated to the Knowledge base.
This means that you now have access to an even richer and more comprehensive range of resources to supercharge your document management journey.
Note
Knowledge Base content
Articles:
Using the REST API
Optimizing API responses using the dynamic API fields feature
Using API sorting and ordering
The batch request API system
Troubleshooting:
The API for the file downloads section is missing
How to retrieve the list of available search models
Examples
Install the Python Requests library (http://docs.python-requests.org/en/master/):
pip install requests
Get a list of document types:
import requests
requests.get(url='http://127.0.0.1:8000/api/v4/document_types/', auth=('username', 'password')).json()
{'count': 1,
'next': None,
'previous': None,
'results': [{'delete_time_period': 30,
'delete_time_unit': 'days',
'filename_generator_backend': 'uuid',
'filename_generator_backend_arguments': '',
'id': 1,
'label': 'Default',
'quick_label_list_url': 'http://127.0.0.1:8000/api/v4/document_types/1/quick_labels/',
'trash_time_period': None,
'trash_time_unit': None,
'url': 'http://127.0.0.1:8000/api/v4/document_types/1/'}]}
Create a new document:
requests.post(url='http://127.0.0.1:8000/api/v4/documents/', auth=('username', 'password'), data={'document_type_id': 1, 'label': 'test document'}).json()
{'datetime_created': '2021-06-03T08:57:19.733359Z',
'description': '',
'document_change_type_url': 'http://127.0.0.1:8000/api/v4/documents/1/type/change/',
'document_type': {'delete_time_period': 30,
'delete_time_unit': 'days',
'filename_generator_backend': 'uuid',
'filename_generator_backend_arguments': '',
'id': 1,
'label': 'Default',
'quick_label_list_url': 'http://127.0.0.1:8000/api/v4/document_types/1/quick_labels/',
'trash_time_period': None,
'trash_time_unit': None,
'url': 'http://127.0.0.1:8000/api/v4/document_types/1/'},
'file_list_url': 'http://127.0.0.1:8000/api/v4/documents/1/files/',
'id': 1,
'label': 'test document',
'language': 'eng',
'file_latest': None,
'url': 'http://127.0.0.1:8000/api/v4/documents/1/',
'uuid': '5f350d5a-cae1-4236-beba-dab187f112e3',
'version_active': None,
'version_list_url': 'http://127.0.0.1:8000/api/v4/documents/1/versions/'}
After creating a document, you need to upload a file to it. Use
action_name code replace to also have a new document version
created and its pages pointing to the pages of the new file uploaded:
with open(file='test_document.pdf', mode='rb') as file_object:
response = requests.post(url='http://127.0.0.1:8000/api/v4/documents/1/files/', auth=('username', 'password'), files={'file_new': file_object}, data={'action_name': 'replace'})
response.status_code
202
The API will return status code 202 meaning it has accepted the request and will perform the processing in the background.
API Tokens
Use API tokens to avoid sending the username and password on every request. Obtain a token by making a POST request to /api/v4/auth/token/obtain/?format=json:
requests.post(url='http://127.0.0.1:8000/api/v4/auth/token/obtain/?format=json', data={'username': 'username', 'password': 'password'}).json()
{'token': '4ccbc35b5eb327aa82dc3b7c9747b578900f02bb'}
The API token may also be obtained using management commands:
./manage.py drf_create_token admin
Generated token 4ccbc35b5eb327aa82dc3b7c9747b578900f02bb for user admin
Add the API token to the request header:
headers = {'Authorization': 'Token 4ccbc35b5eb327aa82dc3b7c9747b578900f02bb'}
requests.get(url='http://127.0.0.1:8000/api/v4/document_types/', headers=headers).json()
{'count': 1,
'next': None,
'previous': None,
'results': [{'delete_time_period': 30,
'delete_time_unit': 'days',
'filename_generator_backend': 'uuid',
'filename_generator_backend_arguments': '',
'id': 1,
'label': 'Default',
'quick_label_list_url': 'http://127.0.0.1:8000/api/v4/document_types/1/quick_labels/',
'trash_time_period': None,
'trash_time_unit': None,
'url': 'http://127.0.0.1:8000/api/v4/document_types/1/'}]}
Sessions
Use sessions to avoid having to add the headers on each request:
session = requests.Session()
headers = {'Authorization': 'Token 4ccbc35b5eb327aa82dc3b7c9747b578900f02bb'}
session.headers.update(headers)
session.get(url='http://127.0.0.1:8000/api/v4/document_types/')
{'count': 1,
'next': None,
'previous': None,
'results': [{'delete_time_period': 30,
'delete_time_unit': 'days',
'filename_generator_backend': 'uuid',
'filename_generator_backend_arguments': '',
'id': 1,
'label': 'Default',
'quick_label_list_url': 'http://127.0.0.1:8000/api/v4/document_types/1/quick_labels/',
'trash_time_period': None,
'trash_time_unit': None,
'url': 'http://127.0.0.1:8000/api/v4/document_types/1/'}]}
Batch API requests
Important
Our commitment to providing a top-notch document management system and resources remain stronger than ever.
As part of this journey, this chapter has been expanded and migrated to the Knowledge base.
This means that you now have access to an even richer and more comprehensive range of resources to supercharge your document management journey.
Note
Knowledge Base content
Articles:
Using the REST API
Optimizing API responses using the dynamic API fields feature
Using API sorting and ordering
The batch request API system
Troubleshooting:
The API for the file downloads section is missing
How to retrieve the list of available search models
Dynamic fields
Important
Our commitment to providing a top-notch document management system and resources remain stronger than ever.
As part of this journey, this chapter has been expanded and migrated to the Knowledge base.
This means that you now have access to an even richer and more comprehensive range of resources to supercharge your document management journey.
Note
Knowledge Base content
Articles:
Using the REST API
Optimizing API responses using the dynamic API fields feature
Using API sorting and ordering
The batch request API system
Troubleshooting:
The API for the file downloads section is missing
How to retrieve the list of available search models