Retrieve a single document, including its file contents

Looks the document up by its id inside the given folder and returns its filename, file type and base64-encoded contents.

Availability: Full version only — a Clock instance answers 404 for this endpoint.

Request

GET /api/v1/folders/{id}/documents/{document_id}

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/folders/{id}/documents/{document_id}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

Path parameters

Name
id
Type
integer
Description
The folder ID
Name
document_id
Type
integer
Description
The document ID

Response

{
  "data": {
    "id": 1,
    "filename": "string",
    "file_type": "string",
    "file_contents": "string"
  }
}

Response fields

Name
id
Type
integer
Description
Unique identifier of the document.
Name
filename
Type
string
Description
The file’s original name, as it was uploaded.
Name
file_type
Type
string, nullable
Description
MIME type of the stored file.
Name
file_contents
Type
string, nullable
Description
Base64-encoded content of the current document version; null when the version has no stored file.

Generated from the OpenAPI specification — edit the source code, not this page.

GET List the documents stored in a folder Devices