From 0112fce5dd91b4d607c1cb64a0cf7ac421cd3d90 Mon Sep 17 00:00:00 2001
From: Jan Zickermann <jan.zickermann@dataport.de>
Date: Mon, 25 Nov 2024 14:18:03 +0100
Subject: [PATCH] #4 OZG-7112 swagger: Transform to yaml
---
pom.xml | 2 +-
spec/postfach-api-facade.json | 4843 --------------------------------
spec/postfach-api-facade.yaml | 4909 +++++++++++++++++++++++++++++++++
3 files changed, 4910 insertions(+), 4844 deletions(-)
delete mode 100644 spec/postfach-api-facade.json
create mode 100644 spec/postfach-api-facade.yaml
diff --git a/pom.xml b/pom.xml
index f0838e2..a03dac2 100644
--- a/pom.xml
+++ b/pom.xml
@@ -136,7 +136,7 @@
<goal>generate</goal>
</goals>
<configuration>
- <inputSpec>${project.basedir}/spec/postfach-api-facade.json</inputSpec>
+ <inputSpec>${project.basedir}/spec/postfach-api-facade.yaml</inputSpec>
<generatorName>java</generatorName>
<configOptions>
<sourceFolder>src/gen/java/main</sourceFolder>
diff --git a/spec/postfach-api-facade.json b/spec/postfach-api-facade.json
deleted file mode 100644
index 80d4e09..0000000
--- a/spec/postfach-api-facade.json
+++ /dev/null
@@ -1,4843 +0,0 @@
-{
- "openapi": "3.0.1",
- "info": {
- "title": "Postfach API Facade",
- "description": "<h3>Zentraler Service zur Nutzung der Plattformdienste des <i>Plattformdienstteams Postfach</i></h3>siehe auch <a href=https://docs.osi.dataport.de/x/VgO8Bw>PF-Facade</a>",
- "version": "1.0"
- },
- "servers": [
- {
- "url": "/facade"
- }
- ],
- "paths": {
- "/Filestorage/v1": {
- "post": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Lädt eine komplette Datei oder das erste Dateistück hoch",
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "description": "Inhalt der Datei bzw. des Dateistücks",
- "format": "binary"
- },
- "moreWillFollow": {
- "type": "boolean",
- "description": "Ob noch weitere Chunks folgen"
- },
- "target": {
- "$ref": "#/components/schemas/V1_FilestorageTarget"
- },
- "expirationDate": {
- "type": "string",
- "description": "Verfallsdatum der Datei (Standard: nach Standard-Verfallszeit) - Wenn hier `null` angegeben wird, gilt die im System definierte Standard-Verfallszeit.Die Zeit wird an der REST-Schnittstelle incl. Zeitzoneninformation entgegengenommen und entsprechend verarbeitet. Eine Zeit ohne Zeitzonenangabe (sog. unspezifizierte Zeit) wird als lokale (deutsche) Zeit interpretiert.",
- "format": "date-time"
- },
- "additionalContext": {
- "type": "string",
- "description": "zusätzlicher Kontext -\r\n Bildet zusammen mit dem großgeschriebenen Name-Identifier (Shortcode des Onlinedienstes) aus der OIDC-Anmeldung den Berechtigungskontext."
- },
- "fileName": {
- "type": "string",
- "description": "Name der Datei (default: Name aus `file`)"
- }
- }
- },
- "example": "24b91411-34e0-4ad2-aedb-ef9726cfe8aa",
- "encoding": {
- "file": {
- "style": "form"
- },
- "moreWillFollow": {
- "style": "form"
- },
- "target": {
- "style": "form"
- },
- "expirationDate": {
- "style": "form"
- },
- "additionalContext": {
- "style": "form"
- },
- "fileName": {
- "style": "form"
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK<br />Erfolgreich hochgeladen.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_UploadResponse"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_UploadResponse"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_UploadResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- }
- }
- }
- },
- "/Filestorage/v1/{uploadId}/{chunkIndex}": {
- "post": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Lädt ein weiteres Dateistück hoch",
- "parameters": [
- {
- "name": "uploadId",
- "in": "path",
- "description": "Identifikator des Uploads",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- }
- },
- {
- "name": "chunkIndex",
- "in": "path",
- "description": "0-basierter Index des Dateistücks (Chunks), hier immer >= 1",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "description": "Inhalt des Dateistücks",
- "format": "binary"
- },
- "moreWillFollow": {
- "type": "boolean",
- "description": "Ob noch weitere Chunks folgen",
- "example": "false"
- }
- }
- },
- "encoding": {
- "file": {
- "style": "form"
- },
- "moreWillFollow": {
- "style": "form"
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK<br />Dateistück erfolgreich hochgeladen."
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "409": {
- "description": "Conflict<br />Dieses Dateistück wurde bereits zuvor hochgeladen.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict","title":"Conflict","status":409,"detail":"Dieses Dateistück wurde bereits zuvor hochgeladen."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict","title":"Conflict","status":409,"detail":"Dieses Dateistück wurde bereits zuvor hochgeladen."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict","title":"Conflict","status":409,"detail":"Dieses Dateistück wurde bereits zuvor hochgeladen."}
- }
- }
- }
- }
- }
- },
- "/Filestorage/v1/{uploadId}/CheckUpload": {
- "get": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Überprüft Sicherheitsstatus und Verfügbarkeit der hochgeladenen Datei",
- "parameters": [
- {
- "name": "uploadId",
- "in": "path",
- "description": "Identifikator des Uploads",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK<br />Die Datei wurde erfolgreich virenüberprüft und steht in den angegebenen `storages` zum Download bereit.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_CheckUploadResponse"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_CheckUploadResponse"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_CheckUploadResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request<br />Die Datei ist nicht sicher und wurde abgelehnt.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Die Datei ist nicht sicher und wurde abgelehnt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Die Datei ist nicht sicher und wurde abgelehnt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Die Datei ist nicht sicher und wurde abgelehnt."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "404": {
- "description": "Not found<br />Die Datei existiert weder im Upload-Bereich noch in einem Filestorage.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Die Datei existiert weder im Upload-Bereich noch in einem Filestorage."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Die Datei existiert weder im Upload-Bereich noch in einem Filestorage."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Die Datei existiert weder im Upload-Bereich noch in einem Filestorage."}
- }
- }
- },
- "422": {
- "description": "Unprocessable Content<br />Es wurden noch nicht alle Dateistücke hochgeladen.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21","title":"Unprocessable Content","status":422,"detail":"Es wurden noch nicht alle Dateistücke hochgeladen."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21","title":"Unprocessable Content","status":422,"detail":"Es wurden noch nicht alle Dateistücke hochgeladen."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21","title":"Unprocessable Content","status":422,"detail":"Es wurden noch nicht alle Dateistücke hochgeladen."}
- }
- }
- },
- "503": {
- "description": "Service unavailable<br />Virenprüfung läuft.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- }
- }
- }
- }
- }
- },
- "/Filestorage/v1/{guid}": {
- "get": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Download aus dem OD-Filestorage",
- "description": "Beim Download werden diverse Checks ausgeführt und die Datei auch erforderlichenfalls vom Quarantine-Filestorage (QFS) in den OD-Filestorage (ODFS) übertragen. Wenn die Datei noch nicht virengeprüft wurde oder virenbefallen ist, erfolgt ein Fehlerabbruch. Wenn die Datei noch nicht in den OD-Filestorage übertragen wurde, erfolgt diese Übertragung vor der Auslieferung der Datei. Aus der Anmeldung und dem additionalContext wird automatisch der Berechtigungskontext erzeugt. additionalContext muss mit einem '$' beginnen, um einen gesicherten Download zu kennzeichnen. Nur solche Dateien können mit dieser Aktion heruntergeladen werden. Stimmt der Berechtigungskontext nicht mit dem gespeicherten Berechtigungskontext überein, erfolgt ein Fehlerabbruch.",
- "parameters": [
- {
- "name": "guid",
- "in": "path",
- "description": "Identifikator der Datei.",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- }
- },
- {
- "name": "additionalContext",
- "in": "query",
- "description": "zusätzlicher Kontext - Bildet zusammen mit der Anmeldung den Berechtigungskontext. (Default: \"$\")",
- "schema": {
- "type": "string"
- },
- "example": "$"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_FilestoragePayloadContent"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_FilestoragePayloadContent"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_FilestoragePayloadContent"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Nur für herunterladbare Dateien. `additionalContext` muss mit einem '$' beginnen."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Nur für herunterladbare Dateien. `additionalContext` muss mit einem '$' beginnen."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Nur für herunterladbare Dateien. `additionalContext` muss mit einem '$' beginnen."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Die Datei existiert weder im Upload-Bereich noch in einem Filestorage."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Die Datei existiert weder im Upload-Bereich noch in einem Filestorage."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Die Datei existiert weder im Upload-Bereich noch in einem Filestorage."}
- }
- }
- },
- "422": {
- "description": "Unprocessable Content",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21","title":"Unprocessable Content","status":422,"detail":"Es wurden noch nicht alle Dateistücke hochgeladen."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21","title":"Unprocessable Content","status":422,"detail":"Es wurden noch nicht alle Dateistücke hochgeladen."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21","title":"Unprocessable Content","status":422,"detail":"Es wurden noch nicht alle Dateistücke hochgeladen."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- }
- }
- }
- }
- },
- "delete": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Löscht eine Datei",
- "description": "<br>Diese Operation bezieht sich auf alle Filestorages (QFS, ODFS und PFFS) sowie die Quarantäne. Sie löscht auch unvollständige Uploads.\r\n<br>Der Aufruf setzt eine Löschmarkierung, das physische Löschen geschieht automatisch unmittelbar danach asynchron.",
- "parameters": [
- {
- "name": "guid",
- "in": "path",
- "description": "Identifikator der Datei",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- }
- }
- }
- },
- "/Filestorage/v1/{guid}/ExpirationDate": {
- "put": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Setzt das Verfallsdatum",
- "description": "Diese Operation bezieht sich auf den OD-Filestorage (ODFS) und funktioniert auch, wenn die Datei noch in der Quarantäne ist. Nach erfolgreichem Aufruf dieser Operation befindet sich die Datei immer im ODFS; sie wird ggf. dort hin verlagert.",
- "parameters": [
- {
- "name": "guid",
- "in": "path",
- "description": "Identifikator der Datei",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- },
- {
- "name": "additionalContext",
- "in": "query",
- "description": "Zusätzlicher Kontext - Bildet zusammen mit der Anmeldung den Berechtigungskontext.",
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "description": "Verfallsdatum der Datei",
- "content": {
- "application/json-patch+json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- },
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- },
- "text/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request<br />Die Datei ist von einem Virus befallen.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable<br />Die Virenprüfung läuft noch.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- }
- }
- }
- }
- },
- "get": {
- "tags": [
- "Filestorage"
- ],
- "summary": "Liefert das Verfallsdatum",
- "description": "Diese Operation bezieht sich auf den OD-Filestorage (ODFS) und funktioniert auch, wenn die Datei noch in der Quarantäne ist. Nach erfolgreichem Aufruf dieser Operation befindet sich die Datei immer im ODFS; sie wird ggf. dort hin verlagert.",
- "parameters": [
- {
- "name": "guid",
- "in": "path",
- "description": "Identifikator der Datei",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- },
- {
- "name": "additionalContext",
- "in": "query",
- "description": "Zusätzlicher Kontext - Bildet zusammen mit der Anmeldung den Berechtigungskontext.",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_ExpirationDateDto"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request<br />Die Datei ist von einem Virus befallen.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable<br />Die Virenprüfung läuft noch.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Die Virenprüfung läuft noch."}
- }
- }
- }
- }
- }
- },
- "/Mailbox/v1/Read/UnreadMessages/Count/{mailboxType}": {
- "get": {
- "tags": [
- "Mailbox"
- ],
- "summary": "Liefert die Anzahl der ungelesenen Nachrichten einer Mailbox des eingeloggten Users.",
- "parameters": [
- {
- "name": "mailboxType",
- "in": "path",
- "description": "Die Art der Mailbox",
- "required": true,
- "schema": {
- "$ref": "#/components/schemas/V1_MailboxType"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"unreadMessages":"3","meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"unreadMessages":"3","meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"unreadMessages":"3","meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- }
- },
- "/Mailbox/v1/Read/Messages/{mailboxType}": {
- "get": {
- "tags": [
- "Mailbox"
- ],
- "summary": "Liefert eine Liste der Nachrichtenheader einer Mailbox des eingeloggten Users.",
- "parameters": [
- {
- "name": "mailboxType",
- "in": "path",
- "description": "Die Art der Mailbox",
- "required": true,
- "schema": {
- "$ref": "#/components/schemas/V1_MailboxType"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"mails":[{"mailHeader":{"replyAction":"ReplyForbidden","sender":null,"recipient":null,"processDate":"2023-07-10T14:11:17.8095333+02:00","statedDate":"2023-07-10T14:11:16.8095333+02:00","subject":"My First Mail","sequenceNumber":null,"isRead":true,"isObligatory":true,"countConversation":0,"hasAttachments":false,"isReply":false,"eidas":"Substantial","isAuthorized":true,"references":[],"guid":"9efdc6b3-e90d-4054-b0ca-3ef9634e9095"},"linkToBody":null},{"mailHeader":{"replyAction":"ReplyForbidden","sender":null,"recipient":null,"processDate":"2023-07-10T15:11:17.8095333+02:00","statedDate":"2023-07-10T15:11:16.8095333+02:00","subject":"My Second Mail","sequenceNumber":null,"isRead":true,"isObligatory":true,"countConversation":0,"hasAttachments":false,"isReply":false,"eidas":"Substantial","isAuthorized":true,"references":[],"guid":"5f12aee3-d35b-4d94-855c-53bdcc704fd0"},"linkToBody":null}],"meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"mails":[{"mailHeader":{"replyAction":"ReplyForbidden","sender":null,"recipient":null,"processDate":"2023-07-10T14:11:17.8095333+02:00","statedDate":"2023-07-10T14:11:16.8095333+02:00","subject":"My First Mail","sequenceNumber":null,"isRead":true,"isObligatory":true,"countConversation":0,"hasAttachments":false,"isReply":false,"eidas":"Substantial","isAuthorized":true,"references":[],"guid":"9efdc6b3-e90d-4054-b0ca-3ef9634e9095"},"linkToBody":null},{"mailHeader":{"replyAction":"ReplyForbidden","sender":null,"recipient":null,"processDate":"2023-07-10T15:11:17.8095333+02:00","statedDate":"2023-07-10T15:11:16.8095333+02:00","subject":"My Second Mail","sequenceNumber":null,"isRead":true,"isObligatory":true,"countConversation":0,"hasAttachments":false,"isReply":false,"eidas":"Substantial","isAuthorized":true,"references":[],"guid":"5f12aee3-d35b-4d94-855c-53bdcc704fd0"},"linkToBody":null}],"meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"mails":[{"mailHeader":{"replyAction":"ReplyForbidden","sender":null,"recipient":null,"processDate":"2023-07-10T14:11:17.8095333+02:00","statedDate":"2023-07-10T14:11:16.8095333+02:00","subject":"My First Mail","sequenceNumber":null,"isRead":true,"isObligatory":true,"countConversation":0,"hasAttachments":false,"isReply":false,"eidas":"Substantial","isAuthorized":true,"references":[],"guid":"9efdc6b3-e90d-4054-b0ca-3ef9634e9095"},"linkToBody":null},{"mailHeader":{"replyAction":"ReplyForbidden","sender":null,"recipient":null,"processDate":"2023-07-10T15:11:17.8095333+02:00","statedDate":"2023-07-10T15:11:16.8095333+02:00","subject":"My Second Mail","sequenceNumber":null,"isRead":true,"isObligatory":true,"countConversation":0,"hasAttachments":false,"isReply":false,"eidas":"Substantial","isAuthorized":true,"references":[],"guid":"5f12aee3-d35b-4d94-855c-53bdcc704fd0"},"linkToBody":null}],"meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- }
- },
- "/MailboxDirectory/v1/Lookup": {
- "post": {
- "tags": [
- "MailboxDirectory"
- ],
- "summary": "Liefert eine Liste der zu NameIdentifiern gehörenden OSI-Postfächer (Personal)",
- "requestBody": {
- "description": "Liste der angefragten NameIdentifier",
- "content": {
- "application/json-patch+json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "text/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "uuid"
- }
- }
- },
- "application/*+json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "uuid"
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxDirectoryResponse"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxDirectoryResponse"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxDirectoryResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Send/{mailboxId}": {
- "post": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Sendet eine Nachricht an ein externes oder internes Postfach.",
- "description": "Wenn die Nachricht Anlagen enthalten soll, müssen diese zuvor mit `/Quarantine/v1/Upload` hochgeladen und virengeprüft worden sein.",
- "parameters": [
- {
- "name": "mailboxId",
- "in": "path",
- "description": "GUID des lokalen OSI-Postfachs oder Postfachreferenz, an die die Nachricht zugestellt werden soll.\r\n <i>Hinweis:</i> Im Swagger muss das Zeichen `'/'` durch `'|'` ersetzt werden.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "de-b1||24b91411-34e0-4ad2-aedb-ef9726cfe8aa"
- }
- ],
- "requestBody": {
- "description": "Daten der zu sendenden Nachricht.",
- "content": {
- "application/json-patch+json": {
- "schema": {
- "$ref": "#/components/schemas/Out_SendMessageRequestV2"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Out_SendMessageRequestV2"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Out_SendMessageRequestV2"
- }
- },
- "application/*+json": {
- "schema": {
- "$ref": "#/components/schemas/Out_SendMessageRequestV2"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_SendMessageResponse"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_SendMessageResponse"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_SendMessageResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Das Postfach ist unbekannt.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Postfach mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Postfach mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Postfach mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Receive/{messageId}/Attachment/{attachmentId}": {
- "get": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Liefert den Inhalt eines hochgeladenen Attachments im Kontext einer übergebenen MessageId und einer AttachmentId",
- "parameters": [
- {
- "name": "messageId",
- "in": "path",
- "description": "Identifikator der Nachricht",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "4B7588ED-65C9-4877-9526-B19C20116E99"
- },
- {
- "name": "attachmentId",
- "in": "path",
- "description": "Identifikator der Datei des Nachrichtenanhangs",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/octet-stream": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Der Nachrichtenanhang ist unbekannt.",
- "content": {
- "application/octet-stream": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Nachrichtenanhang mit dem angegebenen Identifikatoren (GUIDs) wurde nicht gefunden."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Receive/{messageId}": {
- "get": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Liefert den Inhalt einer Antwortnachricht.",
- "parameters": [
- {
- "name": "messageId",
- "in": "path",
- "description": "Identifikator der Nachricht",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "4B7588ED-65C9-4877-9526-B19C20116E99"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/V1_ReplyMessage"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/V1_ReplyMessage"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/V1_ReplyMessage"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Die Nachricht ist unbekannt.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Receive": {
- "get": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Liefert eine Liste von Antwortnachrichten inklusive der Anhänge.",
- "description": "Beispiele für eine Liste mit 10 Einträgen:\r\n<ul><li>`take=4&skip=0`\r\n <ul><li>4 Einträge/Seite</li><li>nichts überspringen</li><li>⇒ der erste, zweite, dritte und vierte Eintrag werden geliefert</li></ul></li><li>`take= 4&skip=1`\r\n <ul><li>4 Einträge/Seite</li><li>1 Seite = 4 Einträge überspringen</li><li>⇒ der fünfte, sechste, siebte und achte Eintrag werden geliefert</li></ul></li><li>`take=4&skip=2`\r\n <ul><li>4 Einträge/Seite</li><li>2 Seiten = 2*4 Einträge überspringen</li><li>⇒ der neunte und zehnte Eintrag wird geliefert (den 11. und 12. Eintrag gibt es in der Liste nicht)</li></ul></li></ul>",
- "parameters": [
- {
- "name": "take",
- "in": "query",
- "description": "Anzahl der Einträge pro Seite.",
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "skip",
- "in": "query",
- "description": "Anzahl der Seiten á `take` Einträge, die übersprungen werden sollen.",
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_ReceiveMessagesResponse"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_ReceiveMessagesResponse"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_ReceiveMessagesResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Delete/{messageId}": {
- "delete": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Löscht eine Nachricht.",
- "parameters": [
- {
- "name": "messageId",
- "in": "path",
- "description": "Identifikator der Nachricht",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "4B7588ED-65C9-4877-9526-B19C20116E99"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_DeleteMessageResponse"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_DeleteMessageResponse"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_DeleteMessageResponse"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Die Nachricht ist unbekannt.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Send/MessageWithAttachments/{mailboxId}": {
- "post": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Sendet eine Nachricht incl. Dateiupload an ein externes oder internes Postfach.",
- "description": "Senden einer Nachricht mit Attachments an ein externes oder internes Postfach. Die Anhänge werden direkt mitgegeben, die Schnittstelle kümmert sich intern um das Handling der Dateien. Der Request ist ähnlich zum \"normalen\" Send, nur mit direktem Datei-Upload.",
- "parameters": [
- {
- "name": "mailboxId",
- "in": "path",
- "description": "GUID des lokalen OSI-Postfachs oder Postfachreferenz, an die die Nachricht zugestellt werden soll.\r\n <i>Hinweis:</i> Im Swagger muss das Zeichen `'/'` durch `'|'` ersetzt werden.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "de-b1||24b91411-34e0-4ad2-aedb-ef9726cfe8aa"
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "sendRequest": {
- "$ref": "#/components/schemas/V1_SendMessageWithAttachmentsRequest"
- },
- "fileList": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "binary"
- },
- "description": "Liste der als Anhänge zu sendenden Dateien."
- }
- }
- },
- "example": "24b91411-34e0-4ad2-aedb-ef9726cfe8aa",
- "encoding": {
- "Body": {
- "style": "form"
- },
- "Subject": {
- "style": "form"
- },
- "EidasLevel": {
- "style": "form"
- },
- "IsHtml": {
- "style": "form"
- },
- "IsObligatory": {
- "style": "form"
- },
- "SequenceNumber": {
- "style": "form"
- },
- "ReplyAction": {
- "style": "form"
- },
- "DisplayName": {
- "style": "form"
- },
- "OriginSender": {
- "style": "form"
- },
- "References": {
- "style": "form"
- },
- "fileList": {
- "style": "form"
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"unreadMessages":"3","meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"unreadMessages":"3","meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Responses_MailboxResponse"
- },
- "example": {"unreadMessages":"3","meta":{"correlationId":"b7cba351-5710-417e-9057-ede1e81222ae","serviceCode":"postfachapi","serviceDescription":"postfach api (Appserver solution)"}}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "404": {
- "description": "Not Found<br />Das Postfach ist unbekannt.",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Postfach mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Postfach mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Ein Postfach mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/Status/{messageId}": {
- "get": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Liefert den Status einer versendeten Nachricht.",
- "description": "Es wird der Status innerhalb von OSI und ggf. auch im externen Nachrichtensystem (z.B. MUK) abgefragt.",
- "parameters": [
- {
- "name": "messageId",
- "in": "path",
- "description": "Identifikator der Nachricht.<br />Muss zuvor als Ergebnis des Sendeauftrags der zu überprüfenden Nachricht, z.B. von `POST MessageExchange/v1/Send/{mailboxId}`, zurückgegeben worden sein.",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "588FE793-AD80-4A2D-8BD8-0C33F92D69DF"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/MessageExchange_MessageStatusInquiryResponse"
- },
- "example": {"messageId":"b7cba351-5710-417e-9057-ede1e81222ae","responseStatus":"Accepted","responseSubStatus":"EtrVersendet","responseMessage":"accountId: Bitte geben Sie einen gültigen Empfänger (Benutzerkonto‑ID) an.","target":"MukEp2","responseTime":"2023-07-10T12:09:17.8095333+02:00","retryCounter":0,"timeOfMessageRetrieval":"2023-07-11T14:11:17.8095333+02:00"}
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found","title":"Not Found","status":404,"detail":"Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde nicht gefunden."}
- }
- }
- }
- }
- }
- },
- "/MessageExchange/v1/GetBundIdPostkorbHandle/{mailboxId}": {
- "get": {
- "tags": [
- "MessageExchange"
- ],
- "summary": "Liefert das Postkorbhandle für einen BundId-Postkorb",
- "description": "Bezeichnet die übergebene mailboxId keinen BundId-Postkorb, so wird ein leerer String zurück gegeben.",
- "parameters": [
- {
- "name": "mailboxId",
- "in": "path",
- "description": "Postfachreferenz. <i>Hinweis:</i> Im Swagger muss das Zeichen `'/'` durch `'|'` ersetzt werden.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "de-b1||24b91411-34e0-4ad2-aedb-ef9726cfe8aa"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "string"
- },
- "example": "24b91411-34e0-4ad2-aedb-ef9726cfe8aa"
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- }
- },
- "/_startup": {
- "get": {
- "tags": [
- "Probe"
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "451": {
- "description": "Unavailable For Legal Reasons"
- }
- }
- }
- },
- "/_ready": {
- "get": {
- "tags": [
- "Probe"
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "424": {
- "description": "Failed Dependency"
- }
- }
- }
- },
- "/_alive": {
- "get": {
- "tags": [
- "Probe"
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "500": {
- "description": "Internal Server Error"
- }
- }
- }
- },
- "/_metrics": {
- "get": {
- "tags": [
- "Probe"
- ],
- "responses": {
- "200": {
- "description": "OK"
- }
- }
- }
- },
- "/Quarantine/v1/Upload/{guid}": {
- "get": {
- "tags": [
- "Quarantine"
- ],
- "summary": "Liefert den Status der Virenprüfung.",
- "parameters": [
- {
- "name": "guid",
- "in": "path",
- "description": "Identifikator der Datei",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Quarantine_Status"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Quarantine_Status"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Quarantine_Status"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- },
- "delete": {
- "tags": [
- "Quarantine"
- ],
- "summary": "Markiert die Datei zum Löschen",
- "description": "Eine zum Löschen markierte Datei wird binnen 10 Minuten gelöscht.<br />\r\nExistiert die Datei nicht (mehr), wird auch `Status 200 OK` zurück gegeben.",
- "parameters": [
- {
- "name": "guid",
- "in": "path",
- "description": "Identifikator der Datei",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid"
- },
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- }
- }
- }
- },
- "/Quarantine/v1/Upload/Chunked": {
- "post": {
- "tags": [
- "Quarantine"
- ],
- "summary": "Lädt ein Dateistück in die Quarantäne hoch",
- "description": "<br>Die Dateistücke (Chunks) werden nacheinander hochgeladen. Zum Abschluss (`chunkIndex = totalChunks`) muss ein Aufruf mit leerem `file` gesendet werden.\r\n<br>Es gibt keine konkrete Vorgabe, wie groß ein Chunk sein darf. Zu große Chunks können zu Timeouts führen.\r\n<br>Mit dem Upload wird die Datei der Virenprüfung zugeführt. Nach Abschluss der erfolgreichen Virenprüfung steht die Datei im Quarantäne-Filestorage (QFS) zur Verfügung.",
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "metadata": {
- "$ref": "#/components/schemas/Domain_ChunkMetaData"
- },
- "tenant": {
- "type": "string",
- "description": "OSI-Mandant (Landesmandant oder GO)",
- "example": "hh"
- },
- "nameIdentifier": {
- "type": "string",
- "description": "Name Identifier"
- },
- "file": {
- "type": "string",
- "description": "Inhalt des Dateistücks",
- "format": "binary"
- }
- }
- },
- "example": "24b91411-34e0-4ad2-aedb-ef9726cfe8aa",
- "encoding": {
- "UploadUid": {
- "style": "form"
- },
- "FileName": {
- "style": "form"
- },
- "ContentType": {
- "style": "form"
- },
- "ChunkIndex": {
- "style": "form"
- },
- "TotalChunks": {
- "style": "form"
- },
- "TotalFileSize": {
- "style": "form"
- },
- "Target": {
- "style": "form"
- },
- "tenant": {
- "style": "form"
- },
- "nameIdentifier": {
- "style": "form"
- },
- "file": {
- "style": "form"
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Quarantine_FileResult"
- }
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Quarantine_FileResult"
- }
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Quarantine_FileResult"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request","title":"Bad Request","status":400,"detail":"Feld 'Xyz' darf nicht leer sein."}
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized","title":"Unauthorized","status":401,"detail":"Die eingegebenen Zugangsdaten sind nicht ausreichend."}
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Mvc_ProblemDetails"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden","title":"Forbidden","status":403,"detail":"Der Zugang ist nicht erlaubt."}
- }
- }
- },
- "429": {
- "description": "Too Many Requests",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc6585#section-4","title":"Too Many Requests","status":429,"detail":"Es wurden zu häufig Requests eingereicht."}
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error","title":"Internal Server Error","status":500,"detail":"Es ist ein interner Serverfehler aufgetreten."}
- }
- }
- },
- "503": {
- "description": "Service Unavailable",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable","title":"Service Unavailable","status":503,"detail":"Der Dienst ist zurzeit nicht verfügbar."}
- }
- }
- },
- "409": {
- "description": "Conflict",
- "content": {
- "text/plain": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict","title":"Conflict","status":409,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) existiert bereits."}
- },
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict","title":"Conflict","status":409,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) existiert bereits."}
- },
- "text/json": {
- "schema": {
- "$ref": "#/components/schemas/Contract_FailInfo"
- },
- "example": {"type":"https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict","title":"Conflict","status":409,"detail":"Eine Datei mit dem angegebenen Identifikator (GUID) existiert bereits."}
- }
- }
- }
- }
- }
- }
- },
- "components": {
- "schemas": {
- "Contract_FailInfo": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "Ein URI-Verweis [RFC3986], der den Problemtyp identifiziert. Er sollte ggf. auf eine menschenlesbare Dokumentation\r\ndes Problemtyps verweisen (z. B. unter Verwendung von HTML [W3C.REC-html5-20141028]).\r\nWenn dieses Element nicht vorhanden ist, wird der Wert als \"about:blank\" angenommen.",
- "nullable": true,
- "example": "https://tools.ietf.org/html/rfc7231#section-6.5.1"
- },
- "title": {
- "type": "string",
- "description": "Eine kurze, menschenlesbare Zusammenfassung des Problemtyps.\r\nEs SOLLTE SICH NICHT von Auftreten zu Auftreten des Problems ändern,\r\naußer zu Lokalisierungszwecken (z. B. mithilfe proaktiver Inhaltsaushandlung; siehe[RFC7231], Abschnitt 3.4).",
- "nullable": true,
- "example": "Bad Request"
- },
- "status": {
- "type": "integer",
- "description": "Der HTTP-Statuscode([RFC7231], Abschnitt 6), der vom Ursprungsserver für dieses Auftreten des Problems generiert wurde.",
- "format": "int32",
- "example": 400
- },
- "detail": {
- "type": "string",
- "description": "Eine menschenlesbare Erklärung, die für dieses Auftreten des Problems spezifisch ist.<br/><br/>\n Enthält auch Angaben über Exceptions\n ",
- "nullable": true,
- "example": "Die Datei ist von einem Virus befallen."
- },
- "instance": {
- "type": "string",
- "description": "Ein URI-Verweis, der das spezifische Auftreten des Problems identifiziert. Er kann auf weitere Informationen verweisen.",
- "nullable": true,
- "example": null
- },
- "synopsis": {
- "type": "string",
- "description": "Zusammenfassung",
- "nullable": true,
- "deprecated": true
- },
- "code": {
- "type": "integer",
- "description": "Status-Code",
- "format": "int32",
- "deprecated": true
- },
- "details": {
- "type": "string",
- "description": "Merkmale",
- "nullable": true,
- "deprecated": true
- },
- "typeName": {
- "type": "string",
- "description": "Typname der Exception",
- "nullable": true,
- "deprecated": true
- },
- "innerTypeName": {
- "type": "string",
- "description": "Typname der inneren Exception",
- "nullable": true,
- "deprecated": true
- },
- "id": {
- "type": "string",
- "description": "Relevnz Id",
- "nullable": true,
- "deprecated": true
- }
- },
- "additionalProperties": false,
- "description": "Fehlerinformationen<br/><br/>\n Ursprünglich wurde die `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo`-Klasse verwendet, um im Fehlerfall zusätzliche Informationen zu übermitteln.\n Außerdem wurde diese Klasse auch verwendet, um sie mithilfe von `WebApiStartup.UseApiFailCustomization` beim Auftreten bestimmter Exceptions richtig zu befüllen.\n \n Seit ASP.NET Core 2.1 ist für Response-Objekte im Fehlerfall die Klasse `Microsoft.AspNetCore.Mvc.ProblemDetails` vorgesehen und sollte auch hierzu verwendet werden. Wenn man das für bestehende Endpunkte macht, bricht dies den Kontrakt und die Schnittstelle muss versioniert werden. Möchte man einen solchen Bruch vermeiden, kann man in der Übergangszeit bis zur neuen Kontraktversion diese Klasse weiter für das Response-Objekt verwenden.Für dieses Szenario wurde diese Klasse um die Properties von `Microsoft.AspNetCore.Mvc.ProblemDetails` erweitert, sodass der Client-Code bereits die neuen Felder verwenden kann. Bis auf `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Detail`/`Dataport.OSP.Postfach.Common.Utility.Contract.StatusInfo.Details` sind die ProblemDetails-Properties Aliase ihrer Legacy-Pendants, d.h. man kann z.B. in `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Title` einen Wert speichern und diesen sowohl in `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Title` als auch in `Dataport.OSP.Postfach.Common.Utility.Contract.StatusInfo.Synopsis` wieder auslesen. Die neue Property `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Detail` gibt allerdings ggf. neben dem Wert `Dataport.OSP.Postfach.Common.Utility.Contract.StatusInfo.Details` auch die Werte `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.TypeName` und `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.InnerTypeName` der Legacy-Schnittstelle wieder. Das Setzen von Fehlerinformationen auf der Grundlage einer Exception sollte daher über die Methode `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.SetException(System.Exception)` erfolgen. Die komplette Zukunfts-Schnittstelle wird durch `Dataport.OSP.Postfach.Common.Utility.Contract.Interface.IFailInfo` beschrieben.",
- "example": {
- "Type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
- "Title": "Bad Request",
- "Status": 400,
- "Detail": "Der Betreff darf nicht leer sein."
- }
- },
- "DTO_MailboxScopeData": {
- "type": "object",
- "properties": {
- "membershipcontext": {
- "type": "string",
- "description": "Zugehörigkeitskontext zu Person oder zu Gruppe",
- "format": "uuid"
- },
- "memberscope": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Mddi_MailboxIndexData"
- },
- "description": "Mitglider der Gruppe",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Postfach-Umfang Contract"
- },
- "Domain_ChunkMetaData": {
- "type": "object",
- "properties": {
- "uploadUid": {
- "type": "string",
- "description": "Identifikator der Datei<br/><br/>\n Dieser Identifikator ist vom Aufrufer für den Upload neu zu erstellen (`Guid.NewGuid`).\n ",
- "format": "uuid"
- },
- "fileName": {
- "type": "string",
- "description": "Name der Datei",
- "nullable": true,
- "example": "hello.txt"
- },
- "contentType": {
- "type": "string",
- "description": "MIME-Type der Datei",
- "nullable": true,
- "example": "text/plain"
- },
- "chunkIndex": {
- "type": "integer",
- "description": "0-basierter Index des Chunks",
- "format": "int32"
- },
- "totalChunks": {
- "type": "integer",
- "description": "Gesamtzahl der Chunks",
- "format": "int32",
- "example": 1
- },
- "totalFileSize": {
- "type": "integer",
- "description": "Dateigröße in Bytes",
- "format": "int64",
- "example": 12
- },
- "target": {
- "$ref": "#/components/schemas/V1_FilestorageTarget"
- }
- },
- "additionalProperties": false,
- "description": "Metadaten für den Chunk-Upload (`Domain_ChunkMetaData` im Swagger-Schema)"
- },
- "Mddi_MailboxIndexData": {
- "type": "object",
- "properties": {
- "tenant": {
- "type": "string",
- "description": "Postfach-Guid",
- "nullable": true
- },
- "mailboxguid": {
- "type": "string",
- "description": "Postfach-Guid",
- "format": "uuid"
- },
- "mailboxname": {
- "type": "string",
- "description": "Postfach-Guid",
- "nullable": true
- },
- "mailboxdescription": {
- "type": "string",
- "description": "Postfach-Bescreibung",
- "nullable": true
- },
- "mailboxtype": {
- "$ref": "#/components/schemas/Mddi_MailboxType"
- }
- },
- "additionalProperties": false
- },
- "Mddi_MailboxType": {
- "enum": [
- "Unknown",
- "Personal",
- "Functional"
- ],
- "type": "string",
- "description": "Typ des Postfachs</p><table><tr><td>Unknown</td><td>Unbekannt (Defaultwert, der niemals erreicht werden darf)</td></tr> <tr><td>Personal</td><td>Persönliches Postfach</td></tr> <tr><td>Functional</td><td>Funktionspostfach</td></tr> </table><p>"
- },
- "MessageExchange_DeleteMessageResponse": {
- "type": "object",
- "properties": {
- "messageId": {
- "type": "string",
- "description": "Id der Nachricht, die gelöscht werden soll",
- "format": "uuid"
- }
- },
- "additionalProperties": false,
- "description": "Antwort auf den Löschvorgang einer Nachricht"
- },
- "MessageExchange_Files": {
- "type": "object",
- "properties": {
- "guid": {
- "type": "string",
- "description": "Identifikator der Datei",
- "format": "uuid",
- "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
- },
- "name": {
- "type": "string",
- "description": "Name der Datei",
- "nullable": true,
- "example": "hello.txt"
- },
- "mimeType": {
- "type": "string",
- "description": "MIME-Type der Datei",
- "nullable": true,
- "example": "text/plain"
- },
- "isOriginalMessage": {
- "type": "boolean",
- "description": "Beinhaltet die Datei Original Nachrichtenelemente?"
- },
- "size": {
- "type": "integer",
- "description": "Größe der Datei in Bytes",
- "format": "int64",
- "example": 12
- }
- },
- "additionalProperties": false,
- "description": "Daten zu einem Dateianhang"
- },
- "MessageExchange_MessageStatusInquiryResponse": {
- "type": "object",
- "properties": {
- "messageId": {
- "type": "string",
- "description": "Identifikator der Nachricht in OSI",
- "format": "uuid"
- },
- "responseStatus": {
- "$ref": "#/components/schemas/MessageExchange_ResponseStatusEnum"
- },
- "responseSubStatus": {
- "$ref": "#/components/schemas/MessageExchange_ResponseSubStatusEnum"
- },
- "responseMessage": {
- "type": "string",
- "description": "Rückmeldung des Systems, das den Status produziert hat (z.B. Validierungsfehler von einem externen System wie MUK)",
- "nullable": true
- },
- "target": {
- "$ref": "#/components/schemas/MessageExchange_MessageType"
- },
- "responseTime": {
- "type": "string",
- "description": "Zeitpunkt der Erhebung des Status",
- "format": "date-time",
- "nullable": true
- },
- "retryCounter": {
- "type": "integer",
- "description": "Wie oft dieser Status für die Nachricht vorher schon abgefragt wurde",
- "format": "int32"
- },
- "timeOfMessageRetrieval": {
- "type": "string",
- "description": "Zeitpunkt (Datum und Uhrzeit) des Dokumentenabrufs durch den Empfänger, sofern bereits abgerufen und bekannt ist",
- "format": "date-time",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Antwort einer Statusabfrage"
- },
- "MessageExchange_MessageType": {
- "enum": [
- "Unknown",
- "Internal",
- "InterOp",
- "BundIdPok",
- "MukEp2"
- ],
- "type": "string",
- "description": "Message Typ</p><table><tr><td>Unknown</td><td>Unbekannt</td></tr> <tr><td>Internal</td><td>OSI-Postfach im eigenen Mandanten</td></tr> <tr><td>InterOp</td><td>OSI-Postfach im fremden Mandanten</td></tr> <tr><td>BundIdPok</td><td>Bund ID Postkorb</td></tr> <tr><td>MukEp2</td><td>MUK Elster-Postfach 2.0</td></tr> </table><p>"
- },
- "MessageExchange_ReceiveAttachment": {
- "type": "object",
- "properties": {
- "guid": {
- "type": "string",
- "description": "Guid des Anhangs",
- "format": "uuid"
- }
- },
- "additionalProperties": false,
- "description": "Anhänge (erhalten)"
- },
- "MessageExchange_ReceiveMessage": {
- "type": "object",
- "properties": {
- "guid": {
- "type": "string",
- "format": "uuid"
- },
- "attachments": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MessageExchange_ReceiveAttachment"
- },
- "description": "Anhänge",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "ReceiveMessage"
- },
- "MessageExchange_ReceiveMessagesResponse": {
- "type": "object",
- "properties": {
- "messages": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MessageExchange_ReceiveMessage"
- },
- "description": "Liste mit Nachrichten",
- "nullable": true
- },
- "message": {
- "type": "string",
- "description": "Nachricht",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "ReceiveMessages Antwort (Kontext: OD fragt Nachrichten ab)"
- },
- "MessageExchange_ResponseStatus": {
- "enum": [
- "Ok",
- "Authentication",
- "Internal",
- "Request"
- ],
- "type": "string",
- "description": "MessageStatus der Antwort</p><table><tr><td>Ok</td><td>Die Nachricht wurde gesendet.</td></tr> <tr><td>Authentication</td><td>Es ist ein Authentifizierungsfehler aufgetreten.</td></tr> <tr><td>Internal</td><td>Es ist ein interner Fehler aufgetreten.</td></tr> <tr><td>Request</td><td>Es ist ein Request-Fehler aufgetreten.</td></tr> </table><p>"
- },
- "MessageExchange_ResponseStatusEnum": {
- "enum": [
- "Unknown",
- "Scheduled",
- "Accepted",
- "NotAccepted",
- "Confirmed",
- "NotConfirmed",
- "Displayed",
- "Read",
- "Deleted"
- ],
- "type": "string",
- "description": "Hauptstatus der Postfach-Nachricht<br/><br/>\n Eine Postfach-Nachricht durchläuft folgende Stufen:\n \n |Stufe |Erklärung |\n |---------------|-------------------------------------------------------------------------------------------------|\n |Einlieferung |Durch den Send-Befehl wird die Nachricht bei OSI eingeliefert. |\n |Zwischensystem |Im Falle der BundID wird die Nachricht zunächst an ein Zwischensystem (ETR) geschickt. |\n |Zielsystem |Die Nachricht wird an das Zielsystem (OSI, BundID, MUK) gesendet. |\n |Feedback |Einige Zielsysteme können Auskunft darüber geben, ob die Nachricht angezeigt oder gelesen wurde. |\n \n \n Jede Stufe hat zugehörige Statuswerte.\n </p><table><tr><td>Unknown</td><td>Unbekannt</td></tr> <tr><td>Scheduled</td><td>Bei OSI eingeliefert</td></tr> <tr><td>Accepted</td><td>In Zwischensystem übertragen</td></tr> <tr><td>NotAccepted</td><td>Übertragung ins Zwischensystem gescheitert</td></tr> <tr><td>Confirmed</td><td>In Zielsystem übertragen</td></tr> <tr><td>NotConfirmed</td><td>Übertragung ins Zielsystem gescheitert</td></tr> <tr><td>Displayed</td><td>Dem Empfänger angezeigt</td></tr> <tr><td>Read</td><td>Vom Empfänger gelesen</td></tr> <tr><td>Deleted</td><td>Gelöscht</td></tr> </table><p>"
- },
- "MessageExchange_ResponseSubStatusEnum": {
- "enum": [
- "InInternerVerarbeitung",
- "EtrNotAccepted",
- "EtrAccepted",
- "EtrInBearbeitung",
- "EtrUebertragungsfehler",
- "EtrVersendet",
- "EtrEingestellt",
- "MukDatenFehlerhaft",
- "EtrBereitZurAbholung",
- "MukVomEmpfaengerAbgeholt",
- "EtrEingangBestaetigt",
- "MukGeloescht",
- "MukInternalError",
- "EtrUnbekannt",
- "PokSent",
- "PokNotSent"
- ],
- "type": "string",
- "description": "Verarbeitungssubstatus der Postfach-Nachricht<br/><br/>\n Der genutzte Adapter (OSI, Bund ID, MUK...) kann hiermit Status-Details liefern.\n </p><table><tr><td>InInternerVerarbeitung</td><td>Nachricht wurde in Queue eingestellt, aber noch nicht an Etr oder BundId verschickt</td></tr> <tr><td>EtrNotAccepted</td><td>Konnte nicht zum ETR übertragen werden</td></tr> <tr><td>EtrAccepted</td><td>Zum ETR übertragen</td></tr> <tr><td>EtrInBearbeitung</td><td>ETR meldet: Initialer Status bei neu angelegten Aufträgen.</td></tr> <tr><td>EtrUebertragungsfehler</td><td>ETR meldet: Es ist ein technischer Fehler aufgetreten.</td></tr> <tr><td>EtrVersendet</td><td>ETR meldet: Die Nachricht wurde erfolgreich an ELSTER übermittelt. Ein Status wurde noch nicht erzeugt.</td></tr> <tr><td>EtrEingestellt</td><td>ETR meldet: Die Nachricht wurde eingestellt, die Benachrichtigung an den Empfänger wurde jedoch noch nicht zugestellt.</td></tr> <tr><td>MukDatenFehlerhaft</td><td>MUK meldet: Die Daten konnten aufgrund eines Fehlers nicht an den Empfänger bereitgestellt werden. Mögliche Gründe: Datei invalide, Dateiformat passt nicht zur Dateinamenerweiterung, Virenfund.</td></tr> <tr><td>EtrBereitZurAbholung</td><td>ETR meldet: Die Nachricht wurde an den Empfänger bereitgestellt. Die Benachrichtigung an den Empfänger ist erfolgt.</td></tr> <tr><td>MukVomEmpfaengerAbgeholt</td><td>MUK meldet: Die Nachricht wurde vom Empfänger abgeholt.</td></tr> <tr><td>EtrEingangBestaetigt</td><td>ETR meldet: Die Anwendung des Empfängers hat die Abholung bestätigt.</td></tr> <tr><td>MukGeloescht</td><td>MUK meldet: Die Nachricht wurde aus dem Postfach gelöscht.</td></tr> <tr><td>MukInternalError</td><td>MUK meldet: Es kam zu einem internen Fehler.</td></tr> <tr><td>EtrUnbekannt</td><td>ETR meldet: Die Bereitstellung konnte nicht im System gefunden werden.</td></tr> <tr><td>PokSent</td><td>BundID Postkorb meldet: Die Nachricht wurde erfolgreich an die Bund ID versendet.</td></tr> <tr><td>PokNotSent</td><td>BundID Postkorb meldet: Die Nachricht konnte nicht an die Bund ID versendet werden.</td></tr> </table><p>"
- },
- "MessageExchange_SendMessageResponse": {
- "type": "object",
- "properties": {
- "messageId": {
- "type": "string",
- "description": "Identifikator der Nachricht",
- "format": "uuid"
- },
- "message": {
- "type": "string",
- "description": "Fehlernachricht",
- "nullable": true
- },
- "status": {
- "$ref": "#/components/schemas/MessageExchange_ResponseStatus"
- }
- },
- "additionalProperties": false,
- "description": "Antwort auf die Sendeanforderung"
- },
- "Mvc_ProblemDetails": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "description": "Ein URI-Verweis [RFC3986], der den Problemtyp identifiziert. Er sollte ggf. auf eine menschenlesbare Dokumentation des Problemtyps verweisen (z. B. unter Verwendung von HTML [W3C.REC-html5-20141028]). Wenn dieses Element nicht vorhanden ist, wird der Wert als \"about:blank\" angenommen.",
- "nullable": true,
- "example": "https://tools.ietf.org/html/rfc7231#section-6.5.1"
- },
- "title": {
- "type": "string",
- "description": "Eine kurze, menschenlesbare Zusammenfassung des Problemtyps. Es SOLLTE SICH NICHT von Auftreten zu Auftreten des Problems ändern, außer zu Lokalisierungszwecken (z. B. mithilfe proaktiver Inhaltsaushandlung; siehe[RFC7231], Abschnitt 3.4).",
- "nullable": true,
- "example": "Bad Request"
- },
- "status": {
- "type": "integer",
- "description": "Der HTTP-Statuscode([RFC7231], Abschnitt 6), der vom Ursprungsserver für dieses Auftreten des Problems generiert wurde.",
- "format": "int32",
- "nullable": true,
- "example": 400
- },
- "detail": {
- "type": "string",
- "description": "Eine menschenlesbare Erklärung, die für dieses Auftreten des Problems spezifisch ist.",
- "nullable": true,
- "example": "Die Datei ist von einem Virus befallen."
- },
- "instance": {
- "type": "string",
- "description": "Ein URI-Verweis, der das spezifische Auftreten des Problems identifiziert. Er kann auf weitere Informationen verweisen.",
- "nullable": true,
- "example": null
- }
- },
- "additionalProperties": false,
- "description": "Ein maschinenlesbares Format zum Angeben von Fehlern in HTTP-API-Antworten basierend auf https://tools.ietf.org/html/rfc7807",
- "example": {
- "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
- "title": "Bad Request",
- "status": 400,
- "detail": "Der Betreff darf nicht leer sein."
- }
- },
- "Out_SendMessageRequestV2": {
- "type": "object",
- "properties": {
- "sequencenumber": {
- "type": "string",
- "description": "Die fachliche Vorgangsnummer.<br/><br/>\n Zu einem Vorgang kann es mehrere Nachrichten geben. (max. 256 Zeichen)\n ",
- "nullable": true
- },
- "subject": {
- "type": "string",
- "description": "Betreff der Nachricht<br/><br/>\n (max. 255 Zeichen)\n ",
- "nullable": true
- },
- "body": {
- "type": "string",
- "description": "Nachrichtentext<br/><br/>\n Dies ist entweder ein einfacher Text oder ein HTML-Text (s. Parameter `isHtml`).\n (max. 400000 Zeichen)\n ",
- "nullable": true
- },
- "displayName": {
- "type": "string",
- "description": "Anzeigename des Absenders",
- "nullable": true
- },
- "originSender": {
- "type": "string",
- "description": "Technischer Absender<br/><br/>\n Dies ist entweder eine Postfachreferenz oder die GUID eines lokalen OSI-Postfachs.\n ",
- "nullable": true
- },
- "replyAction": {
- "$ref": "#/components/schemas/V1_ReplyBehavior"
- },
- "eidasLevel": {
- "$ref": "#/components/schemas/V1_EidasLevel"
- },
- "isObligatory": {
- "type": "boolean",
- "description": "Ist die Nachricht rechtlich verbindlich?"
- },
- "isHtml": {
- "type": "boolean",
- "description": "Ist die Nachricht eine HTML-Nachricht?"
- },
- "files": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MessageExchange_Files"
- },
- "description": "Anhänge zur Nachricht<br/><br/>\n Die Anhänge müssen zuvor hochgeladen worden sein und dürfen nur in dieser Nachricht verwendet werden. (max. 100 Anhänge)\n ",
- "nullable": true
- },
- "references": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_References"
- },
- "description": "Referenzen zur Nachricht<br/><br/>\n (max. 100 Referenzen)\n ",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Daten der zu sendenden Nachricht"
- },
- "Postfach_Eidas": {
- "enum": [
- "Undefined",
- "Low",
- "Substantial",
- "High"
- ],
- "type": "string",
- "description": "Eidas</p><table><tr><td>Undefined</td><td>AuthNiveau Undefinded</td></tr> <tr><td>Low</td><td>AuthNiveau Low</td></tr> <tr><td>Substantial</td><td>AuthNiveau Substanziell</td></tr> <tr><td>High</td><td>AuthNiveau High</td></tr> </table><p>"
- },
- "Postfach_Mail": {
- "type": "object",
- "properties": {
- "mailHeader": {
- "$ref": "#/components/schemas/Postfach_MailHeader"
- },
- "linkToBody": {
- "type": "string",
- "description": "",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": ""
- },
- "Postfach_MailHeader": {
- "type": "object",
- "properties": {
- "replyAction": {
- "$ref": "#/components/schemas/Postfach_ReplyBehaviour"
- },
- "sender": {
- "type": "string",
- "description": "Anzeigename für den Absender einer Nachricht.",
- "nullable": true
- },
- "recipient": {
- "type": "string",
- "description": "Anzeigename für den Empfänger einer Nachricht",
- "nullable": true
- },
- "processDate": {
- "type": "string",
- "description": "Verarbeitungsdatum der Nachricht im System.<br/><br/>Wird auf NOW gesetzt, sobald die Nachricht eines Konsumenten der SOAP-Schnittstelle ins\n Postfach eingereicht oder aus der Warteschlange ausgelesen wird.",
- "format": "date-time"
- },
- "statedDate": {
- "type": "string",
- "description": "Vom Einreichenden angegebenes Datum. Kann von Konsumenten der SOAP-Schnittstelle gesetzt werden.",
- "format": "date-time",
- "nullable": true
- },
- "subject": {
- "type": "string",
- "description": "Betreff.",
- "nullable": true
- },
- "sequenceNumber": {
- "type": "string",
- "description": "Vorgangsnummer, zu der die Nachricht gehört.",
- "nullable": true
- },
- "isRead": {
- "type": "boolean",
- "description": "Zeigt an, ob die Nachricht bereits gelesen wurden."
- },
- "isObligatory": {
- "type": "boolean",
- "description": "Zeigt an, ob die Nachricht rechtsverbindlich ist."
- },
- "countConversation": {
- "type": "integer",
- "description": "Wieviele Nachrichten sind innerhalb des Vorgangs?",
- "format": "int32"
- },
- "hasAttachments": {
- "type": "boolean",
- "description": "Zeigt an, ob zu der Vorgangsnummer vorherige Nachrichten existieren."
- },
- "isReply": {
- "type": "boolean",
- "description": "Zeigt an, ob zu der Vorgangsnummer vorherige Nachrichten existieren."
- },
- "eidas": {
- "$ref": "#/components/schemas/Postfach_Eidas"
- },
- "isAuthorized": {
- "type": "boolean",
- "description": "Reicht das Auth Niveau des User aus, um die Nachricht zu lesen"
- },
- "references": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Postfach_Reference"
- },
- "description": "Liste der Deeplink Referenzen",
- "nullable": true
- },
- "guid": {
- "type": "string",
- "description": "",
- "format": "uuid"
- }
- },
- "additionalProperties": false,
- "description": "DTO für Nachrichten-Header (also ohne Body und Historie)."
- },
- "Postfach_Reference": {
- "type": "object",
- "properties": {
- "referenceUrl": {
- "type": "string",
- "description": "Url des Deeplinks",
- "nullable": true
- },
- "referenceText": {
- "type": "string",
- "description": "Text des Deeplinks",
- "nullable": true
- },
- "referenceSeverity": {
- "$ref": "#/components/schemas/Postfach_SeverityType"
- },
- "referenceTitle": {
- "type": "string",
- "description": "Titel der Reference",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Dtoklasse für Deeplinks"
- },
- "Postfach_ReplyBehaviour": {
- "enum": [
- "ReplyPossible",
- "ReplyRequired",
- "ReplyForbidden"
- ],
- "type": "string",
- "description": "Art der Antwortmöglichkeit.</p><table><tr><td>ReplyPossible</td><td>Antwort erlaubt.</td></tr> <tr><td>ReplyRequired</td><td>Antwort erforderlich.</td></tr> <tr><td>ReplyForbidden</td><td>Antwort verboten.</td></tr> </table><p>"
- },
- "Postfach_SeverityType": {
- "enum": [
- "Low",
- "Medium",
- "High"
- ],
- "type": "string",
- "description": "Bestimmt den Grad der Severity</p><table><tr><td>Low</td><td>Grün Meldung</td></tr> <tr><td>Medium</td><td>Gelbe Meldung</td></tr> <tr><td>High</td><td>Rote Meldung</td></tr> </table><p>"
- },
- "Quarantine_FileResult": {
- "type": "object",
- "properties": {
- "uploaded": {
- "type": "boolean",
- "description": "uploaded"
- },
- "fileUid": {
- "type": "string",
- "description": "fileUid",
- "nullable": true
- },
- "success": {
- "type": "boolean",
- "description": "success"
- },
- "error": {
- "type": "string",
- "description": "error",
- "nullable": true
- }
- },
- "additionalProperties": false
- },
- "Quarantine_Status": {
- "enum": [
- "None",
- "Legacy",
- "Safe",
- "Unsafe",
- "Commited",
- "Corrupt",
- "Missing"
- ],
- "type": "string",
- "description": "Status der Virenprüfung</p><table><tr><td>None</td><td>None</td></tr> <tr><td>Legacy</td><td>Noch nicht geprüft</td></tr> <tr><td>Safe</td><td>Sicher</td></tr> <tr><td>Unsafe</td><td>Unsicher</td></tr> <tr><td>Commited</td><td>Commited</td></tr> <tr><td>Corrupt</td><td>Beschädigt</td></tr> <tr><td>Missing</td><td>Nicht vorhanden</td></tr> </table><p>"
- },
- "Responses_CheckUploadResponse": {
- "type": "object",
- "properties": {
- "fileName": {
- "type": "string",
- "description": "Name der Datei",
- "nullable": true
- },
- "contentType": {
- "type": "string",
- "description": "MIME-Type der Datei",
- "nullable": true
- },
- "fileSize": {
- "type": "integer",
- "description": "Größe der Datei",
- "format": "int64"
- },
- "storages": {
- "$ref": "#/components/schemas/Responses_Storages"
- }
- },
- "additionalProperties": false,
- "description": "Response-Objekt für den CheckUpload-Aufruf<br/><br/>\n `filename`, `contentType` und `fileSize` werden nur angegeben, wenn die Datei noch im Upload-Bereich ist (bis zu 2 Stunden nach Upload). Die Datei kann aus den angegebenen `storages` abgerufen werden.\n "
- },
- "Responses_ExpirationDateDto": {
- "type": "object",
- "properties": {
- "expirationDate": {
- "type": "string",
- "description": "Verfallsdatum der Datei (Default: nach Standard-Verfallszeit)<br/><br/>Wenn hier `null` angegeben wird, gilt die im System definierte Standard-Verfallszeit.Die Zeit wird an der REST-Schnittstelle incl. Zeitzoneninformation entgegengenommen und entsprechend verarbeitet.\n Eine Zeit ohne Zeitzonenangabe (sog. unspezifizierte Zeit) wird als lokale (deutsche) Zeit interpretiert.",
- "format": "date-time",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Ein serialiserbares Objekt für das Verfallsdatum<br/><br/>Wenn für das Verfallsdatum `null` angegeben wird, gilt die im System definierte Standard-Verfallszeit.Die Zeit wird an der REST-Schnittstelle incl. Zeitzoneninformation entgegengenommen und entsprechend verarbeitet.\n Eine Zeit ohne Zeitzonenangabe (sog. unspezifizierte Zeit) wird als lokale (deutsche) Zeit interpretiert."
- },
- "Responses_FilestoragePayloadContent": {
- "type": "object",
- "properties": {
- "guid": {
- "type": "string",
- "description": "Identifikator der Datei",
- "format": "uuid"
- },
- "isDisposable": {
- "type": "boolean",
- "description": "Ob ein Dateiinhalt vorhanden ist"
- },
- "isApproved": {
- "type": "boolean",
- "description": "Ob der Inhalt der Datei valide ist"
- },
- "isEnclosed": {
- "type": "boolean",
- "description": "Ob der Inhalt in <see cref=\"P:Dataport.OSP.Postfach.Application.Facade.Model.Responses.FilestoragePayloadContent.Content\">`content`</see> enthalten ist",
- "readOnly": true
- },
- "features": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "description": "Zusätzliche Features/Attribute des Inhaltes",
- "nullable": true
- },
- "content": {
- "type": "string",
- "description": "Inhalt",
- "format": "byte",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Inhalt des Filestorage Payloads"
- },
- "Responses_MailboxDirectoryResponse": {
- "required": [
- "meta"
- ],
- "type": "object",
- "properties": {
- "mailBoxIndex": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DTO_MailboxScopeData"
- },
- "description": "MailboxIndex",
- "nullable": true
- },
- "meta": {
- "$ref": "#/components/schemas/V1_Meta"
- },
- "warnings": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_AlertMessage"
- },
- "description": "Warnings",
- "nullable": true
- },
- "errors": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_AlertMessage"
- },
- "description": "Errors",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "MailboxDirectoryResponse"
- },
- "Responses_MailboxResponse": {
- "required": [
- "meta"
- ],
- "type": "object",
- "properties": {
- "unreadMessages": {
- "type": "string",
- "description": "ungelesene Nachrichten",
- "nullable": true
- },
- "mails": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Postfach_Mail"
- },
- "description": "Mails",
- "nullable": true
- },
- "status": {
- "type": "string",
- "description": "Stati",
- "nullable": true
- },
- "messageId": {
- "type": "string",
- "description": "MessageId",
- "nullable": true
- },
- "meta": {
- "$ref": "#/components/schemas/V1_Meta"
- },
- "warnings": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_AlertMessage"
- },
- "description": "Warnings",
- "nullable": true
- },
- "errors": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_AlertMessage"
- },
- "description": "Errors",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "MailboxResponse"
- },
- "Responses_Storages": {
- "enum": [
- "None",
- "QFS",
- "ODFS",
- "PFFS",
- "UndeterminableInQFS",
- "UndeterminableInODFS",
- "UndeterminableInPFFS"
- ],
- "type": "string",
- "description": "Menge von Storages</p><table><tr><td>None</td><td>Kein Storage</td></tr> <tr><td>QFS</td><td>Quarantine Filestorage</td></tr> <tr><td>ODFS</td><td>Onlinedienst Filestorage</td></tr> <tr><td>PFFS</td><td>Postfach Filestorage</td></tr> <tr><td>UndeterminableInQFS</td><td>Status im Quarantine Filestorage kann nicht ermittelt werden</td></tr> <tr><td>UndeterminableInODFS</td><td>Status im Onlinedienst Filestorage kann nicht ermittelt werden</td></tr> <tr><td>UndeterminableInPFFS</td><td>Status im Postfach Filestorage kann nicht ermittelt werden</td></tr> </table><p>"
- },
- "Responses_UploadResponse": {
- "type": "object",
- "properties": {
- "uploadId": {
- "type": "string",
- "description": "Identifikator des Uploads",
- "format": "uuid"
- }
- },
- "additionalProperties": false,
- "description": "Response-Objekt für den (ersten) Upload-Aufruf"
- },
- "V1_AlertMessage": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "description": "",
- "nullable": true
- },
- "code": {
- "type": "string",
- "description": "",
- "nullable": true
- },
- "description": {
- "type": "string",
- "description": "",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": ""
- },
- "V1_EidasLevel": {
- "enum": [
- "Low",
- "Medium",
- "High"
- ],
- "type": "string",
- "description": "Sicherheitsstufe für die Nachricht</p><table><tr><td>Low</td><td>Niedrig</td></tr> <tr><td>Medium</td><td>Mittel</td></tr> <tr><td>High</td><td>Hoch</td></tr> </table><p>"
- },
- "V1_FilestorageTarget": {
- "enum": [
- "Unspecified",
- "ODFS",
- "PFFS"
- ],
- "type": "string",
- "description": "Definiert, ob und in welchen Ziel-Filestorage ein Upload automatisch verschoben werden soll.</p><table><tr><td>Unspecified</td><td>Es ist kein Ziel-Filestorage spezifiziert und es findet kein automatischer Verschub statt. Die Datei muss explizit in den Ziel-Filestorage gepullt werden.</td></tr> <tr><td>ODFS</td><td>Es soll in den OD-Filestorage verschoben werden.</td></tr> <tr><td>PFFS</td><td>Es soll in den Postfach-Filestorage verschoben werden.</td></tr> </table><p>"
- },
- "V1_MailboxType": {
- "enum": [
- "Inbox",
- "Sent",
- "Trash"
- ],
- "type": "string",
- "description": "Postfach Typ</p><table><tr><td>Inbox</td><td>Eingangs-Ordner.</td></tr> <tr><td>Sent</td><td>Gesendet-Ordner.</td></tr> <tr><td>Trash</td><td>Papierkorb.</td></tr> </table><p>"
- },
- "V1_Meta": {
- "type": "object",
- "properties": {
- "correlationId": {
- "type": "string",
- "description": "",
- "nullable": true
- },
- "serviceCode": {
- "type": "string",
- "description": "",
- "nullable": true
- },
- "serviceDescription": {
- "type": "string",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Meta info in response"
- },
- "V1_References": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string",
- "description": "URL zur Referenz",
- "nullable": true
- },
- "text": {
- "type": "string",
- "description": "Der Anzeigetext<br/><br/>\n Dieser Text dient als Repräsentation für die URL.\n ",
- "nullable": true
- },
- "severity": {
- "$ref": "#/components/schemas/V1_SeverityLevel"
- },
- "title": {
- "type": "string",
- "description": "Informationstext, der zur Referenz angezeigt wird",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Referenz zur Nachricht"
- },
- "V1_ReplyBehavior": {
- "enum": [
- "Replypossible",
- "Replymandatory",
- "Replyforbidden"
- ],
- "type": "string",
- "description": "Antwortverhalten</p><table><tr><td>Replypossible</td><td>Antwort erlaubt</td></tr> <tr><td>Replymandatory</td><td>Antwort erforderlich - User kann die Nachricht nicht löschen</td></tr> <tr><td>Replyforbidden</td><td>Antwort verboten</td></tr> </table><p>"
- },
- "V1_ReplyFiles": {
- "type": "object",
- "properties": {
- "guid": {
- "type": "string",
- "description": "Guid des Anhangs",
- "format": "uuid"
- },
- "name": {
- "type": "string",
- "description": "Name des Anhangs",
- "nullable": true
- },
- "mimeType": {
- "type": "string",
- "description": "Mime Typ des Anhangs",
- "nullable": true
- },
- "size": {
- "type": "integer",
- "description": "Größe des Anhangs",
- "format": "int64"
- }
- },
- "additionalProperties": false,
- "description": "Anhänge der Antwort"
- },
- "V1_ReplyMessage": {
- "type": "object",
- "properties": {
- "sequencenumber": {
- "type": "string",
- "description": "Sequenznummer",
- "nullable": true
- },
- "subject": {
- "type": "string",
- "description": "Betreff",
- "nullable": true
- },
- "body": {
- "type": "string",
- "description": "Nachrichteninhalt",
- "nullable": true
- },
- "displayName": {
- "type": "string",
- "description": "Display- bzw. Service Name (Onlinedienst)",
- "nullable": true
- },
- "originSender": {
- "type": "string",
- "description": "Absender des Originalnachricht",
- "nullable": true
- },
- "replyAction": {
- "$ref": "#/components/schemas/V1_ReplyBehavior"
- },
- "eidasLevel": {
- "$ref": "#/components/schemas/V1_EidasLevel"
- },
- "isObligatory": {
- "type": "boolean",
- "description": "Rechtsverbindlichkeit"
- },
- "isHtml": {
- "type": "boolean",
- "description": "Html Nachricht (ja/nein)"
- },
- "files": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_ReplyFiles"
- },
- "description": "Anhänge",
- "nullable": true
- },
- "guid": {
- "type": "string",
- "description": "Guid der Antwortnachricht",
- "format": "uuid"
- },
- "messageBox": {
- "type": "string",
- "description": "Postfach (des Empfängers)",
- "format": "uuid"
- },
- "senderDisplayName": {
- "type": "string",
- "description": "Display- bzw. Service Name (Onlinedienst)",
- "nullable": true
- },
- "recipientDisplayName": {
- "type": "string",
- "description": "Empfänger Anzeigename",
- "nullable": true
- },
- "responseTime": {
- "type": "string",
- "description": "Antwortzeit",
- "format": "date-time"
- }
- },
- "additionalProperties": false,
- "description": "Antwort Nachricht"
- },
- "V1_SendMessageWithAttachmentsRequest": {
- "required": [
- "body",
- "subject"
- ],
- "type": "object",
- "properties": {
- "body": {
- "minLength": 1,
- "type": "string",
- "description": "Nachrichtentext; entweder als einfacher Text oder als HTML-Text (s. Parameter <see cref=\"P:Dataport.OSP.Postfach.Application.Facade.Model.Requests.Dto.In.V1.SendMessageWithAttachmentsRequest.IsHtml\">`isHtml`</see>).<br/><br/>\n (max. 400000 Zeichen)\n ",
- "example": "Hello World!"
- },
- "subject": {
- "minLength": 1,
- "type": "string",
- "description": "Betreff der Nachricht<br/><br/>(max. 255 Zeichen)",
- "example": "Mein Betreff"
- },
- "eidasLevel": {
- "$ref": "#/components/schemas/V1_EidasLevel"
- },
- "isHtml": {
- "type": "boolean",
- "description": "Ist die Nachricht eine HTML-Nachricht?"
- },
- "isObligatory": {
- "type": "boolean",
- "description": "Ist die Nachricht rechtlich verbindlich?"
- },
- "sequenceNumber": {
- "type": "string",
- "description": "Die fachliche Vorgangsnummer.<br/><br/>\n Zu einem Vorgang kann es mehrere Nachrichten geben. (max. 256 Zeichen)\n ",
- "nullable": true
- },
- "replyAction": {
- "$ref": "#/components/schemas/V1_ReplyBehavior"
- },
- "displayName": {
- "type": "string",
- "description": "Anzeigename des Absenders",
- "nullable": true
- },
- "originSender": {
- "type": "string",
- "description": "Technischer Absender<br/><br/>\n Dies ist entweder eine Postfachreferenz oder die GUID eines lokalen OSI-Postfachs.\n ",
- "nullable": true
- },
- "references": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/V1_References"
- },
- "description": "Referenzen zur Nachricht<br/><br/>\n (max. 100 Referenzen)\n ",
- "nullable": true
- }
- },
- "additionalProperties": false,
- "description": "Requestobjekt für die Daten der Nachricht (`V1_SendMessageWithAttachmentsRequest` im Swagger-Schema)"
- },
- "V1_SeverityLevel": {
- "enum": [
- "Low",
- "Medium",
- "High"
- ],
- "type": "string",
- "description": "SeverityLevel</p><table><tr><td>Low</td><td>Low - wird grün angezeigt</td></tr> <tr><td>Medium</td><td>Medium - wird gelb angezeigt</td></tr> <tr><td>High</td><td>High - wird rot angezeigt</td></tr> </table><p>"
- }
- },
- "securitySchemes": {
- "OIDC": {
- "type": "openIdConnect",
- "openIdConnectUrl": "/Facade/WellKnownOpenidConfiguration"
- }
- }
- },
- "security": [
- {
- "OIDC": [ ]
- }
- ],
- "tags": [
- {
- "name": "Filestorage",
- "description": "Der <i>Filestorage Controller</i> bietet eine Schnittstelle zum <i>Plattformdienst Filestorage.</i>."
- },
- {
- "name": "Mailbox",
- "description": "Der <i>Mailbox Controller</i> stellt eine Schnittstelle bereit, um Nachrichten des eingeloggten Users auszulesen."
- },
- {
- "name": "MailboxDirectory",
- "description": "Der <i>MailboxDirectory Controller</i> bietet Verzeichnisdienste für die OSI-Postfächer."
- },
- {
- "name": "Probe",
- "description": "Der <i>Probe Controller</i> stellt eine interne Schnittstelle innerhalb der OSI-Plattform\r\nzur Überwachung der Facade-Instanz bereit."
- },
- {
- "name": "MessageExchange",
- "description": "Der <i>MessageExchange Controller</i> dient dem Senden, Lesen und Löschen von Postfach-Nachrichten."
- },
- {
- "name": "Quarantine",
- "description": "Der <i>Quarantine-Controller</i> ermöglicht das Hochladen von Dateien in die Quarantäne."
- }
- ]
-}
\ No newline at end of file
diff --git a/spec/postfach-api-facade.yaml b/spec/postfach-api-facade.yaml
new file mode 100644
index 0000000..a9227d5
--- /dev/null
+++ b/spec/postfach-api-facade.yaml
@@ -0,0 +1,4909 @@
+openapi: 3.0.1
+info:
+ title: Postfach API Facade
+ description: <h3>Zentraler Service zur Nutzung der Plattformdienste des <i>Plattformdienstteams
+ Postfach</i></h3>siehe auch <a href=https://docs.osi.dataport.de/x/VgO8Bw>PF-Facade</a>
+ version: 1.0
+servers:
+- url: /facade
+paths:
+ /Filestorage/v1:
+ post:
+ tags:
+ - Filestorage
+ summary: Lädt eine komplette Datei oder das erste Dateistück hoch
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ file:
+ type: string
+ description: Inhalt der Datei bzw. des Dateistücks
+ format: binary
+ moreWillFollow:
+ type: boolean
+ description: Ob noch weitere Chunks folgen
+ target:
+ $ref: "#/components/schemas/V1_FilestorageTarget"
+ expirationDate:
+ type: string
+ description: "Verfallsdatum der Datei (Standard: nach Standard-Verfallszeit)\
+ \ - Wenn hier `null` angegeben wird, gilt die im System definierte\
+ \ Standard-Verfallszeit.Die Zeit wird an der REST-Schnittstelle\
+ \ incl. Zeitzoneninformation entgegengenommen und entsprechend\
+ \ verarbeitet. Eine Zeit ohne Zeitzonenangabe (sog. unspezifizierte\
+ \ Zeit) wird als lokale (deutsche) Zeit interpretiert."
+ format: date-time
+ additionalContext:
+ type: string
+ description: "zusätzlicher Kontext -\r\n Bildet zusammen\
+ \ mit dem großgeschriebenen Name-Identifier (Shortcode des Onlinedienstes)\
+ \ aus der OIDC-Anmeldung den Berechtigungskontext."
+ fileName:
+ type: string
+ description: "Name der Datei (default: Name aus `file`)"
+ example: 24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ encoding:
+ file:
+ style: form
+ moreWillFollow:
+ style: form
+ target:
+ style: form
+ expirationDate:
+ style: form
+ additionalContext:
+ style: form
+ fileName:
+ style: form
+ responses:
+ "200":
+ description: OK<br />Erfolgreich hochgeladen.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_UploadResponse"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_UploadResponse"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_UploadResponse"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ /Filestorage/v1/{uploadId}/{chunkIndex}:
+ post:
+ tags:
+ - Filestorage
+ summary: Lädt ein weiteres Dateistück hoch
+ parameters:
+ - name: uploadId
+ in: path
+ description: Identifikator des Uploads
+ required: true
+ schema:
+ type: string
+ format: uuid
+ - name: chunkIndex
+ in: path
+ description: "0-basierter Index des Dateistücks (Chunks), hier immer >= 1"
+ required: true
+ schema:
+ type: integer
+ format: int32
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ file:
+ type: string
+ description: Inhalt des Dateistücks
+ format: binary
+ moreWillFollow:
+ type: boolean
+ description: Ob noch weitere Chunks folgen
+ example: "false"
+ encoding:
+ file:
+ style: form
+ moreWillFollow:
+ style: form
+ responses:
+ "200":
+ description: OK<br />Dateistück erfolgreich hochgeladen.
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "409":
+ description: Conflict<br />Dieses Dateistück wurde bereits zuvor hochgeladen.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict
+ title: Conflict
+ status: 409
+ detail: Dieses Dateistück wurde bereits zuvor hochgeladen.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict
+ title: Conflict
+ status: 409
+ detail: Dieses Dateistück wurde bereits zuvor hochgeladen.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict
+ title: Conflict
+ status: 409
+ detail: Dieses Dateistück wurde bereits zuvor hochgeladen.
+ /Filestorage/v1/{uploadId}/CheckUpload:
+ get:
+ tags:
+ - Filestorage
+ summary: Überprüft Sicherheitsstatus und Verfügbarkeit der hochgeladenen Datei
+ parameters:
+ - name: uploadId
+ in: path
+ description: Identifikator des Uploads
+ required: true
+ schema:
+ type: string
+ format: uuid
+ responses:
+ "200":
+ description: OK<br />Die Datei wurde erfolgreich virenüberprüft und steht
+ in den angegebenen `storages` zum Download bereit.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_CheckUploadResponse"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_CheckUploadResponse"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_CheckUploadResponse"
+ "400":
+ description: Bad Request<br />Die Datei ist nicht sicher und wurde abgelehnt.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Die Datei ist nicht sicher und wurde abgelehnt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Die Datei ist nicht sicher und wurde abgelehnt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Die Datei ist nicht sicher und wurde abgelehnt.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "404":
+ description: Not found<br />Die Datei existiert weder im Upload-Bereich
+ noch in einem Filestorage.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Die Datei existiert weder im Upload-Bereich noch in einem
+ Filestorage.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Die Datei existiert weder im Upload-Bereich noch in einem
+ Filestorage.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Die Datei existiert weder im Upload-Bereich noch in einem
+ Filestorage.
+ "422":
+ description: Unprocessable Content<br />Es wurden noch nicht alle Dateistücke
+ hochgeladen.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21
+ title: Unprocessable Content
+ status: 422
+ detail: Es wurden noch nicht alle Dateistücke hochgeladen.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21
+ title: Unprocessable Content
+ status: 422
+ detail: Es wurden noch nicht alle Dateistücke hochgeladen.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21
+ title: Unprocessable Content
+ status: 422
+ detail: Es wurden noch nicht alle Dateistücke hochgeladen.
+ "503":
+ description: Service unavailable<br />Virenprüfung läuft.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ /Filestorage/v1/{guid}:
+ get:
+ tags:
+ - Filestorage
+ summary: Download aus dem OD-Filestorage
+ description: "Beim Download werden diverse Checks ausgeführt und die Datei auch\
+ \ erforderlichenfalls vom Quarantine-Filestorage (QFS) in den OD-Filestorage\
+ \ (ODFS) übertragen. Wenn die Datei noch nicht virengeprüft wurde oder virenbefallen\
+ \ ist, erfolgt ein Fehlerabbruch. Wenn die Datei noch nicht in den OD-Filestorage\
+ \ übertragen wurde, erfolgt diese Übertragung vor der Auslieferung der Datei.\
+ \ Aus der Anmeldung und dem additionalContext wird automatisch der Berechtigungskontext\
+ \ erzeugt. additionalContext muss mit einem '$' beginnen, um einen gesicherten\
+ \ Download zu kennzeichnen. Nur solche Dateien können mit dieser Aktion heruntergeladen\
+ \ werden. Stimmt der Berechtigungskontext nicht mit dem gespeicherten Berechtigungskontext\
+ \ überein, erfolgt ein Fehlerabbruch."
+ parameters:
+ - name: guid
+ in: path
+ description: Identifikator der Datei.
+ required: true
+ schema:
+ type: string
+ format: uuid
+ - name: additionalContext
+ in: query
+ description: "zusätzlicher Kontext - Bildet zusammen mit der Anmeldung den\
+ \ Berechtigungskontext. (Default: \"$\")"
+ schema:
+ type: string
+ example: $
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_FilestoragePayloadContent"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_FilestoragePayloadContent"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_FilestoragePayloadContent"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Nur für herunterladbare Dateien. `additionalContext` muss
+ mit einem '$' beginnen.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Nur für herunterladbare Dateien. `additionalContext` muss
+ mit einem '$' beginnen.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Nur für herunterladbare Dateien. `additionalContext` muss
+ mit einem '$' beginnen.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "404":
+ description: Not Found
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Die Datei existiert weder im Upload-Bereich noch in einem
+ Filestorage.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Die Datei existiert weder im Upload-Bereich noch in einem
+ Filestorage.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Die Datei existiert weder im Upload-Bereich noch in einem
+ Filestorage.
+ "422":
+ description: Unprocessable Content
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21
+ title: Unprocessable Content
+ status: 422
+ detail: Es wurden noch nicht alle Dateistücke hochgeladen.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21
+ title: Unprocessable Content
+ status: 422
+ detail: Es wurden noch nicht alle Dateistücke hochgeladen.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.21
+ title: Unprocessable Content
+ status: 422
+ detail: Es wurden noch nicht alle Dateistücke hochgeladen.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ delete:
+ tags:
+ - Filestorage
+ summary: Löscht eine Datei
+ description: "<br>Diese Operation bezieht sich auf alle Filestorages (QFS, ODFS\
+ \ und PFFS) sowie die Quarantäne. Sie löscht auch unvollständige Uploads.\r\
+ \n<br>Der Aufruf setzt eine Löschmarkierung, das physische Löschen geschieht\
+ \ automatisch unmittelbar danach asynchron."
+ parameters:
+ - name: guid
+ in: path
+ description: Identifikator der Datei
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ responses:
+ "200":
+ description: OK
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ /Filestorage/v1/{guid}/ExpirationDate:
+ put:
+ tags:
+ - Filestorage
+ summary: Setzt das Verfallsdatum
+ description: "Diese Operation bezieht sich auf den OD-Filestorage (ODFS) und\
+ \ funktioniert auch, wenn die Datei noch in der Quarantäne ist. Nach erfolgreichem\
+ \ Aufruf dieser Operation befindet sich die Datei immer im ODFS; sie wird\
+ \ ggf. dort hin verlagert."
+ parameters:
+ - name: guid
+ in: path
+ description: Identifikator der Datei
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ - name: additionalContext
+ in: query
+ description: Zusätzlicher Kontext - Bildet zusammen mit der Anmeldung den
+ Berechtigungskontext.
+ schema:
+ type: string
+ requestBody:
+ description: Verfallsdatum der Datei
+ content:
+ application/json-patch+json:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ application/*+json:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ type: boolean
+ application/json:
+ schema:
+ type: boolean
+ text/json:
+ schema:
+ type: boolean
+ "400":
+ description: Bad Request<br />Die Datei ist von einem Virus befallen.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "404":
+ description: Not Found<br />Eine Datei mit dem angegebenen Identifikator
+ (GUID) wurde nicht gefunden.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ "503":
+ description: Service Unavailable<br />Die Virenprüfung läuft noch.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ get:
+ tags:
+ - Filestorage
+ summary: Liefert das Verfallsdatum
+ description: "Diese Operation bezieht sich auf den OD-Filestorage (ODFS) und\
+ \ funktioniert auch, wenn die Datei noch in der Quarantäne ist. Nach erfolgreichem\
+ \ Aufruf dieser Operation befindet sich die Datei immer im ODFS; sie wird\
+ \ ggf. dort hin verlagert."
+ parameters:
+ - name: guid
+ in: path
+ description: Identifikator der Datei
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ - name: additionalContext
+ in: query
+ description: Zusätzlicher Kontext - Bildet zusammen mit der Anmeldung den
+ Berechtigungskontext.
+ schema:
+ type: string
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_ExpirationDateDto"
+ "400":
+ description: Bad Request<br />Die Datei ist von einem Virus befallen.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "404":
+ description: Not Found<br />Eine Datei mit dem angegebenen Identifikator
+ (GUID) wurde nicht gefunden.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ "503":
+ description: Service Unavailable<br />Die Virenprüfung läuft noch.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Die Virenprüfung läuft noch.
+ /Mailbox/v1/Read/UnreadMessages/Count/{mailboxType}:
+ get:
+ tags:
+ - Mailbox
+ summary: Liefert die Anzahl der ungelesenen Nachrichten einer Mailbox des eingeloggten
+ Users.
+ parameters:
+ - name: mailboxType
+ in: path
+ description: Die Art der Mailbox
+ required: true
+ schema:
+ $ref: "#/components/schemas/V1_MailboxType"
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ unreadMessages: 3
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ unreadMessages: 3
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ unreadMessages: 3
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ /Mailbox/v1/Read/Messages/{mailboxType}:
+ get:
+ tags:
+ - Mailbox
+ summary: Liefert eine Liste der Nachrichtenheader einer Mailbox des eingeloggten
+ Users.
+ parameters:
+ - name: mailboxType
+ in: path
+ description: Die Art der Mailbox
+ required: true
+ schema:
+ $ref: "#/components/schemas/V1_MailboxType"
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ mails:
+ - mailHeader:
+ replyAction: ReplyForbidden
+ sender: null
+ recipient: null
+ processDate: 2023-07-10T14:11:17.8095333+02:00
+ statedDate: 2023-07-10T14:11:16.8095333+02:00
+ subject: My First Mail
+ sequenceNumber: null
+ isRead: true
+ isObligatory: true
+ countConversation: 0
+ hasAttachments: false
+ isReply: false
+ eidas: Substantial
+ isAuthorized: true
+ references: []
+ guid: 9efdc6b3-e90d-4054-b0ca-3ef9634e9095
+ linkToBody: null
+ - mailHeader:
+ replyAction: ReplyForbidden
+ sender: null
+ recipient: null
+ processDate: 2023-07-10T15:11:17.8095333+02:00
+ statedDate: 2023-07-10T15:11:16.8095333+02:00
+ subject: My Second Mail
+ sequenceNumber: null
+ isRead: true
+ isObligatory: true
+ countConversation: 0
+ hasAttachments: false
+ isReply: false
+ eidas: Substantial
+ isAuthorized: true
+ references: []
+ guid: 5f12aee3-d35b-4d94-855c-53bdcc704fd0
+ linkToBody: null
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ mails:
+ - mailHeader:
+ replyAction: ReplyForbidden
+ sender: null
+ recipient: null
+ processDate: 2023-07-10T14:11:17.8095333+02:00
+ statedDate: 2023-07-10T14:11:16.8095333+02:00
+ subject: My First Mail
+ sequenceNumber: null
+ isRead: true
+ isObligatory: true
+ countConversation: 0
+ hasAttachments: false
+ isReply: false
+ eidas: Substantial
+ isAuthorized: true
+ references: []
+ guid: 9efdc6b3-e90d-4054-b0ca-3ef9634e9095
+ linkToBody: null
+ - mailHeader:
+ replyAction: ReplyForbidden
+ sender: null
+ recipient: null
+ processDate: 2023-07-10T15:11:17.8095333+02:00
+ statedDate: 2023-07-10T15:11:16.8095333+02:00
+ subject: My Second Mail
+ sequenceNumber: null
+ isRead: true
+ isObligatory: true
+ countConversation: 0
+ hasAttachments: false
+ isReply: false
+ eidas: Substantial
+ isAuthorized: true
+ references: []
+ guid: 5f12aee3-d35b-4d94-855c-53bdcc704fd0
+ linkToBody: null
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ mails:
+ - mailHeader:
+ replyAction: ReplyForbidden
+ sender: null
+ recipient: null
+ processDate: 2023-07-10T14:11:17.8095333+02:00
+ statedDate: 2023-07-10T14:11:16.8095333+02:00
+ subject: My First Mail
+ sequenceNumber: null
+ isRead: true
+ isObligatory: true
+ countConversation: 0
+ hasAttachments: false
+ isReply: false
+ eidas: Substantial
+ isAuthorized: true
+ references: []
+ guid: 9efdc6b3-e90d-4054-b0ca-3ef9634e9095
+ linkToBody: null
+ - mailHeader:
+ replyAction: ReplyForbidden
+ sender: null
+ recipient: null
+ processDate: 2023-07-10T15:11:17.8095333+02:00
+ statedDate: 2023-07-10T15:11:16.8095333+02:00
+ subject: My Second Mail
+ sequenceNumber: null
+ isRead: true
+ isObligatory: true
+ countConversation: 0
+ hasAttachments: false
+ isReply: false
+ eidas: Substantial
+ isAuthorized: true
+ references: []
+ guid: 5f12aee3-d35b-4d94-855c-53bdcc704fd0
+ linkToBody: null
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ /MailboxDirectory/v1/Lookup:
+ post:
+ tags:
+ - MailboxDirectory
+ summary: Liefert eine Liste der zu NameIdentifiern gehörenden OSI-Postfächer
+ (Personal)
+ requestBody:
+ description: Liste der angefragten NameIdentifier
+ content:
+ application/json-patch+json:
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ application/json:
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ text/json:
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ application/*+json:
+ schema:
+ type: array
+ items:
+ type: string
+ format: uuid
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxDirectoryResponse"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxDirectoryResponse"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxDirectoryResponse"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ /MessageExchange/v1/Send/{mailboxId}:
+ post:
+ tags:
+ - MessageExchange
+ summary: Sendet eine Nachricht an ein externes oder internes Postfach.
+ description: "Wenn die Nachricht Anlagen enthalten soll, müssen diese zuvor\
+ \ mit `/Quarantine/v1/Upload` hochgeladen und virengeprüft worden sein."
+ parameters:
+ - name: mailboxId
+ in: path
+ description: "GUID des lokalen OSI-Postfachs oder Postfachreferenz, an die\
+ \ die Nachricht zugestellt werden soll.\r\n <i>Hinweis:</i> Im\
+ \ Swagger muss das Zeichen `'/'` durch `'|'` ersetzt werden."
+ required: true
+ schema:
+ type: string
+ example: de-b1||24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ requestBody:
+ description: Daten der zu sendenden Nachricht.
+ content:
+ application/json-patch+json:
+ schema:
+ $ref: "#/components/schemas/Out_SendMessageRequestV2"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Out_SendMessageRequestV2"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Out_SendMessageRequestV2"
+ application/*+json:
+ schema:
+ $ref: "#/components/schemas/Out_SendMessageRequestV2"
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_SendMessageResponse"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_SendMessageResponse"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_SendMessageResponse"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "404":
+ description: Not Found<br />Das Postfach ist unbekannt.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Postfach mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Postfach mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Postfach mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ /MessageExchange/v1/Receive/{messageId}/Attachment/{attachmentId}:
+ get:
+ tags:
+ - MessageExchange
+ summary: Liefert den Inhalt eines hochgeladenen Attachments im Kontext einer
+ übergebenen MessageId und einer AttachmentId
+ parameters:
+ - name: messageId
+ in: path
+ description: Identifikator der Nachricht
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 4B7588ED-65C9-4877-9526-B19C20116E99
+ - name: attachmentId
+ in: path
+ description: Identifikator der Datei des Nachrichtenanhangs
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ responses:
+ "200":
+ description: OK
+ content:
+ application/octet-stream:
+ schema:
+ type: string
+ format: binary
+ "400":
+ description: Bad Request
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "404":
+ description: Not Found<br />Der Nachrichtenanhang ist unbekannt.
+ content:
+ application/octet-stream:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Nachrichtenanhang mit dem angegebenen Identifikatoren
+ (GUIDs) wurde nicht gefunden.
+ /MessageExchange/v1/Receive/{messageId}:
+ get:
+ tags:
+ - MessageExchange
+ summary: Liefert den Inhalt einer Antwortnachricht.
+ parameters:
+ - name: messageId
+ in: path
+ description: Identifikator der Nachricht
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 4B7588ED-65C9-4877-9526-B19C20116E99
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/V1_ReplyMessage"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/V1_ReplyMessage"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/V1_ReplyMessage"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "404":
+ description: Not Found<br />Die Nachricht ist unbekannt.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ /MessageExchange/v1/Receive:
+ get:
+ tags:
+ - MessageExchange
+ summary: Liefert eine Liste von Antwortnachrichten inklusive der Anhänge.
+ description: "Beispiele für eine Liste mit 10 Einträgen:\r\n<ul><li>`take=4&skip=0`\r\
+ \n <ul><li>4 Einträge/Seite</li><li>nichts überspringen</li><li>⇒ der erste,\
+ \ zweite, dritte und vierte Eintrag werden geliefert</li></ul></li><li>`take=\
+ \ 4&skip=1`\r\n <ul><li>4 Einträge/Seite</li><li>1 Seite = 4 Einträge ü\
+ berspringen</li><li>⇒ der fünfte, sechste, siebte und achte Eintrag werden\
+ \ geliefert</li></ul></li><li>`take=4&skip=2`\r\n <ul><li>4 Einträge/Seite</li><li>2\
+ \ Seiten = 2*4 Einträge überspringen</li><li>⇒ der neunte und zehnte Eintrag\
+ \ wird geliefert (den 11. und 12. Eintrag gibt es in der Liste nicht)</li></ul></li></ul>"
+ parameters:
+ - name: take
+ in: query
+ description: Anzahl der Einträge pro Seite.
+ schema:
+ type: integer
+ format: int32
+ - name: skip
+ in: query
+ description: "Anzahl der Seiten á `take` Einträge, die übersprungen werden\
+ \ sollen."
+ schema:
+ type: integer
+ format: int32
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_ReceiveMessagesResponse"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_ReceiveMessagesResponse"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_ReceiveMessagesResponse"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ /MessageExchange/v1/Delete/{messageId}:
+ delete:
+ tags:
+ - MessageExchange
+ summary: Löscht eine Nachricht.
+ parameters:
+ - name: messageId
+ in: path
+ description: Identifikator der Nachricht
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 4B7588ED-65C9-4877-9526-B19C20116E99
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_DeleteMessageResponse"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_DeleteMessageResponse"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_DeleteMessageResponse"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "404":
+ description: Not Found<br />Die Nachricht ist unbekannt.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ /MessageExchange/v1/Send/MessageWithAttachments/{mailboxId}:
+ post:
+ tags:
+ - MessageExchange
+ summary: Sendet eine Nachricht incl. Dateiupload an ein externes oder internes
+ Postfach.
+ description: "Senden einer Nachricht mit Attachments an ein externes oder internes\
+ \ Postfach. Die Anhänge werden direkt mitgegeben, die Schnittstelle kümmert\
+ \ sich intern um das Handling der Dateien. Der Request ist ähnlich zum \"\
+ normalen\" Send, nur mit direktem Datei-Upload."
+ parameters:
+ - name: mailboxId
+ in: path
+ description: "GUID des lokalen OSI-Postfachs oder Postfachreferenz, an die\
+ \ die Nachricht zugestellt werden soll.\r\n <i>Hinweis:</i> Im\
+ \ Swagger muss das Zeichen `'/'` durch `'|'` ersetzt werden."
+ required: true
+ schema:
+ type: string
+ example: de-b1||24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ sendRequest:
+ $ref: "#/components/schemas/V1_SendMessageWithAttachmentsRequest"
+ fileList:
+ type: array
+ items:
+ type: string
+ format: binary
+ description: Liste der als Anhänge zu sendenden Dateien.
+ example: 24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ encoding:
+ Body:
+ style: form
+ Subject:
+ style: form
+ EidasLevel:
+ style: form
+ IsHtml:
+ style: form
+ IsObligatory:
+ style: form
+ SequenceNumber:
+ style: form
+ ReplyAction:
+ style: form
+ DisplayName:
+ style: form
+ OriginSender:
+ style: form
+ References:
+ style: form
+ fileList:
+ style: form
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ unreadMessages: 3
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ unreadMessages: 3
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Responses_MailboxResponse"
+ example:
+ unreadMessages: 3
+ meta:
+ correlationId: b7cba351-5710-417e-9057-ede1e81222ae
+ serviceCode: postfachapi
+ serviceDescription: postfach api (Appserver solution)
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "404":
+ description: Not Found<br />Das Postfach ist unbekannt.
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Postfach mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Postfach mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Ein Postfach mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ /MessageExchange/v1/Status/{messageId}:
+ get:
+ tags:
+ - MessageExchange
+ summary: Liefert den Status einer versendeten Nachricht.
+ description: Es wird der Status innerhalb von OSI und ggf. auch im externen
+ Nachrichtensystem (z.B. MUK) abgefragt.
+ parameters:
+ - name: messageId
+ in: path
+ description: "Identifikator der Nachricht.<br />Muss zuvor als Ergebnis des\
+ \ Sendeauftrags der zu überprüfenden Nachricht, z.B. von `POST MessageExchange/v1/Send/{mailboxId}`,\
+ \ zurückgegeben worden sein."
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 588FE793-AD80-4A2D-8BD8-0C33F92D69DF
+ responses:
+ "200":
+ description: OK
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/MessageExchange_MessageStatusInquiryResponse"
+ example:
+ messageId: b7cba351-5710-417e-9057-ede1e81222ae
+ responseStatus: Accepted
+ responseSubStatus: EtrVersendet
+ responseMessage: "accountId: Bitte geben Sie einen gültigen Empfä\
+ nger (Benutzerkonto‑ID) an."
+ target: MukEp2
+ responseTime: 2023-07-10T12:09:17.8095333+02:00
+ retryCounter: 0
+ timeOfMessageRetrieval: 2023-07-11T14:11:17.8095333+02:00
+ "400":
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "404":
+ description: Not Found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-404-not-found
+ title: Not Found
+ status: 404
+ detail: Eine Nachricht mit dem angegebenen Identifikator (GUID) wurde
+ nicht gefunden.
+ /MessageExchange/v1/GetBundIdPostkorbHandle/{mailboxId}:
+ get:
+ tags:
+ - MessageExchange
+ summary: Liefert das Postkorbhandle für einen BundId-Postkorb
+ description: "Bezeichnet die übergebene mailboxId keinen BundId-Postkorb, so\
+ \ wird ein leerer String zurück gegeben."
+ parameters:
+ - name: mailboxId
+ in: path
+ description: Postfachreferenz. <i>Hinweis:</i> Im Swagger muss das Zeichen
+ `'/'` durch `'|'` ersetzt werden.
+ required: true
+ schema:
+ type: string
+ example: de-b1||24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ responses:
+ "200":
+ description: OK
+ content:
+ application/json:
+ schema:
+ type: string
+ example: 24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ "400":
+ description: Bad Request
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ /_startup:
+ get:
+ tags:
+ - Probe
+ responses:
+ "200":
+ description: OK
+ "451":
+ description: Unavailable For Legal Reasons
+ /_ready:
+ get:
+ tags:
+ - Probe
+ responses:
+ "200":
+ description: OK
+ "424":
+ description: Failed Dependency
+ /_alive:
+ get:
+ tags:
+ - Probe
+ responses:
+ "200":
+ description: OK
+ "500":
+ description: Internal Server Error
+ /_metrics:
+ get:
+ tags:
+ - Probe
+ responses:
+ "200":
+ description: OK
+ /Quarantine/v1/Upload/{guid}:
+ get:
+ tags:
+ - Quarantine
+ summary: Liefert den Status der Virenprüfung.
+ parameters:
+ - name: guid
+ in: path
+ description: Identifikator der Datei
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Quarantine_Status"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Quarantine_Status"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Quarantine_Status"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ delete:
+ tags:
+ - Quarantine
+ summary: Markiert die Datei zum Löschen
+ description: "Eine zum Löschen markierte Datei wird binnen 10 Minuten gelöscht.<br\
+ \ />\r\nExistiert die Datei nicht (mehr), wird auch `Status 200 OK` zurück\
+ \ gegeben."
+ parameters:
+ - name: guid
+ in: path
+ description: Identifikator der Datei
+ required: true
+ schema:
+ type: string
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ responses:
+ "200":
+ description: OK
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ /Quarantine/v1/Upload/Chunked:
+ post:
+ tags:
+ - Quarantine
+ summary: Lädt ein Dateistück in die Quarantäne hoch
+ description: "<br>Die Dateistücke (Chunks) werden nacheinander hochgeladen.\
+ \ Zum Abschluss (`chunkIndex = totalChunks`) muss ein Aufruf mit leerem `file`\
+ \ gesendet werden.\r\n<br>Es gibt keine konkrete Vorgabe, wie groß ein Chunk\
+ \ sein darf. Zu große Chunks können zu Timeouts führen.\r\n<br>Mit dem Upload\
+ \ wird die Datei der Virenprüfung zugeführt. Nach Abschluss der erfolgreichen\
+ \ Virenprüfung steht die Datei im Quarantäne-Filestorage (QFS) zur Verfügung."
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ metadata:
+ $ref: "#/components/schemas/Domain_ChunkMetaData"
+ tenant:
+ type: string
+ description: OSI-Mandant (Landesmandant oder GO)
+ example: hh
+ nameIdentifier:
+ type: string
+ description: Name Identifier
+ file:
+ type: string
+ description: Inhalt des Dateistücks
+ format: binary
+ example: 24b91411-34e0-4ad2-aedb-ef9726cfe8aa
+ encoding:
+ UploadUid:
+ style: form
+ FileName:
+ style: form
+ ContentType:
+ style: form
+ ChunkIndex:
+ style: form
+ TotalChunks:
+ style: form
+ TotalFileSize:
+ style: form
+ Target:
+ style: form
+ tenant:
+ style: form
+ nameIdentifier:
+ style: form
+ file:
+ style: form
+ responses:
+ "200":
+ description: OK
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Quarantine_FileResult"
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Quarantine_FileResult"
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Quarantine_FileResult"
+ "400":
+ description: Bad Request
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-400-bad-request
+ title: Bad Request
+ status: 400
+ detail: Feld 'Xyz' darf nicht leer sein.
+ "401":
+ description: Unauthorized
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-401-unauthorized
+ title: Unauthorized
+ status: 401
+ detail: Die eingegebenen Zugangsdaten sind nicht ausreichend.
+ "403":
+ description: Forbidden
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Mvc_ProblemDetails"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-403-forbidden
+ title: Forbidden
+ status: 403
+ detail: Der Zugang ist nicht erlaubt.
+ "429":
+ description: Too Many Requests
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc6585#section-4
+ title: Too Many Requests
+ status: 429
+ detail: Es wurden zu häufig Requests eingereicht.
+ "500":
+ description: Internal Server Error
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-500-internal-server-error
+ title: Internal Server Error
+ status: 500
+ detail: Es ist ein interner Serverfehler aufgetreten.
+ "503":
+ description: Service Unavailable
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-503-service-unavailable
+ title: Service Unavailable
+ status: 503
+ detail: Der Dienst ist zurzeit nicht verfügbar.
+ "409":
+ description: Conflict
+ content:
+ text/plain:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict
+ title: Conflict
+ status: 409
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) existiert
+ bereits.
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict
+ title: Conflict
+ status: 409
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) existiert
+ bereits.
+ text/json:
+ schema:
+ $ref: "#/components/schemas/Contract_FailInfo"
+ example:
+ type: https://datatracker.ietf.org/doc/html/rfc9110#name-409-conflict
+ title: Conflict
+ status: 409
+ detail: Eine Datei mit dem angegebenen Identifikator (GUID) existiert
+ bereits.
+components:
+ schemas:
+ Contract_FailInfo:
+ type: object
+ properties:
+ type:
+ type: string
+ description: "Ein URI-Verweis [RFC3986], der den Problemtyp identifiziert.\
+ \ Er sollte ggf. auf eine menschenlesbare Dokumentation\r\ndes Problemtyps\
+ \ verweisen (z. B. unter Verwendung von HTML [W3C.REC-html5-20141028]).\r\
+ \nWenn dieses Element nicht vorhanden ist, wird der Wert als \"about:blank\"\
+ \ angenommen."
+ nullable: true
+ example: https://tools.ietf.org/html/rfc7231#section-6.5.1
+ title:
+ type: string
+ description: "Eine kurze, menschenlesbare Zusammenfassung des Problemtyps.\r\
+ \nEs SOLLTE SICH NICHT von Auftreten zu Auftreten des Problems ändern,\r\
+ \naußer zu Lokalisierungszwecken (z. B. mithilfe proaktiver Inhaltsaushandlung;\
+ \ siehe[RFC7231], Abschnitt 3.4)."
+ nullable: true
+ example: Bad Request
+ status:
+ type: integer
+ description: "Der HTTP-Statuscode([RFC7231], Abschnitt 6), der vom Ursprungsserver\
+ \ für dieses Auftreten des Problems generiert wurde."
+ format: int32
+ example: 400
+ detail:
+ type: string
+ description: "Eine menschenlesbare Erklärung, die für dieses Auftreten des\
+ \ Problems spezifisch ist.<br/><br/>\n Enthält auch Angaben über Exceptions\n\
+ \ "
+ nullable: true
+ example: Die Datei ist von einem Virus befallen.
+ instance:
+ type: string
+ description: "Ein URI-Verweis, der das spezifische Auftreten des Problems\
+ \ identifiziert. Er kann auf weitere Informationen verweisen."
+ nullable: true
+ example: null
+ synopsis:
+ type: string
+ description: Zusammenfassung
+ nullable: true
+ deprecated: true
+ code:
+ type: integer
+ description: Status-Code
+ format: int32
+ deprecated: true
+ details:
+ type: string
+ description: Merkmale
+ nullable: true
+ deprecated: true
+ typeName:
+ type: string
+ description: Typname der Exception
+ nullable: true
+ deprecated: true
+ innerTypeName:
+ type: string
+ description: Typname der inneren Exception
+ nullable: true
+ deprecated: true
+ id:
+ type: string
+ description: Relevnz Id
+ nullable: true
+ deprecated: true
+ additionalProperties: false
+ description: "Fehlerinformationen<br/><br/>\n Ursprünglich wurde die `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo`-Klasse\
+ \ verwendet, um im Fehlerfall zusätzliche Informationen zu übermitteln.\n\
+ \ Außerdem wurde diese Klasse auch verwendet, um sie mithilfe von `WebApiStartup.UseApiFailCustomization`\
+ \ beim Auftreten bestimmter Exceptions richtig zu befüllen.\n \n Seit ASP.NET\
+ \ Core 2.1 ist für Response-Objekte im Fehlerfall die Klasse `Microsoft.AspNetCore.Mvc.ProblemDetails`\
+ \ vorgesehen und sollte auch hierzu verwendet werden. Wenn man das für bestehende\
+ \ Endpunkte macht, bricht dies den Kontrakt und die Schnittstelle muss versioniert\
+ \ werden. Möchte man einen solchen Bruch vermeiden, kann man in der Übergangszeit\
+ \ bis zur neuen Kontraktversion diese Klasse weiter für das Response-Objekt\
+ \ verwenden.Für dieses Szenario wurde diese Klasse um die Properties von `Microsoft.AspNetCore.Mvc.ProblemDetails`\
+ \ erweitert, sodass der Client-Code bereits die neuen Felder verwenden kann.\
+ \ Bis auf `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Detail`/`Dataport.OSP.Postfach.Common.Utility.Contract.StatusInfo.Details`\
+ \ sind die ProblemDetails-Properties Aliase ihrer Legacy-Pendants, d.h. man\
+ \ kann z.B. in `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Title`\
+ \ einen Wert speichern und diesen sowohl in `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Title`\
+ \ als auch in `Dataport.OSP.Postfach.Common.Utility.Contract.StatusInfo.Synopsis`\
+ \ wieder auslesen. Die neue Property `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.Detail`\
+ \ gibt allerdings ggf. neben dem Wert `Dataport.OSP.Postfach.Common.Utility.Contract.StatusInfo.Details`\
+ \ auch die Werte `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.TypeName`\
+ \ und `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.InnerTypeName`\
+ \ der Legacy-Schnittstelle wieder. Das Setzen von Fehlerinformationen auf\
+ \ der Grundlage einer Exception sollte daher über die Methode `Dataport.OSP.Postfach.Common.Utility.Contract.FailInfo.SetException(System.Exception)`\
+ \ erfolgen. Die komplette Zukunfts-Schnittstelle wird durch `Dataport.OSP.Postfach.Common.Utility.Contract.Interface.IFailInfo`\
+ \ beschrieben."
+ example:
+ Type: https://tools.ietf.org/html/rfc7231#section-6.5.1
+ Title: Bad Request
+ Status: 400
+ Detail: Der Betreff darf nicht leer sein.
+ DTO_MailboxScopeData:
+ type: object
+ properties:
+ membershipcontext:
+ type: string
+ description: Zugehörigkeitskontext zu Person oder zu Gruppe
+ format: uuid
+ memberscope:
+ type: array
+ items:
+ $ref: "#/components/schemas/Mddi_MailboxIndexData"
+ description: Mitglider der Gruppe
+ nullable: true
+ additionalProperties: false
+ description: Postfach-Umfang Contract
+ Domain_ChunkMetaData:
+ type: object
+ properties:
+ uploadUid:
+ type: string
+ description: "Identifikator der Datei<br/><br/>\n Dieser Identifikator ist\
+ \ vom Aufrufer für den Upload neu zu erstellen (`Guid.NewGuid`).\n "
+ format: uuid
+ fileName:
+ type: string
+ description: Name der Datei
+ nullable: true
+ example: hello.txt
+ contentType:
+ type: string
+ description: MIME-Type der Datei
+ nullable: true
+ example: text/plain
+ chunkIndex:
+ type: integer
+ description: 0-basierter Index des Chunks
+ format: int32
+ totalChunks:
+ type: integer
+ description: Gesamtzahl der Chunks
+ format: int32
+ example: 1
+ totalFileSize:
+ type: integer
+ description: Dateigröße in Bytes
+ format: int64
+ example: 12
+ target:
+ $ref: "#/components/schemas/V1_FilestorageTarget"
+ additionalProperties: false
+ description: Metadaten für den Chunk-Upload (`Domain_ChunkMetaData` im Swagger-Schema)
+ Mddi_MailboxIndexData:
+ type: object
+ properties:
+ tenant:
+ type: string
+ description: Postfach-Guid
+ nullable: true
+ mailboxguid:
+ type: string
+ description: Postfach-Guid
+ format: uuid
+ mailboxname:
+ type: string
+ description: Postfach-Guid
+ nullable: true
+ mailboxdescription:
+ type: string
+ description: Postfach-Bescreibung
+ nullable: true
+ mailboxtype:
+ $ref: "#/components/schemas/Mddi_MailboxType"
+ additionalProperties: false
+ Mddi_MailboxType:
+ enum:
+ - Unknown
+ - Personal
+ - Functional
+ type: string
+ description: "Typ des Postfachs</p><table><tr><td>Unknown</td><td>Unbekannt\
+ \ (Defaultwert, der niemals erreicht werden darf)</td></tr> <tr><td>Personal</td><td>Persö\
+ nliches Postfach</td></tr> <tr><td>Functional</td><td>Funktionspostfach</td></tr>\
+ \ </table><p>"
+ MessageExchange_DeleteMessageResponse:
+ type: object
+ properties:
+ messageId:
+ type: string
+ description: "Id der Nachricht, die gelöscht werden soll"
+ format: uuid
+ additionalProperties: false
+ description: Antwort auf den Löschvorgang einer Nachricht
+ MessageExchange_Files:
+ type: object
+ properties:
+ guid:
+ type: string
+ description: Identifikator der Datei
+ format: uuid
+ example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
+ name:
+ type: string
+ description: Name der Datei
+ nullable: true
+ example: hello.txt
+ mimeType:
+ type: string
+ description: MIME-Type der Datei
+ nullable: true
+ example: text/plain
+ isOriginalMessage:
+ type: boolean
+ description: Beinhaltet die Datei Original Nachrichtenelemente?
+ size:
+ type: integer
+ description: Größe der Datei in Bytes
+ format: int64
+ example: 12
+ additionalProperties: false
+ description: Daten zu einem Dateianhang
+ MessageExchange_MessageStatusInquiryResponse:
+ type: object
+ properties:
+ messageId:
+ type: string
+ description: Identifikator der Nachricht in OSI
+ format: uuid
+ responseStatus:
+ $ref: "#/components/schemas/MessageExchange_ResponseStatusEnum"
+ responseSubStatus:
+ $ref: "#/components/schemas/MessageExchange_ResponseSubStatusEnum"
+ responseMessage:
+ type: string
+ description: "Rückmeldung des Systems, das den Status produziert hat (z.B.\
+ \ Validierungsfehler von einem externen System wie MUK)"
+ nullable: true
+ target:
+ $ref: "#/components/schemas/MessageExchange_MessageType"
+ responseTime:
+ type: string
+ description: Zeitpunkt der Erhebung des Status
+ format: date-time
+ nullable: true
+ retryCounter:
+ type: integer
+ description: Wie oft dieser Status für die Nachricht vorher schon abgefragt
+ wurde
+ format: int32
+ timeOfMessageRetrieval:
+ type: string
+ description: "Zeitpunkt (Datum und Uhrzeit) des Dokumentenabrufs durch den\
+ \ Empfänger, sofern bereits abgerufen und bekannt ist"
+ format: date-time
+ nullable: true
+ additionalProperties: false
+ description: Antwort einer Statusabfrage
+ MessageExchange_MessageType:
+ enum:
+ - Unknown
+ - Internal
+ - InterOp
+ - BundIdPok
+ - MukEp2
+ type: string
+ description: Message Typ</p><table><tr><td>Unknown</td><td>Unbekannt</td></tr>
+ <tr><td>Internal</td><td>OSI-Postfach im eigenen Mandanten</td></tr> <tr><td>InterOp</td><td>OSI-Postfach
+ im fremden Mandanten</td></tr> <tr><td>BundIdPok</td><td>Bund ID Postkorb</td></tr>
+ <tr><td>MukEp2</td><td>MUK Elster-Postfach 2.0</td></tr> </table><p>
+ MessageExchange_ReceiveAttachment:
+ type: object
+ properties:
+ guid:
+ type: string
+ description: Guid des Anhangs
+ format: uuid
+ additionalProperties: false
+ description: Anhänge (erhalten)
+ MessageExchange_ReceiveMessage:
+ type: object
+ properties:
+ guid:
+ type: string
+ format: uuid
+ attachments:
+ type: array
+ items:
+ $ref: "#/components/schemas/MessageExchange_ReceiveAttachment"
+ description: Anhänge
+ nullable: true
+ additionalProperties: false
+ description: ReceiveMessage
+ MessageExchange_ReceiveMessagesResponse:
+ type: object
+ properties:
+ messages:
+ type: array
+ items:
+ $ref: "#/components/schemas/MessageExchange_ReceiveMessage"
+ description: Liste mit Nachrichten
+ nullable: true
+ message:
+ type: string
+ description: Nachricht
+ nullable: true
+ additionalProperties: false
+ description: "ReceiveMessages Antwort (Kontext: OD fragt Nachrichten ab)"
+ MessageExchange_ResponseStatus:
+ enum:
+ - Ok
+ - Authentication
+ - Internal
+ - Request
+ type: string
+ description: MessageStatus der Antwort</p><table><tr><td>Ok</td><td>Die Nachricht
+ wurde gesendet.</td></tr> <tr><td>Authentication</td><td>Es ist ein Authentifizierungsfehler
+ aufgetreten.</td></tr> <tr><td>Internal</td><td>Es ist ein interner Fehler
+ aufgetreten.</td></tr> <tr><td>Request</td><td>Es ist ein Request-Fehler aufgetreten.</td></tr>
+ </table><p>
+ MessageExchange_ResponseStatusEnum:
+ enum:
+ - Unknown
+ - Scheduled
+ - Accepted
+ - NotAccepted
+ - Confirmed
+ - NotConfirmed
+ - Displayed
+ - Read
+ - Deleted
+ type: string
+ description: "Hauptstatus der Postfach-Nachricht<br/><br/>\n Eine Postfach-Nachricht\
+ \ durchläuft folgende Stufen:\n \n |Stufe |Erklärung |\n |---------------|-------------------------------------------------------------------------------------------------|\n\
+ \ |Einlieferung |Durch den Send-Befehl wird die Nachricht bei OSI eingeliefert.\
+ \ |\n |Zwischensystem |Im Falle der BundID wird die Nachricht zunächst an\
+ \ ein Zwischensystem (ETR) geschickt. |\n |Zielsystem |Die Nachricht wird\
+ \ an das Zielsystem (OSI, BundID, MUK) gesendet. |\n |Feedback |Einige Zielsysteme\
+ \ können Auskunft darüber geben, ob die Nachricht angezeigt oder gelesen wurde.\
+ \ |\n \n \n Jede Stufe hat zugehörige Statuswerte.\n </p><table><tr><td>Unknown</td><td>Unbekannt</td></tr>\
+ \ <tr><td>Scheduled</td><td>Bei OSI eingeliefert</td></tr> <tr><td>Accepted</td><td>In\
+ \ Zwischensystem übertragen</td></tr> <tr><td>NotAccepted</td><td>Übertragung\
+ \ ins Zwischensystem gescheitert</td></tr> <tr><td>Confirmed</td><td>In Zielsystem\
+ \ übertragen</td></tr> <tr><td>NotConfirmed</td><td>Übertragung ins Zielsystem\
+ \ gescheitert</td></tr> <tr><td>Displayed</td><td>Dem Empfänger angezeigt</td></tr>\
+ \ <tr><td>Read</td><td>Vom Empfänger gelesen</td></tr> <tr><td>Deleted</td><td>Gelö\
+ scht</td></tr> </table><p>"
+ MessageExchange_ResponseSubStatusEnum:
+ enum:
+ - InInternerVerarbeitung
+ - EtrNotAccepted
+ - EtrAccepted
+ - EtrInBearbeitung
+ - EtrUebertragungsfehler
+ - EtrVersendet
+ - EtrEingestellt
+ - MukDatenFehlerhaft
+ - EtrBereitZurAbholung
+ - MukVomEmpfaengerAbgeholt
+ - EtrEingangBestaetigt
+ - MukGeloescht
+ - MukInternalError
+ - EtrUnbekannt
+ - PokSent
+ - PokNotSent
+ type: string
+ description: |-
+ Verarbeitungssubstatus der Postfach-Nachricht<br/><br/>
+ Der genutzte Adapter (OSI, Bund ID, MUK...) kann hiermit Status-Details liefern.
+ </p><table><tr><td>InInternerVerarbeitung</td><td>Nachricht wurde in Queue eingestellt, aber noch nicht an Etr oder BundId verschickt</td></tr> <tr><td>EtrNotAccepted</td><td>Konnte nicht zum ETR übertragen werden</td></tr> <tr><td>EtrAccepted</td><td>Zum ETR übertragen</td></tr> <tr><td>EtrInBearbeitung</td><td>ETR meldet: Initialer Status bei neu angelegten Aufträgen.</td></tr> <tr><td>EtrUebertragungsfehler</td><td>ETR meldet: Es ist ein technischer Fehler aufgetreten.</td></tr> <tr><td>EtrVersendet</td><td>ETR meldet: Die Nachricht wurde erfolgreich an ELSTER übermittelt. Ein Status wurde noch nicht erzeugt.</td></tr> <tr><td>EtrEingestellt</td><td>ETR meldet: Die Nachricht wurde eingestellt, die Benachrichtigung an den Empfänger wurde jedoch noch nicht zugestellt.</td></tr> <tr><td>MukDatenFehlerhaft</td><td>MUK meldet: Die Daten konnten aufgrund eines Fehlers nicht an den Empfänger bereitgestellt werden. Mögliche Gründe: Datei invalide, Dateiformat passt nicht zur Dateinamenerweiterung, Virenfund.</td></tr> <tr><td>EtrBereitZurAbholung</td><td>ETR meldet: Die Nachricht wurde an den Empfänger bereitgestellt. Die Benachrichtigung an den Empfänger ist erfolgt.</td></tr> <tr><td>MukVomEmpfaengerAbgeholt</td><td>MUK meldet: Die Nachricht wurde vom Empfänger abgeholt.</td></tr> <tr><td>EtrEingangBestaetigt</td><td>ETR meldet: Die Anwendung des Empfängers hat die Abholung bestätigt.</td></tr> <tr><td>MukGeloescht</td><td>MUK meldet: Die Nachricht wurde aus dem Postfach gelöscht.</td></tr> <tr><td>MukInternalError</td><td>MUK meldet: Es kam zu einem internen Fehler.</td></tr> <tr><td>EtrUnbekannt</td><td>ETR meldet: Die Bereitstellung konnte nicht im System gefunden werden.</td></tr> <tr><td>PokSent</td><td>BundID Postkorb meldet: Die Nachricht wurde erfolgreich an die Bund ID versendet.</td></tr> <tr><td>PokNotSent</td><td>BundID Postkorb meldet: Die Nachricht konnte nicht an die Bund ID versendet werden.</td></tr> </table><p>
+ MessageExchange_SendMessageResponse:
+ type: object
+ properties:
+ messageId:
+ type: string
+ description: Identifikator der Nachricht
+ format: uuid
+ message:
+ type: string
+ description: Fehlernachricht
+ nullable: true
+ status:
+ $ref: "#/components/schemas/MessageExchange_ResponseStatus"
+ additionalProperties: false
+ description: Antwort auf die Sendeanforderung
+ Mvc_ProblemDetails:
+ type: object
+ properties:
+ type:
+ type: string
+ description: "Ein URI-Verweis [RFC3986], der den Problemtyp identifiziert.\
+ \ Er sollte ggf. auf eine menschenlesbare Dokumentation des Problemtyps\
+ \ verweisen (z. B. unter Verwendung von HTML [W3C.REC-html5-20141028]).\
+ \ Wenn dieses Element nicht vorhanden ist, wird der Wert als \"about:blank\"\
+ \ angenommen."
+ nullable: true
+ example: https://tools.ietf.org/html/rfc7231#section-6.5.1
+ title:
+ type: string
+ description: "Eine kurze, menschenlesbare Zusammenfassung des Problemtyps.\
+ \ Es SOLLTE SICH NICHT von Auftreten zu Auftreten des Problems ändern,\
+ \ außer zu Lokalisierungszwecken (z. B. mithilfe proaktiver Inhaltsaushandlung;\
+ \ siehe[RFC7231], Abschnitt 3.4)."
+ nullable: true
+ example: Bad Request
+ status:
+ type: integer
+ description: "Der HTTP-Statuscode([RFC7231], Abschnitt 6), der vom Ursprungsserver\
+ \ für dieses Auftreten des Problems generiert wurde."
+ format: int32
+ nullable: true
+ example: 400
+ detail:
+ type: string
+ description: "Eine menschenlesbare Erklärung, die für dieses Auftreten des\
+ \ Problems spezifisch ist."
+ nullable: true
+ example: Die Datei ist von einem Virus befallen.
+ instance:
+ type: string
+ description: "Ein URI-Verweis, der das spezifische Auftreten des Problems\
+ \ identifiziert. Er kann auf weitere Informationen verweisen."
+ nullable: true
+ example: null
+ additionalProperties: false
+ description: Ein maschinenlesbares Format zum Angeben von Fehlern in HTTP-API-Antworten
+ basierend auf https://tools.ietf.org/html/rfc7807
+ example:
+ type: https://tools.ietf.org/html/rfc7231#section-6.5.1
+ title: Bad Request
+ status: 400
+ detail: Der Betreff darf nicht leer sein.
+ Out_SendMessageRequestV2:
+ type: object
+ properties:
+ sequencenumber:
+ type: string
+ description: "Die fachliche Vorgangsnummer.<br/><br/>\n Zu einem Vorgang\
+ \ kann es mehrere Nachrichten geben. (max. 256 Zeichen)\n "
+ nullable: true
+ subject:
+ type: string
+ description: "Betreff der Nachricht<br/><br/>\n (max. 255 Zeichen)\n "
+ nullable: true
+ body:
+ type: string
+ description: "Nachrichtentext<br/><br/>\n Dies ist entweder ein einfacher\
+ \ Text oder ein HTML-Text (s. Parameter `isHtml`).\n (max. 400000 Zeichen)\n\
+ \ "
+ nullable: true
+ displayName:
+ type: string
+ description: Anzeigename des Absenders
+ nullable: true
+ originSender:
+ type: string
+ description: "Technischer Absender<br/><br/>\n Dies ist entweder eine Postfachreferenz\
+ \ oder die GUID eines lokalen OSI-Postfachs.\n "
+ nullable: true
+ replyAction:
+ $ref: "#/components/schemas/V1_ReplyBehavior"
+ eidasLevel:
+ $ref: "#/components/schemas/V1_EidasLevel"
+ isObligatory:
+ type: boolean
+ description: Ist die Nachricht rechtlich verbindlich?
+ isHtml:
+ type: boolean
+ description: Ist die Nachricht eine HTML-Nachricht?
+ files:
+ type: array
+ items:
+ $ref: "#/components/schemas/MessageExchange_Files"
+ description: "Anhänge zur Nachricht<br/><br/>\n Die Anhänge müssen zuvor\
+ \ hochgeladen worden sein und dürfen nur in dieser Nachricht verwendet\
+ \ werden. (max. 100 Anhänge)\n "
+ nullable: true
+ references:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_References"
+ description: "Referenzen zur Nachricht<br/><br/>\n (max. 100 Referenzen)\n\
+ \ "
+ nullable: true
+ additionalProperties: false
+ description: Daten der zu sendenden Nachricht
+ Postfach_Eidas:
+ enum:
+ - Undefined
+ - Low
+ - Substantial
+ - High
+ type: string
+ description: Eidas</p><table><tr><td>Undefined</td><td>AuthNiveau Undefinded</td></tr>
+ <tr><td>Low</td><td>AuthNiveau Low</td></tr> <tr><td>Substantial</td><td>AuthNiveau
+ Substanziell</td></tr> <tr><td>High</td><td>AuthNiveau High</td></tr> </table><p>
+ Postfach_Mail:
+ type: object
+ properties:
+ mailHeader:
+ $ref: "#/components/schemas/Postfach_MailHeader"
+ linkToBody:
+ type: string
+ description: ""
+ nullable: true
+ additionalProperties: false
+ description: ""
+ Postfach_MailHeader:
+ type: object
+ properties:
+ replyAction:
+ $ref: "#/components/schemas/Postfach_ReplyBehaviour"
+ sender:
+ type: string
+ description: Anzeigename für den Absender einer Nachricht.
+ nullable: true
+ recipient:
+ type: string
+ description: Anzeigename für den Empfänger einer Nachricht
+ nullable: true
+ processDate:
+ type: string
+ description: |-
+ Verarbeitungsdatum der Nachricht im System.<br/><br/>Wird auf NOW gesetzt, sobald die Nachricht eines Konsumenten der SOAP-Schnittstelle ins
+ Postfach eingereicht oder aus der Warteschlange ausgelesen wird.
+ format: date-time
+ statedDate:
+ type: string
+ description: Vom Einreichenden angegebenes Datum. Kann von Konsumenten der
+ SOAP-Schnittstelle gesetzt werden.
+ format: date-time
+ nullable: true
+ subject:
+ type: string
+ description: Betreff.
+ nullable: true
+ sequenceNumber:
+ type: string
+ description: "Vorgangsnummer, zu der die Nachricht gehört."
+ nullable: true
+ isRead:
+ type: boolean
+ description: "Zeigt an, ob die Nachricht bereits gelesen wurden."
+ isObligatory:
+ type: boolean
+ description: "Zeigt an, ob die Nachricht rechtsverbindlich ist."
+ countConversation:
+ type: integer
+ description: Wieviele Nachrichten sind innerhalb des Vorgangs?
+ format: int32
+ hasAttachments:
+ type: boolean
+ description: "Zeigt an, ob zu der Vorgangsnummer vorherige Nachrichten existieren."
+ isReply:
+ type: boolean
+ description: "Zeigt an, ob zu der Vorgangsnummer vorherige Nachrichten existieren."
+ eidas:
+ $ref: "#/components/schemas/Postfach_Eidas"
+ isAuthorized:
+ type: boolean
+ description: "Reicht das Auth Niveau des User aus, um die Nachricht zu lesen"
+ references:
+ type: array
+ items:
+ $ref: "#/components/schemas/Postfach_Reference"
+ description: Liste der Deeplink Referenzen
+ nullable: true
+ guid:
+ type: string
+ description: ""
+ format: uuid
+ additionalProperties: false
+ description: DTO für Nachrichten-Header (also ohne Body und Historie).
+ Postfach_Reference:
+ type: object
+ properties:
+ referenceUrl:
+ type: string
+ description: Url des Deeplinks
+ nullable: true
+ referenceText:
+ type: string
+ description: Text des Deeplinks
+ nullable: true
+ referenceSeverity:
+ $ref: "#/components/schemas/Postfach_SeverityType"
+ referenceTitle:
+ type: string
+ description: Titel der Reference
+ nullable: true
+ additionalProperties: false
+ description: Dtoklasse für Deeplinks
+ Postfach_ReplyBehaviour:
+ enum:
+ - ReplyPossible
+ - ReplyRequired
+ - ReplyForbidden
+ type: string
+ description: Art der Antwortmöglichkeit.</p><table><tr><td>ReplyPossible</td><td>Antwort
+ erlaubt.</td></tr> <tr><td>ReplyRequired</td><td>Antwort erforderlich.</td></tr>
+ <tr><td>ReplyForbidden</td><td>Antwort verboten.</td></tr> </table><p>
+ Postfach_SeverityType:
+ enum:
+ - Low
+ - Medium
+ - High
+ type: string
+ description: Bestimmt den Grad der Severity</p><table><tr><td>Low</td><td>Grün
+ Meldung</td></tr> <tr><td>Medium</td><td>Gelbe Meldung</td></tr> <tr><td>High</td><td>Rote
+ Meldung</td></tr> </table><p>
+ Quarantine_FileResult:
+ type: object
+ properties:
+ uploaded:
+ type: boolean
+ description: uploaded
+ fileUid:
+ type: string
+ description: fileUid
+ nullable: true
+ success:
+ type: boolean
+ description: success
+ error:
+ type: string
+ description: error
+ nullable: true
+ additionalProperties: false
+ Quarantine_Status:
+ enum:
+ - None
+ - Legacy
+ - Safe
+ - Unsafe
+ - Commited
+ - Corrupt
+ - Missing
+ type: string
+ description: Status der Virenprüfung</p><table><tr><td>None</td><td>None</td></tr>
+ <tr><td>Legacy</td><td>Noch nicht geprüft</td></tr> <tr><td>Safe</td><td>Sicher</td></tr>
+ <tr><td>Unsafe</td><td>Unsicher</td></tr> <tr><td>Commited</td><td>Commited</td></tr>
+ <tr><td>Corrupt</td><td>Beschädigt</td></tr> <tr><td>Missing</td><td>Nicht
+ vorhanden</td></tr> </table><p>
+ Responses_CheckUploadResponse:
+ type: object
+ properties:
+ fileName:
+ type: string
+ description: Name der Datei
+ nullable: true
+ contentType:
+ type: string
+ description: MIME-Type der Datei
+ nullable: true
+ fileSize:
+ type: integer
+ description: Größe der Datei
+ format: int64
+ storages:
+ $ref: "#/components/schemas/Responses_Storages"
+ additionalProperties: false
+ description: "Response-Objekt für den CheckUpload-Aufruf<br/><br/>\n `filename`,\
+ \ `contentType` und `fileSize` werden nur angegeben, wenn die Datei noch im\
+ \ Upload-Bereich ist (bis zu 2 Stunden nach Upload). Die Datei kann aus den\
+ \ angegebenen `storages` abgerufen werden.\n "
+ Responses_ExpirationDateDto:
+ type: object
+ properties:
+ expirationDate:
+ type: string
+ description: |-
+ Verfallsdatum der Datei (Default: nach Standard-Verfallszeit)<br/><br/>Wenn hier `null` angegeben wird, gilt die im System definierte Standard-Verfallszeit.Die Zeit wird an der REST-Schnittstelle incl. Zeitzoneninformation entgegengenommen und entsprechend verarbeitet.
+ Eine Zeit ohne Zeitzonenangabe (sog. unspezifizierte Zeit) wird als lokale (deutsche) Zeit interpretiert.
+ format: date-time
+ nullable: true
+ additionalProperties: false
+ description: |-
+ Ein serialiserbares Objekt für das Verfallsdatum<br/><br/>Wenn für das Verfallsdatum `null` angegeben wird, gilt die im System definierte Standard-Verfallszeit.Die Zeit wird an der REST-Schnittstelle incl. Zeitzoneninformation entgegengenommen und entsprechend verarbeitet.
+ Eine Zeit ohne Zeitzonenangabe (sog. unspezifizierte Zeit) wird als lokale (deutsche) Zeit interpretiert.
+ Responses_FilestoragePayloadContent:
+ type: object
+ properties:
+ guid:
+ type: string
+ description: Identifikator der Datei
+ format: uuid
+ isDisposable:
+ type: boolean
+ description: Ob ein Dateiinhalt vorhanden ist
+ isApproved:
+ type: boolean
+ description: Ob der Inhalt der Datei valide ist
+ isEnclosed:
+ type: boolean
+ description: Ob der Inhalt in <see cref="P:Dataport.OSP.Postfach.Application.Facade.Model.Responses.FilestoragePayloadContent.Content">`content`</see>
+ enthalten ist
+ readOnly: true
+ features:
+ type: object
+ additionalProperties:
+ type: string
+ description: Zusätzliche Features/Attribute des Inhaltes
+ nullable: true
+ content:
+ type: string
+ description: Inhalt
+ format: byte
+ nullable: true
+ additionalProperties: false
+ description: Inhalt des Filestorage Payloads
+ Responses_MailboxDirectoryResponse:
+ required:
+ - meta
+ type: object
+ properties:
+ mailBoxIndex:
+ type: array
+ items:
+ $ref: "#/components/schemas/DTO_MailboxScopeData"
+ description: MailboxIndex
+ nullable: true
+ meta:
+ $ref: "#/components/schemas/V1_Meta"
+ warnings:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_AlertMessage"
+ description: Warnings
+ nullable: true
+ errors:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_AlertMessage"
+ description: Errors
+ nullable: true
+ additionalProperties: false
+ description: MailboxDirectoryResponse
+ Responses_MailboxResponse:
+ required:
+ - meta
+ type: object
+ properties:
+ unreadMessages:
+ type: string
+ description: ungelesene Nachrichten
+ nullable: true
+ mails:
+ type: array
+ items:
+ $ref: "#/components/schemas/Postfach_Mail"
+ description: Mails
+ nullable: true
+ status:
+ type: string
+ description: Stati
+ nullable: true
+ messageId:
+ type: string
+ description: MessageId
+ nullable: true
+ meta:
+ $ref: "#/components/schemas/V1_Meta"
+ warnings:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_AlertMessage"
+ description: Warnings
+ nullable: true
+ errors:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_AlertMessage"
+ description: Errors
+ nullable: true
+ additionalProperties: false
+ description: MailboxResponse
+ Responses_Storages:
+ enum:
+ - None
+ - QFS
+ - ODFS
+ - PFFS
+ - UndeterminableInQFS
+ - UndeterminableInODFS
+ - UndeterminableInPFFS
+ type: string
+ description: Menge von Storages</p><table><tr><td>None</td><td>Kein Storage</td></tr>
+ <tr><td>QFS</td><td>Quarantine Filestorage</td></tr> <tr><td>ODFS</td><td>Onlinedienst
+ Filestorage</td></tr> <tr><td>PFFS</td><td>Postfach Filestorage</td></tr>
+ <tr><td>UndeterminableInQFS</td><td>Status im Quarantine Filestorage kann
+ nicht ermittelt werden</td></tr> <tr><td>UndeterminableInODFS</td><td>Status
+ im Onlinedienst Filestorage kann nicht ermittelt werden</td></tr> <tr><td>UndeterminableInPFFS</td><td>Status
+ im Postfach Filestorage kann nicht ermittelt werden</td></tr> </table><p>
+ Responses_UploadResponse:
+ type: object
+ properties:
+ uploadId:
+ type: string
+ description: Identifikator des Uploads
+ format: uuid
+ additionalProperties: false
+ description: Response-Objekt für den (ersten) Upload-Aufruf
+ V1_AlertMessage:
+ type: object
+ properties:
+ message:
+ type: string
+ description: ""
+ nullable: true
+ code:
+ type: string
+ description: ""
+ nullable: true
+ description:
+ type: string
+ description: ""
+ nullable: true
+ additionalProperties: false
+ description: ""
+ V1_EidasLevel:
+ enum:
+ - Low
+ - Medium
+ - High
+ type: string
+ description: Sicherheitsstufe für die Nachricht</p><table><tr><td>Low</td><td>Niedrig</td></tr>
+ <tr><td>Medium</td><td>Mittel</td></tr> <tr><td>High</td><td>Hoch</td></tr>
+ </table><p>
+ V1_FilestorageTarget:
+ enum:
+ - Unspecified
+ - ODFS
+ - PFFS
+ type: string
+ description: "Definiert, ob und in welchen Ziel-Filestorage ein Upload automatisch\
+ \ verschoben werden soll.</p><table><tr><td>Unspecified</td><td>Es ist kein\
+ \ Ziel-Filestorage spezifiziert und es findet kein automatischer Verschub\
+ \ statt. Die Datei muss explizit in den Ziel-Filestorage gepullt werden.</td></tr>\
+ \ <tr><td>ODFS</td><td>Es soll in den OD-Filestorage verschoben werden.</td></tr>\
+ \ <tr><td>PFFS</td><td>Es soll in den Postfach-Filestorage verschoben werden.</td></tr>\
+ \ </table><p>"
+ V1_MailboxType:
+ enum:
+ - Inbox
+ - Sent
+ - Trash
+ type: string
+ description: Postfach Typ</p><table><tr><td>Inbox</td><td>Eingangs-Ordner.</td></tr>
+ <tr><td>Sent</td><td>Gesendet-Ordner.</td></tr> <tr><td>Trash</td><td>Papierkorb.</td></tr>
+ </table><p>
+ V1_Meta:
+ type: object
+ properties:
+ correlationId:
+ type: string
+ description: ""
+ nullable: true
+ serviceCode:
+ type: string
+ description: ""
+ nullable: true
+ serviceDescription:
+ type: string
+ nullable: true
+ additionalProperties: false
+ description: Meta info in response
+ V1_References:
+ type: object
+ properties:
+ url:
+ type: string
+ description: URL zur Referenz
+ nullable: true
+ text:
+ type: string
+ description: "Der Anzeigetext<br/><br/>\n Dieser Text dient als Repräsentation\
+ \ für die URL.\n "
+ nullable: true
+ severity:
+ $ref: "#/components/schemas/V1_SeverityLevel"
+ title:
+ type: string
+ description: "Informationstext, der zur Referenz angezeigt wird"
+ nullable: true
+ additionalProperties: false
+ description: Referenz zur Nachricht
+ V1_ReplyBehavior:
+ enum:
+ - Replypossible
+ - Replymandatory
+ - Replyforbidden
+ type: string
+ description: Antwortverhalten</p><table><tr><td>Replypossible</td><td>Antwort
+ erlaubt</td></tr> <tr><td>Replymandatory</td><td>Antwort erforderlich - User
+ kann die Nachricht nicht löschen</td></tr> <tr><td>Replyforbidden</td><td>Antwort
+ verboten</td></tr> </table><p>
+ V1_ReplyFiles:
+ type: object
+ properties:
+ guid:
+ type: string
+ description: Guid des Anhangs
+ format: uuid
+ name:
+ type: string
+ description: Name des Anhangs
+ nullable: true
+ mimeType:
+ type: string
+ description: Mime Typ des Anhangs
+ nullable: true
+ size:
+ type: integer
+ description: Größe des Anhangs
+ format: int64
+ additionalProperties: false
+ description: Anhänge der Antwort
+ V1_ReplyMessage:
+ type: object
+ properties:
+ sequencenumber:
+ type: string
+ description: Sequenznummer
+ nullable: true
+ subject:
+ type: string
+ description: Betreff
+ nullable: true
+ body:
+ type: string
+ description: Nachrichteninhalt
+ nullable: true
+ displayName:
+ type: string
+ description: Display- bzw. Service Name (Onlinedienst)
+ nullable: true
+ originSender:
+ type: string
+ description: Absender des Originalnachricht
+ nullable: true
+ replyAction:
+ $ref: "#/components/schemas/V1_ReplyBehavior"
+ eidasLevel:
+ $ref: "#/components/schemas/V1_EidasLevel"
+ isObligatory:
+ type: boolean
+ description: Rechtsverbindlichkeit
+ isHtml:
+ type: boolean
+ description: Html Nachricht (ja/nein)
+ files:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_ReplyFiles"
+ description: Anhänge
+ nullable: true
+ guid:
+ type: string
+ description: Guid der Antwortnachricht
+ format: uuid
+ messageBox:
+ type: string
+ description: Postfach (des Empfängers)
+ format: uuid
+ senderDisplayName:
+ type: string
+ description: Display- bzw. Service Name (Onlinedienst)
+ nullable: true
+ recipientDisplayName:
+ type: string
+ description: Empfänger Anzeigename
+ nullable: true
+ responseTime:
+ type: string
+ description: Antwortzeit
+ format: date-time
+ additionalProperties: false
+ description: Antwort Nachricht
+ V1_SendMessageWithAttachmentsRequest:
+ required:
+ - body
+ - subject
+ type: object
+ properties:
+ body:
+ minLength: 1
+ type: string
+ description: "Nachrichtentext; entweder als einfacher Text oder als HTML-Text\
+ \ (s. Parameter <see cref=\"P:Dataport.OSP.Postfach.Application.Facade.Model.Requests.Dto.In.V1.SendMessageWithAttachmentsRequest.IsHtml\"\
+ >`isHtml`</see>).<br/><br/>\n (max. 400000 Zeichen)\n "
+ example: Hello World!
+ subject:
+ minLength: 1
+ type: string
+ description: Betreff der Nachricht<br/><br/>(max. 255 Zeichen)
+ example: Mein Betreff
+ eidasLevel:
+ $ref: "#/components/schemas/V1_EidasLevel"
+ isHtml:
+ type: boolean
+ description: Ist die Nachricht eine HTML-Nachricht?
+ isObligatory:
+ type: boolean
+ description: Ist die Nachricht rechtlich verbindlich?
+ sequenceNumber:
+ type: string
+ description: "Die fachliche Vorgangsnummer.<br/><br/>\n Zu einem Vorgang\
+ \ kann es mehrere Nachrichten geben. (max. 256 Zeichen)\n "
+ nullable: true
+ replyAction:
+ $ref: "#/components/schemas/V1_ReplyBehavior"
+ displayName:
+ type: string
+ description: Anzeigename des Absenders
+ nullable: true
+ originSender:
+ type: string
+ description: "Technischer Absender<br/><br/>\n Dies ist entweder eine Postfachreferenz\
+ \ oder die GUID eines lokalen OSI-Postfachs.\n "
+ nullable: true
+ references:
+ type: array
+ items:
+ $ref: "#/components/schemas/V1_References"
+ description: "Referenzen zur Nachricht<br/><br/>\n (max. 100 Referenzen)\n\
+ \ "
+ nullable: true
+ additionalProperties: false
+ description: Requestobjekt für die Daten der Nachricht (`V1_SendMessageWithAttachmentsRequest`
+ im Swagger-Schema)
+ V1_SeverityLevel:
+ enum:
+ - Low
+ - Medium
+ - High
+ type: string
+ description: SeverityLevel</p><table><tr><td>Low</td><td>Low - wird grün angezeigt</td></tr>
+ <tr><td>Medium</td><td>Medium - wird gelb angezeigt</td></tr> <tr><td>High</td><td>High
+ - wird rot angezeigt</td></tr> </table><p>
+ securitySchemes:
+ OIDC:
+ type: openIdConnect
+ openIdConnectUrl: /Facade/WellKnownOpenidConfiguration
+security:
+- OIDC: []
+tags:
+- name: Filestorage
+ description: Der <i>Filestorage Controller</i> bietet eine Schnittstelle zum <i>Plattformdienst
+ Filestorage.</i>.
+- name: Mailbox
+ description: "Der <i>Mailbox Controller</i> stellt eine Schnittstelle bereit, um\
+ \ Nachrichten des eingeloggten Users auszulesen."
+- name: MailboxDirectory
+ description: Der <i>MailboxDirectory Controller</i> bietet Verzeichnisdienste für
+ die OSI-Postfächer.
+- name: Probe
+ description: "Der <i>Probe Controller</i> stellt eine interne Schnittstelle innerhalb\
+ \ der OSI-Plattform\r\nzur Überwachung der Facade-Instanz bereit."
+- name: MessageExchange
+ description: "Der <i>MessageExchange Controller</i> dient dem Senden, Lesen und\
+ \ Löschen von Postfach-Nachrichten."
+- name: Quarantine
+ description: Der <i>Quarantine-Controller</i> ermöglicht das Hochladen von Dateien
+ in die Quarantäne.
--
GitLab