Documents
GET /v1/documents HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"paging": {
"next": {
"after": "text"
}
},
"data": [
{
"id": "text",
"file_name": "text",
"external_id": "text",
"original_file_name": "text",
"original_file_path": "text",
"original_author": "text",
"extension": "text",
"file_path": "text",
"valid_from": "text",
"valid_until": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"size_kb": 1,
"storage": "text"
}
]
}
A user friendly name for the document
The id generated by the system from which the document was extracted
The file name as of the extracted file.
The file path of the extracted file.
The author of the document.
The file extension.
The file path as stored in the object storage.
The date at which the document has been made available.
The date at which the document will be made unavailable.
The file size in kb.
The object storage ID to which the document is associated
POST /v1/documents HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 276
{
"file_name": "text",
"external_id": "text",
"original_file_name": "text",
"original_file_path": "text",
"original_author": "text",
"extension": "text",
"file_path": "text",
"valid_from": "text",
"valid_until": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"size_kb": 1,
"storage": "text"
}
{
"id": "text",
"file_name": "text",
"external_id": "text",
"original_file_name": "text",
"original_file_path": "text",
"original_author": "text",
"extension": "text",
"file_path": "text",
"valid_from": "text",
"valid_until": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"size_kb": 1,
"storage": "text"
}
GET /v1/documents/{documentId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"id": "text",
"file_name": "text",
"external_id": "text",
"original_file_name": "text",
"original_file_path": "text",
"original_author": "text",
"extension": "text",
"file_path": "text",
"valid_from": "text",
"valid_until": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"size_kb": 1,
"storage": "text"
}
Unique ID
A user friendly name for the document
The id generated by the system of referenced
The file name as of the extracted file.
The file path of the extracted file.
The author of the document.
The file extension.
The file path as stored in the object storage.
The date at which the document has been made available.
The date at which the document will be made unavailable.
The file size in kb.
The object storage ID to which the document is associated
PUT /v1/documents/{documentId} HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 288
{
"id": "text",
"file_name": "text",
"external_id": "text",
"original_file_name": "text",
"original_file_path": "text",
"original_author": "text",
"extension": "text",
"file_path": "text",
"valid_from": "text",
"valid_until": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"size_kb": 1,
"storage": "text"
}
{
"id": "text",
"file_name": "text",
"external_id": "text",
"original_file_name": "text",
"original_file_path": "text",
"original_author": "text",
"extension": "text",
"file_path": "text",
"valid_from": "text",
"valid_until": "text",
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"size_kb": 1,
"storage": "text"
}
DELETE /v1/documents/{documentId} HTTP/1.1
Host:
Authorization: Bearer JWT
Accept: */*
{
"id": "text",
"isDeleted": true
}
Last updated
Was this helpful?