REST DokumentationOrdnerGET Einzelnes Dokument abrufen, einschließlich des Dateiinhalts

Einzelnes Dokument abrufen, einschließlich des Dateiinhalts

Sucht das Dokument anhand seiner ID im angegebenen Ordner und liefert Dateinamen, Dateityp und base64-codierten Inhalt.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

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}'

Pfad-Parameter

  • Name
    id
    Type
    integer
    Description

    Die ID des Ordners

  • Name
    document_id
    Type
    integer
    Description

    Die ID des Dokuments

Response

{
  "data": {
    "id": 1,
    "filename": "Allgemeine_Geschaeftsbedingungen.pdf",
    "file_type": "application/pdf",
    "file_contents": "JVBERi0xLjMgCjEgMCBvYmoKPDwKL1BhZ2VzIDIgMCBSCi9UeXBlIC9DYXRhbG9nCj4+CmVuZG9i..."
  }
}

Response-Felder

  • Name
    id
    Type
    integer
    Description

    Die eindeutige Kennung des Dokuments.

  • Name
    filename
    Type
    string
    Description

    Der ursprüngliche Name der Datei beim Hochladen.

  • Name
    file_type
    Type
    string, nullable
    Description

    Der MIME-Typ der gespeicherten Datei.

  • Name
    file_contents
    Type
    string, nullable
    Description

    Der Inhalt der aktuellen Dokumentversion, base64-kodiert; null, wenn die Version keine gespeicherte Datei hat.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.