In einem Ordner abgelegte Dokumente auflisten

Liefert die im angegebenen Ordner abgelegten Dokumente, jeweils einschließlich des Dateiinhalts.

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

Request

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

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

Pfad-Parameter

Name
id
Type
integer
Description
Die ID des Ordners

Query-Parameter

Name
perPage
Type
integer, nullable
Description
Wird auf diesem Endpunkt ignoriert — senden Sie stattdessen limit. Ein hier angegebener Wert wird durch limit ersetzt, oder durch den Standardwert, wenn limit fehlt.
Name
page
Type
integer, nullable
Description
Die zurückzugebende Ergebnisseite, beginnend bei 1.
Name
orderBy
Type
string, nullable
Description
Name des Feldes, nach dem sortiert wird.
Name
order
Type
string, nullable
Description
Sortierrichtung, aufsteigend oder absteigend.
Einer der Werte: "asc", "desc"
Name
limit
Type
integer, nullable
Description
Die Anzahl der Datensätze pro Seite, 1 bis 200. Standardwert ist 15.

Response

{
  "data": [
    {
      "id": 1,
      "filename": "string",
      "file_type": "string",
      "file_contents": "string"
    }
  ],
  "links": {
    "first": "string",
    "last": "string",
    "prev": "string",
    "next": "string"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "string",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Response-Felder

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.

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

GET Einzelnen Dokumentordner abrufen GET Einzelnes Dokument abrufen, einschließlich des Dateiinhalts