docuframe_api library
Classes
- DOCUframeApi
- Öffentlicher Einstiegspunkt für die neue gruppierte DOCUframe-API.
- DocuframeManagementApi
- Öffentliche Management-Oberfläche der gruppierten DOCUframe-API.
- DocuframeRuntimeSettings
- Unveränderlicher Abzug der kontrolliert veränderbaren Runtime-Werte.
- DocuframeV1Api
- Öffentliche Gruppen der nativen V1-API.
- DocuframeV2Api
- Öffentliche Gruppen der nativen V2-API.
- RawApi
- Kontrollierter Escape Hatch für kundenspezifische oder noch nicht nativ unterstützte DOCUframe-Endpunkte.
- RawApiRequest
- Beschreibt einen einzelnen RawApi-Request, bevor er gegen den internen Runtime ausgeführt wird.
- RawApiResponse
- Stabile, transport-unabhängige Antwort von RawApi.
- RefreshSessionResponse
- Response-Klasse für Session-Erneuerungs-Operationen
- RestApi2FASecretResponse
- Antwort-Klasse für 2FA (Zwei-Faktor-Authentifizierung) Secret-Anfragen
- RestApiACLEntry
- Repräsentiert einen ACL (Access Control List) Eintrag im REST-API-Service
- RestApiCallbacks
- Basis-Callback-Management-System für REST-API-Events
- RestApiCheckServiceResponse
- Response-Klasse für Service-Status-Überprüfungen
- RestApiConfig
- Basis-Konfigurationsklasse für REST-API-Parameter
- RestApiDevice
- Repräsentiert ein Gerät, das sich bei der REST-API anmeldet
- RestApiDOCUframeCallbacks
- Erweiterte Callback-Management-System für DOCUframe REST-API-Events
- RestApiDOCUframeConfig
- Erweiterte Konfigurationsklasse für DOCUframe REST-API-Parameter
- RestApiDOCUframeDatabase
- Repräsentiert eine Datenbank im REST-API-Service
- RestApiDOCUframeModule
- Repräsentiert ein Modul im REST-API-Service
- RestApiFileResponse
- Response-Klasse für Datei-Download-Anfragen
- RestAPIFileUploadController
- Controller-Klasse für die Steuerung von Datei-Upload-Prozessen
- RestApiHttpMetric
- RestApiLoginResponse
- Response-Klasse für Login-API-Anfragen
- RestApiLoginSecureKeyResponse
- Response-Klasse für Login-Verschlüsselungsschlüssel-Anfragen
- RestApiObjectLockResponse
- Response-Klasse für Objekt-Sperr-Anfragen
- RestApiResponse
- Basisklasse für alle REST-API-Antworten
- RestApiSyncClassResponse
- Response-Klasse für Synchronisations-API-Aufrufe
- RestApiSyncContainer
- RestApiSyncDataClass
- RestApiUploadFile
- RestApiUserSystemSettingsResponse
- Response-Klasse für Benutzer-Systemeinstellungen
- RestApiVersionInfoResponse
- Response-Klasse für Webservice-Versionsinformationen
- V1AccountApi
- Native Konto-Operationen der V1-Fassade.
- V1AppointmentsApi
- Native Terminoperationen der V1-Fassade.
- V1AuthenticationApi
- Native Authentifizierungsoperationen der neuen V1-Fassade.
- V1DocumentsApi
- Native Dokument-, Datei- und Uploadoperationen der V1-Fassade.
- V1FoldersApi
- Native Ordneroperationen der V1-Fassade.
- V1IntegrationsApi
- Native Makro-, Druck- und Telefonie-Integrationen der V1-Fassade.
- V1MailApi
- Native E-Mail-Operationen der V1-Fassade.
- V1MessagesApi
- Native Operationen für interne Nachrichten der V1-Fassade.
- V1ModelsApi
- Native Modell-, Struktur- und Wörterbuch-Operationen der V1-Fassade.
- V1ObjectsApi
- Native Objektoperationen der V1-Fassade.
- V1PersonalApi
- Native persönliche V1-Operationen für den angemeldeten Benutzer.
- V1ServiceApi
- Native Service-, Lizenz- und Versionsoperationen der V1-Fassade.
- V1SettingsApi
- Native Benutzer-Einstellungsoperationen der V1-Fassade.
- V1TimeRecordingApi
- Native Personalzeiterfassungs-Operationen (PZE) der V1-Fassade.
- V1XSyncApi
-
Native Synchronisationsoperationen unter
v1/xSync. - V2FileApi
- Native V2-Dateioperationen.
- V2ModelApi
- Native V2-Modelloperationen.
- V2ObjectDataApi
- Native V2-Objektdatenoperationen.
- V2SystemApi
- Native V2-Systemoperationen.
- V2ViewApi
- Native V2-Viewoperationen.
Enums
- ApiHttpMethod
-
HTTP-Methode für einen RawApi-Request oder eine interne
ApiRequest. - ApiVersion
- Version der nativen DOCUframe-REST-API.
- HttpMethod
- Enum für unterstützte HTTP-Methoden.
- RequestPriority
- Enum für Request-Prioritäten
- RestApi2FAStatus
- Enum für die verschiedenen 2FA (Zwei-Faktor-Authentifizierung) Status-Werte
- RestApiDeviceType
- Enum für verschiedene Gerätetypen, die mit der REST-API interagieren können
- RestApiDOCUframeFolderType
- Enum für verschiedene Ordnertypen in der REST-API
Extensions
- DateTimeExtention on DateTime
- Extension für DateTime-Klasse mit ISO-Formatierung
- ISODurationExtensions on ISODuration
- Extension für ISODuration-Klasse mit Formatierung
- StringExtensions on String
- Extension für String-Klasse mit REST-API-spezifischen Hilfsmethoden
Exceptions / Errors
- HttpRequestException
- Exception für HTTP-Request-Fehler
- Invalid2FATokenException
- Exception für ungültigen 2FA-Token
- LicenseException
- Exception für Lizenz-bezogene Fehler
- Missing2FATokenException
- Exception für fehlenden 2FA-Token
- Require2FALoginException
- SecurityException
- Exception für Sicherheitsverletzungen
- SessionInvalidException
- Exception für ungültige Session
- TokenOrSessionIsMissingException
- Exception für fehlende Token oder Session
- UserAndPassWrongException
- Exception für falsche Anmeldedaten
- WebServiceException
- Exception für allgemeine Webservice-Fehler