Documents

get
Authorizations
Query parameters
afterstringOptional
limitnumberOptional
externalIdstringOptional
Responses
200Success
application/json
Responseall of
and
get
GET /v1/documents HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "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"
    }
  ]
}
post
Authorizations
Body
file_namestringRequired

A user friendly name for the document

external_idstringRequired

The id generated by the system from which the document was extracted

original_file_namestring | nullableRequired

The file name as of the extracted file.

original_file_pathstring | nullableRequired

The file path of the extracted file.

original_authorstring | nullableRequired

The author of the document.

extensionstringRequired

The file extension.

file_pathstringRequired

The file path as stored in the object storage.

valid_fromstring | nullableRequired

The date at which the document has been made available.

valid_untilstring | nullableRequired

The date at which the document will be made unavailable.

size_kbnumber | nullableRequired

The file size in kb.

storagestringRequired

The object storage ID to which the document is associated

Responses
200Success
application/json
post
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"
}
200Success
{
  "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
Authorizations
Path parameters
documentIdstringRequired
Responses
200Success
application/json
get
GET /v1/documents/{documentId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "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"
}
put
Authorizations
Path parameters
documentIdstringRequired
Body
idstringRequired

Unique ID

file_namestringRequired

A user friendly name for the document

external_idstringRequired

The id generated by the system of referenced

original_file_namestring | nullableRequired

The file name as of the extracted file.

original_file_pathstring | nullableRequired

The file path of the extracted file.

original_authorstring | nullableRequired

The author of the document.

extensionstringRequired

The file extension.

file_pathstringRequired

The file path as stored in the object storage.

valid_fromstring | nullableRequired

The date at which the document has been made available.

valid_untilstring | nullableRequired

The date at which the document will be made unavailable.

size_kbnumber | nullableRequired

The file size in kb.

storagestringRequired

The object storage ID to which the document is associated

Responses
200Success
application/json
put
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"
}
200Success
{
  "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
Authorizations
Path parameters
documentIdstringRequired
Responses
200Success
application/json
delete
DELETE /v1/documents/{documentId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "isDeleted": true
}

Last updated

Was this helpful?