Die leitzcloud API basiert auf REST. Unsere API ist so konzipiert, dass sie, um vorhersehbare, ressourcenorientierte URLs zu haben, HTTP-Antwortcodes verwenden können, die API-Fehler anzeigen. Wir verwenden integrierte HTTP-Funktionen, wie z.B. HTTP-Authentifizierung und HTTP-Verben, die von handelsüblichen HTTP-Clients verstanden werden können. JSON wird in allen API Antworten, einschließlich Fehlern, zurückgeschickt.
https://<hostname:port>/api/2
Alle Anfragen an die leitzcloud API müssen über HTTPS Wege erfolgen. Nicht-HTTPS-Anfragen werden abgelehnt.
leitzcloud verwendet herkömmliche HTTP-Antwortcodes, um den Erfolg oder Misserfolg einer API-Anfrage anzuzeigen. Im Allgemeinen werden Codes im Bereich 2xx verwendet, die einen Erfolg angeben. Codes im Bereich 4xx zeigen einen Fehler an, der sich aus den bereitgestellten Informationen ergibt (d.h. ein erforderlicher Parameter war fehlend oder ungültig, die Anforderung ist fehlerhaft, etc.) und Codes im Bereich von 5xx zeigen einen Fehler mit dem leitzcloud-Server an.
Alle API-Antworten geben ein JSON-Objekt zurück. Aus Gründen der Konsistenz gilt dies auch für den Fall, dass der HTTP-Statuscode den vollen Funktionsumfang beantworten kann. Beispielsweise zeigen einige API-Methoden einfach an, dass sie mit einem HTTP 200-Statuscode erfolgreich waren. In diesen Fällen ist die Antwort wie folgt:
HTTP status code: 200
Response body:
{
"status": "ok"
}
Ein weiterer Fall ist die Rückgabe eines HTTP 304-Statuscodes, der angibt, dass der Client seine zwischengespeicherte Antwort aus einer früheren Version verwenden sollte. Zum Beispiel:
HTTP status code: 304
Response body:
{
"status": "not_modified"
}
Genaue Antworten finden Sie in den Details der einzelnen Methoden.
Im Fall einer Fehlermeldung verwendet die API einen entsprechenden HTTP-Statuscode in der Antwort. JSON gibt eine Angabe der Fehlerart und falls vorhanden, eine lesbare Beschreibung des Fehlers an.
Im Folgenden finden Sie häufige Fehler, die bei der Arbeit mit der API auftreten können:
HTTP status code: 400
Response body:
{
"error": "invalid_request"
}
HTTP status code: 401
Response body:
{
"error": "access_denied"
}
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
HTTP status code: 500
Response body:
{
"error": "unknown"
}
HTTP status code: 400
Response body:
{
"error": "insecure_transport",
"error_description": "Requests MUST utilize https."
}
HTTP status code: 400
Response body:
{
"error": "invalid_request",
"error_description": "Missing required parameter: <param>"
}
HTTP status code: 400
Response body:
{
"error": "invalid_request",
"error_description": "Invalid value for parameter: <param>"
}
HTTP status code: 400
Response body:
{
"error": "invalid_date_format",
"error_description": "Invalid date format. The expected format is: JJJJ-MM-TT"
}
HTTP status code: 400
Response body:
{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime format. The expected format is: JJJJ-MM-TT SS:MM:SS"
}
HTTP status code: 403
Response body:
{
"error": "license_expired"
}
HTTP status code: 403
Response body:
{
"error": "trial_expired"
}
Fehler, die für bestimmte Methoden spezifisch sind, können in den Methodendetails gefunden werden.
Die wichtigsten API-Versionen werden anhand der Endpunkt-URL ausgewählt. Es ist unsere Absicht, die Abwärtskompatibilität innerhalb eines großen Zeitraums aufrechtzuerhalten, außer wenn es sich um Sicherheitsprobleme handelt. Die verwendete Minor-API-Version kann durch Aufruf der
Version Methode festgelegt werden.
Sofern nicht anders angegeben, erfordern alle leitzcloud API-Methoden eine Authentifizierung über OAuth2. Derzeit unterstützt es das Passwort,refresh token grants, mit authorization code und client credential grants, die in naher Zukunft kommen.
Der OAuth2-Anbieter ist nicht spezifisch für eine API-Version. Weitere Informationen zum Erhalten, Aktualisieren und Widerrufen von OAuth2-Zugriffstoken finden Sie unter der OAuth2-Dokumentation.
POST /api/2/reset_password
HTTP status code: 200
Das Bestätigen eines Reset-Tokens gibt neue OAuth2-Zugriffstoken zurück, welche dann verwendet werden können, um das Passwort des Benutzers über die update person method festzulegen.
POST /api/2/reset_password/confirm
HTTP status code: 200
Response body:
{
"access_token": "<access_token>",
"expires_in": 3600,
"token_type": "Bearer",
"refresh_token": "<refresh_token>",
"scope": "full"
}
HTTP status code: 401
Response body:
{
"error": "password_reset_token_expired"
}
Die Version Methode gibt die genaue API-Version im Format <major>.<minor>.<revision> zurück.
Eine Authentifizierung ist nicht erforderlich.
GET /api/2/version
HTTP status code: 200
Response body:
{
"version": "2.0.9"
}
"root"
Der eindeutige Identifikator der Rootdatei
Der Name der Rootdatei
"/"
Ob die Rootdatei gesperrt ist
Der Typ der Rootdatei: "Synchronisieren", "Teilen" oder "Sichern"
Die Gesamtgröße der Rootdatei in Bytes
Die Gesamtgröße der Rootdatei in menschengerechter Formatierung
Eine Liste der Berechtigungen des authentifizierten Benutzers auf der Rootdatei
Ein Hash der Root-Metadaten, die für das Ergebnis-Caching verwendet werden
{
"children": [
...child files and folders...
],
"hash": "<hash>",
"id": 1,
"is_locked": false,
"name": "Example Files",
"path": "/",
"permissions": [
"FILE_VIEW",
"FILE_READ",
"FILE_WRITE"
],
"root_type": "sync",
"space_used": 10000,
"space_used_formatted": "10k",
"type": "root"
}
"file"
Die eindeutige Kennung der Datei
Die eindeutige Revisionskennung der Datei
Der Bezeichner der Rootdatei, die die Datei enthält
Der Dateiname
Der absolute Pfad der Datei innerhalb des Root-/ Stammverzeichnisses
Ob die Datei gelöscht wird
Datum und Uhrzeit in UTC, zu dem die Datei im Format JJJJ-MM-TT SS:MM:SS erstellt wurde
Datum Uhrzeit in UTC, in dem die Datei zuletzt im Format JJJJ-MM-TT SS:MM:SS geändert wurde
Die Größe der Datei in Bytes
Die Größe der Datei in menschengerechter Formatierung
Ob die Datei gesperrt ist
Eine Liste der Berechtigungen des authentifizierten Benutzers für die Datei
Eine Liste der Versionen der Datei in aufsteigender Reihenfolge. Je nach Kontext kann der erste Eintrag das Stammobjekt der obersten Ebene sein.
{
"created": "2015-01-01T01:02:03",
"id": 1,
"is_deleted": false,
"is_locked": false,
"modified": "2015-01-01T02:03:04",
"path": "/path/to/file.ext",
"permissions": [
"FILE_VIEW",
"FILE_READ",
"FILE_WRITE"
],
"revision_id": 1,
"root_id": 1,
"size": 12205,
"size_formatted": "11.92k",
"type": "file"
}
"folder"
Die eindeutige Kennung des Ordners
Der Bezeichner der Rootdatei, die den Ordner enthält
Der absolute Pfad des Ordners innerhalb des Stammverzeichnisses
Ob der Ordner gelöscht wird
Ob der Ordner gesperrt ist
Eine Liste der Berechtigungen des authentifizierten Benutzers für den Ordner
Ein Hash der Ordnermetadaten, die für das Ergebnis-Caching verwendet werden
Eine Liste der Versionen der Datei in aufsteigender Reihenfolge. Je nach Kontext kann der erste Eintrag das Stammobjekt der obersten Ebene sein
{
"children": [
...child files and folders...
],
"hash": "<hash>",
"id": 1,
"is_deleted": false,
"is_locked": false,
"path": "/path/to/name",
"permissions": [
"FILE_VIEW",
"FILE_READ",
"FILE_WRITE"
],
"root_id": 1,
"type": "folder"
}
"revision"
Der einzigartige Identifikator der Revision
Der einzigartige Identifikator der Datei
Der Identifikator des Stamms, der die Revision enthält
Das Datum/Uhrzeit in UTC, an dem die Revision erstellt wurde, ist im Format YYYY-MM-DDTHH:MM:SS
Das Datum/Uhrzeit in UTC, an dem die Revision zuletzt bearbeitet wurde, ist im Format YYYY-MM-DDTHH:MM:SS
Die Größe der vollständigen Image-Datei der Revision, falls möglich, in Byte
Die Größe der vollständigen Bilddatei der Revision, falls möglich, in benutzerfreundlicher Formatierung
Die Größe der Delta-Bilddatei der Revision, falls möglich, in Byte
Die Größe der Delta-Bilddatei der Revision, falls möglich, in benutzerfreundlicher Formatierung
Die Größe der Bilddatei zum Zeitpunkt dieser Revision in Byte
Die Größe der Bilddatei zum Zeitpunkt dieser Revision in benutzerfreundlicher Formatierung
{
"created": "2019-12-05T14:12:11",
"delta_size": 4096,
"delta_size_formatted": "4.00 KB",
"file_id": 1953,
"file_size": 14679,
"file_size_formatted": "14.33 KB",
"full_size": 11200,
"full_size_formatted": "10.94 KB",
"id": 3747,
"modified": "2019-12-05T14:12:11",
"root_id": 1,
"type": "revision"
}
"root_space_usage"
Anzahl der gelöschten Dateien
Anzahl der gelöschten Revisionen
Platzverbrauch der gelöschten Dateien in Bytes
Platzverbrauch der gelöschten Dateien in einer benutzerfreundlichen Formatierung
Gesamtzahl der Dateien
Speicherverbrauch von nicht gelöschten Dateien in Bytes
Platzverbrauch von nicht gelöschten Dateien in einer benutzerfreundlichen Formatierung
Gesamter Platzbedarf in Bytes
Gesamter Platzbedarf in menschengerechter Formatierung
Anzahl der Revisionen
Platzverbrauch von Revisionen in Bytes
Platzverbrauch von Revisionen in menschengerechter Formatierung
Die Gesamtzahl der Roots, die in den Nutzungskennzahlen enthalten sind
{
"del_file_count": 5,
"del_revision_count": 5,
"deleted_size": 395168,
"deleted_size_formatted": "385.91 KB",
"file_count": 504,
"head_size": 41533273,
"head_size_formatted": "39.61 MB",
"physical_size": 43199769,
"physical_size_formatted": "41.20 MB",
"revision_count": 2275,
"revision_size": 1271328,
"revision_size_formatted": "1.21 MB",
"root_count": 21,
"type": "root_space_usage"
}
GET /api/2/files/<root_id>/<file_id>
HTTP status code: 200
Response body:
{
...a file object...
}
GET /api/2/files/<root_id>/<file_id>/download GET /api/2/files/<root_id>/<file_id>/view
Ob die Datei über den download Endpunkt oder den view Endpunkt heruntergeladen wird, bestimmt
die Content-Disposition in der Antwort -- attachment oder inline.
HTTP status code: 200 Response body: <binary file data>
POST /api/2/files/<root_id>/<file_id>/share
HTTP status code: 200
Response body:
{
...a file share link object...
}
POST /api/2/files/<root_id>/<file_id>/rename
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "invalid_extension"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
POST /api/2/files/<root_id>/<file_id>/move
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
POST /api/2/files/<root_id>/<file_id>/lock
HTTP status code: 200
POST /api/2/files/<root_id>/<file_id>/unlock
HTTP status code: 200
POST /api/2/files/<root_id>/<file_id>/delete
HTTP status code: 200
GET /api/2/files/<root_id>/<file_id>/revisions
HTTP status code: 200
Response body:
{
"page": 1,
"page_size": 20,
"max_page": 3,
"results": [
...up to page_size revision objects...
],
"total": 42
}
GET /api/2/files/<root_id>/<file_id>/revisions/<revision_id>
HTTP status code: 200
Response body:
{
...a revision object...
}
GET /api/2/files/<root_id>/<file_id>/revisions/<revision_id>/download GET /api/2/files/<root_id>/<file_id>/revisions/<revision_id>/view
HTTP status code: 200 Response body: <binary file data>
Ob die Revision über den Endpunkt download oder den Endpunkt view heruntergeladen wird, bestimmt
die Content-Disposition in der Antwort -- Anhang bzw. inline.
GET /api/2/files/<root_id>/folder/<folder_id>
include_children
"true" ist.
HTTP status code: 200
Response body:
{
...a folder object...
}
Children ist eine Liste von Datei- und Ordnermetadatenobjekten innerhalb des Ordners. Sie ist nur vorhanden, wenn include_children
"true" ist.
Der hash Wert eine Signatur für die Antwortdaten darstellt. Wenn der Hash-Wert in der Antwort
identisch mit dem vom Client übergebenen Hash-Wert ist, dann wird HTTP 304 Not Modified zurückgegeben. Hash ist nur vorhanden wenn include_children "true" ist.
GET /api/2/files/<root_id>/folder/<folder_id>/children
Gibt Metadaten für die unmittelbaren untergeordneten Elemente eines Ordners mit Optionen zum Sortieren und Paginieren zurück.
HTTP status code: 200
Response body:
{
"page": 1,
"page_size": 20,
"max_page": 3,
"results": [
...up to page_size file and folder objects...
],
"total": 42
}
POST /api/2/files/<root_id>/folder/<folder_id>/upload
HTTP status code: 200
Response body:
{
...file metadata...
}
HTTP status code: 400
Response body:
{
"error": "no_file_received",
"error_description": "Missing required file: file"
}
HTTP status code: 409
Response body:
{
"error": "policy_error"
}
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "invalid_extension"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
POST /api/2/files/<root_id>/folder/<folder_id>/create_folder
HTTP status code: 200
Response body:
{
...folder metadata...
}
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "name_too_long"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
GET /api/2/files/<root_id>/download GET /api/2/files/<root_id>/folder/<folder_id>/download
Wenn entweder file_ids oder folder_ids präsent ist, enth#lt der Download nur die angegebenen Elemente.
HTTP status code: 200 Response body: <binary zip file data>
POST /api/2/files/<root_id>/folder/<folder_id>/share
HTTP status code: 200
Response body:
{
...a folder share link object...
}
POST /api/2/files/<root_id>/folder/<folder_id>/rename
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "name_too_long"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
POST /api/2/files/<root_id>/folder/<folder_id>/move
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
POST /api/2/files/<root_id>/folder/<folder_id>/lock
HTTP status code: 200
POST /api/2/files/<root_id>/folder/<folder_id>/unlock
HTTP status code: 200
POST /api/2/files/<root_id>/folder/<folder_id>/delete
HTTP status code: 200
GET /api/2/files/<root_id>
children in die Antwort einbezogen werden sollen. "true" oder "false". Voreinstellung " true".include_children
"true" ist.
HTTP status code: 200
Response body:
{
...a root object...
}
Mögliche Werte für root_type sind "sync", "share", und "backup".
Children ist eine Liste von Datei- und Ordnermetadatenobjekten auf der obersten Ebene des Root. Sie ist nur vorhanden, wenn
include_children "true" ist.
Der hash Wert stellt eine Signatur für die Antwortdaten dar. Wenn der Hash-Wert in der Antwort
identisch mit dem vom Client übergebenen Hash-Wert wäre, dann wird HTTP 304 Not Modified zurückgegeben. Hash ist nur vorhanden wenn include_children "true" ist.
HTTP status code: 304
GET /api/2/files/<root_id>/children
Gibt Metadaten für die unmittelbaren untergeordneten Elemente einer Wurzel mit Optionen zum Sortieren und Paginieren zurück.
HTTP status code: 200
Response body:
{
"page": 1,
"page_size": 20,
"max_page": 3,
"results": [
...up to page_size file and folder objects...
],
"total": 42
}
POST /api/2/files/<root_id>/upload
HTTP status code: 200
Response body:
{
...file metadata...
}
HTTP status code: 400
Response body:
{
"error": "no_file_received",
"error_description": "Missing required file: file"
}
HTTP status code: 409
Response body:
{
"error": "policy_error"
}
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "invalid_extension"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
POST /api/2/files/<root_id>/create_folder
HTTP status code: 200
Response body:
{
...folder metadata...
}
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "name_too_long"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
GET /api/2/files/<root_id>/search
HTTP status code: 200
Response body:
{
"results": [
...file and folder metadata...
]
}
GET /api/2/files/<root_id>/modified_since
HTTP status code: 200
Response body:
{
"results": [
...file metadata...
]
}
POST /api/2/files/<root_id>/lock
HTTP status code: 200
POST /api/2/files/<root_id>/unlock
HTTP status code: 200
Die folgenden Fehler können für jede Dateisystemmethode auftreten und sind in den Methodenbeschreibungen nicht ausdrücklich erwähnt.
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
HTTP status code: 409
Response body:
{
"error": "resource_locked"
}
HTTP status code: 410
Response body:
{
"error": "root_deleted",
"error_description": "Root was previously deleted."
}
HTTP status code: 503
Response body:
{
"error": "temporarily_unavailable",
"error_description": "Service is temporarily unavailable.""
}
Ein Unternehmen repräsentiert eine Sammlung von Personen, Maschinen, Roots und anderen Kinderorganisationen. Zugriffskontrolle, Richtlinien und die meisten Systemeinstellungen werden auf Unternehmensebene angewendet.
"organisation"
Der eindeutige Identifikator für das Unternehmen
Die eindeutige Kennung der übergeordneten Organisation
Der Name der Organisation
Der URL-freundliche Name des Unternehmens
Eine Beschreibung des Unternehmens
Die Kontakt-Email-Adresse des Unternehmens
Der Hostname, den die Agenten Ihrer Organisation für die Verbindung verwenden
Datum/Uhrzeit in UTC, in dem das Unternehmen im Format JJJJ-MM-TT SS:MM:SS angelegt wurde.
Ob die Bandbreitenbegrenzung für das Unternehmen aktiviert ist
Ob das Unternehmen aktiv ist
Datum/Uhrzeit in UTC der Testphase des Unternehmens läuft im Format JJJJJ-MM-TT SS:MM:SS ab
Ob der Privatsphärenmodus für das Unternehmen aktiviert ist
{
"active": true,
"bandwidth_throttle": null,
"created": "2013-10-08T05:45:40",
"default_encryption": 1,
"description": "",
"email": "organization@example.com",
"email_server_id": null,
"email_templates": false,
"hostname": "",
"id": 2,
"name": "Example Organization",
"parent_id": 1,
"plan_id": null,
"policy": {
...a policy object...
},
"privacy_mode": false,
"share_disclaimer": null,
"slug": "example-organization",
"subscription_uuid": null,
"throttle_exception_days": null,
"throttle_exception_dow": null,
"throttle_exception_end": null,
"throttle_exception_start": null,
"throttle_exception_throttle": null,
"throttled": false,
"trial_until": null,
"type": "organization"
}
"policy"
Der Identifikator des Unternehmens, zu dem die Richtlinie gehört
Ob Administratoren Dateien durchsuchen können
Ob Administratoren Remote-Dateien anzeigen können
Ob Administratoren Benutzer anlegen können
Ob Backups aktiviert sind
Ob benutzerdefiniertes Branding aktiviert ist
Eine kommagetrennte Liste von Dateierweiterungen, die nicht hochgeladen werden dürfen
Eine kommagetrennte Liste von Dateierweiterungen
Die maximale hochgeladene Dateigröße in XX
Die maximal zulässige Anzahl von Unterorganisationen
Die maximal zulässige Anzahl von Benutzern
Die minimal zulässige Anzahl von Benutzern
Ob die PSA-Integration aktiviert ist
Ob gelöschte Dateien automatisch gelöscht werden
Die Häufigkeit, mit der gelöschte Dateien automatisch gelöscht werden
Ob mobile App-Benutzer eine PIN-Verriegelung verwenden müssen
Ob Benutzer aufgefordert werden, eine zweistufige Verifizierung zu aktivieren
Ob Benutzer aufgefordert werden, eine zweistufige Verifizierung zu aktivieren
Der maximale Raum, der von dem Unternehmen genutzt werden darf
Der maximale Platz, der von dem Unternehmen in menschenfreundlicher Form genutzt werden darf
Ob Dateirevisionen automatisch abgeschnitten/ getrimmt werden
Ob es Benutzern erlaubt ist, Backup-Roots zu erstellen
Ob Benutzer Dateien freigeben dürfen
Ob Benutzer Dateien sperren dürfen
Ob es Benutzern erlaubt ist, gelöschte Dateien unwiderruflich zu löschen
Ob es Benutzern erlaubt ist, Dateirevisionen zu trimmen
Ob der WebDAV-Zugriff aktiviert ist
{
"ad_enabled": true,
"admin_browse_files": true,
"admin_browse_remote": true,
"admin_create_users": true,
"backups_enabled": true,
"branding_enabled": true,
"change_password_frequency": null,
"company_id": 2,
"deactivate_token_frequency": "",
"excluded_extensions": ".$$,.$db,.113,.3g2,.3gp,.3gp2,.3gpp,.3mm,.a,.abf,.abk,.afm,.ani,.ann,.asf,.avi,.avs,.bac,.bak,.bck,.bcm,.bdb,.bdf,.bkf,.bkp,.bmk,.bsc,.bsf,.cab,.cf1,.chm,.chq,.chw,.cnt,.com,.cpl,.cur,.dev,.dfont,.dll,.dmp,.drv,.dv,.dvd,.dvr,.dvr-ms,.eot,.evt,.exe,.ffa,.ffl,.ffo,.ffx,.flc,.flv,.fnt,.fon,.ftg,.fts,.fxp,.gid,.grp,.hdd,.hlp,.hxi,.hxq,.hxr,.hxs,.ico,.idb,.idx,.ilk,.img,.inf,.ini,.ins,.ipf,.iso,.isp,.its,.jar,.jse,.kbd,.kext,.key,.lex,.lib,.library-ms,.lnk,.log,.lwfn,.m1p,.m1v,.m2p,.m2v,.m4v,.mem,.mkv,.mov,.mp2,.mp2v,.mp4,.mpe,.mpeg,.mpg,.mpv,.mpv2,.msc,.msi,.msm,.msp,.mst,.ncb,.nt,.nvram,.o,.obj,.obs,.ocx,.old,.ost,.otf,.pch,.pf,.pfa,.pfb,.pfm,.pnf,.pol,.pref,.prf,.prg,.prn,.pvs,.pwl,.qt,.rdb,.reg,.rll,.rox,.sbr,.scf,.scr,.sdb,.shb,.suit,.swf,.swp,.sys,.theme,.tivo,.tmp,.tms,.ttc,.ttf,.v2i,.vbe,.vga,.vgd,.vhd,.video,.vmc,.vmdk,.vmsd,.vmsn,.vmx,.vxd,.win,.wpk",
"file_server_enabled": false,
"locked_extensions": ".doc,.docx,.xls,.xlsx,.ppt,.pptx,.pdf,.txt,.xlsb,.xlsm,.csv,.docm,.dotx,.dotm,.pub,.wpd,.odt,.ott,.oth,.odm,.ots,.odp,.odg,.otp,.odf,.oxt,.odc,.ods,.vdx,.vsx,.vtx,.one",
"max_file_size": 1,
"monthly_cost_cents": 0,
"monthly_cost_currency": "",
"num_orgs_maximum": 10,
"num_users_maximum": 0,
"num_users_minimum": 0,
"psa_enabled": true,
"purge_deleted": false,
"purge_deleted_frequency": "",
"require_mobile_lock": true,
"require_two_step_auth": false,
"secure_shares": false,
"service_plans_enabled": false,
"space_quota": "1073741824",
"trial_length_days": 30,
"trim_revisions": false,
"trim_revisions_x": "",
"type": "policy",
"user_create_backups": true,
"user_create_shares": true,
"user_lock_files": true,
"user_purge_deleted": false,
"user_trim_revisions": false,
"webdav_enabled": true
}
"organization_usage"
Ein Root Space Nutzungsobjekt der Backup-Nutzungskennzahlen
Ein Root Space Nutzungsobjekt von Kennzahlen zur Nutzung der Team-Shares
Ein Root Space Nutzungsobjekt der gesamten Nutzungskennzahlen für alle Roots
Ein Root Space Nutzungsobjekt der Kennzahlen zur Benutzer-Root-Nutzung
{
"backup_space_usage": {
...a root space usage object...
},
"counts": {
...an organization usage counts object...
},
"team_share_space_usage": {
...a root space usage object...
},
"total_space_usage": {
...a root space usage object...
},
"type": "organization_usage",
"user_space_usage": {
...a root space usage object...
}
}
"organization_usage_counts"
Gesamtzahl der Konten
Anzahl der Admin-Konten
Anzahl der Gruppen
Anzahl der Gäste
Anzahl der Maschinen
Anzahl der Unternehmen
{
"accounts": 11,
"admin_accounts": 5,
"groups": 8,
"guests": 4,
"machines": 6,
"organizations": 7,
"type": "organization_usage_counts"
}
GET /api/2/organization/<organization_id> GET /api/2/organization/<license_key>
HTTP status code: 200
Response body:
{
...an organization object...
}
POST /api/2/organization/<organization_id>/organizations/create
Gibt die erstellte Organisation zurück
HTTP status code: 200
Response body:
{
...an organization object...
}
POST /api/2/organization/<organization_id>/update
Gibt die aktualisierte Organisation zurück
HTTP status code: 200
Response body:
{
...an organization object...
}
POST /api/2/organization/<organization_id>/disable
POST /api/2/organization/<organization_id>/enable
POST /api/2/organization/<organization_id>/delete
POST /api/2/organization/<organization_id>/policy/update
Gibt die aktualisierte Organisation zurück
HTTP status code: 200
Response body:
{
...an organization object...
}
GET /api/2/organization/<organization_id>/organizations
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 organization objects...
],
"total": 42
}
GET /api/2/organization/<organization_id>/roots
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 root objects...
],
"total": 42
}
GET /api/2/organization/<organization_id>/root/<root_id>
HTTP status code: 200
Response body:
{
...a root object...
}
GET /api/2/organization/<organization_id>/shares
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 root objects...
],
"total": 42
}
POST /api/2/organization/<organization_id>/shares/create
Gibt die erstellte Freigabe zurück.
HTTP status code: 200
Response body:
{
...a root object...
}
GET /api/2/organization/<organization_id>/share/<root_id>
HTTP status code: 200
Response body:
{
...a root object...
}
POST /api/2/organization/<organization_id>/share/<root_id>/update
Gibt die aktualisierte Freigabe zurück.
HTTP status code: 200
Response body:
{
...a root object...
}
GET /api/2/organization/<organization_id>/share/<root_id>/subscribers
HTTP status code: 200
Response body:
{
"external_subscribers": {"one@example.com": "invited", "two@example.com": "accepted"},
"from_group": [[2, "web", "COLLABORATOR"], [2, "webdav", "COLLABORATOR"], [2, "future", "COLLABORATOR"]],
"group_subscribers": [[1, "web", "COLLABORATOR"], [1, "webdav", "COLLABORATOR"], [1, "machines", "COLLABORATOR"]],
"subscribers": [[1, "web", "COLLABORATOR"], [3, "web", "COLLABORATOR"], [3, "future", "COLLABORATOR"]]
}
POST /api/2/organization/<organization_id>/share/<root_id>/subscribers/update
HTTP status code: 200
POST /api/2/organization/<organization_id>/share/<root_id>/delete
HTTP status code: 200
GET /api/2/organization/<organization_id>/machines
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 machine objects...
],
"total": 42
}
GET /api/2/organization/<organization_id>/persons
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 person objects...
],
"total": 42
}
GET /api/2/organization/<organization_id>/guests
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 guest objects...
],
"total": 42
}
GET /api/2/organization/<organization_id>/groups
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 group objects...
],
"total": 12
}
GET /api/2/organization/<organization_id>/auth_sources
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 authentication source objects...
],
"total": 42
}
GET /api/2/organization/<organization_id>/auth_sources/nicknames GET /api/2/organization/<slug>/auth_sources/nicknames GET /api/2/organization/<hostname>/auth_sources/nicknames
Die Organisation hat Authentifizierungsquellen konfiguriert, aber hat keine Spitznamen
HTTP status code: 200
Response body:
{
"results": []
}
Die Organisation hat Authentifizierungsquellen konfiguriert mit Spitznamen
HTTP status code: 200
Response body:
{
"results": [
...a list of auth source nickname strings...
]
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
GET /api/2/organization/<organization_id>/activity
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 activity objects in reverse chronological order...
],
"total": 42
}
GET /api/2/organization/<organization_id>/metrics/usage
HTTP status code: 200
Response body:
{
...an organization usage object...
}
Die folgenden Fehler können für jede Organisationsmethode auftreten und werden in den Methodenbeschreibungen nicht explizit erwähnt.
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
Ein Personenobjekt repräsentiert ein leitzcloud-Benutzerkonto.
"person"
Der eindeutige Identifikator für die Person
Die E-Mail-Adresse der Person
Der Benutzername der Person
Die Kennung der Firma, zu der die Person gehört
Der Vorname der Person
Der Nachname der Person
Der Name der Person, der für die Anzeige formatiert ist
Der Identifikator der Sync-Root der Person
Eine Liste von Root-Objekten bei dem die Person abonniert ist
Das Raumkontingent der Person in Bytes
Das Raumkontingent der Person in menschengerechter Formatierung
Der von der Person belegte Platz in Bytes
Der Platz, den die Person in einer menschenfreundlichen Formatierung einnimmt
Ob die Firmenpolitik der Person es erlaubt, Teamshares anzulegen.
Das erweiterte Unternehmen Richtlinienobjekt
{
"can_share": true,
"company_policy": {
...
},
"display_name": "First Last",
"email": "user@example.com",
"first_name": "First",
"id": 1,
"last_name": "Last",
"root_id": 1,
"roots": [
...
],
"space_quota": 10000,
"space_quota_formatted": "10k",
"space_usage": 100,
"space_usage_formatted": "100b",
"type": "person",
"username": ""
}
Die person Methode gibt Informationen über den authentifizierten Benutzer oder einen Benutzer mit einer bestimmten ID oder E-Mail-Adresse zurück.
GET /api/2/person GET /api/2/person/<person_id> GET /api/2/person/<email>
HTTP status code: 200
Response body:
{
...a person object...
}
POST /api/2/person/create
Gibt die erstellte Person zurück.
HTTP status code: 200
Response body:
{
...a person object...
}
POST /api/2/person/<person_id>/update
Gibt die aktualisierte Person zurück.
HTTP status code: 200
Response body:
{
...a person object...
}
Diese Fehlermeldung zeigt an, dass das passwort welches vorgeschlagen wurde, das geleiche Passwort ist, wei das bereits bestehende Passwort.
HTTP status code: 400
Response body:
{
"error": "password_unchanged"
}
POST /api/2/person/<person_id>/delete
HTTP status code: 200
Erstellen Sie eine Synchronisierungs-Root für ein Konto, wenn es noch nicht vorhanden ist
POST /api/2/person/<person_id>/roots/create
Gibt die erstellte Root zurück.
HTTP status code: 200
Response body:
{
...a root object...
}
GET /api/2/person/<person_id>/sharelinks
HTTP status code: 200
Response body:
{
"page": 1,
"page_size": 20,
"max_page": 3,
"results": [
...up to page_size file and folder share link objects...
],
"total": 42
}
GET /api/2/person/<person_id>/sharelinks/received
HTTP status code: 200
Response body:
{
"page": 1,
"page_size": 20,
"max_page": 3,
"results": [
...up to page_size file and folder share link objects...
],
"total": 42
}
GET /api/2/person/<person_id>/activity
HTTP status code: 200
Response body:
{
"offset": 0,
"results": [
...up to 100 activity objects in reverse chronological order...
],
"total": 42
}
POST /api/2/person/two_step/enable
HTTP status code: 200
Response body:
{
"backup_key": "GZTEQRKMGIYDS4JU",
"key": "GM4EUUKOKNMHEZS2OZ2UE43YNVYG4OL2",
"uri": "otpauth://totp/foo@example.com?secret=GM4EUUKOKNMHEZS2OZ2UE43YNVYG4OL2"
}
HTTP status code: 200
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
POST /api/2/person/two_step/disable
HTTP status code: 200
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
POST /api/2/person/two_step/recovery
HTTP status code: 200
HTTP status code: 401
Response body:
{
"error": "access_denied"
}
Die folgenden Fehler können für jede Personenmethode auftreten und werden in den Methodenbeschreibungen nicht explizit erwähnt.
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
Ein Gast repräsentiert ein eingeschränktes Konto mit eingeschränktem Zugriff auf freigegebene Dateien.
"guest"
Die eindeutige Kennung für den Gast
Die Kennung der Firma, zu der der Gast gehört
Die Kennung der Person, die den Gast angelegt hat
Die Email-Adresse des Gastes
Der Vorname des Gastes
Der Nachname des Gastes
Ob das Gastkonto aktiv ist
Datum/Uhrzeit in UTC, in dem der Gast im Format JJJJ-MM-TT SS:MM:SS angelegt wurde
{
"active": true,
"company_id": 1,
"created": "2015-01-01T01:02:03",
"creator_id": 1,
"email": "guest@example.com",
"first_name": "First",
"id": 1,
"last_name": "Last",
"type": "guest"
}
Erstellen Sie sich einen Gast über seine ID oder Email-Adresse.
GET /api/2/guest/<guest_id> GET /api/2/guest/<email>
HTTP status code: 200
Response body:
{
...a guest object...
}
POST /api/2/guest/create
Gibt den erstellten Gast zurück.
HTTP status code: 200
Response body:
{
...a guest object...
}
POST /api/2/guest/<guest_id>/update
Gibt den aktualisierten Gast zurück.
HTTP status code: 200
Response body:
{
...a guest object...
}
POST /api/2/guest/<guest_id>/delete
HTTP status code: 200
GET /api/2/guest/<guest_id>/shares
HTTP status code: 200
Response body:
{
"results": [
...file share objects...
]
}
POST /api/2/guest/<guest_id>/convert
Gibt das erstellte Konto zurück.
HTTP status code: 200
Response body:
{
...a person object...
}
Tritt auf, wenn die Umwandlung des Gastkontos das Kontolimit des Unternehmens überschreiten würde.
HTTP status code: 409
Response body:
{
"error": "user_limit_exceeded",
"error_description": "User limit has been reached."
}
Eine Gruppe stellt eine Sammlung von Benutzern und anderen Gruppen dar.
"group"
Der eindeutige Identifikator für die Gruppe
Die eindeutige Kennung für die Organisation der Gruppe
Der Gruppenname
Datum/Uhrzeit in UTC, in dem die Gruppe im Format JJJJ-MM-TT SS:MM:SS erstellt wurde.
Ob die Gruppe aktiv ist
{
"active": true,
"company_id": 2,
"created": "2016-03-30T05:57:23",
"id": 1,
"name": "Example Group",
"type": "group"
}
POST /api/2/group/create
Gibt die erstellte Gruppe zurück.
HTTP status code: 200
Response body:
{
...a group object...
}
GET /api/2/group/<group_id>
HTTP status code: 200
Response body:
{
...a group object...
}
POST /api/2/group/<group_id>/update
Gibt die aktualisierte Gruppe zurück.
HTTP status code: 200
Response body:
{
...a group object...
}
GET /api/2/group/<group_id>/members
HTTP status code: 200
Response body:
{
"member_groups": [
2
],
"member_groups_from_group": [
3
],
"members": [
2,
3
],
"members_from_group": [
1
]
}
include_from_group "true" ist.include_from_group "true" ist.POST /api/2/group/<group_id>/members/update
HTTP status code: 200
POST /api/2/group/<group_id>/delete
HTTP status code: 200
Ein Computer stellt eine Vorrichtung dar, die zur Verbindung mit der leitzcloud verwendet wird, wie beispielsweise ein Computer, Telefon oder Tablett.
"machine"
Die eindeutige Kennung für die Maschine
Ein beschreibender Name für das Gerät, wie beispielsweise der Hostname oder der Gerätehersteller und das Modell
Datum/Uhrzeit in UTC, an dem sich das Gerät zuletzt im Format JJJJ-MM-TT SS:MM:SS angemeldet hat. Wird vom Desktop-Agenten verwendet
Eine global eindeutige Kennung, die der Maschine zugeordnet ist
Datum/Uhrzeit in UTC, in dem das Gerät im Format JJJJ-MM-TT SS:MM:SS erstellt wurde
Der Systemtyp des Gerätes, wie z.B. "win", "osx", "android", "ios" oder "winphone"
Die Systemversion des Gerätes, z.B. "5.1.0"
Die auf der Maschine installierte Agentenversion. Wird vom Desktop-Agenten verwendet
Ob die Bandbreitenbegrenzung für die Maschine aktiviert ist
Der Gerätentyp
Das Datum/Uhrzeit in UTC, in dem die Maschine zuletzt im Format JJJJ-MM-TT SS:MM:SS getrennt wurde. Wird vom Desktop-Agenten verwendet
{
"agent_version": null,
"bandwidth_throttle": null,
"created": "2015-01-01T01:02:03",
"dns_name": "Google Nexus 6",
"guid": "794f7f67-3bd6-407c-9274-be735b880143",
"health_report_period_minutes": null,
"id": 1,
"last_disconnect": null,
"last_login": null,
"locked": false,
"machine_type": "mobile",
"manual_collisions": true,
"nickname": null,
"os_type": "android",
"os_version": "5.1.0",
"throttle_exception_days": null,
"throttle_exception_dow": null,
"throttle_exception_end": null,
"throttle_exception_start": null,
"throttle_exception_throttle": null,
"throttled": false,
"type": "machine"
}
Eine Maschinenzuordnung stellt einen Pfad auf einem Dateiserver-fähigen Rechner dar, der einem Root zugeordnet ist.
"machine_mapping"
Der eindeutige Identifikator für das Mapping
Die Kennung des Dateiserver-fähigen Rechners, dem die Root zugeordnet ist
Der Mapping-Name
Der Pfad auf dem Dateiserver-fähigen Computer, dem die Root zugeordnet ist
Die Kennung des Kontos, wenn die abgebildete Root eine Kontoroot ist
Der Bezeichner der abgebildeten Root
Ob die zugeordnete Root eine Freigabe ist
{
"id": 1234,
"machine_id": 1,
"name": "Example Share",
"path": "C:\Example1",
"person_id": null,
"root_id": 2,
"share": true,
"type": "machine_mapping"
}
Ein Backup stellt eine Backup-Root dar, die einem Pfad auf einem Dateiserver-fähigen Rechner zugeordnet ist.
"backup"
Die eindeutige Kennung für das Backup
Die Kennung des Dateiserver-fähigen Rechners, dem die Root zugeordnet ist
Der Pfad auf dem Dateiserver-fähigen Computer, von dem aus Dateien gesichert werden
{
"id": 1234,
"machine_id": 1,
"path": "C:\\Example",
"type": "backup"
}
GET /api/2/machine/<machine_id>
HTTP status code: 200
Response body:
{
...a machine object...
}
GET /api/2/machine/<machine_id>/status
HTTP status code: 200
Response body:
{
"results": {
"subscriptions": [
{
"excl_files": 1,
"rsub_id": 1234,
"synced": true,
"synced_folder": "C:\\Example"
}
],
"synced": true,
"transfers": []
}
}
POST /api/2/machine/<machine_id>/server/enable
HTTP status code: 200
POST /api/2/machine/<machine_id>/server/disable
HTTP status code: 200
POST /api/2/machine/<machine_id>/ls
HTTP status code: 200
Response body:
{
"results": [
"Example1",
"Example2"
]
}
GET /api/2/machine/<machine_id>/mappings
HTTP status code: 200
Response body:
{
"results": [
...machine_mapping objects...
]
}
POST /api/2/machine/<machine_id>/mappings/create
Gibt das erstellte Mapping zurück.
HTTP status code: 200
Response body:
{
...a machine_mapping object...
}
GET /api/2/machine/<machine_id>/mapping/<mapping_id>
HTTP status code: 200
Response body:
{
...a machine_mapping object...
}
POST /api/2/machine/<machine_id>/mapping/<mapping_id>/delete
HTTP status code: 200
GET /api/2/machine/<machine_id>/backups
HTTP status code: 200
Response body:
{
"results": [
...backup objects...
]
}
POST /api/2/machine/<machine_id>/backups/create
Gibt das erstellte Backup zurück
HTTP status code: 200
Response body:
{
...a backup object...
}
GET /api/2/machine/<machine_id>/backup/<root_id>
HTTP status code: 200
Response body:
{
...a backup object...
}
POST /api/2/machine/<machine_id>/backup/<root_id>/restore
Returns the updated backup object.
HTTP status code: 200
Response body:
{
...a backup object...
}
POST /api/2/machine/<machine_id>/backup/<root_id>/delete
HTTP status code: 200
Die folgenden Fehler können bei jedem Maschinenverfahren auftreten und sind in den Methodenbeschreibungen nicht explizit erwähnt.
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
Eine Aktivität stellt eine protokollierte Aktion dar, die Details der agierenden Einheit und der betroffenen Einheit enthält.
"activity"
Der eindeutige Identifikator für die Aktivität
Der Entitätstyp, der die Aktivität auslöst
Die Beschreibung der Einheit, die die Aktivität auslöst
Zusätzliche Beschreibung der ergriffenen Maßnahmen
Der Entitätstyp, auf den reagiert wurde
Die Beschreibung des Entitätstyps, auf den reagiert wird
Die Beschreibung der getroffenen Maßnahmen
Die Kennung der Aktivitätsart für diese Aktivität
Datum/Uhrzeit in UTC, zu dem die Aktivität im Format JJJJ-MM-TT SS:MM:SS stattgefunden hat
{
"acted_on_company_id": 1,
"acted_on_group_id": null,
"acted_on_guest_id": null,
"acted_on_machine_id": null,
"acted_on_person_id": null,
"acted_on_root_id": null,
"acted_on_text": "Example Company",
"acted_on_type": "site",
"action_text": null,
"activity_type_id": 8,
"actor_company_id": null,
"actor_guest_id": null,
"actor_machine_id": null,
"actor_person_id": 1,
"actor_text": "First Last",
"actor_type": "person",
"created": "2015-01-01T01:02:03",
"data_text": "increased from 4.00G to 100.00G",
"id": 123,
"processed": true,
"type": "activity"
}
"activity_type"
Der eindeutige Identifikator für die Aktivitätsart
Die Beschreibung der Aktivität
ob die Aktivität im Rahmen eines Gerätes ausgeführt wird
ob die Aktivität im Rahmen eines Benutzers durchgeführt wird
ob die Aktivität auf Systemebene ausgeführt wird
{
"activity": "added organization",
"id": 3,
"machine_scope": false,
"system_scope": false,
"type": "activity_type",
"user_scope": false
}
GET /api/2/activity/types
HTTP status code: 200
Response body:
{
"results": [
...a list of activity objects...
]
}
GET /api/2/activity/<activity_id>
HTTP status code: 200
Response body:
{
...an activity object...
}
POST /api/2/activity/create
Gibt den erstellten Aktivitätsdatensatz zurück.
HTTP status code: 200
Response body:
{
...an activity object...
}
Die folgenden Fehler können für jede Aktivitätsmethode auftreten und werden in den Methodenbeschreibungen nicht explizit erwähnt.
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}
Eine Authentifizierungsquelle stellt einen Verzeichnisserver dar, von dem Benutzer importiert werden können.
"auth_source"
Die eindeutige Kennung für die Authentifizierungsquelle
Der Hostname des Verzeichnis-Servers
Der Domänenname auf dem Verzeichnisserver, der für den Import von Benutzern verwendet werden soll
Der Benutzername, mit dem auf den Verzeichnisserver zugegriffen wurde
Die Portnummer des Verzeichnis-Servers
Ob der Verzeichnisserver SSL/TLS verwendet
Ein öffentlicher Spitzname für die Authentifizierungsquelle, der Besuchern auf der Anmeldeseite angezeigt wird
{
"domain": "example.com",
"host": "localhost",
"id": 1,
"login": "example",
"machine_id": null,
"port": null,
"protocol": null,
"ssl": false,
"type": "auth_source"
}
"file_sharelink"
Der einzigartige Identifikator des Dateifreigabe-Link
Der "öffentliche" Hash der genutzt wird, um einen einzigartigen Freigabe-Link zu erstellen
Das geteilte Datei Objekt
Der Identifikator des Stammverzeichnis, welches die Datei enthält
Der Identifikator von der Erstellers des Freigabelinks
Der Name des Erstellers des Freigabelinks
The date/time in UTC the share link was created in the format YYYY-MM-DDTHH:MM:SS
Das Datum, an dem die Freigabe abläuft, im Format JJJJ-MM-TT oder null, wenn sie kein Ablaufdatum hat
Ob der Freigabe - Link öffentlich ist (false) oder nur für authentifizierte Nutzer zugänglich ist (true)
Die maximale Nummer, wie oft die Datei heruntergeladen werden kann oder null, wenn es kein Limit gibt
Ob der Freigabe-Link Ersteller benachrichtigt wird, wenn die Datei heruntergeladen wird
Ob Dateien bearbeitet werden dürfen über die öffentliche Freigabe (z.B von anonymen Nutzern)
Eine Liste von Abonnentenobjekten. Hinweis: Die Liste ist nicht immer vollständig, abhängig vom Kontext der Anfrage. Zum Beispiel, wenn Dateien und Ordner abrufen werden, die mit einem Gast geteilt werden, werden nur die Abonnentendaten des angefragten Gastes zurückgegeben.
Die Gesamtanzahl wie oft der Freigabelink heruntergeladen wurde. Kann je nach Kontext der Anfrage variieren.
Gesamtanzahl der Zugriffe auf den Freigabelink. Kann je nach Kontext der Anfrage variieren.
Die URL des Freigabelinks.
{
"anon_edit": false,
"created": "2019-03-27T10:42:34",
"creator_name": "Jane Doe",
"creator_id": 1,
"download_limit": 1000,
"download_notify": true,
"expires": "2019-04-28",
"file": {
...a file object...
},
"hash": "10d2d8d4e15e91",
"id": 1,
"login_required": true,
"root_id": 1,
"subscribers": [
...share link subscriber objects...
],
"times_downloaded": 0,
"times_viewed": 0,
"type": "file_sharelink",
"url": "http://example.com/shares/file/10d2d8d4e15e91/"
}
"folder_sharelink"
Der eindeutiger Identifikator des Ordnerfreigabelinks
Der "öffentliche" Hash, der verwendet wird, um die eindeutige URL für den Freigabelink zu erstellen
Das geteilte Ordner Objekt
Die Kennung des Stammverzeichnisses, das den freigegebenen Ordner enthält
Der Identifikator des Erstellers des Freigabelinks
Der Name des Erstellers des Freigabelinks
Datum/Uhrzeit in UTC, in der der Freigabelink erstellt wurde, im Format YYYY-MM-DDTHH:MM:SS
Das Datum, an dem der Freigabelink im Format JJJJ-MM-TT abläuft oder null, wenn er kein Ablaufdatum hat
Ob der Link öffentlich ist (false) oder nur von authentifizierten Nutzern geöffnet werden kann (true)
The maximum number of times the share link may be downloaded or null if there is no limit
Ob der Ersteller des Freigabelinks benachrichtigt wird, wenn der freigegebene Ordner über den Freigabelink heruntergeladen wird
Ob der Ersteller des Freigabelinks benachrichtigt wird, wenn eine Datei über den Freigabelink in den freigegebenen Ordner hochgeladen wird
Ob Dateien über die öffentliche Freigabelink-URL bearbeitet werden dürfen (d. h. von anonymen Benutzern)
ine Liste von Abonnentenobjekten. Hinweis: Die Liste ist nicht immer vollständig, abhängig vom Kontext der Anfrage. Zum Beispiel, wenn Dateien und Ordner abrufen werden, die mit einem Gast geteilt werden, werden nur die Abonnentendaten des angefragten Gastes zurückgegeben.
Gesamtanzahl der Downloads des freigegebenen Ordners. Kann je nach Kontext der Anfrage variieren.
Gesamtanzahl der Zugriffe auf den Freigabelink. Kann je nach Kontext der Anfrage variieren.
Die URL des Freigabelinks.
{
"anon_edit": false,
"created": "2019-03-27T11:54:34",
"creator_name": "Jane Doe",
"creator_id": 1,
"download_limit": null,
"download_notify": false,
"expires": null,
"folder": {
...a folder object...
},
"hash": "10d2d8d4e15e91",
"id": 1,
"login_required": false,
"root_id": 1,
"subscribers": [
...share link subscriber objects...
],
"times_downloaded": 0,
"times_viewed": 0,
"type": "folder_sharelink",
"upload_notify": false,
"url": "http://example.com/shares/folder/10d2d8d4e15e91/"
}
"sharelink_subscriber"
Der eindeutige Identifikator des Share-Link-Abonnements
Der Share-Hash des Abonnenten, der verwendet wird, um seine eindeutige Share-Link-URL zu erstellen
Ob der Abonnent Lesezugriff hat.
Ob der Abonnent Schreibzugriff hat
Ob der Abonnent Löschzugriff hat.
Der mit dem Abonnement verknüpfte Abonnententyp: Person, Gast, Gruppe oder E-Mail
Ein Objekt, das zusätzliche Abonnentenmetadaten enthält wenn Subscriber_type eine person, guest oder group ist. Die E-Mail-Adresse des Abonnenten als String, wenn Subscriber_type email ist.
Wie oft die freigegebene Datei oder der freigegebene Ordner mit dem Freigabe-Hash des Abonnenten heruntergeladen wurde.
Anzahl der Zugriffe auf den Share-Link mit dem Share-Hash des Abonnenten.
Die URL des Freigabelinks des Abonnenten.
{
"delete_access": false,
"hash": "d2d8d4e119105e",
"id": 1,
"read_access": true,
"subscriber": {
"email": "example@example.com",
"id": 1,
"name": "Jane Doe"
},
"subscriber_type": "person",
"times_downloaded": 0,
"times_viewed": 0,
"type": "sharelink_subscriber",
"write_access": false,
"url": "http://example.com/shares/file/d2d8d4e119105e/"
}
GET /api/2/sharelinks/<sharelink_id>
HTTP status code: 200
Response body:
{
...a file share link object or a folder share link object...
}
GET /api/2/sharelinks/<hash>
HTTP status code: 200
Response body:
{
...a file share link object or a folder share link object...
}
PUT /api/2/sharelinks/<sharelink_id>
HTTP status code: 200
Response body:
{
...a file share link object or a folder share link object...
}
DELETE /api/2/sharelinks/<sharelink_id>
HTTP status code: 200
POST /api/2/sharelinks/<sharelink_id>/subscribers
HTTP status code: 200
Response body:
{
...a share link subscriber object...
}
POST /api/2/sharelinks/<sharelink_id>/subscribers
HTTP status code: 200
Response body:
{
...a share link subscriber object...
}
PUT /api/2/sharelinks/<sharelink_id>/subscribers/<subscriber_id>
HTTP status code: 200
Response body:
{
...a share link subscriber object...
}
DELETE /api/2/sharelinks/<sharelink_id>/subscribers/<subscriber_id>
HTTP status code: 200
GET /api/2/sharelinks/<sharelink_id>/files GET /api/2/sharelinks/<hash>/files GET /api/2/sharelinks/<sharelink_id>/files/folder/<folder_id> GET /api/2/sharelinks/<hash>/files/folder/<folder_id>
include_children
gleich "wahr" ist.
HTTP status code: 200
Response body:
{
...a folder object...
}
children ist eine Liste von Datei- und Ordnermetadatenobjekten innerhalb des Ordners. Es ist nur vorhanden, wenn include_children
gelich "wahr" ist.
Der hash Wert repräsentiert eine Signatur für die Antwortdaten. Ist der Hashwert in der Antwort
identisch mit dem vom Client übergebenen Hash-Wert, wird "HTTP 304 Not Modified" zurückgegeben. hash
ist nur vorhanden
wenn include_children gleich "wahr" ist.
GET /api/2/sharelinks/<sharelink_id>/files/children GET /api/2/sharelinks/<hash>/files/children GET /api/2/sharelinks/<sharelink_id>/files/folder/<folder_id>/children GET /api/2/sharelinks/<hash>/files/folder/<folder_id>/children
Gibt Metadaten für die unmittelbar untergeordneten Elemente eines freigegebenen Ordners mit Optionen zum Sortieren und Paginieren zurück.
HTTP status code: 200
Response body:
{
"page": 1,
"page_size": 20,
"max_page": 3,
"results": [
...up to page_size file and folder objects...
],
"total": 42
}
GET /api/2/sharelinks/<sharelink_id>/files/<file_id> GET /api/2/sharelinks/<hash>/files/<file_id>
HTTP status code: 200
Response body:
{
...a file object...
}
GET /api/2/sharelinks/<sharelink_id>/download GET /api/2/sharelinks/<sharelink_id>/view
Diese Endpunkte werden verwendet, um den vollständigen Inhalt eines Freigabelinks, die Datei selbst für einen Freigabenlink oder den gezippten Inhalt eines freigegebenen Ordners herunterzuladen.
Ob die Datei heruntergeladen wird von dem download Endpunkt oder dem view Endpunkt, entscheidet die Content-Verteilung
in der Antwort -- attachment or inline. Ein geteilter Ordner unterstützt nicht view und wird mit einem 404 antworten.
Download verfügbar.Download verfügbar.Wenn entweder file_ids oder folder_ids vorhanden ist, wird der Download nur die bestimmten Elemente enthalten.
HTTP status code: 200 Response body: <binary file data>
GET /api/2/sharelinks/<sharelink_id>/files/<file_id>/download GET /api/2/sharelinks/<sharelink_id>/files/<file_id>/view GET /api/2/sharelinks/<hash>/files/<file_id>/download GET /api/2/sharelinks/<hash>/files/<file_id>/view
Diese Endpunkte werde genutzt, um eine spezifische Datei in einem geteilten Ordner herunterzuladen.
Ob die Datei über den download Endpunkt oder den view Endpunkt heruntergeladen wird,
bestimmt die Content-Verteilung in der Anwort-- attachment or inline.
HTTP status code: 200 Response body: <binary file data>
GET /api/2/sharelinks/<sharelink_id>/files/folder/<folder_id>/download GET /api/2/sharelinks/<hash>/files/folder/<folder_id>/download
Diese Endpunkte werden verwendet, um einen bestimmten Ordner innerhalb eines freigegebenen Ordners als ZIP-Datei herunterzuladen.
download Endpunkt.download Endpunkt..If either file_ids or folder_ids is present, the download will include only the items specified.
HTTP status code: 200 Response body: <binary file data>
POST /api/2/sharelinks/<sharelink_id>/files/create_folder POST /api/2/sharelinks/<hash>/files/create_folder POST /api/2/sharelinks/<sharelink_id>/files/folder/<folder_id>/create_folder POST /api/2/sharelinks/<hash>/files/folder/<folder_id>/create_folder
HTTP status code: 200
Response body:
{
...folder metadata...
}
HTTP status code: 400
Response body:
{
"error": "invalid_name"
}
HTTP status code: 400
Response body:
{
"error": "name_too_long"
}
HTTP status code: 409
Response body:
{
"error": "name_conflict"
}
Die folgenden Fehler können bei jeder Share-Link-Methode auftreten und werden in den Methodenbeschreibungen nicht explizit erwähnt.
HTTP status code: 403
Response body:
{
"error": "forbidden"
}
HTTP status code: 404
Response body:
{
"error": "not_found"
}