{ "openapi": "3.1.0", "info": { "title": "MDT-API", "version": "v1", "description": "Mobile Dispatch Terminal. Generiert aus apidocs.md und der Routentabelle des Servers." }, "servers": [ { "url": "https://mdt.npdev.eu/api/v1" } ], "security": [ { "bearer": [] }, { "session": [], "guildHeader": [] } ], "tags": [ { "name": "Allgemein" }, { "name": "Statistik" }, { "name": "Leitstelle" }, { "name": "Administration" }, { "name": "Personalblatt" }, { "name": "Einsatzblatt" }, { "name": "Einrichtung" }, { "name": "Medic und InGame" }, { "name": "Kurse" }, { "name": "Kalender" }, { "name": "Schwarzes Brett" }, { "name": "Dokumente" }, { "name": "Listen" }, { "name": "Lager" }, { "name": "Versicherungen" }, { "name": "Postfach" }, { "name": "TV" }, { "name": "Websites" }, { "name": "KI" }, { "name": "Bürgerimport" }, { "name": "Plattform" }, { "name": "Globale Administration" }, { "name": "Dokumentation" } ], "paths": { "/access": { "get": { "operationId": "GET_access", "summary": "Zugriffsstatus und freigegebene Partnerbereiche", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "member", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/branding/{guildId}": { "get": { "operationId": "GET_branding_guildId", "summary": "Öffentliches Erscheinungsbild einer Instanz (inkl. modules und tabOrder )", "tags": [ "Allgemein" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/branding/{guildId}/icon.png": { "get": { "operationId": "GET_branding_guildId_icon_png", "summary": "Öffentliches Instanz-Icon", "tags": [ "Allgemein" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/dispatch": { "get": { "operationId": "GET_dispatch", "summary": "Leitstellenblatt im Browser (ohne Auth)", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "text/html": { "schema": { "type": "string" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null, "servers": [ { "url": "https://mdt.npdev.eu" } ] } }, "/emojis": { "get": { "operationId": "GET_emojis", "summary": "Auswählbare Server-Emojis der Instanz", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "member", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/emojis/{id}": { "get": { "operationId": "GET_emojis_id", "summary": "Bild eines Server-Emojis (Session-Cookie)", "tags": [ "Allgemein" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/emojis/sync": { "post": { "operationId": "POST_emojis_sync", "summary": "Server-Emojis sofort mit Discord abgleichen", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "emojis.sync", "x-mdt-topics": [ "emojis" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/health": { "get": { "operationId": "GET_health", "summary": "Statusprüfung (ohne Auth)", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/letterheads": { "get": { "operationId": "GET_letterheads", "summary": "Briefköpfe lesen", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.letterhead.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.letterhead.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_letterheads", "summary": "Briefkopf anlegen oder löschen", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.letterhead.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.letterhead.create", "x-mdt-audit": "letterhead.create", "x-mdt-topics": [ "letterheads" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/letterheads/{id}": { "patch": { "operationId": "PATCH_letterheads_id", "summary": "Briefkopf ändern", "tags": [ "Allgemein" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.letterhead.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.letterhead.edit", "x-mdt-audit": "letterhead.update", "x-mdt-topics": [ "letterheads" ], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_letterheads_id", "summary": "Briefkopf anlegen oder löschen", "tags": [ "Allgemein" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.letterhead.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.letterhead.delete", "x-mdt-audit": "letterhead.delete", "x-mdt-topics": [ "letterheads" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/letterheads/order": { "put": { "operationId": "PUT_letterheads_order", "summary": "Briefköpfe sortieren", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.letterhead.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.letterhead.edit", "x-mdt-audit": "letterhead.reorder", "x-mdt-topics": [ "letterheads" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/alarm": { "get": { "operationId": "GET_me_alarm", "summary": "Dashboard-, Alarm- und persönlichen Alarmstatus lesen", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "onDuty": { "type": "boolean", "description": "onDuty – ob die aufrufende Person eingestempelt ist." }, "alarms": { "type": "array", "description": "alarms – Rufzeichen aller Einheiten, deren aktueller Status in GET /admin/statuses alarm: true trägt.", "items": { "type": "string" } } } }, "example": { "onDuty": true, "alarms": [ "Adam-01" ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `timeclock.own.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "timeclock.own.use", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/clock-in": { "post": { "operationId": "POST_me_clock_in", "summary": "Selbst einstempeln", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `timeclock.own.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "timeclock.own.use", "x-mdt-audit": "shift.clock_in", "x-mdt-topics": [ "onDuty", "overview", "dispatchers", "alarm", "standby" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/clock-out": { "post": { "operationId": "POST_me_clock_out", "summary": "Selbst ausstempeln", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `timeclock.own.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "timeclock.own.use", "x-mdt-audit": "shift.clock_out", "x-mdt-topics": [ "onDuty", "overview", "dispatchers", "units", "alarm", "access", "einsatzEntries" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/dispatcher": { "put": { "operationId": "PUT_me_dispatcher", "summary": "Selbst als Leitstelle setzen", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `timeclock.own.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "timeclock.own.use", "x-mdt-audit": "dispatchers.self_set", "x-mdt-topics": [ "dispatchers", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/personal/activity": { "get": { "operationId": "GET_me_personal_activity", "summary": "Aktivität der eigenen Personalakte (nur Lesezugriff nötig)", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `personal.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "personal.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/personal/history": { "get": { "operationId": "GET_me_personal_history", "summary": "Verlauf der eigenen Personalakte (nur Lesezugriff nötig)", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `personal.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "personal.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/preferences": { "get": { "operationId": "GET_me_preferences", "summary": "Eigene Benutzereinstellungen (Darstellung, Alarmton, abbestellte DMs); jedes Mitglied, nur Sitzung", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "member", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_me_preferences", "summary": "Eigene Benutzereinstellungen ändern, Body { \"prefs\": { … } } ; zusammengeführt, null setzt einen Wert auf den Standard", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "member", "x-mdt-capability": null, "x-mdt-audit": "user.preferences_set", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/stats": { "get": { "operationId": "GET_me_stats", "summary": "Eigene Statistik (nur Lesezugriff nötig)", "tags": [ "Allgemein" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "detail", "in": "query", "required": false, "description": "Gilt für: Einzelstatistik, /me/stats", "schema": { "type": "boolean", "default": false } }, { "name": "charts", "in": "query", "required": false, "description": "Gilt für: Stats-JSON-Endpunkte", "schema": { "type": "boolean", "default": false } }, { "name": "maxPixels", "in": "query", "required": false, "description": "Ganzzahl ≥ 50000 · Gilt für: alle Diagramme", "schema": { "type": "integer", "default": 990000 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `timeclock.own.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "timeclock.own.use", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/me/unit-status": { "put": { "operationId": "PUT_me_unit_status", "summary": "Status einer selbst besetzten Einheit setzen, Body { \"callsign\", \"status\" } (nur Sitzung)", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `timeclock.own.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "timeclock.own.use", "x-mdt-audit": "unit.self_status", "x-mdt-topics": [ "units", "alarm" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/onboarding/{guildId}/seed": { "post": { "operationId": "POST_onboarding_guildId_seed", "summary": "Vorlagen für leere Bereiche anwenden", "tags": [ "Allgemein" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "onboarding.seed", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/onboarding/{guildId}/seedable": { "get": { "operationId": "GET_onboarding_guildId_seedable", "summary": "Leere Einrichtungsbereiche ermitteln", "tags": [ "Allgemein" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/uploads": { "get": { "operationId": "GET_uploads", "summary": "Eigene Uploads verwalten", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_uploads", "summary": "Bild als multipart/form-data (Feld file ) hochladen, höchstens 5 MB", "tags": [ "Allgemein" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "upload.create", "x-mdt-topics": [ "uploads" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/uploads/{id}": { "get": { "operationId": "GET_uploads_id", "summary": "Authentifiziertes Dokumentbild", "tags": [ "Allgemein" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_uploads_id", "summary": "Eigene Uploads verwalten", "tags": [ "Allgemein" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "upload.delete", "x-mdt-topics": [ "uploads" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/embed/chart/{token}.png": { "get": { "operationId": "GET_embed_chart_token_png", "summary": "Öffentlicher Einbett-Link eines Diagramms, der Token ist der Zugang (ohne Auth, außerhalb von /api/v1 )", "tags": [ "Statistik" ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Zufälliger Token aus dem Link", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null, "servers": [ { "url": "https://mdt.npdev.eu" } ] } }, "/stats/einsatz": { "get": { "operationId": "GET_stats_einsatz", "summary": "Einsatz-Kennzahlen im Zeitraum", "tags": [ "Statistik" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/filters": { "get": { "operationId": "GET_stats_filters", "summary": "Ränge und Organisationseinheiten für die Filter", "tags": [ "Statistik" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/heatmap": { "get": { "operationId": "GET_stats_heatmap", "summary": "Aktivitäts-Heatmap lesen, mit Unterbesetzung", "tags": [ "Statistik" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "rankId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "orgUnitId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "includeArchived", "in": "query", "required": false, "description": "Gilt für: Rangliste, Heatmap, Ranglisten-Diagramme", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/inactive": { "get": { "operationId": "GET_stats_inactive", "summary": "Aktive Mitarbeiter mit ihrer letzten Schicht", "tags": [ "Statistik" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "rankId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "orgUnitId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/leaderboard": { "get": { "operationId": "GET_stats_leaderboard", "summary": "Rangliste des Servers", "tags": [ "Statistik" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "compare", "in": "query", "required": false, "description": "Gilt für: Rangliste, Einzelstatistik", "schema": { "type": "boolean", "default": false } }, { "name": "rankId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "orgUnitId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "1–500 · Gilt für: Rangliste (JSON)", "schema": { "type": "integer", "default": 10 } }, { "name": "charts", "in": "query", "required": false, "description": "Gilt für: Stats-JSON-Endpunkte", "schema": { "type": "boolean", "default": false } }, { "name": "maxPixels", "in": "query", "required": false, "description": "Ganzzahl ≥ 50000 · Gilt für: alle Diagramme", "schema": { "type": "integer", "default": 990000 } }, { "name": "includeArchived", "in": "query", "required": false, "description": "Gilt für: Rangliste, Heatmap, Ranglisten-Diagramme", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string", "description": "period ist der ausgewertete Zeitraum-Typ, wie angefragt." }, "generatedAt": { "type": "string", "description": "generatedAt ist der Zeitpunkt der Berechnung.", "format": "date-time" }, "window": { "type": "object", "description": "window ist der tatsächlich ausgewertete Zeitraum (start ist null bei period=alltime) - halboffen, also start eingeschlossen und end nicht.", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "totals": { "type": "object", "description": "totals sind die Summen über alle Personen im Zeitraum.", "properties": { "totalMs": { "type": "number" }, "totalShifts": { "type": "number" }, "activeCount": { "type": "number" }, "totalBreakMs": { "type": "number" }, "autoClosedShifts": { "type": "number" } } }, "rows": { "type": "array", "description": "rows sind die Personen, absteigend nach totalMs sortiert und auf limit begrenzt.", "items": { "type": "object", "properties": { "userId": { "type": "string" }, "badgeNumber": { "type": "string" }, "nickname": { "type": "string" }, "totalMs": { "type": "number" }, "shiftCount": { "type": "number" }, "avgMs": { "type": "number" }, "breakMs": { "type": "number" }, "autoClosedCount": { "type": "number" } } } }, "trend": { "type": "array", "description": "trend ist der Verlauf über den Zeitraum, je Stunde, Tag oder Woche (siehe period).", "items": { "type": "object", "properties": { "label": { "type": "string" }, "totalMs": { "type": "number" } } } }, "charts": { "type": "object", "description": "Das Feld charts erscheint nur bei charts=true und wenn Daten vorhanden sind.", "properties": { "bars": { "type": "string" }, "share": { "type": "string" }, "trend": { "type": "string", "description": "trend ist der Verlauf über den Zeitraum, je Stunde, Tag oder Woche (siehe period)." } } } } }, "example": { "period": "weekly", "generatedAt": "2026-07-25T02:15:10.000Z", "window": { "start": "2026-07-19T22:00:00.000Z", "end": "2026-07-25T02:15:10.000Z" }, "totals": { "totalMs": 518400000, "totalShifts": 42, "activeCount": 9, "totalBreakMs": 7200000, "autoClosedShifts": 2 }, "rows": [ { "userId": "123456789012345678", "badgeNumber": "01", "nickname": "[MD-01] Mustermann", "totalMs": 144000000, "shiftCount": 12, "avgMs": 12000000, "breakMs": 1800000, "autoClosedCount": 1 } ], "trend": [ { "label": "Mo", "totalMs": 72000000 } ], "charts": { "bars": "", "share": "", "trend": "" } } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/leaderboard/chart/{type}.png": { "get": { "operationId": "GET_stats_leaderboard_chart_type_png", "summary": "Ranglisten-Diagramm", "tags": [ "Statistik" ], "parameters": [ { "name": "type", "in": "path", "required": true, "description": "Diagramm-Typ, siehe „Diagramm-Typen\"", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "rankId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "orgUnitId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "maxPixels", "in": "query", "required": false, "description": "Ganzzahl ≥ 50000 · Gilt für: alle Diagramme", "schema": { "type": "integer", "default": 990000 } }, { "name": "includeArchived", "in": "query", "required": false, "description": "Gilt für: Rangliste, Heatmap, Ranglisten-Diagramme", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/shifts": { "get": { "operationId": "GET_stats_shifts", "summary": "Einzelne Schichten im Zeitraum (Team oder userId )", "tags": [ "Statistik" ], "parameters": [ { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "rankId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "orgUnitId", "in": "query", "required": false, "description": "Id aus /stats/filters · Gilt für: Rangliste, Heatmap, Schichten, Inaktive", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "required": false, "description": "Nur die Schichten dieser Person (Discord-Id); ohne: das ganze Team", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.leaderboard.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.leaderboard.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/user/{userId}": { "get": { "operationId": "GET_stats_user_userId", "summary": "Statistik eines einzelnen Nutzers", "tags": [ "Statistik" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "compare", "in": "query", "required": false, "description": "Gilt für: Rangliste, Einzelstatistik", "schema": { "type": "boolean", "default": false } }, { "name": "detail", "in": "query", "required": false, "description": "Gilt für: Einzelstatistik, /me/stats", "schema": { "type": "boolean", "default": false } }, { "name": "charts", "in": "query", "required": false, "description": "Gilt für: Stats-JSON-Endpunkte", "schema": { "type": "boolean", "default": false } }, { "name": "maxPixels", "in": "query", "required": false, "description": "Ganzzahl ≥ 50000 · Gilt für: alle Diagramme", "schema": { "type": "integer", "default": 990000 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "period": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "window": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "userId": { "type": "string" }, "row": { "type": "object", "description": "row ist null, wenn der Nutzer im Zeitraum keine Schichten hatte.", "properties": { "userId": { "type": "string" }, "badgeNumber": { "type": "string" }, "nickname": { "type": "string" }, "totalMs": { "type": "number" }, "shiftCount": { "type": "number" }, "avgMs": { "type": "number" } } }, "trend": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "totalMs": { "type": "number" } } } }, "charts": { "type": "object", "properties": { "shifts": { "type": "string" }, "trend": { "type": "string" } } } } }, "example": { "period": "weekly", "generatedAt": "2026-07-25T02:15:10.000Z", "window": { "start": "2026-07-19T22:00:00.000Z", "end": "2026-07-25T02:15:10.000Z" }, "userId": "123456789012345678", "row": { "userId": "123456789012345678", "badgeNumber": "01", "nickname": "[MD-01] Mustermann", "totalMs": 144000000, "shiftCount": 12, "avgMs": 12000000 }, "trend": [ { "label": "Mo", "totalMs": 72000000 } ], "charts": { "shifts": "", "trend": "" } } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.user.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.user.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/stats/user/{userId}/chart/{type}.png": { "get": { "operationId": "GET_stats_user_userId_chart_type_png", "summary": "Nutzer-Diagramm", "tags": [ "Statistik" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "description": "Diagramm-Typ, siehe „Diagramm-Typen\"", "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly", "alltime", "custom" ], "default": "weekly" } }, { "name": "date", "in": "query", "required": false, "description": "Gilt für: alle Stats-Endpunkte außer inactive", "schema": { "type": "string", "format": "date" } }, { "name": "from", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "required": false, "description": "Gilt für: nur mit period=custom (beide Tage eingeschlossen, max. 366 Tage)", "schema": { "type": "string", "format": "date" } }, { "name": "maxPixels", "in": "query", "required": false, "description": "Ganzzahl ≥ 50000 · Gilt für: alle Diagramme", "schema": { "type": "integer", "default": 990000 } } ], "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.user.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `stats` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.user.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "stats", "x-mdt-rollout-flag": null } }, "/alarm": { "get": { "operationId": "GET_alarm", "summary": "Dashboard-, Alarm- und persönlichen Alarmstatus lesen", "tags": [ "Leitstelle" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.duty.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.duty.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/calls": { "get": { "operationId": "GET_calls", "summary": "Meldungen aus dem Spiel für das Leitstellenblatt: offene, übernommene und die der letzten 6 Stunden", "tags": [ "Leitstelle" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.dispatch.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.dispatch.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "board", "x-mdt-rollout-flag": null } }, "/calls/{id}/{action}": { "post": { "operationId": "POST_calls_id_action", "summary": "Meldung bearbeiten: take (legt einen Einsatz mit Kartenpin an, wenn das Einsatz-Modul an ist), dismiss , reopen , assign mit { \"callsign\": \"RTW 1\" | null } (Einheit zuteilen; ihre Besatzung bekommt im Spiel einen Wegpunkt)", "tags": [ "Leitstelle" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.dispatch.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.dispatch.edit", "x-mdt-audit": "call.handle", "x-mdt-topics": [ "calls", "einsatz", "einsatzStale", "overview" ], "x-mdt-module": "board", "x-mdt-rollout-flag": null } }, "/overview": { "get": { "operationId": "GET_overview", "summary": "Dashboard-, Alarm- und persönlichen Alarmstatus lesen", "tags": [ "Leitstelle" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.duty.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.duty.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/api-usage/legacy": { "get": { "operationId": "GET_admin_api_usage_legacy", "summary": "Aufrufe der umbenannten Pfade /hospital und /firstaid in den letzten 7 Tagen, davon per API-Schlüssel (Admin)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/apikeys": { "get": { "operationId": "GET_admin_apikeys", "summary": "API-Schlüssel auflisten", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_apikeys", "summary": "API-Key erstellen; Klartext nur in der Antwort", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "apikey.create", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/apikeys/{id}": { "delete": { "operationId": "DELETE_admin_apikeys_id", "summary": "API-Schlüssel widerrufen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "apikey.delete", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit": { "get": { "operationId": "GET_admin_audit", "summary": "Änderungsprotokoll lesen; Filter q , category , action , source , actor , target , sensitive , from / to , since / until , hours , tz (siehe unten)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/actors": { "get": { "operationId": "GET_admin_audit_actors", "summary": "Personen und Schlüssel, die im Protokoll vorkommen ( ?q= )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/entries/{id}": { "get": { "operationId": "GET_admin_audit_entries_id", "summary": "Ein Eintrag mit allen Feldern, weiteren Einträgen zum selben Ziel und seinen Rücknahmen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/entries/{id}/revert": { "get": { "operationId": "GET_admin_audit_entries_id_revert", "summary": "Vorschau einer Rücknahme: je Feld Vorher, Nachher, heutiger Wert und Konflikt", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_audit_entries_id_revert", "summary": "Änderung zurücknehmen ( { \"keys\": [...], \"reason\": \"...\" } ), läuft durch die ursprüngliche Route", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": "audit.revert", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/export": { "get": { "operationId": "GET_admin_audit_export", "summary": "Gefilterte Einträge als Datei ( ?format=csv|json&cols=changes,ids,technical )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.export`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.export", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/meta": { "get": { "operationId": "GET_admin_audit_meta", "summary": "Bereiche, Aktionen und Rechte der lesenden Person im Protokoll", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/security": { "get": { "operationId": "GET_admin_audit_security", "summary": "Abgewiesene Zugriffe gebündelt, Häufungen und Zugriffe von außen ( ?days= )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.security.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.security.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/settings": { "get": { "operationId": "GET_admin_audit_settings", "summary": "Aufbewahrung, Stand der Kettenprüfung und wer das Protokoll lesen darf", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_audit_settings", "summary": "Aufbewahrung setzen ( retentionDays , sensitiveRetentionDays , timeclockRetentionDays )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "audit.settings_update", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/stats": { "get": { "operationId": "GET_admin_audit_stats", "summary": "Übersicht über die gefilterten Einträge: Summen, je Stunde, Tag, Bereich und Person", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/verify": { "post": { "operationId": "POST_admin_audit_verify", "summary": "Hash-Kette des Protokolls jetzt prüfen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "audit.verify", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/views": { "get": { "operationId": "GET_admin_audit_views", "summary": "Eigene und geteilte gespeicherte Ansichten des Protokolls", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_audit_views", "summary": "Ansicht speichern ( { \"name\", \"query\", \"shared\" } )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": "audit.view_create", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/views/{id}": { "delete": { "operationId": "DELETE_admin_audit_views_id", "summary": "Ansicht löschen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `audit.log.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "audit.log.view", "x-mdt-audit": "audit.view_delete", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/watch-rules": { "get": { "operationId": "GET_admin_audit_watch_rules", "summary": "Wachregeln auflisten", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_audit_watch_rules", "summary": "Wachregel anlegen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "audit.watch_create", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/audit/watch-rules/{id}": { "patch": { "operationId": "PATCH_admin_audit_watch_rules_id", "summary": "Wachregel ändern oder nur ein-/ausschalten ( { \"enabled\": false } )", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "audit.watch_update", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_admin_audit_watch_rules_id", "summary": "Wachregel löschen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "audit.watch_delete", "x-mdt-topics": [ "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/branding": { "put": { "operationId": "PUT_admin_branding", "summary": "Instanzname, Badge-Format, Begriffe, Module und Reiterfolge ( tabOrder ) ändern; showcaseOnLanding (Startseiten-Galerie) und showcaseInviteUrl (nur https://discord.gg/… oder https://discord.com/invite/… , leer entfernt)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "branding.update", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/branding/icon": { "post": { "operationId": "POST_admin_branding_icon", "summary": "Instanz-Icon hochladen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "branding.icon_upload", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/callsign-prefixes": { "get": { "operationId": "GET_admin_callsign_prefixes", "summary": "Rufnamen-Präfixe lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.config.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.config.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_callsign_prefixes", "summary": "Rufnamen-Präfixe setzen ( { \"prefixes\": [...] } , ersetzt die Liste); baut das Panel neu auf", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.config.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.config.edit", "x-mdt-audit": "callsign_prefixes.set", "x-mdt-topics": [ "prefixes" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/channels": { "get": { "operationId": "GET_admin_channels", "summary": "Discord-Kanäle auflisten", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/chart-embeds": { "get": { "operationId": "GET_admin_chart_embeds", "summary": "Öffentliche Einbett-Links für Diagramme auflisten (Admin)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_chart_embeds", "summary": "Einbett-Link anlegen: { \"kind\": \"leaderboard\" | \"user\", \"chart\", \"userId\"?, \"query\"?, \"label\"?, \"expiresInDays\"? } , siehe „Einbett-Links für Diagramme\" (Admin)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "chartembed.create", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/chart-embeds/{id}": { "delete": { "operationId": "DELETE_admin_chart_embeds_id", "summary": "Einbett-Link widerrufen; der Link antwortet sofort mit 404 (Admin)", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "chartembed.delete", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/clock-in": { "post": { "operationId": "POST_admin_clock_in", "summary": "Person per Dienstmarke einstempeln", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "badgeNumber": { "type": "string" }, "userId": { "type": "string" }, "nickname": { "type": "string" }, "clockInAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" } } }, "example": { "badgeNumber": "99", "userId": "…", "nickname": "[MD-99] Dr. Pearce", "clockInAt": "2026-07-25T10:00:00.000Z", "status": "OPEN" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `timeclock.others.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "timeclock.others.manage", "x-mdt-audit": "shift.admin_clock_in", "x-mdt-topics": [ "onDuty", "overview", "dispatchers", "alarm", "standby" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/clock-out": { "post": { "operationId": "POST_admin_clock_out", "summary": "Person per Dienstmarke ausstempeln", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "badgeNumber": { "type": "string" }, "userId": { "type": "string" }, "clockOutAt": { "type": "string", "format": "date-time" }, "workedMs": { "type": "number" }, "breakMs": { "type": "number" }, "status": { "type": "string" } } }, "example": { "badgeNumber": "99", "userId": "…", "clockOutAt": "2026-07-25T18:00:00.000Z", "workedMs": 27000000, "breakMs": 1800000, "status": "CLOSED" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `timeclock.others.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "timeclock.others.manage", "x-mdt-audit": "shift.admin_clock_out", "x-mdt-topics": [ "onDuty", "overview", "dispatchers", "units", "alarm", "access", "einsatzEntries" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/clock-status/{badge}": { "get": { "operationId": "GET_admin_clock_status_badge", "summary": "Ist die Dienstmarke im Dienst?", "tags": [ "Administration" ], "parameters": [ { "name": "badge", "in": "path", "required": true, "description": "Dienstmarke, z. B. `07`", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "badgeNumber": { "type": "string" }, "clockedIn": { "type": "boolean", "description": "clockedIn ist false (mit status/since = null), wenn die Marke keine offene Schicht hat." }, "status": { "type": "string" }, "since": { "type": "string", "format": "date-time" } } }, "example": { "badgeNumber": "99", "clockedIn": true, "status": "OPEN", "since": "2026-07-25T10:00:00.000Z" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.duty.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.duty.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/export": { "get": { "operationId": "GET_admin_config_export", "summary": "Konfiguration als mdt-config.json (Formatversion, je Bereich der Stand; keine Personen, keine Schlüssel). organization und callsignTemplates nur für eine Sitzung, die die frische Prüfung als Server-Admin besteht (wie /platform/config )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/import": { "post": { "operationId": "POST_admin_config_import", "summary": "Import übernehmen ( { \"file\": {...}, \"areas\": [...] } ); legt vorher einen Sicherungspunkt an, eine Transaktion je Bereich. Nur mit Sitzung, nie mit API-Schlüssel; organization und callsignTemplates nur nach frischer Prüfung als Server-Admin, sonst ok: false für diese Bereiche", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "config.import", "x-mdt-topics": [ "settings", "access", "statuses", "codes", "gebiete", "prefixes", "personal", "calendar", "courses", "facility", "facilityStale", "documents", "documentsStale", "letterheads", "versicherung", "postfach", "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/import/preview": { "post": { "operationId": "POST_admin_config_import_preview", "summary": "Import prüfen ( { \"file\": {...} } ): je Bereich neu, geändert, unverändert, Warnungen und nicht übertragbare Discord-Ziele; ändert nichts", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "config.import_preview", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/snapshots": { "get": { "operationId": "GET_admin_config_snapshots", "summary": "Sicherungspunkte auflisten (manuell, täglich automatisch, vor Import und Wiederherstellung)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_config_snapshots", "summary": "Sicherungspunkt anlegen ( { \"name\": \"...\" } )", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "config.snapshot_create", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/snapshots/{id}": { "delete": { "operationId": "DELETE_admin_config_snapshots_id", "summary": "Sicherungspunkt löschen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "config.snapshot_delete", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/snapshots/{id}/compare": { "get": { "operationId": "GET_admin_config_snapshots_id_compare", "summary": "Sicherungspunkt mit dem heutigen Stand vergleichen, je Bereich", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/config/snapshots/{id}/restore": { "post": { "operationId": "POST_admin_config_snapshots_id_restore", "summary": "Sicherungspunkt wiederherstellen ( { \"areas\"?: [...] } ); legt vorher einen Sicherungspunkt vom heutigen Stand an. Nur mit Sitzung; gesperrte Bereiche wie beim Import", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "config.restore", "x-mdt-topics": [ "settings", "access", "statuses", "codes", "gebiete", "prefixes", "personal", "calendar", "courses", "facility", "facilityStale", "documents", "documentsStale", "letterheads", "versicherung", "postfach", "audit" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations": { "get": { "operationId": "GET_admin_cooperations", "summary": "Kooperationen der Instanz auflisten, je mit partnerDisplayName und ownBoundPolicyCount (eigene, nicht archivierte Datenregeln an der Verbindung)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_cooperations", "summary": "Kooperation vorschlagen; DM an die Admins der Partnerinstanz, die Antwort meldet in delivery ( botInPartnerGuild , adminsNotified , null = noch offen), wer erreicht wurde", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.propose", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/accept": { "post": { "operationId": "POST_admin_cooperations_id_accept", "summary": "Kooperation annehmen; DM mit Link zu den Datenregeln an die Admins der vorschlagenden Instanz", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.accept", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/grants": { "put": { "operationId": "PUT_admin_cooperations_id_grants", "summary": "Eigene Kooperationsfreigaben ändern", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.grants_set", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/health-ack": { "post": { "operationId": "POST_admin_cooperations_id_health_ack", "summary": "Erfolgreiche eigene Verbindung zur API bestätigen (Admin-Session; kein Body oder {} )", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.health_acknowledge", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/metadata": { "put": { "operationId": "PUT_admin_cooperations_id_metadata", "summary": "Eigene Kontakt-, Protokoll- und Capability-Metadaten ändern", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.metadata_set", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/resume": { "post": { "operationId": "POST_admin_cooperations_id_resume", "summary": "Ausgesetzte Kooperation mit Begründung fortsetzen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.resume", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/revoke": { "post": { "operationId": "POST_admin_cooperations_id_revoke", "summary": "Kooperation widerrufen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.revoke", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/supersede": { "post": { "operationId": "POST_admin_cooperations_id_supersede", "summary": "Kooperation mit Begründung ablösen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.supersede", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/cooperations/{id}/suspend": { "post": { "operationId": "POST_admin_cooperations_id_suspend", "summary": "Kooperation mit Begründung aussetzen", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "cooperation.suspend", "x-mdt-topics": [ "access", "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/dispatch-codes": { "get": { "operationId": "GET_admin_dispatch_codes", "summary": "Statuscodes lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.config.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.config.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_dispatch_codes", "summary": "Statuscodes setzen ( { \"codes\": [...], \"pauseCode\": ... } , ersetzt die Liste)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.config.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.config.edit", "x-mdt-audit": "dispatch_codes.set", "x-mdt-topics": [ "codes" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/dispatchers": { "get": { "operationId": "GET_admin_dispatchers", "summary": "Aktuelle Leitstellen-Slots und Statusdefinitionen lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.dispatch.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.dispatch.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_dispatchers", "summary": "Leitstelle / Sek. Leitstelle / Höchstrangiger setzen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.dispatch.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.dispatch.edit", "x-mdt-audit": "dispatchers.set", "x-mdt-topics": [ "dispatchers", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/gebiete": { "get": { "operationId": "GET_admin_gebiete", "summary": "Einsatzgebiete lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.config.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.config.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_gebiete", "summary": "Einsatzgebiete setzen ( { \"gebiete\": [...] } , ersetzt die Liste); nur Board, kein Panel-Neuaufbau", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.config.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.config.edit", "x-mdt-audit": "gebiete.set", "x-mdt-topics": [ "gebiete" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/instance": { "delete": { "operationId": "DELETE_admin_instance", "summary": "Instanz vollständig löschen (nur Serverbesitzer)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "instance.delete", "x-mdt-topics": [ "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/members": { "get": { "operationId": "GET_admin_members", "summary": "Alle Mitarbeiter (Rolle + Dienstmarke)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "members": { "type": "array", "items": { "type": "object", "properties": { "badgeNumber": { "type": "string" }, "userId": { "type": "string" }, "name": { "type": "string", "description": "name ist der Nickname ohne Marken-Präfix." } } } } } }, "example": { "members": [ { "badgeNumber": "01", "userId": "…", "name": "Jermaine Prince" }, { "badgeNumber": "99", "userId": "…", "name": "Aiden Pearce" } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.duty.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.duty.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/members/search": { "get": { "operationId": "GET_admin_members_search", "summary": "Mitglieder nach Server-Nickname, Account-Name oder Discord-ID suchen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/on-duty": { "get": { "operationId": "GET_admin_on_duty", "summary": "Alle offenen Schichten (im Dienst)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "generatedAt": { "type": "string", "format": "date-time" }, "onDuty": { "type": "array", "items": { "type": "object", "properties": { "badgeNumber": { "type": "string" }, "userId": { "type": "string" }, "nickname": { "type": "string" }, "status": { "type": "string" }, "since": { "type": "string", "format": "date-time" } } } } } }, "example": { "generatedAt": "2026-07-25T19:20:00.000Z", "onDuty": [ { "badgeNumber": "99", "userId": "…", "nickname": "[MD-99] Aiden Pearce", "status": "OPEN", "since": "2026-07-25T10:00:00.000Z" }, { "badgeNumber": "01", "userId": "…", "nickname": "[MD-01] Jermaine Prince", "status": "PAUSED", "since": "2026-07-25T18:45:00.000Z" } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.duty.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.duty.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/on-duty/{userId}/code": { "put": { "operationId": "PUT_admin_on_duty_userId_code", "summary": "Dienstcode setzen", "tags": [ "Administration" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.units.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.units.edit", "x-mdt-audit": "shift.set_code", "x-mdt-topics": [ "onDuty" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/panel": { "post": { "operationId": "POST_admin_panel", "summary": "Stempeluhr-Panel veröffentlichen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "panel.publish", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/permissions/holders": { "get": { "operationId": "GET_admin_permissions_holders", "summary": "Wer welchen Rang (Discord, manuell, InGame) hält und wer welcher Abteilung angehört; discordComplete: false , wenn der Mitglieder-Cache unvollständig ist", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/permissions/members/{userId}": { "get": { "operationId": "GET_admin_permissions_members_userId", "summary": "Warum ein Mitglied welche Rechte hat: Admin-Status, Ränge samt Quelle, Abteilungen, Suspendierung und die wirksame Rechteliste", "tags": [ "Administration" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/permissions/objects": { "get": { "operationId": "GET_admin_permissions_objects", "summary": "Die Dinge mit Einzelrechten (Kurse, Listen, geschützte Spalten, Website-Seiten und Umfragen) eingeschalteter Module, je mit restricted : die Aktionen, für die das Bereichsrecht nicht genügt", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/permissions/objects/{resource}/{id}": { "put": { "operationId": "PUT_admin_permissions_objects_resource_id", "summary": "„Nur mit Einzelrecht\" an einem Ding schalten, Rumpf { \"restricted\": [\"…\"] }", "tags": [ "Administration" ], "parameters": [ { "name": "resource", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "permissions.object_restricted", "x-mdt-topics": [ "settings", "access", "personal", "courses", "lists", "sites" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/presence": { "get": { "operationId": "GET_admin_presence", "summary": "Wer gerade eine Registerkarte des MDT offen hat ( { users: [{ userId, name, avatarUrl }] } ); unabhängig vom Dienststatus", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/roles": { "get": { "operationId": "GET_admin_roles", "summary": "Discord-Rollen auflisten", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/settings": { "get": { "operationId": "GET_admin_settings", "summary": "Instanz-Einstellungen lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_settings", "summary": "Guild-, Stempeluhr- und Branding-Einstellungen ändern", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "settings.update", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/standby": { "get": { "operationId": "GET_admin_standby", "summary": "Bereitschaftsliste lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.standby.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.standby.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/standby/call": { "post": { "operationId": "POST_admin_standby_call", "summary": "Bereitschaft rufen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.standby.alarm`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.standby.alarm", "x-mdt-audit": "standby.call", "x-mdt-topics": [ "standby" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/standby/revoke": { "post": { "operationId": "POST_admin_standby_revoke", "summary": "Bereitschaftsruf zurücknehmen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.standby.alarm`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.standby.alarm", "x-mdt-audit": "standby.revoke", "x-mdt-topics": [ "standby" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/statuses": { "get": { "operationId": "GET_admin_statuses", "summary": "Aktuelle Leitstellen-Slots und Statusdefinitionen lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.config.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.config.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_statuses", "summary": "Statusmeldungen ersetzen, Body { \"statuses\": [ … ] }", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.config.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.config.edit", "x-mdt-audit": "statuses.set", "x-mdt-topics": [ "statuses", "alarm" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/stempeluhr": { "get": { "operationId": "GET_admin_stempeluhr", "summary": "Stempeluhr-Einstellungen lesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_admin_stempeluhr", "summary": "Guild-, Stempeluhr- und Branding-Einstellungen ändern", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "stempeluhr.settings_update", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/stempeluhr/panel/test": { "post": { "operationId": "POST_admin_stempeluhr_panel_test", "summary": "Stempeluhr-Panel als Testnachricht per DM an die aufrufende Person ( { \"panelTitle\", \"panelAccentColor\" } , ungespeicherte Werte)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "panel.test_dm", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/units": { "get": { "operationId": "GET_admin_units", "summary": "Einheiten auflisten", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.units.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.units.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_admin_units", "summary": "Einheit anlegen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.units.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.units.create", "x-mdt-audit": "unit.create", "x-mdt-topics": [ "units", "alarm", "onDuty" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/units/{callsign}": { "put": { "operationId": "PUT_admin_units_callsign", "summary": "Einheit aktualisieren (leere Besatzung löscht sie)", "tags": [ "Administration" ], "parameters": [ { "name": "callsign", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.units.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.units.edit", "x-mdt-audit": "unit.update", "x-mdt-topics": [ "units", "alarm", "onDuty", "einsatzEntries" ], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_admin_units_callsign", "summary": "Einheit löschen", "tags": [ "Administration" ], "parameters": [ { "name": "callsign", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.units.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.units.delete", "x-mdt-audit": "unit.delete", "x-mdt-topics": [ "units", "alarm", "onDuty", "einsatzEntries" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/view-as/start": { "post": { "operationId": "POST_admin_view_as_start", "summary": "„Ansicht als …“ beginnen ( { \"target\": \"rank:\" } oder \"member:\" ): prüft das Ziel und schreibt die Protokollzeile, Antwort { kind, id, label } . Die Ansicht selbst trägt der Kopf x-view-as jeder Anfrage: nur für Admins, Lesen mit den Rechten des Ziels, jede schreibende Anfrage mit diesem Kopf wird mit 403 abgewiesen", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "viewas.start", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/admin/view-as/stop": { "post": { "operationId": "POST_admin_view_as_stop", "summary": "„Ansicht als …“ beenden ( { \"target\": … } ), nur die Protokollzeile; ohne x-view-as senden", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "viewas.stop", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/history/document/{id}": { "get": { "operationId": "GET_history_document_id", "summary": "Verlauf eines Dokuments aus dem Protokoll", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/history/einsatz/{id}": { "get": { "operationId": "GET_history_einsatz_id", "summary": "Verlauf eines Einsatzblatts aus dem Protokoll", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/history/employee/{id}": { "get": { "operationId": "GET_history_employee_id", "summary": "Verlauf einer Personalakte aus dem Protokoll ( ?notes=0 , ?timeclock=1 )", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.employee.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.employee.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/history/unit/{id}": { "get": { "operationId": "GET_history_unit_id", "summary": "Verlauf einer Einheit aus dem Protokoll", "tags": [ "Administration" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.units.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.units.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/settings/discord-check": { "get": { "operationId": "GET_settings_discord_check", "summary": "Alle in den Einstellungen verwendeten Kanäle und Rollen gegen die Bot-Rechte prüfen ( items[] mit status ok/warn/error, detail , steps ); 60 s zwischengespeichert, ?fresh=1 prüft neu", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/settings/health": { "get": { "operationId": "GET_settings_health", "summary": "Gesundheitscheck der Einstellungen: Befunde ( findings[] mit severity , section , action ) und Kennzahlen ( stats ); ?fresh=1 prüft Discord neu", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/settings/impact": { "get": { "operationId": "GET_settings_impact", "summary": "Folgen eines Abschaltens zählen: ?module= (Kursspalten, verknüpfte Termine, wirkungslose Rechte) oder ?status= , ?calendarCategory= , ?documentCategory= , ?clearance= (Anzahl der Einträge, die den Wert benutzen)", "tags": [ "Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/personal": { "get": { "operationId": "GET_personal", "summary": "Personalblatt lesen (Mitarbeiter + Spalten)", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "employees": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "userId": { "type": "string", "description": "userId ist null bei manuell angelegten Mitarbeitern ohne Discord-Konto." }, "badgeNumber": { "type": "string" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "values": { "type": "object", "description": "values ist nach Spalten-id indiziert; fehlt eine Spalte in einer Zeile, wurde für sie noch nie ein Wert gesetzt.", "properties": { "clm…": { "type": "object", "properties": { "v": { "type": "boolean" }, "at": { "type": "string", "format": "date-time" }, "by": { "type": "string" } } } } } } } }, "columns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "kind": { "type": "string", "description": "kind ist eine von text, number, date, promotion, select, checkbox, rank; color eine von red, green, orange, blue, magenta oder null." }, "options": { "type": "array", "items": {} }, "group": { "type": "string" }, "color": { "type": "string" }, "adminOnly": { "type": "boolean" }, "order": { "type": "number" } } } } } }, "example": { "employees": [ { "id": "clx…", "userId": "123456789012345678", "badgeNumber": "01", "name": "Jermaine Prince", "active": true, "values": { "clm…": { "v": true, "at": "2026-07-26T10:00:00.000Z", "by": "987654321012345678" } } } ], "columns": [ { "id": "clm…", "label": "Flug Ausbildung", "kind": "checkbox", "options": [], "group": "Ausbildung", "color": "orange", "adminOnly": false, "order": 0 } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `personal.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "personal.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/columns": { "put": { "operationId": "PUT_personal_columns", "summary": "Spalten des Personalblatts ersetzen", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.columns.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.columns.edit", "x-mdt-audit": "personal.columns_set", "x-mdt-topics": [ "personal", "dispatchers" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees": { "post": { "operationId": "POST_personal_employees", "summary": "Mitarbeiter manuell anlegen", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.employee.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.employee.create", "x-mdt-audit": "employee.create", "x-mdt-topics": [ "personal", "dispatchers", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}": { "patch": { "operationId": "PATCH_personal_employees_id", "summary": "Zellen eines Mitarbeiters aktualisieren", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.employee.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.employee.edit", "x-mdt-audit": "employee.update", "x-mdt-topics": [ "personal", "dispatchers", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/activity": { "get": { "operationId": "GET_personal_employees_id_activity", "summary": "Aktivität einer Personalakte lesen (Stunden, Schichten, letzter Login)", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `stats.user.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "stats.user.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/archive": { "post": { "operationId": "POST_personal_employees_id_archive", "summary": "Mitarbeiter archivieren", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.employee.archive`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.employee.archive", "x-mdt-audit": "employee.archive", "x-mdt-topics": [ "personal", "dispatchers", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/discord-ranks": { "patch": { "operationId": "PATCH_personal_employees_id_discord_ranks", "summary": "Explizite Discord-Rangänderungen anwenden", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.ranks.assign`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.ranks.assign", "x-mdt-audit": "employee.ranks_set", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/history": { "get": { "operationId": "GET_personal_employees_id_history", "summary": "Verlauf einer Personalakte lesen", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.employee.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.employee.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/notes": { "get": { "operationId": "GET_personal_employees_id_notes", "summary": "Notizen zur Personalakte lesen", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.notes.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.notes.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_personal_employees_id_notes", "summary": "Notiz anlegen", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.notes.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.notes.create", "x-mdt-audit": "employee.note_create", "x-mdt-topics": [ "personal", "dispatchers" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/notes/{noteId}": { "patch": { "operationId": "PATCH_personal_employees_id_notes_noteId", "summary": "Notiz ändern", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "noteId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.notes.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.notes.edit", "x-mdt-audit": "employee.note_update", "x-mdt-topics": [ "personal", "dispatchers" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_personal_employees_id_notes_noteId", "summary": "Notiz löschen", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "noteId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.notes.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.notes.delete", "x-mdt-audit": "employee.note_delete", "x-mdt-topics": [ "personal", "dispatchers" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/ranks": { "get": { "operationId": "GET_personal_employees_id_ranks", "summary": "Rangzuweisungen einer Mitarbeiterzeile lesen", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.ranks.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.ranks.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_personal_employees_id_ranks", "summary": "Manuelle oder InGame-Rangzuweisungen einer Mitarbeiterzeile ersetzen", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.ranks.assign`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.ranks.assign", "x-mdt-audit": "employee.ranks_set", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/employees/{id}/restore": { "post": { "operationId": "POST_personal_employees_id_restore", "summary": "Archivierten Mitarbeiter reaktivieren", "tags": [ "Personalblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.employee.archive`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.employee.archive", "x-mdt-audit": "employee.restore", "x-mdt-topics": [ "personal", "dispatchers", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/ranks": { "get": { "operationId": "GET_personal_ranks", "summary": "Rangdefinitionen lesen ( capabilities , discordRoleId , inGameKey )", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.ranks.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.ranks.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_personal_ranks", "summary": "Rangliste ändern", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "personal.ranks_set", "x-mdt-topics": [ "personal", "dispatchers", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/sync": { "get": { "operationId": "GET_personal_sync", "summary": "Vorschläge aus dem Discord-Abgleich lesen", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.sync.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.sync.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/personal/sync/apply": { "post": { "operationId": "POST_personal_sync_apply", "summary": "Vorschläge annehmen/verwerfen", "tags": [ "Personalblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `personal.sync.apply`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `personal` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "personal.sync.apply", "x-mdt-audit": "personal.sync_apply", "x-mdt-topics": [ "personal", "dispatchers", "access" ], "x-mdt-module": "personal", "x-mdt-rollout-flag": null } }, "/einsatz": { "get": { "operationId": "GET_einsatz", "summary": "Einsatzblätter lesen (ohne archived nur laufende)", "tags": [ "Einsatzblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_einsatz", "summary": "Einsatzblatt anlegen", "tags": [ "Einsatzblatt" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.create", "x-mdt-audit": "einsatz.create", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}": { "get": { "operationId": "GET_einsatz_id", "summary": "Einzelnes Einsatzblatt lesen; ?ownerGuildId= liest ein freigegebenes Partnerblatt, bei Freigabestufe redacted geschwärzt", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_einsatz_id", "summary": "Titel, Ort, Kartenmarkierung oder Einsatzleiter setzen - Titel nur mit Admin-Rechten", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.edit", "x-mdt-audit": "einsatz.update", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_einsatz_id", "summary": "Abgeschlossenes Einsatzblatt löschen (nur Archiv; ein offener Einsatz wird mit 409 abgelehnt)", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `einsatz.sheet.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "einsatz.sheet.delete", "x-mdt-audit": "einsatz.delete", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/close": { "post": { "operationId": "POST_einsatz_id_close", "summary": "Einsatz abschließen (ins Archiv)", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.sheet.close`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.sheet.close", "x-mdt-audit": "einsatz.close", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale", "units" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/entries": { "get": { "operationId": "GET_einsatz_id_entries", "summary": "Verlauf des Einsatzes lesen (Einsatz- und Patienteneinträge)", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_einsatz_id_entries", "summary": "Notiz eintragen ( patientId: null = Lagemeldung)", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.entry.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.entry.create", "x-mdt-audit": "einsatz.entry_create", "x-mdt-topics": [ "einsatz", "facility", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/entries/{eid}": { "patch": { "operationId": "PATCH_einsatz_id_entries_eid", "summary": "Eigene Verlaufsnotiz ändern", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "description": "Id des Verlaufseintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.entry.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.entry.edit", "x-mdt-audit": "einsatz.entry_edit", "x-mdt-topics": [ "einsatz", "facility", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_einsatz_id_entries_eid", "summary": "Eigene Notiz zurücknehmen", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "description": "Id des Verlaufseintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.entry.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.entry.delete", "x-mdt-audit": "einsatz.entry_delete", "x-mdt-topics": [ "einsatz", "facility", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/patients": { "post": { "operationId": "POST_einsatz_id_patients", "summary": "Patient erfassen", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.create", "x-mdt-audit": "einsatz.patient_create", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/patients/{pid}": { "patch": { "operationId": "PATCH_einsatz_id_patients_pid", "summary": "Name, Zugehörigkeit, Triage, Ort oder Schritte ändern", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.edit", "x-mdt-audit": "einsatz.patient_update", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_einsatz_id_patients_pid", "summary": "Patient entfernen", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.patient.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.patient.delete", "x-mdt-audit": "einsatz.patient_delete", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/patients/{pid}/announce": { "post": { "operationId": "POST_einsatz_id_patients_pid_announce", "summary": "Patient der Einrichtung ankündigen (erscheint dort ausgegraut über dem Warteraum) - optionales Feld buildingId ; die Verlegung löscht die Ankündigung", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.create", "x-mdt-audit": "einsatz.patient_announce", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_einsatz_id_patients_pid_announce", "summary": "Ankündigung zurücknehmen", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.delete", "x-mdt-audit": "einsatz.patient_announce_withdraw", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/patients/{pid}/register-link": { "put": { "operationId": "PUT_einsatz_id_patients_pid_register_link", "summary": "Patient mit authorityRecordId verknüpfen, mit null lösen oder mit createFromPatient: true eine neue Akte anlegen und verknüpfen; optional reason", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.edit", "x-mdt-audit": "einsatz.patient_register_link", "x-mdt-topics": [ "einsatz", "einsatzStale", "citizen" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/patients/{pid}/register-suggestions": { "get": { "operationId": "GET_einsatz_id_patients_pid_register_suggestions", "summary": "Registerakten der eigenen Instanz als Vorschlag für einen Patienten, optional q (Standard: Patientenname); früher verknüpfte Akten zuerst; nur lesbare Akten", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/patients/{pid}/transfer": { "post": { "operationId": "POST_einsatz_id_patients_pid_transfer", "summary": "Patient in die Einrichtung verlegen - optionales Feld buildingId wählt die Zieleinrichtung; ohne Angabe die erste", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.patient.transfer`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.patient.transfer", "x-mdt-audit": "einsatz.patient_transfer", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/register-warnings": { "get": { "operationId": "GET_einsatz_id_register_warnings", "summary": "Warnhinweise und medizinische Registerangaben der verknüpften Patienten eines Einsatzes", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/einsatz/{id}/reopen": { "post": { "operationId": "POST_einsatz_id_reopen", "summary": "Abgeschlossenen Einsatz wieder öffnen", "tags": [ "Einsatzblatt" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.sheet.close`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.sheet.close", "x-mdt-audit": "einsatz.reopen", "x-mdt-topics": [ "einsatz", "facility", "overview", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/facility": { "get": { "operationId": "GET_facility", "summary": "Board der Einrichtung lesen - ohne Parameter die aktiven Patienten, pending die Entlassenen ohne geschriebene Akte (mit involved : wer beteiligt war), discharged das Archiv. ?discharged=1 bleibt als Alias für view=discharged , liefert seitdem aber nur noch Patienten mit geschriebener Akte - vor pending waren das alle Entlassenen, jetzt strikt weniger. Antwort enthält buildings (alle Einrichtungen der Guild); jeder Raum und jeder Patient trägt buildingId . Gefiltert wird im Client. Das Archiv ( discharged ) nimmt zusätzlich from / to (ISO-Zeitpunkte, Entlassung), triage , betreuer (Teil des Namens) und limit (1–100) an. Die aktive Ansicht trägt settings (Hinweis-Schwellen) und incoming (angekündigte Patienten).", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.board.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.board.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/beds/{id}": { "patch": { "operationId": "PATCH_facility_beds_id", "summary": "Bett umbenennen oder Position ändern", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.edit", "x-mdt-audit": "facility.bed_update", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_facility_beds_id", "summary": "Bett löschen (Patient fällt in den Streifen „ohne Bett\" zurück)", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.delete", "x-mdt-audit": "facility.bed_delete", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/buildings": { "get": { "operationId": "GET_facility_buildings", "summary": "Einrichtungen auflisten", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.board.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.board.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_facility_buildings", "summary": "Einrichtung anlegen", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.create", "x-mdt-audit": "facility.building_create", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/buildings/{id}": { "patch": { "operationId": "PATCH_facility_buildings_id", "summary": "Einrichtung umbenennen oder Position ändern", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.edit", "x-mdt-audit": "facility.building_update", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_facility_buildings_id", "summary": "Einrichtung löschen - 409, solange Patienten darin liegen oder es das letzte ist", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.delete", "x-mdt-audit": "facility.building_delete", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients": { "post": { "operationId": "POST_facility_patients", "summary": "Patient direkt in der Einrichtung anlegen (Direktaufnahme, landet im Warteraum). Optionales Feld buildingId wählt die Einrichtung; ohne Angabe die erste.", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.create", "x-mdt-audit": "facility.patient_create", "x-mdt-topics": [ "facility", "einsatz", "overview", "einsatzEntries", "facilityEntries", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients/{id}": { "get": { "operationId": "GET_facility_patients_id", "summary": "Einzelnen Einrichtung-Patienten lesen; ?ownerGuildId= liest einen freigegebenen Partnerpatienten", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_facility_patients_id", "summary": "Ort ( buildingId + Raum/Bett - alle drei Felder gemeinsam), Triage, Zugehörigkeit oder Schritte eines Patienten ändern", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.edit", "x-mdt-audit": "facility.patient_update", "x-mdt-topics": [ "facility", "einsatz", "overview", "einsatzEntries", "facilityEntries", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients/{id}/citizen": { "get": { "operationId": "GET_facility_patients_id_citizen", "summary": "Bürgerakte zum Patienten: Stammdaten (Blutgruppe, Allergien, Vorerkrankungen) und die letzten früheren Aufenthalte; citizen: null ohne verknüpften Bürger", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients/{id}/entries": { "get": { "operationId": "GET_facility_patients_id_entries", "summary": "Verlauf eines Einrichtung-Patienten lesen", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_facility_patients_id_entries", "summary": "Notiz zu einem Einrichtung-Patienten eintragen", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.entry.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.entry.create", "x-mdt-audit": "facility.entry_create", "x-mdt-topics": [ "facility", "einsatzEntries", "facilityEntries", "facilityStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients/{id}/entries/{eid}": { "delete": { "operationId": "DELETE_facility_patients_id_entries_eid", "summary": "Eigene Notiz eines Einrichtung-Patienten zurücknehmen (Leitstelle: jede)", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "description": "Id des Verlaufseintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.entry.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.entry.delete", "x-mdt-audit": "facility.entry_delete", "x-mdt-topics": [ "facility", "einsatzEntries", "facilityEntries", "facilityStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients/{id}/handover": { "post": { "operationId": "POST_facility_patients_id_handover", "summary": "Patient mit einer aktiven Partnerfreigabe an die Partner-Einrichtung übergeben", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.handover`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.handover", "x-mdt-audit": "facility.patient_handover", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/patients/{pid}/entries/{eid}": { "patch": { "operationId": "PATCH_facility_patients_pid_entries_eid", "summary": "Einrichtungpatient oder Verlauf ändern", "tags": [ "Einrichtung" ], "parameters": [ { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } }, { "name": "eid", "in": "path", "required": true, "description": "Id des Verlaufseintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.entry.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.entry.edit", "x-mdt-audit": "facility.entry_edit", "x-mdt-topics": [ "facility", "einsatzEntries", "facilityEntries", "facilityStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/queue": { "get": { "operationId": "GET_facility_queue", "summary": "Offene Wartenummern der Notaufnahme", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.board.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.board.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_facility_queue", "summary": "Wartenummer am Tresen ausgeben { \"name\"? }", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.edit", "x-mdt-audit": "facility.queue_ticket", "x-mdt-topics": [ "facilityStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/queue/{ticketId}/{action}": { "post": { "operationId": "POST_facility_queue_ticketId_action", "summary": "Wartenummer: arrive , call { \"calledTo\"? } , done , cancel , triage { \"triage\": red|yellow|green|null }", "tags": [ "Einrichtung" ], "parameters": [ { "name": "ticketId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.patient.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.patient.edit", "x-mdt-audit": "facility.queue_action", "x-mdt-topics": [ "facilityStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/rooms": { "get": { "operationId": "GET_facility_rooms", "summary": "Einrichtungen mit ihren Räumen und Betten auflisten (Antwort: { buildings: [{ id, name, position, rooms: [...] }] } )", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.board.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.board.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_facility_rooms", "summary": "Raum anlegen (Felder buildingId , name )", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.create", "x-mdt-audit": "facility.room_create", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/rooms/{id}": { "patch": { "operationId": "PATCH_facility_rooms_id", "summary": "Raum umbenennen oder Position ändern", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.edit", "x-mdt-audit": "facility.room_update", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_facility_rooms_id", "summary": "Raum löschen (Patienten fallen in den Warteraum zurück)", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.delete", "x-mdt-audit": "facility.room_delete", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/rooms/{id}/beds": { "post": { "operationId": "POST_facility_rooms_id_beds", "summary": "Bett in einem Raum anlegen", "tags": [ "Einrichtung" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.create", "x-mdt-audit": "facility.bed_create", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/settings": { "get": { "operationId": "GET_facility_settings", "summary": "Hinweis-Schwellen der Einrichtung lesen: stayWarnMinutes (Verweildauer-Warnung), fileReminderHours (Akten-Erinnerung); null = aus", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.board.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.board.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_facility_settings", "summary": "Hinweis-Schwellen setzen (Admin) - Teil-Update, Minuten 1–10080 oder null", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `facility.structure.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "facility.structure.edit", "x-mdt-audit": "facility.settings_update", "x-mdt-topics": [ "facility", "facilityStale" ], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/facility/stats": { "get": { "operationId": "GET_facility_stats", "summary": "Kennzahlen der Einrichtung: Aufnahmen, Entlassungen, Ø/Median-Verweildauer, Belegung im Verlauf, Entlassungen pro Tag und je Früh/Spät/Nacht, offene Akten je Betreuer", "tags": [ "Einrichtung" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.board.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `facility` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.board.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "facility", "x-mdt-rollout-flag": null } }, "/integrations/ingame/calls": { "get": { "operationId": "GET_integrations_ingame_calls", "summary": "Meldungen an die Leitstelle lesen: offene, übernommene und die der letzten 6 Stunden (Scope calls:read )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_integrations_ingame_calls", "summary": "Meldung aus dem Spiel anlegen oder über dieselbe externalId aktualisieren, siehe „Meldungen aus dem Spiel\" (Scope calls:call.report )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "call.report", "x-mdt-topics": [ "calls" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/calls/{externalId}": { "get": { "operationId": "GET_integrations_ingame_calls_externalId", "summary": "Eine Meldung über die Kennung des Spielservers lesen (Scope calls:read )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "externalId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/calls/{externalId}/resolve": { "post": { "operationId": "POST_integrations_ingame_calls_externalId_resolve", "summary": "Meldung abschließen, weil sie sich im Spiel erledigt hat: { \"resolution\"? } (Scope calls:call.report )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "externalId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "call.resolve", "x-mdt-topics": [ "calls" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/capabilities": { "get": { "operationId": "GET_integrations_ingame_capabilities", "summary": "Verfügbare InGame-Integrationsfunktionen lesen", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/employees/{userId}": { "get": { "operationId": "GET_integrations_ingame_employees_userId", "summary": "Mitarbeiter über die Discord-Kennung lesen: Name, Dienstnummer, Ränge mit inGameKey , im Dienst, gesperrt (Scope employees:read )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/employees/{userId}/clock-in": { "post": { "operationId": "POST_integrations_ingame_employees_userId_clock_in", "summary": "Im Spiel einstempeln (Discord-Kennung); 409 , wenn schon eingestempelt (Scope timeclock:shift.ingame_clock )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "shift.ingame_clock_in", "x-mdt-topics": [ "onDuty", "overview", "dispatchers", "alarm", "standby" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/employees/{userId}/clock-out": { "post": { "operationId": "POST_integrations_ingame_employees_userId_clock_out", "summary": "Im Spiel ausstempeln; 404 , wenn nicht eingestempelt (Scope timeclock:shift.ingame_clock )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "shift.ingame_clock_out", "x-mdt-topics": [ "onDuty", "overview", "dispatchers", "units", "alarm", "access", "einsatzEntries" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/employees/{userId}/ranks": { "put": { "operationId": "PUT_integrations_ingame_employees_userId_ranks", "summary": "InGame-Ränge einer Discord-Person synchronisieren", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "personal.ranks_set", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/employees/{userId}/unit-status": { "put": { "operationId": "PUT_integrations_ingame_employees_userId_unit_status", "summary": "Status der eigenen Einheit aus dem Spiel: { \"status\", \"callsign\"? } ; ohne callsign die Einheit, in der die Person sitzt; nur Besatzung, nur konfigurierte Status (Scope units:unit.ingame_status )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "Discord-Nutzer-Id (Snowflake)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "unit.ingame_status", "x-mdt-topics": [ "units", "alarm" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/hospital": { "get": { "operationId": "GET_integrations_ingame_hospital", "summary": "Das Krankenhaus im Spiel lesen: Häuser mit Räumen und Betten, je mit at ( x , y , z , heading oder null ), Belegung je Bett als Patienten-Ids, die Punkte ( xray , ct , theatre , reception ) und die Patienten im Haus mit Platz; 404 ohne Einrichtung-Modul (Scope facility:hospital.ingame_read )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/hospital/points": { "put": { "operationId": "PUT_integrations_ingame_hospital_points", "summary": "Im Spiel einrichten: { \"kind\", \"refId\"?, \"name\"?, \"buildingId\"?, \"roomId\"?, \"x\", \"y\", \"z\", \"heading\" } ; ohne refId legt building , room und bed die Zeile im MDT an ( 201 , gleicher Name im selben Haus bzw. Raum 409 ), mit refId wird eine vorhandene Zeile oder ein Punkt der eigenen Gilde platziert bzw. verschoben (Scope facility:hospital.ingame_layout )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "facility.ingame_hospital_point_set", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/hospital/points/{kind}/{refId}": { "delete": { "operationId": "DELETE_integrations_ingame_hospital_points_kind_refId", "summary": "Entfernen: bei bed und room samt Zeile im MDT (wie in den Einstellungen), bei building nur die Stelle im Spiel, bei Punkten der Punkt (Scope facility:hospital.ingame_layout )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "kind", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "refId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "facility.ingame_hospital_point_remove", "x-mdt-topics": [ "facility", "einsatz", "overview", "facilityStale", "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/queue-tickets": { "post": { "operationId": "POST_integrations_ingame_queue_tickets", "summary": "Wartenummer am Automaten im Spiel ziehen: { \"name\"? } , wie am Tresen (Person ist da); 409 , wenn Wartenummern aus sind (Scope facility:queue.ingame_ticket )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "facility.ingame_queue_ticket", "x-mdt-topics": [ "facilityStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/statuses": { "get": { "operationId": "GET_integrations_ingame_statuses", "summary": "Konfigurierte Status ( label , color , alarm ) für den Spielserver (Scope units:unit.ingame_status )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/integrations/ingame/tablet-links": { "post": { "operationId": "POST_integrations_ingame_tablet_links", "summary": "Einmaligen Anmeldelink fürs MDT im Spiel anfordern: { \"userId\": \"\" } -> 201 { url, expiresAt } , 60 Sekunden gültig, siehe „Das MDT im Spiel\" (Scope sessions:ingame.tablet_login )", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ingame.tablet_link_issue", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/medic/citizens/{id}": { "get": { "operationId": "GET_medic_citizens_id", "summary": "Medic-Person lesen", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.record.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.record.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/medic/citizens/{id}/state": { "put": { "operationId": "PUT_medic_citizens_id_state", "summary": "Medic-Personstatus setzen", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `medic.record.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "medic.record.edit", "x-mdt-audit": "medic.citizen_state_set", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/medic/citizens/resolve": { "post": { "operationId": "POST_medic_citizens_resolve", "summary": "Medic-Person auflösen", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `medic.record.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "medic.record.edit", "x-mdt-audit": "medic.citizen_resolve", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/medic/events": { "post": { "operationId": "POST_medic_events", "summary": "Medic-Ereignisse übernehmen; patient.admit ( { patientId, bedId, admittedByName? } , P7) legt auf ein Bett der eigenen Gilde, patient.discharge nimmt zusätzlich dischargedByName? und note?", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `medic.record.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "medic.record.edit", "x-mdt-audit": "medic.event_ingest", "x-mdt-topics": [ "medicPatient", "citizen", "einsatz", "facility", "overview", "einsatzStale", "facilityStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/medic/patients/{id}": { "get": { "operationId": "GET_medic_patients_id", "summary": "Medic-Patient lesen, mit den letzten 20 EKG-Streifen ( ecgStrips )", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.record.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.record.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/medic/qualifications": { "get": { "operationId": "GET_medic_qualifications", "summary": "Medic-Qualifikationen lesen", "tags": [ "Medic und InGame" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.record.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.record.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/patients/{pid}/injuries": { "get": { "operationId": "GET_patients_pid_injuries", "summary": "Verletzungen lesen", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.injury.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `injuries` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.injury.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "injuries", "x-mdt-rollout-flag": null } }, "/patients/{pid}/injuries/{region}": { "put": { "operationId": "PUT_patients_pid_injuries_region", "summary": "Verletzung setzen", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } }, { "name": "region", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.injury.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `injuries` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.injury.edit", "x-mdt-audit": "injury.set", "x-mdt-topics": [ "einsatz", "facility", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "injuries", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_patients_pid_injuries_region", "summary": "Verletzung ändern", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } }, { "name": "region", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.injury.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `injuries` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.injury.edit", "x-mdt-audit": "injury.update", "x-mdt-topics": [ "einsatz", "facility", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "injuries", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_patients_pid_injuries_region", "summary": "Verletzung entfernen", "tags": [ "Medic und InGame" ], "parameters": [ { "name": "pid", "in": "path", "required": true, "description": "Id des Patienten", "schema": { "type": "string" } }, { "name": "region", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `medic.injury.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `injuries` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "medic.injury.delete", "x-mdt-audit": "injury.delete", "x-mdt-topics": [ "einsatz", "facility", "einsatzEntries", "facilityEntries", "einsatzStale", "facilityStale" ], "x-mdt-module": "injuries", "x-mdt-rollout-flag": null } }, "/courses": { "get": { "operationId": "GET_courses", "summary": "Kurse und ihre Anmeldungen lesen", "tags": [ "Kurse" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "courses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "null" }, "color": { "type": "null" }, "nameLabel": { "type": "string" }, "openLabel": { "type": "string" }, "closedLabel": { "type": "string" }, "selfSignup": { "type": "boolean" }, "adminOnly": { "type": "boolean" }, "archived": { "type": "boolean" }, "order": { "type": "number" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "kind": { "type": "string" }, "options": { "type": "array", "items": {} }, "required": { "type": "boolean" }, "adminOnly": { "type": "boolean" }, "order": { "type": "number" } } } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "kind": { "type": "string" }, "fieldId": { "type": "null" }, "value": { "type": "null" }, "style": { "type": "string", "description": "style ist neutral, primary oder danger." }, "confirm": { "type": "boolean" }, "stage": { "type": "string", "description": "stage ist open, closed oder both - complete ist immer open, reopen immer closed." }, "order": { "type": "number" } } } } } } }, "registrations": { "type": "array", "description": "registrations ist eine Liste über alle Kurse hinweg; courseId sagt, zu welchem eine Anmeldung gehört.", "items": { "type": "object", "properties": { "id": { "type": "string" }, "courseId": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "object", "description": "values ist { Feld-Id: Wert }, getippt nach dem kind des Feldes (text/select → String, number → Zahl, date → \"YYYY-MM-DD\", checkbox → Boolean).", "properties": { "clf…": { "type": "string" } } }, "passedAt": { "type": "null", "description": "passedAt ist null, solange die Anmeldung nicht abgeschlossen wurde, sonst der Zeitpunkt (ISO-8601, UTC); outcome ist dann die Beschriftung der Aktion, die sie abgeschlossen hat. **Die Antwort hängt an der Leserin.** Ein Kurs fehlt samt seinen Anmeldungen, wenn sie ihn nicht sehen darf: courses.entry.view genügt nur, solange der Kurs nicht „nur mit Einzelrecht\" ist (adminOnly: true), sonst braucht es courses.course:.view." }, "outcome": { "type": "null" }, "createdAt": { "type": "string", "format": "date-time" } } } } } }, "example": { "courses": [ { "id": "clx…", "name": "Erste-Hilfe-Kurs", "description": null, "color": null, "nameLabel": "Name", "openLabel": "Anmeldungen", "closedLabel": "Bestanden", "selfSignup": true, "adminOnly": false, "archived": false, "order": 0, "fields": [ { "id": "clf…", "label": "Telefonnummer", "kind": "text", "options": [], "required": false, "adminOnly": false, "order": 0 } ], "actions": [ { "id": "cla…", "label": "Bestanden", "kind": "complete", "fieldId": null, "value": null, "style": "primary", "confirm": false, "stage": "open", "order": 0 } ] } ], "registrations": [ { "id": "clx…", "courseId": "clx…", "name": "Jermaine Prince", "values": { "clf…": "0176 12345678" }, "passedAt": null, "outcome": null, "createdAt": "2026-07-26T10:00:00.000Z" } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `courses.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "courses.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "courses", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_courses", "summary": "Anmeldung anlegen", "tags": [ "Kurse" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `courses.entry.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "courses.entry.create", "x-mdt-audit": "courses.create", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/{id}": { "patch": { "operationId": "PATCH_courses_id", "summary": "Felder einer Anmeldung bearbeiten", "tags": [ "Kurse" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.entry.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.entry.edit", "x-mdt-audit": "courses.update", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_courses_id", "summary": "Anmeldung löschen", "tags": [ "Kurse" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.entry.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.entry.delete", "x-mdt-audit": "courses.delete", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/{id}/actions/{actionId}": { "post": { "operationId": "POST_courses_id_actions_actionId", "summary": "Eine konfigurierte Aktion ausführen", "tags": [ "Kurse" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "actionId", "in": "path", "required": true, "description": "Id der Kursaktion", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.entry.action`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.entry.action", "x-mdt-audit": "courses.action_run", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/{id}/pass": { "post": { "operationId": "POST_courses_id_pass", "summary": "Anmeldung abschließen (erste complete -Aktion)", "tags": [ "Kurse" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.entry.pass`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.entry.pass", "x-mdt-audit": "courses.pass", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/{id}/unpass": { "post": { "operationId": "POST_courses_id_unpass", "summary": "Abschluss zurücknehmen (erste reopen -Aktion)", "tags": [ "Kurse" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.entry.pass`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.entry.pass", "x-mdt-audit": "courses.unpass", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/definitions": { "get": { "operationId": "GET_courses_definitions", "summary": "Kurse mit Feldern und Aktionen, ohne Anmeldungen", "tags": [ "Kurse" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.definition.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.definition.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "courses", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_courses_definitions", "summary": "Kurs anlegen", "tags": [ "Kurse" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.definition.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.definition.manage", "x-mdt-audit": "courses.course_create", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/definitions/{courseId}": { "patch": { "operationId": "PATCH_courses_definitions_courseId", "summary": "Kurs umbenennen/einstellen", "tags": [ "Kurse" ], "parameters": [ { "name": "courseId", "in": "path", "required": true, "description": "Id der Kursdefinition", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.definition.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.definition.manage", "x-mdt-audit": "courses.course_update", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_courses_definitions_courseId", "summary": "Leeren Kurs löschen", "tags": [ "Kurse" ], "parameters": [ { "name": "courseId", "in": "path", "required": true, "description": "Id der Kursdefinition", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.definition.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.definition.manage", "x-mdt-audit": "courses.course_delete", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/definitions/{courseId}/layout": { "put": { "operationId": "PUT_courses_definitions_courseId_layout", "summary": "Felder und Aktionen eines Kurses setzen", "tags": [ "Kurse" ], "parameters": [ { "name": "courseId", "in": "path", "required": true, "description": "Id der Kursdefinition", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.definition.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.definition.manage", "x-mdt-audit": "courses.layout_set", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/courses/definitions/order": { "put": { "operationId": "PUT_courses_definitions_order", "summary": "Kurse sortieren", "tags": [ "Kurse" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `courses.definition.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `courses` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "courses.definition.manage", "x-mdt-audit": "courses.course_reorder", "x-mdt-topics": [ "courses" ], "x-mdt-module": "courses", "x-mdt-rollout-flag": null } }, "/calendar": { "get": { "operationId": "GET_calendar", "summary": "Kalendertermine lesen: ?month=JJJJ-MM für einen Monat oder ?from=JJJJ-MM-TT&to=JJJJ-MM-TT für eine Spanne (höchstens 120 Tage); geliefert wird, was den Zeitraum überlappt", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `calendar.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "calendar.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_calendar", "summary": "Kalendertermin anlegen", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `calendar.entry.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "calendar.entry.create", "x-mdt-audit": "calendar.create", "x-mdt-topics": [ "calendar" ], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null } }, "/calendar/{id}": { "patch": { "operationId": "PATCH_calendar_id", "summary": "Kalendertermin ändern", "tags": [ "Kalender" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `calendar.entry.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "calendar.entry.edit", "x-mdt-audit": "calendar.update", "x-mdt-topics": [ "calendar" ], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_calendar_id", "summary": "Kalendertermin löschen; ?scope=series löscht die ganze Serie, alles andere nur diesen Termin", "tags": [ "Kalender" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `calendar.entry.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "calendar.entry.delete", "x-mdt-audit": "calendar.delete", "x-mdt-topics": [ "calendar" ], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null } }, "/calendar/categories": { "get": { "operationId": "GET_calendar_categories", "summary": "Kalenderkategorien lesen", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `calendar.category.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "calendar.category.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_calendar_categories", "summary": "Kalenderkategorien setzen (ersetzt die Liste; eine ungültige Kategorie lässt die gesamte Anfrage scheitern, statt Zeilen zu entfärben)", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `calendar.category.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "calendar.category.edit", "x-mdt-audit": "calendar.categories_set", "x-mdt-topics": [ "calendar" ], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null } }, "/calendar/reminders": { "get": { "operationId": "GET_calendar_reminders", "summary": "Kalender-Erinnerungen lesen", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `calendar.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "calendar.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null } }, "/calendar/settings": { "get": { "operationId": "GET_calendar_settings", "summary": "Kalendereinstellungen lesen", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_calendar_settings", "summary": "Kalendereinstellungen setzen", "tags": [ "Kalender" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `calendar` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "calendar.settings_set", "x-mdt-topics": [ "calendar" ], "x-mdt-module": "calendar", "x-mdt-rollout-flag": null } }, "/board-activity": { "get": { "operationId": "GET_board_activity", "summary": "Letzte Änderungen am Leitstellenblatt (Protokoll, Kategorie board )", "tags": [ "Schwarzes Brett" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "string", "format": "date-time" }, "action": { "type": "string" }, "actionLabel": { "type": "string" }, "category": { "type": "string" }, "categoryLabel": { "type": "string" }, "source": { "type": "string" }, "actorName": { "type": "string" }, "summary": { "type": "string" } } } } } }, "example": { "entries": [ { "id": "clx…", "at": "2026-09-28T10:05:00.000Z", "action": "unit.update", "actionLabel": "Einheit geändert", "category": "board", "categoryLabel": "Leitstellenblatt", "source": "web", "actorName": "[MD-12] Max", "summary": "RTW 2: Status 4" } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.units.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.units.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "board", "x-mdt-rollout-flag": null } }, "/board-notices": { "get": { "operationId": "GET_board_notices", "summary": "Aushänge des Schwarzen Bretts lesen", "tags": [ "Schwarzes Brett" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "notices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "body": { "type": "string" }, "expiresOn": { "type": "string", "description": "expiresOn ist der letzte Tag, an dem der Aushang läuft (YYYY-MM-DD), oder null für „läuft bis auf Widerruf\"." }, "expired": { "type": "boolean", "description": "expired wird vom Server gegen den Berliner Kalendertag berechnet: Das Laufband zeigt die Aushänge mit expired: false, abgelaufene bleiben in der Antwort, damit ein Admin sie sehen und entfernen kann." }, "createdAt": { "type": "string", "format": "date-time" } } } } } }, "example": { "notices": [ { "id": "clx…", "body": "Schulung am Samstag um 20 Uhr", "expiresOn": "2026-07-30", "expired": false, "createdAt": "2026-07-26T10:00:00.000Z" } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.notices.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.notices.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "board", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_board_notices", "summary": "Aushang veröffentlichen", "tags": [ "Schwarzes Brett" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `board.notices.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "board.notices.create", "x-mdt-audit": "notice.create", "x-mdt-topics": [ "notices" ], "x-mdt-module": "board", "x-mdt-rollout-flag": null } }, "/board-notices/{id}": { "patch": { "operationId": "PATCH_board_notices_id", "summary": "Aushang ändern", "tags": [ "Schwarzes Brett" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `board.notices.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "board.notices.edit", "x-mdt-audit": "notice.update", "x-mdt-topics": [ "notices" ], "x-mdt-module": "board", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_board_notices_id", "summary": "Aushang entfernen", "tags": [ "Schwarzes Brett" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `board.notices.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `board` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "board.notices.delete", "x-mdt-audit": "notice.delete", "x-mdt-topics": [ "notices" ], "x-mdt-module": "board", "x-mdt-rollout-flag": null } }, "/documents": { "get": { "operationId": "GET_documents", "summary": "Dokumente lesen", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_documents", "summary": "Dokument oder Kategorie anlegen", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.create", "x-mdt-audit": "document.create", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}": { "get": { "operationId": "GET_documents_id", "summary": "Dokument lesen", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_documents_id", "summary": "Dokument ändern oder in den Papierkorb legen ( ?permanent=1 : endgültig löschen)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.edit", "x-mdt-audit": "document.update", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_documents_id", "summary": "Dokument ändern oder in den Papierkorb legen ( ?permanent=1 : endgültig löschen)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "permanent", "in": "query", "required": false, "description": "`1` löscht endgültig statt in den Papierkorb", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.delete", "x-mdt-audit": "document.delete", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/access-log": { "get": { "operationId": "GET_documents_id_access_log", "summary": "Zugriffe von Partnern und über öffentliche Links der letzten 30 Tage ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/acknowledge": { "post": { "operationId": "POST_documents_id_acknowledge", "summary": "Aktuelle Version als „Gelesen und verstanden\" bestätigen", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.acknowledge", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/acknowledgements": { "get": { "operationId": "GET_documents_id_acknowledgements", "summary": "Bestätigungen und noch offene Personen lesen (Admin)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.acknowledgement.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.acknowledgement.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/acknowledgements/remind": { "post": { "operationId": "POST_documents_id_acknowledgements_remind", "summary": "Alle, die die aktuelle Version noch nicht bestätigt haben, per Discord-Direktnachricht erinnern; höchstens alle 10 Minuten ( documents.acknowledgement.view )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.acknowledgement.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.acknowledgement.view", "x-mdt-audit": "document.ack_remind", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/comments": { "get": { "operationId": "GET_documents_id_comments", "summary": "Anmerkungen eines Dokuments lesen", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_documents_id_comments", "summary": "Anmerkung schreiben { \"body\", \"quote\"?, \"parentId\"? }", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.comment_create", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/comments/{commentId}": { "patch": { "operationId": "PATCH_documents_id_comments_commentId", "summary": "Eigene Anmerkung ändern { \"body\" } oder Faden erledigen { \"resolved\" }", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "commentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.comment_update", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_documents_id_comments_commentId", "summary": "Anmerkung löschen (eigene; wer schreiben darf, auch fremde)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "commentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.comment_delete", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/discord-posts": { "get": { "operationId": "GET_documents_id_discord_posts", "summary": "Discord-Posts eines Dokuments lesen ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_documents_id_discord_posts", "summary": "Dokument in einen Discord-Kanal posten { \"channelId\", \"message\"?, \"withAckButton\"?, \"updateOnNewVersion\"?, \"mentionRoleId\"? } ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": "document.discord_post", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/discord-posts/{postId}": { "delete": { "operationId": "DELETE_documents_id_discord_posts_postId", "summary": "Post vergessen, mit message=1 auch in Discord löschen ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "postId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": "document.discord_post_delete", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/duplicate": { "post": { "operationId": "POST_documents_id_duplicate", "summary": "Dokument als Kopie anlegen (Admin)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.create", "x-mdt-audit": "document.duplicate", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/pdf": { "get": { "operationId": "GET_documents_id_pdf", "summary": "Dokument als PDF abrufen", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.export`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.export", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/read": { "post": { "operationId": "POST_documents_id_read", "summary": "Dokument als gelesen markieren", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.read", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/restore": { "post": { "operationId": "POST_documents_id_restore", "summary": "Dokument aus dem Papierkorb zurückholen (Admin)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.delete", "x-mdt-audit": "document.restore", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/revisions": { "get": { "operationId": "GET_documents_id_revisions", "summary": "Versionsverlauf eines Dokuments lesen (neueste zuerst, ohne Text)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/revisions/{rev}": { "get": { "operationId": "GET_documents_id_revisions_rev", "summary": "Eine Version vollständig lesen (mit body )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "rev", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/revisions/{rev}/restore": { "post": { "operationId": "POST_documents_id_revisions_rev_restore", "summary": "Version als neue Version wiederherstellen (Admin)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "rev", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.edit", "x-mdt-audit": "document.revision_restore", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/sharing": { "get": { "operationId": "GET_documents_id_sharing", "summary": "Freigaben eines Dokuments: Sichtbarkeit nach Rang, Partnerfreigaben, öffentlicher Link, wählbare Partner, access (Personen und Gruppen als Datenregeln, wählbare Abteilungen und Personen) ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/sharing/access": { "put": { "operationId": "PUT_documents_id_sharing_access", "summary": "Personen und Gruppen am Dokument { \"subject\": { \"kind\": \"rank\" | \"unit\" | \"user\", \"id\" }, \"effect\": \"allow\" | \"deny\" | null } ; jede Zeile ist eine verwaltete Datenregel, null entfernt sie ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": "document.share_access", "x-mdt-topics": [ "documentsStale", "documents" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/sharing/partners/{partnerGuildId}": { "put": { "operationId": "PUT_documents_id_sharing_partners_partnerGuildId", "summary": "Partnerfreigabe setzen { \"access\", \"expiresAt\"? } mit access = READ , CONTRIBUTE oder null ; null zieht zurück ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "partnerGuildId", "in": "path", "required": true, "description": "Server-Id der Partnerinstanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": "document.share_partner", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/{id}/sharing/public": { "put": { "operationId": "PUT_documents_id_sharing_public", "summary": "Öffentlichen Leselink ein-/ausschalten und einstellen { \"enabled\", \"expiresAt\"?, \"password\"?, \"watermark\"?, \"latest\"?, \"regenerate\"? } ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": "document.share_public", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/categories": { "get": { "operationId": "GET_documents_categories", "summary": "Dokumentenkategorien mit Zählung je Kategorie, ohne Dokumente ( categories , counts )", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.category.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.category.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_documents_categories", "summary": "Dokumentenkategorie anlegen", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.category.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.category.create", "x-mdt-audit": "doccategory.create", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/categories/{id}": { "patch": { "operationId": "PATCH_documents_categories_id", "summary": "Dokumentenkategorie ändern", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.category.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.category.edit", "x-mdt-audit": "doccategory.rename", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_documents_categories_id", "summary": "Dokumentenkategorie löschen", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.category.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.category.delete", "x-mdt-audit": "doccategory.delete", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/categories/order": { "put": { "operationId": "PUT_documents_categories_order", "summary": "Dokumentenkategorien sortieren", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.category.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.category.edit", "x-mdt-audit": "doccategory.reorder", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/discord-targets": { "get": { "operationId": "GET_documents_discord_targets", "summary": "Textkanäle und Rollen für Discord-Posts ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/order": { "put": { "operationId": "PUT_documents_order", "summary": "Dokumente sortieren", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.document.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.document.edit", "x-mdt-audit": "document.reorder", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/partner-shares": { "get": { "operationId": "GET_documents_partner_shares", "summary": "Dokumente, die Partnerinstanzen mit dieser Instanz teilen", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/partner-shares/{shareId}": { "get": { "operationId": "GET_documents_partner_shares_shareId", "summary": "Ein geteiltes Dokument einer Partnerinstanz lesen (wird dort protokolliert)", "tags": [ "Dokumente" ], "parameters": [ { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/partner-shares/{shareId}/comments": { "get": { "operationId": "GET_documents_partner_shares_shareId_comments", "summary": "Anmerkungen eines geteilten Dokuments (nur mit „Mitarbeiten\")", "tags": [ "Dokumente" ], "parameters": [ { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_documents_partner_shares_shareId_comments", "summary": "Anmerkung zu einem geteilten Dokument schreiben (nur mit „Mitarbeiten\")", "tags": [ "Dokumente" ], "parameters": [ { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.comment_create", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/partner-shares/{shareId}/comments/{commentId}": { "patch": { "operationId": "PATCH_documents_partner_shares_shareId_comments_commentId", "summary": "Eigene Anmerkung ändern oder Faden erledigen (nur mit „Mitarbeiten\")", "tags": [ "Dokumente" ], "parameters": [ { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "commentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.comment_update", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_documents_partner_shares_shareId_comments_commentId", "summary": "Eigene Anmerkung löschen (nur mit „Mitarbeiten\")", "tags": [ "Dokumente" ], "parameters": [ { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "commentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": "document.comment_delete", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/shares": { "get": { "operationId": "GET_documents_shares", "summary": "Alle Freigaben der Instanz mit Dokument, Empfänger, Ablauf und Aufrufen ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/shares/bulk": { "post": { "operationId": "POST_documents_shares_bulk", "summary": "Mehrere Freigaben verlängern oder entziehen { \"ids\", \"action\", \"days\"? } mit action = extend oder revoke ( documents.share.manage )", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.share.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.share.manage", "x-mdt-audit": "document.share_bulk", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/templates": { "get": { "operationId": "GET_documents_templates", "summary": "Dokumentvorlagen lesen (eingebaute zuerst)", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.template.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.template.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_documents_templates", "summary": "Dokumentvorlage anlegen (Admin)", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.template.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.template.create", "x-mdt-audit": "doctemplate.create", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/templates/{id}": { "patch": { "operationId": "PATCH_documents_templates_id", "summary": "Dokumentvorlage ändern (Admin)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.template.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.template.edit", "x-mdt-audit": "doctemplate.update", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_documents_templates_id", "summary": "Dokumentvorlage löschen (Admin)", "tags": [ "Dokumente" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.template.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.template.delete", "x-mdt-audit": "doctemplate.delete", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/templates/order": { "put": { "operationId": "PUT_documents_templates_order", "summary": "Dokumentvorlagen sortieren (Admin)", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `documents.template.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "documents.template.edit", "x-mdt-audit": "doctemplate.reorder", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/documents/unread": { "get": { "operationId": "GET_documents_unread", "summary": "Ungelesene Dokumente lesen", "tags": [ "Dokumente" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.document.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `documents` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.document.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "documents", "x-mdt-rollout-flag": null } }, "/lists": { "get": { "operationId": "GET_lists", "summary": "Listen samt ihrer Spalten lesen", "tags": [ "Listen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lists", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_lists", "summary": "Liste anlegen oder löschen", "tags": [ "Listen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.create", "x-mdt-audit": "list.create", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}": { "patch": { "operationId": "PATCH_lists_id", "summary": "Liste ändern (Name, Beschreibung, wer darin schreiben darf)", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.edit", "x-mdt-audit": "list.update", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_lists_id", "summary": "Liste anlegen oder löschen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.delete", "x-mdt-audit": "list.delete", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/entries": { "get": { "operationId": "GET_lists_id_entries", "summary": "Zeilen einer Liste lesen; Zählerstände gelten für den gefragten Zeitraum", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lists", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_lists_id_entries", "summary": "Zeile anlegen oder löschen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.create", "x-mdt-audit": "list.entry_create", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/entries/{entryId}": { "patch": { "operationId": "PATCH_lists_id_entries_entryId", "summary": "Zellen einer Zeile ändern", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.edit", "x-mdt-audit": "list.entry_update", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_lists_id_entries_entryId", "summary": "Zeile anlegen oder löschen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.entry.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.entry.delete", "x-mdt-audit": "list.entry_delete", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/entries/{entryId}/counts": { "get": { "operationId": "GET_lists_id_entries_entryId_counts", "summary": "Gesamtzahl der Zählereignisse einer Zeile", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/entries/{entryId}/counts/{fieldId}": { "post": { "operationId": "POST_lists_id_entries_entryId_counts_fieldId", "summary": "Zähler erhöhen (stempelt immer jetzt )", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "description": "Id des Feldes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.count`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.count", "x-mdt-audit": "list.count_add", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/entries/{entryId}/counts/{fieldId}/latest": { "delete": { "operationId": "DELETE_lists_id_entries_entryId_counts_fieldId_latest", "summary": "Neuestes Zählereignis im gezeigten Zeitraum zurücknehmen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "description": "Id des Feldes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `lists.entry.count`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "lists.entry.count", "x-mdt-audit": "list.count_remove", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/fields": { "post": { "operationId": "POST_lists_id_fields", "summary": "Spalte anlegen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.create", "x-mdt-audit": "list.field_create", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/fields/{fieldId}": { "patch": { "operationId": "PATCH_lists_id_fields_fieldId", "summary": "Spalte ändern", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "description": "Id des Feldes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.edit", "x-mdt-audit": "list.field_update", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_lists_id_fields_fieldId", "summary": "Spalte löschen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "description": "Id des Feldes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.delete", "x-mdt-audit": "list.field_delete", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/fields/{fieldId}/usage": { "get": { "operationId": "GET_lists_id_fields_fieldId_usage", "summary": "Wie viele Zellen und Zählereignisse an einer Spalte hängen", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "fieldId", "in": "path", "required": true, "description": "Id des Feldes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.delete", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/{id}/fields/order": { "put": { "operationId": "PUT_lists_id_fields_order", "summary": "Spalten sortieren", "tags": [ "Listen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.edit", "x-mdt-audit": "list.field_reorder", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lists/order": { "put": { "operationId": "PUT_lists_order", "summary": "Listen sortieren", "tags": [ "Listen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lists.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lists` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lists.setup.edit", "x-mdt-audit": "list.reorder", "x-mdt-topics": [ "lists" ], "x-mdt-module": "lists", "x-mdt-rollout-flag": null } }, "/lager": { "get": { "operationId": "GET_lager", "summary": "Lager auflisten (Bestandsübersicht) - Admin-Rechte auch zum Lesen", "tags": [ "Lager" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "lager": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "position": { "type": "number" }, "itemCount": { "type": "number", "description": "itemCount zählt nur nicht archivierte Artikel." }, "lastCountDate": { "type": "string", "description": "lastCountDate ist das Datum (YYYY-MM-DD) des jüngsten erfassten Tages dieses Lagers, oder null, wenn noch nie gezählt wurde." } } } } } }, "example": { "lager": [ { "id": "clx…", "name": "Hauptlager", "position": 0, "itemCount": 12, "lastCountDate": "2026-07-30" } ] } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.lager.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.lager.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lager", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_lager", "summary": "Lager anlegen", "tags": [ "Lager" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.lager.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.lager.create", "x-mdt-audit": "lager.create", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/lager/{id}": { "get": { "operationId": "GET_lager_id", "summary": "Inventur eines Tages lesen (ohne date der heutige)", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": false, "description": "Tag im Format YYYY-MM-DD; ohne: heute", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.lager.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.lager.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lager", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_lager_id", "summary": "Lager umbenennen und/oder Artikelsortierung ändern", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.lager.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.lager.edit", "x-mdt-audit": "lager.update", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_lager_id", "summary": "Lager löschen (mit allen Artikeln, Tagen und Zählungen)", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.lager.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.lager.delete", "x-mdt-audit": "lager.delete", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/lager/{id}/day": { "put": { "operationId": "PUT_lager_id_day", "summary": "Heutige Inventur erfassen/aktualisieren (kein Datum im Body)", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.stock.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.stock.edit", "x-mdt-audit": "lager.day_save", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/lager/{id}/items": { "post": { "operationId": "POST_lager_id_items", "summary": "Artikel anlegen", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.item.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.item.create", "x-mdt-audit": "lager.item_create", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/lager/{id}/items/{itemId}": { "patch": { "operationId": "PATCH_lager_id_items_itemId", "summary": "Artikel bearbeiten", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.item.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.item.edit", "x-mdt-audit": "lager.item_update", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_lager_id_items_itemId", "summary": "Artikel archivieren (keine Löschung)", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.item.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.item.delete", "x-mdt-audit": "lager.item_archive", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/lager/{id}/items/order": { "put": { "operationId": "PUT_lager_id_items_order", "summary": "Eigene Artikelreihenfolge speichern", "tags": [ "Lager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.item.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Versions- oder Zustandskonflikt (siehe Details)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.item.edit", "x-mdt-audit": "lager.item_reorder", "x-mdt-topics": [ "lager" ], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/lager/search": { "get": { "operationId": "GET_lager_search", "summary": "Artikel über alle Lager des Servers suchen ( lagerId optional, für Vorrang)", "tags": [ "Lager" ], "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Suchbegriff", "schema": { "type": "string" } }, { "name": "lagerId", "in": "query", "required": false, "description": "Nur in diesem Lager suchen", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "lagerId": { "type": "string", "description": "lagerId ist **optional** und nennt das Lager, das im Browser gerade offen ist." }, "lagerName": { "type": "string" } } } } } }, "example": { "results": [ { "itemId": "cli…", "name": "Sterile Verbände", "unit": "Packungen", "lagerId": "clx…", "lagerName": "Hauptlager" } ] } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `lager.lager.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `lager` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "lager.lager.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "lager", "x-mdt-rollout-flag": null } }, "/versicherung/catalog": { "get": { "operationId": "GET_versicherung_catalog", "summary": "Preisliste lesen: Tarife, Modul×Tarif-Matrix, Rabattstaffel - Admin-Rechte auch zum Lesen", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/customers": { "get": { "operationId": "GET_versicherung_customers", "summary": "Versicherte auflisten, je mit Personenzahl und gerechneter Prämie", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_versicherung_customers", "summary": "Versicherten anlegen ( name , tariffId , optional note )", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.create", "x-mdt-audit": "customer.create", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/customers/{id}": { "get": { "operationId": "GET_versicherung_customers_id", "summary": "Ein Versicherter samt seiner Personen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_versicherung_customers_id", "summary": "Name, Tarif, Notiz, gebuchte Plätze ( bookedSlots , null = nach eingetragenen Personen rechnen), Vertragslaufzeit ( termFrom / termTo , \"YYYY-MM-DD\" , null = entfernen), Kontingente ( quotas : Liste aus { id, name, limit, taken } , ersetzt die gespeicherte ganz; id: null legt ein neues an, höchstens 12, Namen eindeutig) und/oder gebuchte Module ( moduleIds ) ändern", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.edit", "x-mdt-audit": "customer.update", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_versicherung_customers_id", "summary": "Versicherten löschen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.delete", "x-mdt-audit": "customer.delete", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/customers/{id}/persons": { "post": { "operationId": "POST_versicherung_customers_id_persons", "summary": "Versicherte Person hinzufügen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.person.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.person.create", "x-mdt-audit": "person.create", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/customers/{id}/persons/{personId}": { "patch": { "operationId": "PATCH_versicherung_customers_id_persons_personId", "summary": "Person umbenennen oder Notiz ändern", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "personId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.person.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.person.edit", "x-mdt-audit": "person.update", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_versicherung_customers_id_persons_personId", "summary": "Person entfernen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "personId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.person.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.person.delete", "x-mdt-audit": "person.delete", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/customers/{id}/persons/order": { "put": { "operationId": "PUT_versicherung_customers_id_persons_order", "summary": "Reihenfolge der Personen setzen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.person.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.person.edit", "x-mdt-audit": "person.reorder", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/customers/order": { "put": { "operationId": "PUT_versicherung_customers_order", "summary": "Reihenfolge der Versicherten setzen", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.edit", "x-mdt-audit": "customer.reorder", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/discounts": { "post": { "operationId": "POST_versicherung_discounts", "summary": "Rabattstufe anlegen oder überschreiben (eine je Personenzahl)", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.create", "x-mdt-audit": "discount.upsert", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/discounts/{id}": { "delete": { "operationId": "DELETE_versicherung_discounts_id", "summary": "Rabattstufe löschen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.delete", "x-mdt-audit": "discount.delete", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/expiring": { "get": { "operationId": "GET_versicherung_expiring", "summary": "Verträge, deren Vertragsende in den eingestellten Vorlauf fällt - für das Band auf dem Leitstellenblatt", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.customer.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.customer.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/kasse": { "get": { "operationId": "GET_versicherung_kasse", "summary": "Kassenbuch lesen (ohne month alles); keine Summenzeile", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.kasse.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.kasse.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_versicherung_kasse", "summary": "Kassenzeile anlegen ( date , employeeId , purpose , amount vorzeichenbehaftet, optional note , paidOut )", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.kasse.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.kasse.create", "x-mdt-audit": "kasse.create", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/kasse/{id}": { "patch": { "operationId": "PATCH_versicherung_kasse_id", "summary": "Kassenzeile ändern", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.kasse.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.kasse.edit", "x-mdt-audit": "kasse.update", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_versicherung_kasse_id", "summary": "Kassenzeile löschen", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.kasse.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.kasse.delete", "x-mdt-audit": "kasse.delete", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/kasse/persons": { "get": { "operationId": "GET_versicherung_kasse_persons", "summary": "Wer als Person einer Kassenzeile in Frage kommt: Admins dieser Gilde (Discord-Administratoren und die in den Einstellungen zusätzlich eingetragenen), geschnitten mit dem Personalblatt. partial: true heißt, der Mitglieder-Cache war noch nicht warm (kurz nach dem Start) - es wird bewusst nie pro Anfrage abgerufen", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.kasse.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.kasse.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/modules": { "post": { "operationId": "POST_versicherung_modules", "summary": "Modul anlegen", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.create", "x-mdt-audit": "module.create", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/modules/{id}": { "patch": { "operationId": "PATCH_versicherung_modules_id", "summary": "Modul umbenennen, Abrechnungsart setzen ( perPerson : Preis je Person statt einmalig) und/oder Preise setzen ( prices: { tariffId: Betrag | null } , null löscht den Preis)", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.edit", "x-mdt-audit": "module.update", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_versicherung_modules_id", "summary": "Modul archivieren (bleibt bei Kunden gebucht)", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.delete", "x-mdt-audit": "module.archive", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/modules/order": { "put": { "operationId": "PUT_versicherung_modules_order", "summary": "Reihenfolge der Module setzen", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.edit", "x-mdt-audit": "module.reorder", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/overview": { "get": { "operationId": "GET_versicherung_overview", "summary": "Versicherungsnehmer, die gebuchten Module, Kontingente mit gerechnetem Stand ( quotas : { name, taken, limit } ) und Vertragsende - die einzige Ausnahme im Namensraum: ohne Admin-Rechte lesbar, aber nur wenn die Gilde die Übersicht freigegeben hat ( overviewPublic ); sonst 403. Für Admins immer lesbar", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/settings": { "get": { "operationId": "GET_versicherung_settings", "summary": "Vorlauf der Ablauf-Erinnerung und Freigabe der Übersicht lesen ( expiryLeadDays , overviewPublic )", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_versicherung_settings", "summary": "Beides setzen, jedes für sich ( expiryLeadDays , ganze Zahl 0–90; overviewPublic , Ja/Nein). Nur mitgeschickte Felder werden geschrieben", "tags": [ "Versicherungen" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "versicherung.settings_set", "x-mdt-topics": [ "versicherung", "access" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/versicherung/tariffs/{id}": { "patch": { "operationId": "PATCH_versicherung_tariffs_id", "summary": "Tarifname und/oder Grundpreis ändern", "tags": [ "Versicherungen" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `versicherung.catalog.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `versicherung` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "versicherung.catalog.edit", "x-mdt-audit": "tariff.update", "x-mdt-topics": [ "versicherung" ], "x-mdt-module": "versicherung", "x-mdt-rollout-flag": null } }, "/postfach/banner/{guildId}": { "get": { "operationId": "GET_postfach_banner_guildId", "summary": "Panel-Banner als Bild (Session-Cookie, Einstellungsrecht)", "tags": [ "Postfach" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `postfach.case.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "postfach.case.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases": { "get": { "operationId": "GET_postfach_cases", "summary": "Bewerbungen und Kontaktanfragen auflisten; Intern-Fälle nur mit postfach.intern", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_postfach_cases", "summary": "Gespräch mit einer Person eröffnen ( userId , category , subject , body ): Kontakt-Fall samt Ticket-Kanal und erster Nachricht; Intern nur mit postfach.intern ; verlangt postfach.case.create", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.create", "x-mdt-audit": "postfach.open", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}": { "get": { "operationId": "GET_postfach_cases_id", "summary": "Fall mit Antworten, gespiegeltem Gespräch und Ereignissen", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_postfach_cases_id", "summary": "Status setzen oder sich zuweisen ( assignee: \"me\" | null )", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.edit", "x-mdt-audit": "postfach.update", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/channel": { "post": { "operationId": "POST_postfach_cases_id_channel", "summary": "Ticket-Kanal erneut anlegen", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.edit", "x-mdt-audit": "postfach.channel_retry", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/close": { "post": { "operationId": "POST_postfach_cases_id_close", "summary": "Fall schließen, optional mit Abschlussnachricht", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.edit", "x-mdt-audit": "postfach.close", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/decline": { "post": { "operationId": "POST_postfach_cases_id_decline", "summary": "Bewerbung ablehnen, optional mit Grund", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.applicant.hire`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.applicant.hire", "x-mdt-audit": "postfach.decline", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/hire": { "get": { "operationId": "GET_postfach_cases_id_hire", "summary": "Vorschau zum Einstellen: Dienstnummer, Rang, Rollen, Nickname", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.applicant.hire`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.applicant.hire", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_postfach_cases_id_hire", "summary": "Bewerbung annehmen: Rollen, Nickname, Personalblatt, Begrüßung, Abschluss", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.applicant.hire`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.applicant.hire", "x-mdt-audit": "postfach.hire", "x-mdt-topics": [ "postfach", "personal" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/messages": { "post": { "operationId": "POST_postfach_cases_id_messages", "summary": "Antwort in den Ticket-Kanal senden ( multipart/form-data : body , bis zu 5 files )", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.message.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.message.create", "x-mdt-audit": "postfach.reply", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/messages/{messageId}/retry": { "post": { "operationId": "POST_postfach_cases_id_messages_messageId_retry", "summary": "Fehlgeschlagene eigene Antwort erneut senden", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "messageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.message.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.message.create", "x-mdt-audit": "postfach.retry", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/notes": { "post": { "operationId": "POST_postfach_cases_id_notes", "summary": "Interne Notiz schreiben (wird nie nach Discord gesendet)", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.note.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.note.create", "x-mdt-audit": "postfach.note", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/read": { "post": { "operationId": "POST_postfach_cases_id_read", "summary": "Eigenen Lesestand setzen", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.view", "x-mdt-audit": "postfach.read", "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/cases/{id}/reopen": { "post": { "operationId": "POST_postfach_cases_id_reopen", "summary": "Geschlossenen oder abgelehnten Fall wieder öffnen; holt den Ticket-Kanal zurück oder legt ihn neu an", "tags": [ "Postfach" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.edit", "x-mdt-audit": "postfach.reopen", "x-mdt-topics": [ "postfach" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/files/{messageId}/{index}": { "get": { "operationId": "GET_postfach_files_messageId_index", "summary": "Gespeicherter Anhang einer Postfach-Nachricht (Session-Cookie)", "tags": [ "Postfach" ], "parameters": [ { "name": "messageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "index", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `postfach.case.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "postfach.case.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/intern": { "get": { "operationId": "GET_postfach_intern", "summary": "Nur die internen Nachrichten an die Leitung; verlangt postfach.intern", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.intern.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.intern.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/members": { "get": { "operationId": "GET_postfach_members", "summary": "Server-Mitglieder für „Neues Gespräch\" suchen; verlangt postfach.case.create", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.create", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/settings": { "get": { "operationId": "GET_postfach_settings", "summary": "Postfach-Einstellungen samt Kategorien und Warnungen", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_postfach_settings", "summary": "Postfach-Einstellungen setzen; Team- und Leitungs-Rollen ändert nur, wer postfach.case.view bzw. postfach.intern.view oder settings.manage hält", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "postfach.settings_set", "x-mdt-topics": [ "settings" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/settings/banner": { "post": { "operationId": "POST_postfach_settings_banner", "summary": "Panel-Banner hochladen (PNG/JPEG)", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "postfach.banner_upload", "x-mdt-topics": [ "settings" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_postfach_settings_banner", "summary": "Panel-Banner entfernen", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "postfach.banner_delete", "x-mdt-topics": [ "settings" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/settings/publish/{panel}": { "post": { "operationId": "POST_postfach_settings_publish_panel", "summary": "Panel bewerbung oder kontakt in einem Kanal veröffentlichen", "tags": [ "Postfach" ], "parameters": [ { "name": "panel", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "postfach.panel_publish", "x-mdt-topics": [ "settings" ], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/settings/ranks": { "get": { "operationId": "GET_postfach_settings_ranks", "summary": "Ränge für die Auswahl der Einstiegsränge (nur id und label )", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/postfach/unread": { "get": { "operationId": "GET_postfach_unread", "summary": "Anzahl der Fälle mit ungelesenen Nachrichten der anfragenden Person", "tags": [ "Postfach" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `postfach.case.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `postfach` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "postfach.case.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "postfach", "x-mdt-rollout-flag": null } }, "/tv/design": { "get": { "operationId": "GET_tv_design", "summary": "KI-Design lesen: assets (Logo, Beispielfolien, Hintergründe mit role , note , enabled ), notes (Gestaltungshinweise) und ai ( canGenerate , blocked = Grund, warum nicht, imageModel , imageQuality , maxSlides ) (Admin/ tv.screen.view )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_tv_design", "summary": "Gestaltungshinweise für die KI setzen: { \"notes\": \"…\" } (bis 2000 Zeichen) (Admin/ tv.design.edit )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.design.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.design.edit", "x-mdt-audit": "tv.design_notes_set", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/design/assets": { "post": { "operationId": "POST_tv_design_assets", "summary": "Design-Asset hochladen ( multipart/form-data , Feld file ; PNG/JPEG/WebP, höchstens 12 Assets, auf 2048 px verkleinert, zählt zum Speicher der Gilde) (Admin/ tv.design.edit )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.design.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.design.edit", "x-mdt-audit": "tv.design_asset_add", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/design/assets/{id}": { "patch": { "operationId": "PATCH_tv_design_assets_id", "summary": "Design-Asset ändern: name , role ( logo | example | background | other ), note , enabled (Admin/ tv.design.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.design.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.design.edit", "x-mdt-audit": "tv.design_asset_update", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_tv_design_assets_id", "summary": "Design-Asset löschen (Admin/ tv.design.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.design.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.design.edit", "x-mdt-audit": "tv.design_asset_delete", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/design/assets/{id}/image": { "get": { "operationId": "GET_tv_design_assets_id_image", "summary": "Bild eines Design-Assets (Admin/ tv.screen.view , Session-Cookie)", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `tv.screen.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "tv.screen.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations": { "get": { "operationId": "GET_tv_presentations", "summary": "TV-Reiter lesen: Präsentationen samt Folien, Bildschirme, Standby-Bild, Speicherbelegung und can (je tv.* -Recht ein Wahrheitswert: present , screenCreate , screenEdit , screenDelete , links , presentationCreate , presentationEdit , presentationDelete , slideCreate , slideEdit , slideDelete , slideGenerate , design , standby ) sowie generations (laufende und gerade beendete KI-Erstellungen je Präsentation: status , total , done , failed , error , titles ). Ohne tv.screen.links fehlen die Bildschirm-Links ( streamUrl / stillUrl sind null ) (Admin/ tv.screen.view )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_tv_presentations", "summary": "TV-Präsentation anlegen (Admin/ tv.presentation.create )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.presentation.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.presentation.create", "x-mdt-audit": "tv.presentation_create", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}": { "patch": { "operationId": "PATCH_tv_presentations_id", "summary": "Name und/oder defaultSlideSeconds (3–3600, Takt der Automatik) ändern (Admin/ tv.presentation.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.presentation.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.presentation.edit", "x-mdt-audit": "tv.presentation_rename", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_tv_presentations_id", "summary": "TV-Präsentation samt Folien löschen; ihre Bildschirme zeigen danach das Standby-Bild (Admin/ tv.presentation.delete )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.presentation.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.presentation.delete", "x-mdt-audit": "tv.presentation_delete", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/duplicate": { "post": { "operationId": "POST_tv_presentations_id_duplicate", "summary": "Präsentation samt Folien kopieren, ohne Bildschirme; Antwort mit createdId (Admin/ tv.presentation.create )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.presentation.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.presentation.create", "x-mdt-audit": "tv.presentation_duplicate", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/generate": { "post": { "operationId": "POST_tv_presentations_id_generate", "summary": "Folien mit KI erzeugen und anhängen: { \"topic\": \"…\", \"slideCount\": 1-12, \"assetIds\"?: […] | null, \"wishes\"?: \"…\", \"documentIds\"?: […] } . documentIds sind die im Thema mit „#Titel\" erwähnten Dokumente (höchstens 5); ihr Text geht an das Textmodell, jedes nur, wenn die Person es auch über GET /documents/:id lesen dürfte, sonst 403 vor dem Start. Antwortet sofort; der Lauf steht in generations , jede fertige Folie kommt über den tv -Push. Braucht die KI-Freigabe der Person und einen OpenAI-Schlüssel; 409, wenn für die Präsentation schon ein Lauf läuft (Admin/ tv.slide.generate )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.generate`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.generate", "x-mdt-audit": "tv.slides_generate", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_tv_presentations_id_generate", "summary": "Laufende KI-Erstellung abbrechen bzw. einen beendeten Lauf aus generations entfernen (Admin/ tv.slide.generate )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.generate`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.generate", "x-mdt-audit": "tv.slides_generate_cancel", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides": { "post": { "operationId": "POST_tv_presentations_id_slides", "summary": "Folie(n) als multipart/form-data (Feld file ) anhängen: PNG/JPEG/WebP als eine Folie, PDF als eine Folie je Seite (höchstens 100 Seiten); je höchstens 7 MB, Speichergrenze je Gilde 500 MB (Admin/ tv.slide.create )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.create", "x-mdt-audit": "tv.slide_add", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/{slideId}": { "patch": { "operationId": "PATCH_tv_presentations_id_slides_slideId", "summary": "Folie ändern: name , notes (Sprechernotiz, nie im Stream), hidden , durationSeconds (oder null ), text bzw. live (Quelltext einer Text-/Live-Folie) (Admin/ tv.slide.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "slideId", "in": "path", "required": true, "description": "Id der Folie", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.edit", "x-mdt-audit": "tv.slide_update", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_tv_presentations_id_slides_slideId", "summary": "Folie löschen (weich: 24 h wiederherstellbar); Bildschirme darauf springen weiter (Admin/ tv.slide.delete )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "slideId", "in": "path", "required": true, "description": "Id der Folie", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.delete", "x-mdt-audit": "tv.slide_delete", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/{slideId}/file": { "put": { "operationId": "PUT_tv_presentations_id_slides_slideId_file", "summary": "Bild einer Bildfolie ersetzen ( multipart/form-data , Feld file ); Id und Position bleiben (Admin/ tv.slide.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "slideId", "in": "path", "required": true, "description": "Id der Folie", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.edit", "x-mdt-audit": "tv.slide_replace", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/{slideId}/restore": { "post": { "operationId": "POST_tv_presentations_id_slides_slideId_restore", "summary": "Gelöschte Folie wiederherstellen (Admin/ tv.slide.delete )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "slideId", "in": "path", "required": true, "description": "Id der Folie", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.delete", "x-mdt-audit": "tv.slide_restore", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/google": { "post": { "operationId": "POST_tv_presentations_id_slides_google", "summary": "Alle Folien einer öffentlich freigegebenen Google-Slides-Präsentation in 1920×1080 importieren: { \"url\": \"https://docs.google.com/presentation/d/…\", \"replace\": false } - replace: true ersetzt die vorhandenen Folien (Admin/ tv.slide.create )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.create", "x-mdt-audit": "tv.slide_import", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/live": { "post": { "operationId": "POST_tv_presentations_id_slides_live", "summary": "Live-Folie anlegen: { \"type\": \"onDuty\" | \"clock\" | \"countdown\" | \"stats\" | \"board\" | \"facility\" | \"einsatz\", \"title\"?, \"target\"?, \"ref\"? } ( target ISO-Zeit mit Jahr 2000-2999, Pflicht bei countdown ; ref Haus-Id bei facility bzw. Einsatz-Id bei einsatz , fehlt/ null = alle) (Admin/ tv.slide.create )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.create", "x-mdt-audit": "tv.slide_add", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/order": { "put": { "operationId": "PUT_tv_presentations_id_slides_order", "summary": "Folien sortieren (Admin/ tv.slide.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.edit", "x-mdt-audit": "tv.slide_reorder", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/text": { "post": { "operationId": "POST_tv_presentations_id_slides_text", "summary": "Textfolie anlegen: { \"title\", \"body\", \"background\": \"#rrggbb\", \"color\": \"#rrggbb\", \"letterheadId\"? } (Admin/ tv.slide.create )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.create", "x-mdt-audit": "tv.slide_add", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/presentations/{id}/slides/transfer": { "post": { "operationId": "POST_tv_presentations_id_slides_transfer", "summary": "Folien in eine andere Präsentation kopieren oder verschieben: { \"slideIds\", \"targetPresentationId\", \"mode\": \"copy\" | \"move\" } (Admin/ tv.slide.create , bei move zusätzlich tv.slide.delete )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.slide.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.slide.create", "x-mdt-audit": "tv.slide_transfer", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens": { "post": { "operationId": "POST_tv_screens", "summary": "Bildschirm (Fernseher) anlegen: { \"label\"?, \"presentationId\"? } ; Antwort mit createdId (Admin/ tv.screen.create )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.create", "x-mdt-audit": "tv.screen_create", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}": { "patch": { "operationId": "PATCH_tv_screens_id", "summary": "Bildschirm umbenennen ( label ) und/oder spiegeln ( followsScreenId , null beendet es) (Admin/ tv.screen.edit )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.edit", "x-mdt-audit": "tv.screen_rename", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_tv_screens_id", "summary": "Bildschirm löschen; offene Streams enden (Admin/ tv.screen.delete )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.delete`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.delete", "x-mdt-audit": "tv.screen_delete", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}/autoplay": { "put": { "operationId": "PUT_tv_screens_id_autoplay", "summary": "Automatik ein/aus: { \"autoplay\": true } (Admin/ tv.screen.present )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.present`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.present", "x-mdt-audit": "tv.screen_autoplay", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}/mode": { "put": { "operationId": "PUT_tv_screens_id_mode", "summary": "Modus setzen: { \"mode\": \"slide\" | \"black\" | \"standby\" } (Admin/ tv.screen.present )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.present`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.present", "x-mdt-audit": "tv.screen_mode", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}/presentation": { "put": { "operationId": "PUT_tv_screens_id_presentation", "summary": "Präsentation zuweisen: { \"presentationId\": \"…\" } oder null (Standby) (Admin/ tv.screen.present )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.present`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.present", "x-mdt-audit": "tv.screen_assign", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}/preview": { "get": { "operationId": "GET_tv_screens_id_preview", "summary": "Der tatsächliche Stream eines Bildschirms fürs MDT; zählt nicht als Zuschauer und ändert lastFetchedAt nicht (Admin/ tv.screen.view , Session-Cookie)", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `tv.screen.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "tv.screen.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}/rotate-token": { "post": { "operationId": "POST_tv_screens_id_rotate_token", "summary": "Neuen Link erzeugen; der alte hört sofort auf, offene Streams enden (Admin/ tv.screen.links )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.links`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.links", "x-mdt-audit": "tv.screen_rotate_token", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/screens/{id}/show": { "post": { "operationId": "POST_tv_screens_id_show", "summary": "Folie wechseln: { \"step\": 1 } , { \"step\": -1 } oder { \"slideId\": \"…\" } ; beendet Schwarz/Standby (Admin/ tv.screen.present )", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.screen.present`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.screen.present", "x-mdt-audit": "tv.slide_show", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/slides/{id}/image": { "get": { "operationId": "GET_tv_slides_id_image", "summary": "Folienbild für die Vorschau (Admin/ tv.screen.view , Session-Cookie)", "tags": [ "TV" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `tv.screen.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "tv.screen.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/standby": { "put": { "operationId": "PUT_tv_standby", "summary": "Standby-Bild der Gilde hochladen ( multipart/form-data , Feld file ) (Admin/ tv.standby.edit )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.standby.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.standby.edit", "x-mdt-audit": "tv.standby_set", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_tv_standby", "summary": "Standby-Bild entfernen (danach Schwarz) (Admin/ tv.standby.edit )", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `tv.standby.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "tv.standby.edit", "x-mdt-audit": "tv.standby_delete", "x-mdt-topics": [ "tv" ], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/tv/standby/image": { "get": { "operationId": "GET_tv_standby_image", "summary": "Standby-Bild für die Vorschau (Admin/ tv.screen.view , Session-Cookie)", "tags": [ "TV" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `tv.screen.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `tv` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": null, "x-mdt-capability": "tv.screen.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "tv", "x-mdt-rollout-flag": null } }, "/public/documents/{token}": { "get": { "operationId": "GET_public_documents_token", "summary": "Öffentlich, ohne Anmeldung: Dokument über einen öffentlichen Leselink; 404, wenn der Link abgelaufen, zurückgezogen oder das Modul aus ist. Mit Passwort 401 { passwordRequired, wrong } bis zum Kopf x-document-password (höchstens 10 Fehlversuche je 15 Minuten)", "tags": [ "Websites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Zufälliger Token aus dem Link", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/ingame/tablet/{token}": { "get": { "operationId": "GET_public_ingame_tablet_token", "summary": "Öffentlich über den geheimen Teil: löst einen Tablet-Link genau einmal ein, setzt die Sitzung und leitet ins MDT der Instanz weiter; sonst eine kurze HTML-Seite mit 400 , 403 oder 410", "tags": [ "Websites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Zufälliger Token aus dem Link", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/queue/{token}": { "get": { "operationId": "GET_public_queue_token", "summary": "Öffentlich über den geheimen Teil: Stand einer Wartenummer (vor dir, geschätzte Minuten, aufgerufen)", "tags": [ "Websites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Zufälliger Token aus dem Link", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_public_queue_token", "summary": "Öffentlich: Wartenummer zurückgeben", "tags": [ "Websites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Zufälliger Token aus dem Link", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/showcase": { "get": { "operationId": "GET_public_showcase", "summary": "Öffentlich, ohne Anmeldung: Galerie der Instanzen, die sich dafür freigegeben haben { instances: [{ id, name, iconUrl, template, memberCount, inviteUrl }] } , höchstens 12, größte zuerst; memberCount auf 10 gerundet. 5 Minuten zwischengespeichert", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/site": { "get": { "operationId": "GET_public_site", "summary": "Nur auf einer bestätigten eigenen Domain: dieselbe Antwort, die Website bestimmt der Host", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/site-domains/check": { "get": { "operationId": "GET_public_site_domains_check", "summary": "Öffentlich: 200, wenn die Domain bestätigt zu einer Website gehört, sonst 404 - für Caddys on_demand_tls { ask … }", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/site-preview/{token}": { "get": { "operationId": "GET_public_site_preview_token", "summary": "Öffentlich über den geheimen Vorschaulink: der Entwurf einer Seite", "tags": [ "Websites" ], "parameters": [ { "name": "token", "in": "path", "required": true, "description": "Zufälliger Token aus dem Link", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/sites/{guildId}/{slug}": { "get": { "operationId": "GET_public_sites_guildId_slug", "summary": "Öffentlich, ohne Anmeldung: veröffentlichte Seite einer öffentlichen Website samt Navigation, Farbschema und Live-Daten; 404, wenn es sie nicht gibt, sie intern, offline oder das Modul aus ist. Passwortseiten antworten 401 { passwordRequired } bis zum Kopf x-site-password , Weiterleitungen mit { redirect }", "tags": [ "Websites" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/sites/{guildId}/{slug}/forms": { "post": { "operationId": "POST_public_sites_guildId_slug_forms", "summary": "Öffentlich: Formular einsenden { \"pageId\", \"formId\", \"values\": {…} } ; wird ein Fall im Postfach (Tempolimit je Absender)", "tags": [ "Websites" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/sites/{guildId}/{slug}/queue": { "post": { "operationId": "POST_public_sites_guildId_slug_queue", "summary": "Öffentlich: Wartenummer der Notaufnahme ziehen { \"name\"? } ; nur mit dem Block „Wartenummer“ und solange jemand im Dienst ist. Antwort { token, ticket }", "tags": [ "Websites" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/sites/{guildId}/{slug}/requests": { "post": { "operationId": "POST_public_sites_guildId_slug_requests", "summary": "Öffentlich: Anfrage an die Leitstelle aus dem Block „Anfrage an die Leitstelle“ { \"pageId\", \"blockId\", \"values\": { kind, location, phone, message, wanted } } ; nur solange jemand im Dienst ist, gesperrte Nummern werden abgewiesen", "tags": [ "Websites" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/sites/{guildId}/{slug}/track": { "post": { "operationId": "POST_public_sites_guildId_slug_track", "summary": "Öffentlich: Klicks und Scrolltiefe einer Seite melden { \"pageId\", \"clicks\": [\"page:team\", …], \"depth\": 25|50|75|100 } ; nur Summen je Tag, ohne IP und Cookie (Tempolimit je Absender)", "tags": [ "Websites" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } }, { "name": "slug", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/public/stats": { "get": { "operationId": "GET_public_stats", "summary": "Öffentlich, ohne Anmeldung: Summen über alle Instanzen für die Startseite { generatedAt, servers, onDutyNow, shifts7d, einsaetze7d, daily: [{ date, shifts, einsaetze }] } (die letzten 7 UTC-Tage, ältester zuerst; keine Servernamen, keine Personen). 5 Minuten zwischengespeichert", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/s/{code}": { "get": { "operationId": "GET_s_code", "summary": "Öffentlich (ohne /api/v1 ): Kurzlink einer öffentlichen Website, leitet mit 302 auf /sites//", "tags": [ "Websites" ], "parameters": [ { "name": "code", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null, "servers": [ { "url": "https://mdt.npdev.eu" } ] } }, "/site-assets/{file}": { "get": { "operationId": "GET_site_assets_file", "summary": "Öffentlich, ohne Anmeldung (ohne /api/v1 ): Bild einer Website, .", "tags": [ "Websites" ], "parameters": [ { "name": "file", "in": "path", "required": true, "description": "Dateiname", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null, "servers": [ { "url": "https://mdt.npdev.eu" } ] } }, "/sites": { "get": { "operationId": "GET_sites", "summary": "Websites der Instanz lesen (Modul sites )", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_sites", "summary": "Website anlegen: { \"name\", \"slug\", \"visibility\": \"public\"|\"internal\", \"description\" } ; legt die leere Startseite an (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.create", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}": { "get": { "operationId": "GET_sites_id", "summary": "Website samt Seitenliste für den Editor (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "patch": { "operationId": "PATCH_sites_id", "summary": "Website ändern: { \"values\": { \"name\", \"slug\", \"visibility\", \"description\", \"theme\" } } (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.update", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_sites_id", "summary": "Website in den Papierkorb legen (7 Tage wiederherstellbar, dann endgültig gelöscht) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.delete", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/ai": { "post": { "operationId": "POST_sites_id_ai", "summary": "KI-Chat im Editor: { \"messages\": [{ \"role\", \"content\" }], \"pageId\" } ; die KI ändert Entwürfe über Werkzeuge (KI-Freigabe und OpenAI-Schlüssel nötig) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.ai_chat", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/ai/rewrite": { "post": { "operationId": "POST_sites_id_ai_rewrite", "summary": "Markierten Text mit KI umschreiben { \"text\", \"style\": kuerzer|freundlicher|foermlicher|einfacher|korrektur|englisch } ; speichert nichts (Admin, KI-Freigabe)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.ai_rewrite", "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/app.zip": { "get": { "operationId": "GET_sites_id_app_zip", "summary": "FiveM-Ressource, die die öffentliche Website als Handy-App zeigt (lb-phone oder Fenster per Befehl) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/assets": { "get": { "operationId": "GET_sites_id_assets", "summary": "Bilder der Website lesen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_sites_id_assets", "summary": "Bild als multipart/form-data (Feld file , PNG/JPEG/GIF/WebP, höchstens 5 MB) hochladen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "Nutzlast zu groß", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.asset_create", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/assets/{assetId}": { "patch": { "operationId": "PATCH_sites_id_assets_assetId", "summary": "Alt-Text setzen: { \"alt\": \"…\" } (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "assetId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.asset_update", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_sites_id_assets_assetId", "summary": "Bild löschen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "assetId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.asset_delete", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/assets/{assetId}/replace": { "post": { "operationId": "POST_sites_id_assets_assetId_replace", "summary": "Bild ersetzen (multipart file ); jede Stelle, die das alte zeigt, zeigt danach das neue (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "assetId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.asset_replace", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/changes": { "get": { "operationId": "GET_sites_id_changes", "summary": "Seiten mit unveröffentlichten Änderungen samt Zahl der neuen, entfernten und geänderten Blöcke (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/checklist": { "get": { "operationId": "GET_sites_id_checklist", "summary": "Startklar-Liste einer Website bis zur ersten Veröffentlichung (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/chrome/{kind}": { "post": { "operationId": "POST_sites_id_chrome_kind", "summary": "Kopf- ( header ) oder Fußzeile ( footer ) der Website öffnen; legt sie beim ersten Mal an (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_create", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/courses": { "get": { "operationId": "GET_sites_id_courses", "summary": "Eigene Anmeldungen, bestandene Kurse und fehlende Voraussetzungen für den Kurse-Block", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/courses/{courseId}/signup": { "post": { "operationId": "POST_sites_id_courses_courseId_signup", "summary": "Selbst zu einem Kurs anmelden; bei vollen Plätzen auf die Warteliste", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "courseId", "in": "path", "required": true, "description": "Id der Kursdefinition", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": "site.course_signup", "x-mdt-topics": [ "courses", "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_sites_id_courses_courseId_signup", "summary": "Sich selbst abmelden; die erste Person der Warteliste rückt nach", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "courseId", "in": "path", "required": true, "description": "Id der Kursdefinition", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": "site.course_leave", "x-mdt-topics": [ "courses", "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/domains": { "get": { "operationId": "GET_sites_id_domains", "summary": "Eigene Domains der Website samt den nötigen DNS-Einträgen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_sites_id_domains", "summary": "Eigene Domain hinzufügen: { \"hostname\": \"www.meine-firma.de\" } ; höchstens 5 je Website (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.domain_add", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/domains/{domainId}": { "delete": { "operationId": "DELETE_sites_id_domains_domainId", "summary": "Eigene Domain entfernen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.domain_delete", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/domains/{domainId}/verify": { "post": { "operationId": "POST_sites_id_domains_domainId_verify", "summary": "DNS prüfen: der TXT-Eintrag _mdt-site. mit dem Code bestätigt die Domain, der CNAME wird nur gemeldet (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.domain_verify", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/duplicate": { "post": { "operationId": "POST_sites_id_duplicate", "summary": "Website samt Seiten, Design und Bildern kopieren (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.duplicate", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/export": { "get": { "operationId": "GET_sites_id_export", "summary": "Website als Datei ( mdt-site@1 : Seiten, Design, Bilder als Base64) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/live": { "get": { "operationId": "GET_sites_id_live", "summary": "Live-Daten aller MDT-Blöcke für die Vorschau im Editor (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages": { "post": { "operationId": "POST_sites_id_pages", "summary": "Seite anlegen: { \"title\", \"path\", \"copyFromPageId\" } (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_create", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}": { "patch": { "operationId": "PATCH_sites_id_pages_pageId", "summary": "Seite ändern: { \"values\": { \"title\", \"path\", \"showInNav\" } } ; der Pfad der Startseite ist fest (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_update", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_sites_id_pages_pageId", "summary": "Seite in den Papierkorb legen; die Startseite antwortet 409 (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_delete", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/draft": { "get": { "operationId": "GET_sites_id_pages_pageId_draft", "summary": "Entwurf einer Seite als Puck-Daten lesen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_sites_id_pages_pageId_draft", "summary": "Entwurf speichern: { \"data\": , \"baseUpdatedAt\": \"…\" } , höchstens 1 MB; 409 samt aktuellem Stand, wenn jemand anderes zwischendurch gespeichert hat (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_save", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/insights": { "get": { "operationId": "GET_sites_id_pages_pageId_insights", "summary": "Statistik-Ebene: Aufrufe, Klicks je Linkziel, Scrolltiefe der Seite (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/purge": { "delete": { "operationId": "DELETE_sites_id_pages_pageId_purge", "summary": "Seite aus dem Papierkorb endgültig löschen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_purge", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/restore": { "post": { "operationId": "POST_sites_id_pages_pageId_restore", "summary": "Seite aus dem Papierkorb holen; 409, wenn ihr Pfad inzwischen vergeben ist (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_restore", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/versions": { "get": { "operationId": "GET_sites_id_pages_pageId_versions", "summary": "Versionen einer Seite (Veröffentlichungen, stündliche Sicherungen, KI-Änderungen; 30 Tage) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/versions/{versionId}": { "get": { "operationId": "GET_sites_id_pages_pageId_versions_versionId", "summary": "Puck-Daten einer Version (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/{pageId}/versions/{versionId}/restore": { "post": { "operationId": "POST_sites_id_pages_pageId_versions_versionId_restore", "summary": "Version als Entwurf übernehmen; der bisherige Entwurf wird vorher gesichert (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "pageId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.version_restore", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/pages/order": { "put": { "operationId": "PUT_sites_id_pages_order", "summary": "Seiten sortieren: { \"ids\": [...] } (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.page_order", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/polls/{blockId}": { "get": { "operationId": "GET_sites_id_polls_blockId", "summary": "Umfrage oder Terminfindung einer internen Website: Stand und eigene Stimme", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_sites_id_polls_blockId", "summary": "Abstimmen { \"pageId\", \"options\": [0] } bzw. { \"pageId\", \"answers\": { \"0\": \"y|m|n\" } }", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": "site.poll_vote", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/polls/{blockId}/fix": { "post": { "operationId": "POST_sites_id_polls_blockId_fix", "summary": "Termin aus einer Terminfindung festlegen → Kalendereintrag { \"pageId\", \"index\" } (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "blockId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.poll_fix", "x-mdt-topics": [ "calendar" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/presence": { "get": { "operationId": "GET_sites_id_presence", "summary": "Mitbearbeiten im Editor: meldet die eigene Stelle, liefert die der anderen samt Sperren und letzten Änderungen; ?leave=1 meldet ab (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/previews": { "get": { "operationId": "GET_sites_id_previews", "summary": "Aktive Vorschaulinks auf den Entwurf (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_sites_id_previews", "summary": "Vorschaulink erstellen (24 h, ohne Anmeldung unter /sites/vorschau/ ) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.preview_create", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/previews/{linkId}": { "delete": { "operationId": "DELETE_sites_id_previews_linkId", "summary": "Vorschaulink sperren (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.preview_delete", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/previews/{linkId}/extend": { "post": { "operationId": "POST_sites_id_previews_linkId_extend", "summary": "Vorschaulink um 24 h verlängern (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.preview_extend", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/publish": { "post": { "operationId": "POST_sites_id_publish", "summary": "Entwürfe veröffentlichen: { \"pageIds\": [...] } für eine Auswahl, sonst alle; postet die eingerichtete Discord-Ankündigung, außer mit \"announce\": false (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.publish`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.publish", "x-mdt-audit": "site.publish", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/purge": { "delete": { "operationId": "DELETE_sites_id_purge", "summary": "Website aus dem Papierkorb endgültig löschen, samt Bildern (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.purge", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/restore": { "post": { "operationId": "POST_sites_id_restore", "summary": "Website aus dem Papierkorb holen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.restore", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/search": { "get": { "operationId": "GET_sites_id_search", "summary": "Volltextsuche über die veröffentlichten Seiten, die die Person lesen darf", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/stats": { "get": { "operationId": "GET_sites_id_stats", "summary": "Aufrufe der letzten 30 Tage, gesamt und je Seite (ohne IP, ohne Cookie) (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/unpublish": { "post": { "operationId": "POST_sites_id_unpublish", "summary": "Website offline nehmen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.publish`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.publish", "x-mdt-audit": "site.unpublish", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/{id}/view": { "get": { "operationId": "GET_sites_id_view", "summary": "Veröffentlichte Seite zum Lesen im MDT, auch für interne Websites", "tags": [ "Websites" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `sites.site.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "sites.site.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/components": { "get": { "operationId": "GET_sites_components", "summary": "Eigene Komponenten der Instanz (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_sites_components", "summary": "Eigene Komponente anlegen: { \"name\", \"description\", \"content\": [Blöcke] } (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.component_create", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/components/{componentId}": { "patch": { "operationId": "PATCH_sites_components_componentId", "summary": "Eigene Komponente ändern; verknüpfte Stellen zeigen die Änderung sofort (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "componentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.component_update", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_sites_components_componentId", "summary": "Eigene Komponente löschen (Admin)", "tags": [ "Websites" ], "parameters": [ { "name": "componentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.component_delete", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/import": { "post": { "operationId": "POST_sites_import", "summary": "Website aus einer Export-Datei anlegen: { \"name\", \"slug\", \"visibility\", \"description\", \"data\": } (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.import", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/mcp": { "post": { "operationId": "POST_sites_mcp", "summary": "MCP-Server (Model Context Protocol, Streamable HTTP, JSON-RPC 2.0) mit denselben Werkzeugen; mit einem API-Schlüssel als Authorization: Bearer … (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": "site.mcp", "x-mdt-topics": [ "sites" ], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/sources": { "get": { "operationId": "GET_sites_sources", "summary": "Auswahllisten für Live-Blöcke im Editor: Kalenderkategorien, Ränge, Häuser, offene Einsätze, eigene Komponenten (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/templates": { "get": { "operationId": "GET_sites_templates", "summary": "Vorlagen für neue Websites; POST /sites nimmt \"template\": \"\" (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/sites/trash": { "get": { "operationId": "GET_sites_trash", "summary": "Websites im Papierkorb (Admin)", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `sites.site.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `sites` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "sites.site.edit", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "sites", "x-mdt-rollout-flag": null } }, "/website-requests": { "get": { "operationId": "GET_website_requests", "summary": "Anfragen von Websites an die Leitstelle: offene und die der letzten 6 Stunden", "tags": [ "Websites" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/website-requests/{requestId}/{action}": { "post": { "operationId": "POST_website_requests_requestId_action", "summary": "Anfrage bearbeiten: take (legt einen Einsatz an), callback , reject , block / unblock (Nummer sperren)", "tags": [ "Websites" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.sheet.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Modul `einsatz` ist auf der Instanz ausgeschaltet", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "einsatz.sheet.create", "x-mdt-audit": "einsatz.website_request", "x-mdt-topics": [ "einsatz", "einsatzStale", "overview" ], "x-mdt-module": "einsatz", "x-mdt-rollout-flag": null } }, "/ai/access": { "get": { "operationId": "GET_ai_access", "summary": "KI-Zugriff lesen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `ai.features.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "ai.features.use", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/access/check": { "get": { "operationId": "GET_ai_access_check", "summary": "Prüfen, ob eine Person ( ?userId= ) die KI benutzen darf, mit Begründung", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/access/overview": { "get": { "operationId": "GET_ai_access_overview", "summary": "Wer das Recht ai.features.use hält (Ränge, Abteilungen, Alle Mitarbeiter, Leitstelle), aktive Personen je Aktion", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/einsatz-report": { "post": { "operationId": "POST_ai_einsatz_report", "summary": "KI-Lagemeldung erzeugen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `ai.features.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "ai.features.use", "x-mdt-audit": "ai.einsatz_report_generate", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/failures": { "get": { "operationId": "GET_ai_failures", "summary": "Fehlgeschlagene KI-Läufe der letzten 30 Tage nach Ursache und die aktuelle Fehlerserie", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/feedback": { "post": { "operationId": "POST_ai_feedback", "summary": "Eigenen KI-Bericht bewerten ( { runId, rating: 1|-1, reason?, comment? } )", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `ai.features.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "ai.features.use", "x-mdt-audit": "ai.feedback", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/key": { "post": { "operationId": "POST_ai_key", "summary": "OpenAI-Schlüssel prüfen und nur bei Erfolg speichern", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.key_set", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/key/test": { "post": { "operationId": "POST_ai_key_test", "summary": "Hinterlegten OpenAI-Schlüssel samt Modell und Guthaben testen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.key_test", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/models": { "get": { "operationId": "GET_ai_models", "summary": "Verfügbare KI-Modelle lesen: models (Text) und imageModels (Bildmodelle für KI-Folien)", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/quality": { "get": { "operationId": "GET_ai_quality", "summary": "Bewertungen der letzten 30 Tage je Aktion, Vorlage und Prompt-Stand", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/report": { "post": { "operationId": "POST_ai_report", "summary": "KI-Bericht erzeugen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `ai.features.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "ai.features.use", "x-mdt-audit": "ai.report_generate", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/revisions": { "get": { "operationId": "GET_ai_revisions", "summary": "Verlauf eines Prompts oder einer Vorlage ( ?subject=prompt|template&key=... )", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/revisions/{id}/restore": { "post": { "operationId": "POST_ai_revisions_id_restore", "summary": "Früheren Stand eines Prompts oder einer Vorlage wiederherstellen (legt einen neuen Stand an)", "tags": [ "KI" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.revision_restore", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/run/{action}": { "post": { "operationId": "POST_ai_run_action", "summary": "Eine KI-Aktion aus dem Katalog ausführen (Schichtübergabe, Lagemeldung, Dokument zusammenfassen, Korrektur, Bewerbung)", "tags": [ "KI" ], "parameters": [ { "name": "action", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `ai.features.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "ai.features.use", "x-mdt-audit": "ai.action_run", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/settings": { "get": { "operationId": "GET_ai_settings", "summary": "KI-Einstellungen lesen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_ai_settings", "summary": "KI-Einstellungen setzen (Schlüssel, Modell, Prompts, Bildmodell aiImageModel und aiImageQuality : low | medium | high ); ein falsch typisiertes Feld schreibt nichts und antwortet mit 400", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.settings_set", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/templates": { "get": { "operationId": "GET_ai_templates", "summary": "KI-Vorlagen lesen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_ai_templates", "summary": "KI-Vorlage anlegen (Name, Inhalt, Typ, Triage-Freigabe)", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.template_create", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_ai_templates", "summary": "Vorlagenreihenfolge setzen ( { \"ids\": [...] } ); eine veraltete Liste wird mit 409 abgelehnt", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.template_reorder", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/templates/{id}": { "patch": { "operationId": "PATCH_ai_templates_id", "summary": "KI-Vorlage ändern", "tags": [ "KI" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.template_update", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_ai_templates_id", "summary": "KI-Vorlage löschen", "tags": [ "KI" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.template_delete", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/trial": { "post": { "operationId": "POST_ai_trial", "summary": "Probelauf eines Berichts mit Beispiel- oder echtem Fall, optional mit Prompt-Entwurf und anderem Modell", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": "ai.trial_run", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/trial/sources": { "get": { "operationId": "GET_ai_trial_sources", "summary": "Beispielfälle und letzte Einsätze/Patienten für den Probelauf", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/usage": { "get": { "operationId": "GET_ai_usage", "summary": "KI-Nutzung lesen", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/usage/export": { "get": { "operationId": "GET_ai_usage_export", "summary": "KI-Nutzung als CSV (dieselben Filter)", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/ai/usage/query": { "get": { "operationId": "GET_ai_usage_query", "summary": "KI-Nutzung mit Zeitraum und Filtern ( ?from&to&action&user&status ), dazu Kennzahlen und Fehlschläge nach Ursache", "tags": [ "KI" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": "settings.manage", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/citizen-import/uploads": { "post": { "operationId": "POST_citizen_import_uploads", "summary": "Wiederaufnehmbaren Bürgerimport beginnen", "tags": [ "Bürgerimport" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.upload_start", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-import/uploads/{uploadId}/abort": { "post": { "operationId": "POST_citizen_import_uploads_uploadId_abort", "summary": "Unvollständigen Import abbrechen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "uploadId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.upload_abort", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-import/uploads/{uploadId}/chunks/{index}": { "put": { "operationId": "PUT_citizen_import_uploads_uploadId_chunks_index", "summary": "Gehashten Import-Chunk hochladen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "uploadId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "index", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.upload_chunk", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-import/uploads/{uploadId}/finalize": { "post": { "operationId": "POST_citizen_import_uploads_uploadId_finalize", "summary": "Vollständigen Import prüfen und versiegeln", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "uploadId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.upload_finalize", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches": { "get": { "operationId": "GET_citizen_registry_batches", "summary": "Importläufe auflisten", "tags": [ "Bürgerimport" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}": { "get": { "operationId": "GET_citizen_registry_batches_batchId", "summary": "Importlauf lesen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/commit": { "post": { "operationId": "POST_citizen_registry_batches_batchId_commit", "summary": "Importlauf übernehmen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.commit", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/dry-run": { "post": { "operationId": "POST_citizen_registry_batches_batchId_dry_run", "summary": "Importlauf vorprüfen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.stage", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/issues": { "get": { "operationId": "GET_citizen_registry_batches_batchId_issues", "summary": "Importprobleme lesen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/preview": { "get": { "operationId": "GET_citizen_registry_batches_batchId_preview", "summary": "Import-Probelauf lesen: Zusammenfassung, Zeilen mit Kandidat, Trefferquote und Vorschlag, bucket , cursor , limit , rollbackUntil", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" }, "post": { "operationId": "POST_citizen_registry_batches_batchId_preview", "summary": "Import-Probelauf für einen bereitgestellten Lauf mit expectedVersion berechnen; der Commit akzeptiert danach acceptSafeSuggestions: true , das Rückgängigmachen ist 7 Tage nach dem Commit möglich", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.preview", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/progress": { "get": { "operationId": "GET_citizen_registry_batches_batchId_progress", "summary": "Importfortschritt lesen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/rollback": { "post": { "operationId": "POST_citizen_registry_batches_batchId_rollback", "summary": "Importlauf zurücksetzen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.rollback", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/rows": { "get": { "operationId": "GET_citizen_registry_batches_batchId_rows", "summary": "Importzeilen lesen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/batches/{batchId}/stage": { "post": { "operationId": "POST_citizen_registry_batches_batchId_stage", "summary": "Importdaten vorverarbeiten", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.stage", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/links/{linkId}/unlink": { "post": { "operationId": "POST_citizen_registry_links_linkId_unlink", "summary": "Bürgerverknüpfung lösen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.link_unlink", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/links/{sourceEntityId}/reject": { "post": { "operationId": "POST_citizen_registry_links_sourceEntityId_reject", "summary": "Bürgerverknüpfung ablehnen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "sourceEntityId", "in": "path", "required": true, "description": "Id des Quelleintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.link_reject", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/links/{sourceEntityId}/review": { "post": { "operationId": "POST_citizen_registry_links_sourceEntityId_review", "summary": "Bürgerverknüpfung prüfen", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "sourceEntityId", "in": "path", "required": true, "description": "Id des Quelleintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.link_review", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/links/legacy": { "post": { "operationId": "POST_citizen_registry_links_legacy", "summary": "Legacy-Bürgerverknüpfung anlegen", "tags": [ "Bürgerimport" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.legacy_association", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/source-catalog": { "get": { "operationId": "GET_citizen_registry_source_catalog", "summary": "Importquellen-Katalog lesen", "tags": [ "Bürgerimport" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/sources": { "get": { "operationId": "GET_citizen_registry_sources", "summary": "Bürgerdatenquellen auflisten", "tags": [ "Bürgerimport" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" }, "post": { "operationId": "POST_citizen_registry_sources", "summary": "Bürgerdatenquelle registrieren ( sourceSystem , authorityKind , adapterVersion , mappingVersion , imagesPolicy ); MedicNet akzeptiert nur die drei katalogisierten Mapping-Versionen", "tags": [ "Bürgerimport" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.source_register", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/citizen-registry/sources/{sourceRegistryId}/archive": { "post": { "operationId": "POST_citizen_registry_sources_sourceRegistryId_archive", "summary": "Importquelle archivieren", "tags": [ "Bürgerimport" ], "parameters": [ { "name": "sourceRegistryId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `citizenImportsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "citizen_import.source_archive", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "citizenImportsEnabled" } }, "/platform/casefile-catalogs/me/entries": { "get": { "operationId": "GET_platform_casefile_catalogs_me_entries", "summary": "Katalogeinträge der eigenen Instanz (Fallakten: CASE_TYPE , POSITION_CATALOG , LINK_TYPE ), kind , includeArchived", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefile_catalogs_me_entries", "summary": "Katalogeintrag anlegen ( kind , key , label , color , classification , config ); 409 bei doppeltem Schlüssel", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/entries/{entryId}": { "patch": { "operationId": "PATCH_platform_casefile_catalogs_me_entries_entryId", "summary": "Katalogeintrag ändern mit expectedVersion", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/entries/{entryId}/archive": { "post": { "operationId": "POST_platform_casefile_catalogs_me_entries_entryId_archive", "summary": "Katalogeintrag archivieren; bestehende Daten zeigen ihn weiter an", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_archive", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/entries/{entryId}/offer": { "put": { "operationId": "PUT_platform_casefile_catalogs_me_entries_entryId_offer", "summary": "Katalogeintrag in Identitätsbereichen anbieten ( domainIds , nur aktive Mitgliedschaften); gibt keine Daten frei", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_offer", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/entries/{entryId}/restore": { "post": { "operationId": "POST_platform_casefile_catalogs_me_entries_entryId_restore", "summary": "Archivierten Katalogeintrag wiederherstellen", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_restore", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/entries/order": { "put": { "operationId": "PUT_platform_casefile_catalogs_me_entries_order", "summary": "Reihenfolge der Einträge einer Art setzen ( kind , entryIds )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/mappings": { "put": { "operationId": "PUT_platform_casefile_catalogs_me_mappings", "summary": "Fremden Eintrag zuordnen ( mode MAPPED , ADOPTED oder NONE )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.setup.edit", "x-mdt-audit": "platform.register_catalog_mapping", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefile-catalogs/me/shared": { "get": { "operationId": "GET_platform_casefile_catalogs_me_shared", "summary": "Angebotene Einträge der Partner im Identitätsbereich ( domainId ) mit eigener Zuordnung", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId", "summary": "Fallakte lesen, nur die lesbaren Teile; nicht lesbare Reiter nur als Anzahl", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId", "summary": "Fallakte ändern ( expectedVersion ); abgeschlossene Akten sind schreibgeschützt", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/access-log": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_access_log", "summary": "Zugriffsprotokoll der Partner ( cursor , format=json|csv )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/appointments": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_appointments", "summary": "Termine der Fallakte; braucht read auf appointments", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_appointments", "summary": "Kalendertermin anlegen und mit der eigenen Fallakte verknüpfen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_appointment_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/appointments/{linkId}/unlink": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_appointments_linkId_unlink", "summary": "Terminverknüpfung der Fallakte lösen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_appointment_unlink", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/appointments/link": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_appointments_link", "summary": "Bestehenden Kalendertermin mit der Fallakte verknüpfen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_appointment_link", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/banners": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_banners", "summary": "Hinweis-Banner der Fallakte nach den Regeln der eigenen Instanz", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/close": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_close", "summary": "Fallakte abschließen ( expectedVersion , confirm: true ); Folgen nur in eigenen Akten mit den eigenen Rechten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_close", "x-mdt-topics": [ "casefile", "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/closure": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_closure", "summary": "Abschluss: Entwurf, Ergebnisse, Aufbewahrung, offene Punkte", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "put": { "operationId": "PUT_platform_casefiles_ownerGuildId_caseFileId_closure", "summary": "Abschluss-Entwurf speichern ( resultKey , reportBody , consequences , retentionKey )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_closure_save", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_evidence", "summary": "Beweise der Fallakte; nicht lesbare als gesperrte Kachel mit Nummer; uploadsConfigured ist false ohne Beweisablage der Eigentümerinstanz", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence-candidates": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_evidence_candidates", "summary": "Kürzlich hochgeladene Anhänge als Beweis-Kandidaten ( source=recent )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/{evidenceId}": { "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId_evidence_evidenceId", "summary": "Beweis ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/{evidenceId}/archive": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_evidence_evidenceId_archive", "summary": "Beweis entfernen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_archive", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/{evidenceId}/chain": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_evidence_evidenceId_chain", "summary": "Nachweiskette eines Beweises", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_evidence_evidenceId_chain", "summary": "Eintrag in der Nachweiskette ( kind , text , at )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_chain", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/{evidenceId}/content": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_evidence_evidenceId_content", "summary": "Beweisinhalt lesen; vermerkt VIEWED in der Nachweiskette", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "evidenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/from-attachment": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_evidence_from_attachment", "summary": "Vorhandenen versiegelten Anhang als Beweis übernehmen ( attachmentId , title , classification )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_add", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/order": { "put": { "operationId": "PUT_platform_casefiles_ownerGuildId_caseFileId_evidence_order", "summary": "Reihenfolge der Beweise setzen ( evidenceIds )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_order", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/uploads": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_evidence_uploads", "summary": "Beweis-Upload beginnen; braucht update auf evidence", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_upload", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/uploads/{attachmentId}/versions/{versionId}/bytes": { "put": { "operationId": "PUT_platform_casefiles_ownerGuildId_caseFileId_evidence_uploads_attachmentId_versions_versionId_bytes", "summary": "Beweisinhalt hochladen (roher Body)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_upload", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/evidence/uploads/{attachmentId}/versions/{versionId}/finalize": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_evidence_uploads_attachmentId_versions_versionId_finalize", "summary": "Beweis-Upload abschließen ( expectedSha256 , expectedBytes , securedBy , securedAt )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_evidence_upload", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/handover": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_handover", "summary": "Federführung an eine Partnerinstanz übergeben ( partnerGuildId , include , keepReadAccess , reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_handover_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/history": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_history", "summary": "Änderungen der Fallakte ( cursor )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/links": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_links", "summary": "Verknüpfungen zu Einsätzen, Fallakten, Dokumenten und Listen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_links", "summary": "Verknüpfung anlegen ( kind , targetOwnerGuildId , targetId , relationKey , note ); das Ziel muss lesbar sein", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_link_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/links/{linkId}/archive": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_links_linkId_archive", "summary": "Verknüpfung entfernen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_link_archive", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/persons": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_persons", "summary": "Beteiligte Personen; Namen nur nach den Regeln der jeweiligen Bürgerakte", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_persons", "summary": "Person hinzufügen (Bürgerakte oder UNKNOWN mit Beschreibung, roleKey )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_person_add", "x-mdt-topics": [ "casefile", "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/persons/{personId}": { "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId_persons_personId", "summary": "Person ändern oder einer Bürgerakte zuordnen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "personId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_person_update", "x-mdt-topics": [ "casefile", "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/persons/{personId}/archive": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_persons_personId_archive", "summary": "Person aus der Fallakte entfernen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "personId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_person_archive", "x-mdt-topics": [ "casefile", "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/positions": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_positions", "summary": "Positionen mit Summen (von, bis, festgesetzt)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_positions", "summary": "Position hinzufügen (aus dem Katalog oder frei, quantity , amount )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_position_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/positions/{positionId}": { "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId_positions_positionId", "summary": "Position ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "positionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_position_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/positions/{positionId}/archive": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_positions_positionId_archive", "summary": "Position entfernen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "positionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_position_archive", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/reopen": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_reopen", "summary": "Fallakte wiedereröffnen ( expectedVersion , reason 10 bis 500 Zeichen)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_reopen", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/reports": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_reports", "summary": "Berichte des Sachverhalts mit gemeinsamer und eigener Reihenfolge", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_reports", "summary": "Bericht anlegen ( title , body , classification , templateKey )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_report_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/reports/{reportId}": { "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId_reports_reportId", "summary": "Bericht ändern ( expectedVersion ); gesperrte nur Verfasser oder Leitung", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "reportId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_report_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/reports/{reportId}/archive": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_reports_reportId_archive", "summary": "Bericht entfernen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "reportId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_report_archive", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/reports/{reportId}/lock": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_reports_reportId_lock", "summary": "Bericht sperren oder entsperren ( locked )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "reportId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_report_lock", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/reports/order": { "put": { "operationId": "PUT_platform_casefiles_ownerGuildId_caseFileId_reports_order", "summary": "Reihenfolge der Berichte ( scope GLOBAL oder OWN , reportIds )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_report_order", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/share-partners": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_share_partners", "summary": "Partnerinstanzen im Identitätsbereich der Fallakte, mit denen geteilt werden kann", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/shares": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_shares", "summary": "Partnerinstanzen, mit denen die Fallakte geteilt ist", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_shares", "summary": "Fallakte mit einer Partnerinstanz teilen ( partnerGuildId , functionKey , tabs , includeRestricted , expiresAt )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_share_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/shares/{shareId}/extend": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_shares_shareId_extend", "summary": "Teilen verlängern ( expectedVersion , expiresAt )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_share_extend", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/shares/{shareId}/revoke": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_shares_shareId_revoke", "summary": "Teilen sofort beenden ( expectedVersion , reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_share_revoke", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/status": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_status", "summary": "Status setzen ( expectedVersion , statusKey , reason ); Abschluss nur über close", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_status", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/tags": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_tags", "summary": "Kennzeichen der Fallakte; braucht read auf facts", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_tags", "summary": "Kennzeichen an der Fallakte vergeben; braucht update auf facts", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_tag_add", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/tags/{tagId}/remove": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_tags_tagId_remove", "summary": "Kennzeichen von der Fallakte entfernen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_tag_remove", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/tasks": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_tasks", "summary": "Aufgaben der eigenen Instanz an der Fallakte ( status )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_tasks", "summary": "Aufgabe an der Fallakte anlegen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.register_task_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/team": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_team", "summary": "Fallgruppe mit Funktionen und Partnerinstanzen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_team", "summary": "Mitglied der Fallgruppe hinzufügen ( userId , functionKey , until )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_team_add", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/team/{memberId}": { "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId_team_memberId", "summary": "Funktion oder Enddatum ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "memberId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_team_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/team/{memberId}/remove": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_team_memberId_remove", "summary": "Mitglied entfernen ( expectedVersion ); die letzte Leitung bleibt", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "memberId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_team_remove", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/timeline": { "get": { "operationId": "GET_platform_casefiles_ownerGuildId_caseFileId_timeline", "summary": "Zeitachse ( certainty ); nicht lesbare Quellen ohne Inhalt", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_timeline", "summary": "Ereignis anlegen ( at , precision , text , certainty , personIds , sources )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_timeline_create", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/timeline/{eventId}": { "patch": { "operationId": "PATCH_platform_casefiles_ownerGuildId_caseFileId_timeline_eventId", "summary": "Ereignis ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_timeline_update", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/timeline/{eventId}/archive": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_timeline_eventId_archive", "summary": "Ereignis entfernen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_timeline_archive", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/timeline/from-einsaetze": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_timeline_from_einsaetze", "summary": "Ereignisse aus verknüpften Einsätzen übernehmen ( einsatzRefs )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_timeline_import", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/view-as": { "post": { "operationId": "POST_platform_casefiles_ownerGuildId_caseFileId_view_as", "summary": "Fallakte so ansehen, wie ein Partner oder Rang sie sähe (nur Sichtbarkeit, nie Werte); braucht casefiles.setup.edit", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_view_as", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/{ownerGuildId}/{caseFileId}/watch": { "put": { "operationId": "PUT_platform_casefiles_ownerGuildId_caseFileId_watch", "summary": "Fallakte beobachten; braucht summary (sonst 403), die Detailantwort meldet das als summaryReadable", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_watch", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "delete": { "operationId": "DELETE_platform_casefiles_ownerGuildId_caseFileId_watch", "summary": "Beobachtung der Fallakte beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "caseFileId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.use", "x-mdt-audit": "platform.casefile_unwatch", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me": { "get": { "operationId": "GET_platform_casefiles_me", "summary": "Fallakten-Liste ( scope , type , status , member , q , view , cursor ); Partnerakten nach den Regeln ihres Besitzers", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_casefiles_me", "summary": "Fallakte anlegen ( typeEntryId , title , Vorfall, Einsätze, Personen); braucht casefiles.file.create oder das Einzelrecht des Falltyps", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.create", "x-mdt-audit": "platform.casefile_create", "x-mdt-topics": [ "casefile", "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/einsatz-candidates": { "get": { "operationId": "GET_platform_casefiles_me_einsatz_candidates", "summary": "Einsätze zum Übernehmen ( at , hours 24|72|168, q ) mit Personenvorschlägen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/for-einsatz/{einsatzOwnerGuildId}/{einsatzId}": { "get": { "operationId": "GET_platform_casefiles_me_for_einsatz_einsatzOwnerGuildId_einsatzId", "summary": "Fallakten, zu denen ein Einsatz gehört (Hinweis am Einsatz)", "tags": [ "Plattform" ], "parameters": [ { "name": "einsatzOwnerGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/handovers": { "get": { "operationId": "GET_platform_casefiles_me_handovers", "summary": "Übergaben ( direction=incoming|outgoing ); eingehende nur mit casefiles.file.create", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/handovers/{handoverId}/decide": { "post": { "operationId": "POST_platform_casefiles_me_handovers_handoverId_decide", "summary": "Übergabe annehmen oder ablehnen ( expectedVersion , decision , typeEntryId , note ); braucht casefiles.file.create", "tags": [ "Plattform" ], "parameters": [ { "name": "handoverId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.create`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.create", "x-mdt-audit": "platform.casefile_handover_decide", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/handovers/{handoverId}/withdraw": { "post": { "operationId": "POST_platform_casefiles_me_handovers_handoverId_withdraw", "summary": "Eigene offene Übergabe zurückziehen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "handoverId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `casefiles.file.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "casefiles.file.edit", "x-mdt-audit": "platform.casefile_handover_withdraw", "x-mdt-topics": [ "casefile" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/participant-search": { "get": { "operationId": "GET_platform_casefiles_me_participant_search", "summary": "Beteiligte suchen ( q , file ): Bürgerregister, eigenes Personal, Partnerinstanzen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/casefiles/me/sidebar": { "get": { "operationId": "GET_platform_casefiles_me_sidebar", "summary": "Seitenleiste der Fallakten: Typen mit Anzahl, Meine, Frist, Von Partnern, Ansichten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `casefiles.file.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "casefiles.file.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-matching/{ownerGuildId}/{domainId}/sources/{sourceEntityId}": { "get": { "operationId": "GET_platform_citizen_matching_ownerGuildId_domainId_sources_sourceEntityId", "summary": "Importidentität für den Bürgerabgleich lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "sourceEntityId", "in": "path", "required": true, "description": "Id des Quelleintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-matching/{ownerGuildId}/{domainId}/sources/{sourceEntityId}/candidates": { "get": { "operationId": "GET_platform_citizen_matching_ownerGuildId_domainId_sources_sourceEntityId_candidates", "summary": "Abgleichkandidaten laden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "sourceEntityId", "in": "path", "required": true, "description": "Id des Quelleintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-matching/{ownerGuildId}/{domainId}/sources/{sourceEntityId}/decisions": { "post": { "operationId": "POST_platform_citizen_matching_ownerGuildId_domainId_sources_sourceEntityId_decisions", "summary": "Bürgerabgleich bestätigen oder ablehnen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "sourceEntityId", "in": "path", "required": true, "description": "Id des Quelleintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_match_review", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-matching/{ownerGuildId}/{domainId}/sources/{sourceEntityId}/links/{linkId}/unlink": { "post": { "operationId": "POST_platform_citizen_matching_ownerGuildId_domainId_sources_sourceEntityId_links_linkId_unlink", "summary": "Bürgerabgleich korrigieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "sourceEntityId", "in": "path", "required": true, "description": "Id des Quelleintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_match_correct", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/access-requests": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_access_requests", "summary": "Zugriff auf Felder im ganzen Identitätsbereich einer Partnerinstanz anfragen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_access_request_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/assignable-members": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_assignable_members", "summary": "Aktive Mitarbeitende der eigenen Instanz als Zuständige ( q , höchstens 25)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/duplicates": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_duplicates", "summary": "Dubletten-Warteschlange der eigenen Instanz ( ownerGuildId oder me ), status=OPEN|SNOOZED , cursor , limit (1–100); nur Paare, deren beide Akten lesbar sind; total zählt nur sichtbare Paare", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/duplicates/{candidateId}": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_duplicates_candidateId", "summary": "Vergleich nebeneinander: Werte je Seite nach eigener Freigabe, leftRedacted / rightRedacted , Übereinstimmung je Feld, benötigte Zustimmungen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "candidateId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/duplicates/{candidateId}/dismiss": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_duplicates_candidateId_dismiss", "summary": "„Keine Dublette“ mit reason ; speichert die Ablehnung des Paares dauerhaft", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "candidateId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_duplicate_dismiss", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/duplicates/{candidateId}/snooze": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_duplicates_candidateId_snooze", "summary": "Dublette mit days (1–30) zurückstellen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "candidateId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_duplicate_snooze", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/duplicates/scan": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_duplicates_scan", "summary": "Dublettensuche für die eigene Instanz starten (frisch geprüfter Besitzeradministrator); liefert scanned , found", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_duplicate_scan", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/facets": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_facets", "summary": "Zahlen der Schnellfilter (Warnhinweis, verknüpft, beobachtet, heute geändert); nur für die eigene Instanz, me steht für die Heimatinstanz", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/matrix": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_matrix", "summary": "Freigabe-Matrix Felder mal Partner (frischer Instanz-Admin)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "put": { "operationId": "PUT_platform_citizen_register_ownerGuildId_domainId_matrix", "summary": "Freigabe-Matrix speichern (Zielzustand je Partner mit etag ; vertrauliche Felder nur mit confirmRestricted )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_matrix_update", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/merge-requests": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_merge_requests", "summary": "Zusammenführung anfragen mit candidateId , keepTargetRecord ( left | right ), fieldChoices , reason ; braucht approve auf den eigenen betroffenen Akten; ohne fremde Besitzer sofort angewendet", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_merge_request_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/narrative-categories": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_narrative_categories", "summary": "Notizkategorien mit Lese- und Schreibrecht je Kategorie", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/partners/{partnerGuildId}/pause": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_partners_partnerGuildId_pause", "summary": "Einen Partnernutzer pausieren ( userRef , hours 1 bis 168, reason ) oder Pause aufheben ( lift: true )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "partnerGuildId", "in": "path", "required": true, "description": "Server-Id der Partnerinstanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_partner_pause", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/partners/{partnerGuildId}/revoke-all": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_partners_partnerGuildId_revoke_all", "summary": "Alle Matrix-Freigaben, Einzelfreigaben und Aktenauszüge eines Partners zurückziehen ( reason , confirm: true )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "partnerGuildId", "in": "path", "required": true, "description": "Server-Id der Partnerinstanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_partner_revoke_all", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/shares/{shareId}/extend": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_shares_shareId_extend", "summary": "Bereichsweite Freigabe (aus einer Bereichsanfrage) verlängern ( expectedVersion , expiresAt ; frischer Instanz-Admin)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_share_extend", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/shares/{shareId}/revoke": { "post": { "operationId": "POST_platform_citizen_register_ownerGuildId_domainId_shares_shareId_revoke", "summary": "Bereichsweite Freigabe sofort zurückziehen ( expectedVersion , reason ; frischer Instanz-Admin)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_share_revoke", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/{ownerGuildId}/{domainId}/sharing-overview": { "get": { "operationId": "GET_platform_citizen_register_ownerGuildId_domainId_sharing_overview", "summary": "Freigaben-Übersicht je Partner mit Zugriffsvolumen, Auffälligkeiten und Pausen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/access-requests": { "get": { "operationId": "GET_platform_citizen_register_me_access_requests", "summary": "Eigene ( direction=outgoing ) oder zu entscheidende ( direction=incoming ) Zugriffsanfragen, optional status", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/access-requests/{requestId}/decide": { "post": { "operationId": "POST_platform_citizen_register_me_access_requests_requestId_decide", "summary": "Zugriffsanfrage entscheiden ( APPROVE , PARTIAL mit grantedFieldIds , REJECT ; Dauer nur kürzbar)", "tags": [ "Plattform" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_access_request_decide", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/access-requests/{requestId}/withdraw": { "post": { "operationId": "POST_platform_citizen_register_me_access_requests_requestId_withdraw", "summary": "Eigene offene Zugriffsanfrage zurückziehen", "tags": [ "Plattform" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_access_request_withdraw", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/extracts/{extractId}/pdf": { "get": { "operationId": "GET_platform_citizen_register_me_extracts_extractId_pdf", "summary": "Für die eigene Instanz bereitgestellten Aktenauszug herunterladen (wird protokolliert)", "tags": [ "Plattform" ], "parameters": [ { "name": "extractId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/inbox": { "get": { "operationId": "GET_platform_citizen_register_me_inbox", "summary": "Postfach des Bürgerregisters ( kind , unread , cursor ); eigene Meldungen und Instanz-Aufgaben, die man entscheiden darf", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/inbox/{itemId}/read": { "post": { "operationId": "POST_platform_citizen_register_me_inbox_itemId_read", "summary": "Postfacheintrag als gelesen markieren", "tags": [ "Plattform" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "postfach.read", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/inbox/read-all": { "post": { "operationId": "POST_platform_citizen_register_me_inbox_read_all", "summary": "Alle sichtbaren Postfacheinträge als gelesen markieren", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "postfach.read", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/mentions": { "get": { "operationId": "GET_platform_citizen_register_me_mentions", "summary": "Namen erwähnter Akten je Leser ( refs , höchstens 50); nicht lesbare ohne Namen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/merge-requests": { "get": { "operationId": "GET_platform_citizen_register_me_merge_requests", "summary": "Zusammenführungsanfragen, direction=incoming|outgoing", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/merge-requests/{requestId}/decide": { "post": { "operationId": "POST_platform_citizen_register_me_merge_requests_requestId_decide", "summary": "Zustimmen oder ablehnen mit expectedVersion , decision ( APPROVE | REJECT ), reason ; mit der letzten Zustimmung wird die Verknüpfung angewendet oder mit Grund als fehlgeschlagen markiert", "tags": [ "Plattform" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_merge_request_decide", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/merge-requests/{requestId}/withdraw": { "post": { "operationId": "POST_platform_citizen_register_me_merge_requests_requestId_withdraw", "summary": "Eigene offene Anfrage mit expectedVersion zurückziehen", "tags": [ "Plattform" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_merge_request_withdraw", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/search": { "get": { "operationId": "GET_platform_citizen_register_me_search", "summary": "Eine Suche über alle lesbaren Registerbereiche ( q 2 bis 128 Zeichen, limit 1 bis 20); Akten derselben Person bilden einen Treffer mit mehreren Quellen, gesucht wird nur in lesbaren, nicht zurückgehaltenen Feldern", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/shares": { "get": { "operationId": "GET_platform_citizen_register_me_shares", "summary": "Für die eigene Instanz freigegebene Akten und Aktenauszüge", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/tasks": { "get": { "operationId": "GET_platform_citizen_register_me_tasks", "summary": "Eigene Wiedervorlagen ( scope , due , status , target , cursor )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/tasks/{taskId}": { "patch": { "operationId": "PATCH_platform_citizen_register_me_tasks_taskId", "summary": "Wiedervorlage ändern oder erledigen ( expectedVersion , done )", "tags": [ "Plattform" ], "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_task_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/tasks/{taskId}/archive": { "post": { "operationId": "POST_platform_citizen_register_me_tasks_taskId_archive", "summary": "Wiedervorlage löschen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "taskId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_task_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/view-counts": { "get": { "operationId": "GET_platform_citizen_register_me_view_counts", "summary": "Anzahlen je Ansicht für die Seitenleiste ( area , höchstens 9999)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/views": { "get": { "operationId": "GET_platform_citizen_register_me_views", "summary": "Gespeicherte und eingebaute Ansichten ( area=CITIZENS|CASEFILES )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizen_register_me_views", "summary": "Ansicht speichern; shared: true braucht citizens.views.share bzw. casefiles.views.share", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_view_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/views/{viewId}": { "patch": { "operationId": "PATCH_platform_citizen_register_me_views_viewId", "summary": "Ansicht ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "viewId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_view_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "delete": { "operationId": "DELETE_platform_citizen_register_me_views_viewId", "summary": "Ansicht löschen", "tags": [ "Plattform" ], "parameters": [ { "name": "viewId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_view_delete", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/views/order": { "put": { "operationId": "PUT_platform_citizen_register_me_views_order", "summary": "Reihenfolge der eigenen Ansichten setzen ( area , viewIds )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_view_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/watches": { "get": { "operationId": "GET_platform_citizen_register_me_watches", "summary": "Eigene beobachtete Akten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizen_register_me_watches", "summary": "Bis zu 50 Akten auf einmal beobachten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_watch", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizen-register/me/workspace": { "get": { "operationId": "GET_platform_citizen_register_me_workspace", "summary": "Offene Arbeits-Reiter der Person in dieser Instanz", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "put": { "operationId": "PUT_platform_citizen_register_me_workspace", "summary": "Arbeits-Reiter speichern ( expectedVersion , tabs , höchstens 12)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_workspace_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId", "summary": "Bürgerdatensätze eines Bereichs lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId", "summary": "Bürgerdatensatz anlegen; jedes geschriebene Feld muss im Felddefinitionskatalog des Bereichs stehen und einzeln freigegeben sein", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId", "summary": "Einen Bürgerdatensatz lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_authorityRecordId", "summary": "Bürgerdatensatz versionsgesichert ändern; ein Konflikt antwortet mit 409 und currentVersion", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/access-log": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_access_log", "summary": "Zugriffsprotokoll der Akte (nur eigene Instanz; cursor , `format=json", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/access-requests": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_access_requests", "summary": "Zugriff auf nicht freigegebene Felder dieser Akte anfragen (Partner; fieldIds , purpose 10 bis 500 Zeichen, caseNumber , durationHours 24/168/720)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_access_request_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/appointments": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_appointments", "summary": "Termine der Person ( upcoming , past ); Ort und Notiz nur mit appointmentDetails", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_appointments", "summary": "Kalendertermin anlegen und mit der eigenen Akte verknüpfen; braucht calendar.entry.create", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_appointment_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/appointments/{linkId}/attendance": { "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_appointments_linkId_attendance", "summary": "Erscheinen vermerken ( attendance ATTENDED , MISSED oder null )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_appointment_attendance", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/appointments/{linkId}/unlink": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_appointments_linkId_unlink", "summary": "Terminverknüpfung lösen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_appointment_unlink", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/appointments/link": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_appointments_link", "summary": "Bestehenden Kalendertermin der eigenen Instanz verknüpfen ( calendarEntryId , location )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_appointment_link", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_archive", "summary": "Bürgerdatensatz archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/assignees": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_assignees", "summary": "Zuständige der Akte; Partner sehen ohne Freigabe nur die Anzahl", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_assignees", "summary": "Zuständige setzen ( userIds , höchstens 10, nur eigene Mitarbeitende, nur eigene Akten)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_assignees_set", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/banners": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_banners", "summary": "Hinweis-Banner der Akte nach den Regeln der eigenen Instanz", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/casefiles": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_casefiles", "summary": "Fallakten der Person ( status=open|all ), je Besitzer nach dessen Regeln; hiddenOpenCount zählt die nicht freigegebenen, nicht abgeschlossenen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/editing": { "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_editing", "summary": "Bearbeitungshinweis erneuern (alle 20 s, gilt 45 s); antwortet mit den anderen Bearbeitenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "delete": { "operationId": "DELETE_platform_citizens_ownerGuildId_domainId_authorityRecordId_editing", "summary": "Bearbeitungshinweis beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-candidates": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_candidates", "summary": "Auswahl lesbarer, versiegelter Beweise ( source recent oder documents)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-candidates/{attachmentId}/preview": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_candidates_attachmentId_preview", "summary": "Vorschaubild eines auswählbaren Beweises", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-links": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_links", "summary": "Aktive und archivierte Beweisverknüpfungen berechtigt und seitenweise lesen ( limit 1–100, cursor ; items , returnedCount , hasMore , nextCursor ); Metadaten, keine Dateibytes", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_links", "summary": "Beweisdatei mit Bürgerdatensatz verknüpfen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_evidence_link_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-links/{linkId}": { "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_links_linkId", "summary": "Beweisverknüpfung ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_evidence_link_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-links/{linkId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_links_linkId_archive", "summary": "Beweisverknüpfung archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_evidence_link_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-links/{linkId}/preview": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_links_linkId_preview", "summary": "Vorschaubild einer verknüpften Bilddatei (JPEG, PNG, WebP bis 5 MB)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/evidence-links/{linkId}/restore": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_evidence_links_linkId_restore", "summary": "Beweisverknüpfung wiederherstellen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_evidence_link_restore", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/extract-options": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_extract_options", "summary": "Empfänger und verfügbare Abschnitte für einen Aktenauszug ( recipientGuildId )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/extracts": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_extracts", "summary": "Aktenauszüge der Akte", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_extracts", "summary": "Aktenauszug als PDF erstellen (Abschnitte, Felder, Aktenzeichen, Wasserzeichen, Briefkopf, optional shareDays für Partner)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_extract_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/extracts/{extractId}/pdf": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_extracts_extractId_pdf", "summary": "Aktenauszug herunterladen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "extractId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/extracts/{extractId}/revoke": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_extracts_extractId_revoke", "summary": "Aktenauszug zurückziehen ( reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "extractId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_extract_revoke", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_files", "summary": "Dateien der Akte; nicht lesbare als Platzhalter mit Größe und Instanz; uploadsConfigured ist false, solange die Instanz keine Beweisablage eingerichtet hat", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files/{linkId}": { "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_authorityRecordId_files_linkId", "summary": "Titel, Beschreibung oder Einstufung einer Datei ändern ( expectedVersion , title? , description? , classification? ); Titel nur bei in der Akte hochgeladenen Dateien", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_file_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files/{linkId}/content": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_files_linkId_content", "summary": "Dateiinhalt lesen; Partnerzugriffe werden protokolliert", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "linkId", "in": "path", "required": true, "description": "Id der Verknüpfung", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files/order": { "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_files_order", "summary": "Reihenfolge der Dateien setzen ( linkIds )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_file_order", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files/uploads": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_files_uploads", "summary": "Datei-Upload an der Akte beginnen ( originalName , mimeType , byteSize , title , classification ); höchstens 50 MB", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_file_upload", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files/uploads/{attachmentId}/versions/{versionId}/bytes": { "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_files_uploads_attachmentId_versions_versionId_bytes", "summary": "Dateiinhalt hochladen (roher Body)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_file_upload", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/files/uploads/{attachmentId}/versions/{versionId}/finalize": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_files_uploads_attachmentId_versions_versionId_finalize", "summary": "Upload abschließen ( expectedSha256 , expectedBytes ) und an die Akte hängen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_file_upload", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/history": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_history", "summary": "Verlauf mit Vorher/Nachher ( field , origin ALL/OWN/PARTNER/IMPORT, cursor ); Werte nur für lesbare Felder, sonst redacted", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/incidents": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_incidents", "summary": "Einsätze der eigenen Instanz, deren Patienten mit dieser Akte verknüpft sind (nur eigene Instanz)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/match-assistant/rejections": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_match_assistant_rejections", "summary": "Vorschlag mit candidateOwnerGuildId , candidateAuthorityRecordId und reason ablehnen; beide Datensätze müssen die Aktion erlauben", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_match_reject", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/merges": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_merges", "summary": "Identitätsverknüpfungen der Person dieser Akte; braucht Lesefreigabe für identity", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/notes/{narrativeId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_notes_narrativeId_archive", "summary": "Notiz löschen ( reason? ); Verfasser oder citizens.notes.manage , dazu Ändern der Notizkategorie", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "narrativeId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "platform.citizen_note_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/notes/{narrativeId}/lock": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_notes_narrativeId_lock", "summary": "Notiz sperren oder entsperren ( locked ); Verfasser oder citizens.notes.manage", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "narrativeId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "settings.manage", "x-mdt-audit": "platform.citizen_note_lock", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/notes/order": { "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_notes_order", "summary": "Reihenfolge der Notizen ( scope GLOBAL mit citizens.notes.manage oder OWN , lineageIds )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `settings.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "settings.manage", "x-mdt-audit": "platform.citizen_note_order", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/quick-actions": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_quick_actions", "summary": "Schnellaktionen, die die Person an dieser eigenen Akte ausführen darf", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/quick-actions/{actionId}/run": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_quick_actions_actionId_run", "summary": "Schnellaktion ausführen ( expectedVersion , inputs , reason ); alle Schritte in einer Transaktion, jeder mit den eigenen Rechten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "actionId", "in": "path", "required": true, "description": "Id der Kursaktion", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_quick_action_run", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/relations": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_relations", "summary": "Querverweise der Akte in beide Richtungen; nicht lesbare Gegenseiten ohne Namen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_relations", "summary": "Querverweis anlegen ( targetRef , typeRef , direction , since , until , note , classification )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_relation_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/relations/{relationId}": { "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_authorityRecordId_relations_relationId", "summary": "Querverweis ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "relationId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_relation_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/relations/{relationId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_relations_relationId_archive", "summary": "Querverweis entfernen ( expectedVersion , reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "relationId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_relation_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/reveal": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_reveal", "summary": "Vertrauliche Werte mit Zweckangabe für 15 Minuten aufdecken (Partner; fieldIds , narrativeIds , purpose ); wird protokolliert", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_reveal", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/search": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_search", "summary": "Suche in der Akte ( q 2 bis 64 Zeichen), nur in lesbaren Inhalten; nennt nicht freigegebene Bereiche nur als Anzahl", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/share-partners": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_share_partners", "summary": "Mögliche Partnerinstanzen für eine Einzelfreigabe", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/shares": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_shares", "summary": "Einzelfreigaben der Akte und bereichsweite Freigaben je Partner (nur eigene Instanz mit Freigaberecht)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_shares", "summary": "Akte befristet für eine Partnerinstanz freigeben ( partnerGuildId , fieldIds , purpose , caseNumber , expiresAt höchstens 90 Tage)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_share_create", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/shares/{shareId}/extend": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_shares_shareId_extend", "summary": "Einzelfreigabe verlängern ( expectedVersion , expiresAt )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_share_extend", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/shares/{shareId}/revoke": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_shares_shareId_revoke", "summary": "Einzelfreigabe sofort zurückziehen ( expectedVersion , reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "shareId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_share_revoke", "x-mdt-topics": [ "citizen", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/sync-preview": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_sync_preview", "summary": "Vorschau des Basisdaten-Abgleichs für geänderte Felder, ohne zu schreiben", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_match_suggest", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/table-rows": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_table_rows", "summary": "Zeilen aller lesbaren Tabellenfelder oder eines Feldes ( field )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/table-rows/{fieldKey}": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_table_rows_fieldKey", "summary": "Tabellenzeile anlegen ( values , classification , validUntil ); braucht update auf field:", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "fieldKey", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_table_row_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/table-rows/{fieldKey}/{rowId}": { "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_authorityRecordId_table_rows_fieldKey_rowId", "summary": "Tabellenzeile ändern ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "fieldKey", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "rowId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_table_row_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/table-rows/{fieldKey}/{rowId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_table_rows_fieldKey_rowId_archive", "summary": "Tabellenzeile entfernen ( expectedVersion , reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "fieldKey", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "rowId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.register.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.register.edit", "x-mdt-audit": "platform.citizen_table_row_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/tags": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_tags", "summary": "Kennzeichen der Akte und lesbare Kennzeichen anderer Akten derselben Person", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_tags", "summary": "Kennzeichen vergeben ( entryRef , expiresAt , note ); braucht update auf tags", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_tag_add", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/tags/{tagId}/remove": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_tags_tagId_remove", "summary": "Kennzeichen entfernen ( expectedVersion )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "tagId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_tag_remove", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/tasks": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_tasks", "summary": "Wiedervorlagen der eigenen Instanz an dieser Akte ( status=open|done|all )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_tasks", "summary": "Wiedervorlage an der Akte anlegen ( title , dueAt , dueHasTime , assigneeUserId )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.register_task_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/view-as": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_view_as", "summary": "Akte als Partner oder lokaler Rang ansehen, mit Begründung je Feld (frischer Instanz-Admin)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_view_as", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/warnings": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_authorityRecordId_warnings", "summary": "Warnhinweise der Akte; eigene vollständig, bereichsweit geteilte als Kurzform", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_warnings", "summary": "Warnhinweis setzen ( kind , shortText , validUntil , shareWithDomain , showInDispatch , reason )", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_warning_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/warnings/{warningId}": { "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_authorityRecordId_warnings_warningId", "summary": "Warnhinweis versionsgesichert ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "warningId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_warning_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/warnings/{warningId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_authorityRecordId_warnings_warningId_archive", "summary": "Warnhinweis entfernen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } }, { "name": "warningId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_warning_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/{authorityRecordId}/watch": { "put": { "operationId": "PUT_platform_citizens_ownerGuildId_domainId_authorityRecordId_watch", "summary": "Akte beobachten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_watch", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "delete": { "operationId": "DELETE_platform_citizens_ownerGuildId_domainId_authorityRecordId_watch", "summary": "Beobachtung beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "authorityRecordId", "in": "path", "required": true, "description": "Id des Registereintrags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_unwatch", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/field-definitions": { "get": { "operationId": "GET_platform_citizens_ownerGuildId_domainId_field_definitions", "summary": "Felddefinitionen lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_field_definitions", "summary": "Felddefinition anlegen ( key , label , valueType , classification , position ); der Schlüssel ist danach unveränderlich", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_field_definition_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/field-definitions/{definitionId}": { "patch": { "operationId": "PATCH_platform_citizens_ownerGuildId_domainId_field_definitions_definitionId", "summary": "Felddefinition ändern; valueType (bei SELECT mit selectOptionType und selectOptions ) nur, solange keine Werte gespeichert sind; die Optionen einer Auswahl jederzeit", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "definitionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_field_definition_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "delete": { "operationId": "DELETE_platform_citizens_ownerGuildId_domainId_field_definitions_definitionId", "summary": "Felddefinition ohne gespeicherte Werte endgültig löschen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "definitionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_field_definition_delete", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/field-definitions/{definitionId}/archive": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_field_definitions_definitionId_archive", "summary": "Felddefinition archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "definitionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.citizen_field_definition_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/match-assistant": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_match_assistant", "summary": "Lesende Matching-Anfrage mit genau einem von authorityRecordId oder claims , optional limit (1–100); liefert nur policy-geprüfte Vorschläge und reviewRequired: true", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_match_suggest", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/merges": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_merges", "summary": "Identitätszusammenführungen prüfen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_merge_review", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/{ownerGuildId}/{domainId}/merges/{mergeId}/reverse": { "post": { "operationId": "POST_platform_citizens_ownerGuildId_domainId_merges_mergeId_reverse", "summary": "Zusammenführung zurücknehmen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } }, { "name": "mergeId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.citizen_merge_reverse", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/citizens/discovery": { "get": { "operationId": "GET_platform_citizens_discovery", "summary": "Freigegebene Bürgerdatenquellen entdecken", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/config": { "get": { "operationId": "GET_platform_config", "summary": "Plattform-Konfiguration lesen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_platform_config", "summary": "Plattform-Konfiguration versionsgesichert ändern", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.config_update", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/platform/custody/{sourceMedicalGuildId}/offers": { "post": { "operationId": "POST_platform_custody_sourceMedicalGuildId_offers", "summary": "Verwahrungsübergabe anbieten", "tags": [ "Plattform" ], "parameters": [ { "name": "sourceMedicalGuildId", "in": "path", "required": true, "description": "Server-Id der abgebenden medizinischen Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.custody.manage", "x-mdt-audit": "platform.custody_offer", "x-mdt-topics": [ "custodyStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/custody/{sourceMedicalGuildId}/transfers/{transferId}": { "get": { "operationId": "GET_platform_custody_sourceMedicalGuildId_transfers_transferId", "summary": "Verwahrungsübergabe lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "sourceMedicalGuildId", "in": "path", "required": true, "description": "Server-Id der abgebenden medizinischen Instanz", "schema": { "type": "string" } }, { "name": "transferId", "in": "path", "required": true, "description": "Id der Übergabe", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "facility.custody.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/custody/{sourceMedicalGuildId}/transfers/{transferId}/accept": { "post": { "operationId": "POST_platform_custody_sourceMedicalGuildId_transfers_transferId_accept", "summary": "Verwahrungsübergabe annehmen", "tags": [ "Plattform" ], "parameters": [ { "name": "sourceMedicalGuildId", "in": "path", "required": true, "description": "Server-Id der abgebenden medizinischen Instanz", "schema": { "type": "string" } }, { "name": "transferId", "in": "path", "required": true, "description": "Id der Übergabe", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.custody.manage", "x-mdt-audit": "platform.custody_accept", "x-mdt-topics": [ "custodyStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/custody/{sourceMedicalGuildId}/transfers/{transferId}/cancel": { "post": { "operationId": "POST_platform_custody_sourceMedicalGuildId_transfers_transferId_cancel", "summary": "Verwahrungsübergabe abbrechen", "tags": [ "Plattform" ], "parameters": [ { "name": "sourceMedicalGuildId", "in": "path", "required": true, "description": "Server-Id der abgebenden medizinischen Instanz", "schema": { "type": "string" } }, { "name": "transferId", "in": "path", "required": true, "description": "Id der Übergabe", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.custody.manage", "x-mdt-audit": "platform.custody_cancel", "x-mdt-topics": [ "custodyStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/custody/{sourceMedicalGuildId}/transfers/{transferId}/events": { "post": { "operationId": "POST_platform_custody_sourceMedicalGuildId_transfers_transferId_events", "summary": "Verwahrungsverlauf ergänzen", "tags": [ "Plattform" ], "parameters": [ { "name": "sourceMedicalGuildId", "in": "path", "required": true, "description": "Server-Id der abgebenden medizinischen Instanz", "schema": { "type": "string" } }, { "name": "transferId", "in": "path", "required": true, "description": "Id der Übergabe", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.custody.manage", "x-mdt-audit": "platform.custody_event_append", "x-mdt-topics": [ "custodyStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/custody/{sourceMedicalGuildId}/transfers/{transferId}/reject": { "post": { "operationId": "POST_platform_custody_sourceMedicalGuildId_transfers_transferId_reject", "summary": "Verwahrungsübergabe ablehnen", "tags": [ "Plattform" ], "parameters": [ { "name": "sourceMedicalGuildId", "in": "path", "required": true, "description": "Server-Id der abgebenden medizinischen Instanz", "schema": { "type": "string" } }, { "name": "transferId", "in": "path", "required": true, "description": "Id der Übergabe", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.manage`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "facility.custody.manage", "x-mdt-audit": "platform.custody_reject", "x-mdt-topics": [ "custodyStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/custody/inbox": { "get": { "operationId": "GET_platform_custody_inbox", "summary": "Eingehende Verwahrungsübergaben auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `facility.custody.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `custodyEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "facility.custody.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "custodyEnabled" } }, "/platform/dispatchers/{ownerGuildId}": { "get": { "operationId": "GET_platform_dispatchers_ownerGuildId", "summary": "Explizit freigegebene Leitstellenbesetzung einer Instanz lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "required": false, "description": "Kommagetrennte Liste der im Katalog veröffentlichten Felder", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.dispatch.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.dispatch.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/dispatchers/sources": { "get": { "operationId": "GET_platform_dispatchers_sources", "summary": "Für die Leitstelle freigegebene Dispatcherquellen auflisten (Browser-Sitzung, keine API-Schlüssel)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.dispatch.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.dispatch.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/documents/{ownerGuildId}": { "get": { "operationId": "GET_platform_documents_ownerGuildId", "summary": "Plattformdokumente auflisten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}": { "get": { "operationId": "GET_platform_documents_ownerGuildId_documentId", "summary": "Plattformdokument lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/convert": { "post": { "operationId": "POST_platform_documents_ownerGuildId_documentId_convert", "summary": "Legacy-Dokument konvertieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_convert", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/profile": { "post": { "operationId": "POST_platform_documents_ownerGuildId_documentId_profile", "summary": "Dokument für Plattformverwaltung aktivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_profile_update", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" }, "patch": { "operationId": "PATCH_platform_documents_ownerGuildId_documentId_profile", "summary": "Klassifizierung, Organisationseinheit oder Freigabestufe des Dokuments versionsgesichert ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_profile_patch", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/projection/{action}": { "get": { "operationId": "GET_platform_documents_ownerGuildId_documentId_projection_action", "summary": "Dokumentaktion projizieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "action", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/read": { "post": { "operationId": "POST_platform_documents_ownerGuildId_documentId_read", "summary": "Dokument als gelesen markieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": "platform.document_read", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/sections": { "post": { "operationId": "POST_platform_documents_ownerGuildId_documentId_sections", "summary": "Dokumentabschnitt anlegen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_section_create", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/sections/{sectionId}": { "get": { "operationId": "GET_platform_documents_ownerGuildId_documentId_sections_sectionId", "summary": "Dokumentabschnitt lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "required": true, "description": "Id des Abschnitts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" }, "patch": { "operationId": "PATCH_platform_documents_ownerGuildId_documentId_sections_sectionId", "summary": "Abschnitt versionsgesichert ändern: sectionKey , title , body sowie die Zugriffsregeln classificationKey , owningOrgUnitId und requiredClearanceLevelId ; reason ist Pflicht", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "required": true, "description": "Id des Abschnitts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_section_update", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/sections/{sectionId}/archive": { "post": { "operationId": "POST_platform_documents_ownerGuildId_documentId_sections_sectionId_archive", "summary": "Dokumentabschnitt archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "required": true, "description": "Id des Abschnitts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_section_archive", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/sections/{sectionId}/restore": { "post": { "operationId": "POST_platform_documents_ownerGuildId_documentId_sections_sectionId_restore", "summary": "Dokumentabschnitt wiederherstellen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "required": true, "description": "Id des Abschnitts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_section_restore", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/sections/{sectionId}/revisions": { "get": { "operationId": "GET_platform_documents_ownerGuildId_documentId_sections_sectionId_revisions", "summary": "Abschnittsversionen lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "required": true, "description": "Id des Abschnitts", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/{documentId}/sections/order": { "put": { "operationId": "PUT_platform_documents_ownerGuildId_documentId_sections_order", "summary": "Dokumentabschnitte sortieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `documents.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "documents.shared.edit", "x-mdt-audit": "platform.document_section_reorder", "x-mdt-topics": [ "documents", "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/count": { "get": { "operationId": "GET_platform_documents_ownerGuildId_count", "summary": "Anzahl der Plattformdokumente lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/documents/{ownerGuildId}/unread": { "get": { "operationId": "GET_platform_documents_ownerGuildId_unread", "summary": "Ungelesene Plattformdokumente lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `documents.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "documents.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/{ownerGuildId}/attachments/{attachmentId}/versions/{versionId}/content": { "get": { "operationId": "GET_platform_evidence_ownerGuildId_attachments_attachmentId_versions_versionId_content", "summary": "Freigegebenen Beweisdateiinhalt einer Partnerinstanz lesen oder exportieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/{ownerGuildId}/attachments/{attachmentId}/write-requests": { "get": { "operationId": "GET_platform_evidence_ownerGuildId_attachments_attachmentId_write_requests", "summary": "Schreibanfragen als frisch geprüfter Besitzeradministrator lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" }, "post": { "operationId": "POST_platform_evidence_ownerGuildId_attachments_attachmentId_write_requests", "summary": "Mit reason Schreibzugriff beantragen; Browser-Sitzung, explizite Akteursinstanz und Lesefreigabe des Anhangs erforderlich", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.use`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "citizens.register.use", "x-mdt-audit": "platform.evidence_write_request", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/{ownerGuildId}/attachments/{attachmentId}/write-requests/{requestId}/review": { "post": { "operationId": "POST_platform_evidence_ownerGuildId_attachments_attachmentId_write_requests_requestId_review", "summary": "Schreibanfrage als Besitzeradministrator mit expectedVersion , decision ( APPROVE / REJECT ) und reason entscheiden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "requestId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_write_review", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments": { "post": { "operationId": "POST_platform_evidence_attachments", "summary": "Beweisdatei-Upload beginnen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_attachment_create", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments/{attachmentId}": { "get": { "operationId": "GET_platform_evidence_attachments_attachmentId", "summary": "Beweisdatei-Metadaten lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments/{attachmentId}/archive": { "post": { "operationId": "POST_platform_evidence_attachments_attachmentId_archive", "summary": "Beweisdatei archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_attachment_archive", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments/{attachmentId}/versions/{versionId}/bytes": { "put": { "operationId": "PUT_platform_evidence_attachments_attachmentId_versions_versionId_bytes", "summary": "Beweisdateiversion speichern", "tags": [ "Plattform" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_attachment_write", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments/{attachmentId}/versions/{versionId}/content": { "get": { "operationId": "GET_platform_evidence_attachments_attachmentId_versions_versionId_content", "summary": "Beweisdateiinhalt lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments/{attachmentId}/versions/{versionId}/finalize": { "post": { "operationId": "POST_platform_evidence_attachments_attachmentId_versions_versionId_finalize", "summary": "Beweisdateiversion abschließen", "tags": [ "Plattform" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_attachment_finalize", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/attachments/{attachmentId}/versions/{versionId}/purge": { "post": { "operationId": "POST_platform_evidence_attachments_attachmentId_versions_versionId_purge", "summary": "Beweisdateiversion entfernen", "tags": [ "Plattform" ], "parameters": [ { "name": "attachmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "versionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_attachment_purge", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/evidence/policy": { "get": { "operationId": "GET_platform_evidence_policy", "summary": "Beweisablage-Richtlinie lesen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" }, "put": { "operationId": "PUT_platform_evidence_policy", "summary": "Beweisablage-Richtlinie ändern", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `documentsEvidenceEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.evidence_policy_update", "x-mdt-topics": [ "documentsStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "documentsEvidenceEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/citizens": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_citizens", "summary": "Beteiligte Bürger eines Einsatzes lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_citizens", "summary": "Bürgerbeteiligung an einem Einsatz erfassen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_citizen_add", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/citizens/{contributorGuildId}/{involvementId}": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_citizens_contributorGuildId_involvementId", "summary": "Bürgerbeteiligung lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributorGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "involvementId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/citizens/{involvementId}/close": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_citizens_involvementId_close", "summary": "Bürgerbeteiligung beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "involvementId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_citizen_close", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/contributions": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_contributions", "summary": "Einsatzbeiträge auflisten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_contributions", "summary": "Einsatzbeitrag anlegen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_contribution_create", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/contributions/{contributorGuildId}": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_contributions_contributorGuildId", "summary": "Einsatzbeitrag im Namen einer beitragenden Instanz anlegen (nur vertrauenswürdiger Plattformkontext)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributorGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_contribution_create", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/contributions/{contributorGuildId}/{contributionId}": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_contributions_contributorGuildId_contributionId", "summary": "Einsatzbeitrag lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributorGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "patch": { "operationId": "PATCH_platform_incidents_ownerGuildId_einsatzId_contributions_contributorGuildId_contributionId", "summary": "Einsatzbeitrag ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributorGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributionId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_contribution_update", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/participations": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_participations", "summary": "Instanz zu Einsatz einladen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_participation_invite", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/participations/{participationId}/end": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_participations_participationId_end", "summary": "Einsatzteilnahme beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "participationId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_participation_end", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/participations/{participationId}/review": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_participations_participationId_review", "summary": "Einsatzteilnahme prüfen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "participationId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_participation_review", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/patients": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_patients", "summary": "Patientenbeteiligungen eines Einsatzes projiziert auflisten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_patients", "summary": "Patientenbeteiligung verknüpfen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_patient_link", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/patients/{medicalGuildId}/{patientParticipationId}": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_patients_medicalGuildId_patientParticipationId", "summary": "Patientenbeteiligung lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "medicalGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "patientParticipationId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/patients/{patientParticipationId}/unlink": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_patients_patientParticipationId_unlink", "summary": "Patientenbeteiligung lösen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "patientParticipationId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_patient_unlink", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/personnel": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_personnel", "summary": "Einsatzpersonal auflisten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_personnel", "summary": "Einsatzpersonal dokumentieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_personnel_add", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/personnel/{contributorGuildId}/{involvementId}": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_personnel_contributorGuildId_involvementId", "summary": "Personaleintrag lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "contributorGuildId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "involvementId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/personnel/{involvementId}/close": { "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_personnel_involvementId_close", "summary": "Personaleintrag beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "involvementId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_personnel_close", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/incidents/{ownerGuildId}/{einsatzId}/profile": { "get": { "operationId": "GET_platform_incidents_ownerGuildId_einsatzId_profile", "summary": "Einsatzprofil lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `einsatz.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "einsatz.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_incidents_ownerGuildId_einsatzId_profile", "summary": "Einsatzprofil anlegen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_profile_create", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "patch": { "operationId": "PATCH_platform_incidents_ownerGuildId_einsatzId_profile", "summary": "Einsatzprofil versionsgesichert ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "einsatzId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `einsatz.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "einsatz.shared.edit", "x-mdt-audit": "platform.incident_profile_update", "x-mdt-topics": [ "einsatzStale" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/network/access/explain": { "post": { "operationId": "POST_platform_network_access_explain", "summary": "Zugriff auf eine hypothetische Ressource simulieren", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.access_simulate", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/access/overview": { "post": { "operationId": "POST_platform_network_access_overview", "summary": "Was darf diese Person? Alle Datenarten mit Stufe, Feldern und Entscheidungsweg (echte Discord-Rollen)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.access_simulate", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/catalog": { "get": { "operationId": "GET_platform_network_catalog", "summary": "Versionierten Aktions-, Ressourcen- und Feldkatalog lesen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/directory": { "get": { "operationId": "GET_platform_network_directory", "summary": "Explizit freigegebene Partner-Metadaten lesen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "member", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domain-memberships/{membershipId}/leave": { "post": { "operationId": "POST_platform_network_identity_domain_memberships_membershipId_leave", "summary": "Identitätsbereich verlassen", "tags": [ "Plattform" ], "parameters": [ { "name": "membershipId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.identity_domain_leave", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domain-memberships/{membershipId}/review": { "post": { "operationId": "POST_platform_network_identity_domain_memberships_membershipId_review", "summary": "Identitätsbereichsbeitritt prüfen", "tags": [ "Plattform" ], "parameters": [ { "name": "membershipId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.identity_domain_join_review", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domain-memberships/sponsor-inbox": { "get": { "operationId": "GET_platform_network_identity_domain_memberships_sponsor_inbox", "summary": "Sponsor-Anfragen lesen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains": { "post": { "operationId": "POST_platform_network_identity_domains", "summary": "Identitätsbereich anlegen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.identity_domain_create", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/{domainId}/matching-fields": { "get": { "operationId": "GET_platform_network_identity_domains_domainId_matching_fields", "summary": "Matching-Feldkonfiguration des Identitätsbereichs lesen (frisch geprüfter Instanzadministrator)", "tags": [ "Plattform" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" }, "put": { "operationId": "PUT_platform_network_identity_domains_domainId_matching_fields", "summary": "Matching-Felder mit expectedVersion und fields ersetzen; jedes Feld enthält fieldKey , valueType , weight , position , required", "tags": [ "Plattform" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.identity_domain_matching_fields_set", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/{domainId}/requests": { "post": { "operationId": "POST_platform_network_identity_domains_domainId_requests", "summary": "Beitrittsanfrage erstellen; mit switchDomain: true aus einem anderen aktiven Bereich heraus (Bereich wechseln: die Annahme beendet die alte Mitgliedschaft)", "tags": [ "Plattform" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.identity_domain_join_request", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/eligible": { "get": { "operationId": "GET_platform_network_identity_domains_eligible", "summary": "Beitrittsfähige Identitätsbereiche lesen, mit sponsorName und diagnosis (warum die Liste so aussieht)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/memberships": { "get": { "operationId": "GET_platform_network_identity_domains_memberships", "summary": "Identitätsbereichsmitgliedschaften lesen, mit sponsorName und bei offenen Anfragen requestState", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/transfers": { "get": { "operationId": "GET_platform_network_identity_domains_transfers", "summary": "Akten übernehmen: aktueller Bereich ( target ) und die Bereiche mit eigenen Akten ( sources , mit offenen, übernommenen und übersprungenen Akten)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/transfers/{domainId}": { "post": { "operationId": "POST_platform_network_identity_domains_transfers_domainId", "summary": "Akten in den aktuellen Bereich übernehmen; choices (Akten-ID → AUTO , NEW , SKIP ), copyRules (Standard true ). Die alten Akten bleiben als Archiv", "tags": [ "Plattform" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.identity_domain_transfer", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/identity-domains/transfers/{domainId}/preview": { "get": { "operationId": "GET_platform_network_identity_domains_transfers_domainId_preview", "summary": "Vorschau der Übernahme: je eigener Akte LINK , NEW oder MERGE mit Abgleichswert, neue Felder, Feldkonflikte, zu kopierende Regeln", "tags": [ "Plattform" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "description": "Id des Identitätsraums", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/partner-diagnosis": { "get": { "operationId": "GET_platform_network_partner_diagnosis", "summary": "Warum die eigene Instanz bei Partnern nichts sieht: je Partner und Datenbereich die Hindernisse (Identitätsbereich, Kooperation, Plattformzugriff, fehlende oder spätere Regeln, Sicherheitsstufen, Pausen)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/partners/{partnerGuildId}/clearance-mappings": { "post": { "operationId": "POST_platform_network_partners_partnerGuildId_clearance_mappings", "summary": "Dem Partner vorschlagen, welche eigene Sicherheitsstufe als die Stufe zählt, die seine Freigabe verlangt (optional neue Stufe anlegen); der Partner gibt den Vorschlag frei", "tags": [ "Plattform" ], "parameters": [ { "name": "partnerGuildId", "in": "path", "required": true, "description": "Server-Id der Partnerinstanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_partner_mapping_propose", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/partners/{partnerGuildId}/incoming": { "get": { "operationId": "GET_platform_network_partners_partnerGuildId_incoming", "summary": "Freigaben eines Partners für die eigene Instanz lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "partnerGuildId", "in": "path", "required": true, "description": "Server-Id der Partnerinstanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/partners/{partnerGuildId}/requests": { "post": { "operationId": "POST_platform_network_partners_partnerGuildId_requests", "summary": "Partner-Admins per DM um weitere Freigaben bitten", "tags": [ "Plattform" ], "parameters": [ { "name": "partnerGuildId", "in": "path", "required": true, "description": "Server-Id der Partnerinstanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_partner_request", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/policies": { "get": { "operationId": "GET_platform_network_policies", "summary": "Eigene Freigaberichtlinien auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" }, "post": { "operationId": "POST_platform_network_policies", "summary": "Freigaberichtlinie anlegen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_create", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/{id}": { "patch": { "operationId": "PATCH_platform_network_policies_id", "summary": "Freigaberichtlinie versionsgesichert ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_update", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/{id}/archive": { "post": { "operationId": "POST_platform_network_policies_id_archive", "summary": "Freigaberichtlinie archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_archive", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/{id}/history": { "get": { "operationId": "GET_platform_network_policies_id_history", "summary": "Verlauf einer Freigaberichtlinie (Revisionen, neueste zuerst)", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/{id}/restore": { "post": { "operationId": "POST_platform_network_policies_id_restore", "summary": "Stand einer Revision als neue Version wiederherstellen", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_restore", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/batch": { "post": { "operationId": "POST_platform_network_policies_batch", "summary": "Mehrere Freigaberichtlinien in einer Transaktion ändern oder archivieren", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_batch", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/draft": { "post": { "operationId": "POST_platform_network_policies_draft", "summary": "Datenregel in eigenen Worten von der KI entwerfen lassen (Regeln als Entwurf)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_draft", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/export": { "get": { "operationId": "GET_platform_network_policies_export", "summary": "Eigene Freigaberichtlinien mit Namen der Ränge, Abteilungen und Stufen exportieren", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/findings": { "get": { "operationId": "GET_platform_network_policies_findings", "summary": "Regel-Prüfung: wirkungslose, doppelte, verwaiste und abgelaufene Regeln", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/for-resource": { "get": { "operationId": "GET_platform_network_policies_for_resource", "summary": "Wer einen bestimmten Datensatz sieht, samt Ausnahmen für genau diesen Datensatz", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/impact": { "post": { "operationId": "POST_platform_network_policies_impact", "summary": "Wirkungsvorschau: wer durch geplante Änderungen Zugriff gewinnt oder verliert", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.access_simulate", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/import": { "post": { "operationId": "POST_platform_network_policies_import", "summary": "Freigaberichtlinien als Entwurf importieren", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_import", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/matrix": { "get": { "operationId": "GET_platform_network_policies_matrix", "summary": "Matrix „Wer sieht was?“: Gruppen der eigenen Instanz und der Partner × Datenarten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/proposals": { "get": { "operationId": "GET_platform_network_policies_proposals", "summary": "Offene und zuletzt entschiedene Freigabe-Vorschläge auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" }, "post": { "operationId": "POST_platform_network_policies_proposals", "summary": "Heikle Änderung als Vorschlag für einen zweiten Admin stellen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_proposal_create", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/proposals/{id}/approve": { "post": { "operationId": "POST_platform_network_policies_proposals_id_approve", "summary": "Vorschlag eines anderen Admins freigeben und ausführen", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_proposal_approve", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/proposals/{id}/reject": { "post": { "operationId": "POST_platform_network_policies_proposals_id_reject", "summary": "Vorschlag ablehnen", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_proposal_reject", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/settings": { "get": { "operationId": "GET_platform_network_policies_settings", "summary": "Vier-Augen-Prinzip und Zahl der Admins lesen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" }, "put": { "operationId": "PUT_platform_network_policies_settings", "summary": "Vier-Augen-Prinzip ein- oder ausschalten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.policy_settings_update", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/policies/usage": { "get": { "operationId": "GET_platform_network_policies_usage", "summary": "Nutzung der Regeln und häufige Ablehnungen ( days 1 bis 90)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `policyV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "policyV2Enabled" } }, "/platform/network/records/labels": { "get": { "operationId": "GET_platform_network_records_labels", "summary": "Namen zu Datensatz-IDs in Regeln lesen (bis 50)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/network/records/search": { "get": { "operationId": "GET_platform_network_records_search", "summary": "Datensätze für Regeln suchen (Bürgerakten, Dokumente, Kategorien, Einheiten, Einsätze)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `networkV2Enabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "networkV2Enabled" } }, "/platform/organization/clearances": { "get": { "operationId": "GET_platform_organization_clearances", "summary": "Freigabestufen auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" }, "post": { "operationId": "POST_platform_organization_clearances", "summary": "Freigabestufe anlegen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.clearance_level_create", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/clearances/{id}": { "patch": { "operationId": "PATCH_platform_organization_clearances_id", "summary": "Freigabestufe versionsgesichert ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.clearance_level_update", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/clearances/{id}/archive": { "post": { "operationId": "POST_platform_organization_clearances_id_archive", "summary": "Freigabestufe archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.clearance_level_archive", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/clearances/assignments/{id}/revoke": { "post": { "operationId": "POST_platform_organization_clearances_assignments_id_revoke", "summary": "Mitarbeiterfreigabe widerrufen", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.employee_clearance_revoke", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/clearances/employees/{employeeId}": { "get": { "operationId": "GET_platform_organization_clearances_employees_employeeId", "summary": "Freigaben eines Mitarbeiters auflisten", "tags": [ "Plattform" ], "parameters": [ { "name": "employeeId", "in": "path", "required": true, "description": "Id der Mitarbeiterzeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" }, "post": { "operationId": "POST_platform_organization_clearances_employees_employeeId", "summary": "Freigabe einem Mitarbeiter erteilen", "tags": [ "Plattform" ], "parameters": [ { "name": "employeeId", "in": "path", "required": true, "description": "Id der Mitarbeiterzeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.employee_clearance_grant", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/memberships": { "get": { "operationId": "GET_platform_organization_memberships", "summary": "Zuordnungen von Mitarbeitern zu Organisationseinheiten auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" }, "post": { "operationId": "POST_platform_organization_memberships", "summary": "Mitarbeiter einer Organisationseinheit zuordnen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.organization_membership_assign", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/memberships/{id}/end": { "post": { "operationId": "POST_platform_organization_memberships_id_end", "summary": "Organisationszuordnung beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.organization_membership_end", "x-mdt-topics": [ "personal", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/units": { "get": { "operationId": "GET_platform_organization_units", "summary": "Organisationseinheiten auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" }, "post": { "operationId": "POST_platform_organization_units", "summary": "Organisationseinheit anlegen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.organization_unit_create", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/units/{id}": { "patch": { "operationId": "PATCH_platform_organization_units_id", "summary": "Organisationseinheit versionsgesichert ändern; capabilities vergibt Rechte an alle Mitglieder der Einheit und ihrer Untereinheiten", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.organization_unit_update", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/organization/units/{id}/archive": { "post": { "operationId": "POST_platform_organization_units_id_archive", "summary": "Organisationseinheit archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Id des Datensatzes", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `organizationsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.organization_unit_archive", "x-mdt-topics": [ "settings", "access" ], "x-mdt-module": null, "x-mdt-rollout-flag": "organizationsEnabled" } }, "/platform/outbox/preferences": { "get": { "operationId": "GET_platform_outbox_preferences", "summary": "Benachrichtigungseinstellungen auflisten", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "post": { "operationId": "POST_platform_outbox_preferences", "summary": "Benachrichtigungseinstellung anlegen", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.outbox_preference_create", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/platform/outbox/preferences/{preferenceId}": { "patch": { "operationId": "PATCH_platform_outbox_preferences_preferenceId", "summary": "Benachrichtigungseinstellung ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "preferenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.outbox_preference_update", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "delete": { "operationId": "DELETE_platform_outbox_preferences_preferenceId", "summary": "Benachrichtigungseinstellung löschen", "tags": [ "Plattform" ], "parameters": [ { "name": "preferenceId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Admin-Rechte", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "admin", "x-mdt-capability": null, "x-mdt-audit": "platform.outbox_preference_delete", "x-mdt-topics": [ "settings" ], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/platform/register-catalogs/me/entries": { "get": { "operationId": "GET_platform_register_catalogs_me_entries", "summary": "Katalogeinträge der eigenen Instanz (Bürgerregister: TAG , RELATION_TYPE , NOTE_CATEGORY , REPORT_TEMPLATE , BANNER_RULE , QUICK_ACTION ), kind , includeArchived", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "post": { "operationId": "POST_platform_register_catalogs_me_entries", "summary": "Katalogeintrag anlegen ( kind , key , label , color , classification , config ); 409 bei doppeltem Schlüssel", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_create", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/entries/{entryId}": { "patch": { "operationId": "PATCH_platform_register_catalogs_me_entries_entryId", "summary": "Katalogeintrag ändern mit expectedVersion", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/entries/{entryId}/archive": { "post": { "operationId": "POST_platform_register_catalogs_me_entries_entryId_archive", "summary": "Katalogeintrag archivieren; bestehende Daten zeigen ihn weiter an", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_archive", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/entries/{entryId}/offer": { "put": { "operationId": "PUT_platform_register_catalogs_me_entries_entryId_offer", "summary": "Katalogeintrag in Identitätsbereichen anbieten ( domainIds , nur aktive Mitgliedschaften); gibt keine Daten frei", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_offer", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/entries/{entryId}/restore": { "post": { "operationId": "POST_platform_register_catalogs_me_entries_entryId_restore", "summary": "Archivierten Katalogeintrag wiederherstellen", "tags": [ "Plattform" ], "parameters": [ { "name": "entryId", "in": "path", "required": true, "description": "Id der Zeile", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_restore", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/entries/order": { "put": { "operationId": "PUT_platform_register_catalogs_me_entries_order", "summary": "Reihenfolge der Einträge einer Art setzen ( kind , entryIds )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/mappings": { "put": { "operationId": "PUT_platform_register_catalogs_me_mappings", "summary": "Fremden Eintrag zuordnen ( mode MAPPED , ADOPTED oder NONE )", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_catalog_mapping", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/settings": { "get": { "operationId": "GET_platform_register_catalogs_me_settings", "summary": "Aktenkopf und Reiter der eigenen Instanz: Kurzname, Aktenzeichen-Muster mit Vorschau, Reiter-Layout", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" }, "put": { "operationId": "PUT_platform_register_catalogs_me_settings", "summary": "Kurzname, Aktenzeichen-Muster ( {JJJJ} , {JJ} , {NNNN} ) und Reiter-Layout speichern", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `citizens.setup.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "citizens.setup.edit", "x-mdt-audit": "platform.register_settings_update", "x-mdt-topics": [ "citizen" ], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/register-catalogs/me/shared": { "get": { "operationId": "GET_platform_register_catalogs_me_shared", "summary": "Angebotene Einträge der Partner im Identitätsbereich ( domainId ) mit eigener Zuordnung", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `citizens.register.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `canonicalCitizensEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "citizens.register.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "canonicalCitizensEnabled" } }, "/platform/units/{ownerGuildId}": { "get": { "operationId": "GET_platform_units_ownerGuildId", "summary": "Plattform-Einheiten auflisten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_units_ownerGuildId", "summary": "Plattform-Einheit anlegen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_create", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/{ownerGuildId}/{unitId}": { "get": { "operationId": "GET_platform_units_ownerGuildId_unitId", "summary": "Plattform-Einheit lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "patch": { "operationId": "PATCH_platform_units_ownerGuildId_unitId", "summary": "Plattform-Einheit ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_update", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "delete": { "operationId": "DELETE_platform_units_ownerGuildId_unitId", "summary": "Plattform-Einheit versionsgesichert löschen ( { \"expectedVersion\": n } ); der Verlauf bleibt erhalten", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_delete", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/{ownerGuildId}/{unitId}/archive": { "post": { "operationId": "POST_platform_units_ownerGuildId_unitId_archive", "summary": "Plattform-Einheit archivieren", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_archive", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/{ownerGuildId}/{unitId}/assignments": { "get": { "operationId": "GET_platform_units_ownerGuildId_unitId_assignments", "summary": "Einheitszuweisungen lesen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" }, "post": { "operationId": "POST_platform_units_ownerGuildId_unitId_assignments", "summary": "Einheit einem Einsatz zuordnen", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_assignment_assign", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/{ownerGuildId}/{unitId}/assignments/{assignmentId}/end": { "post": { "operationId": "POST_platform_units_ownerGuildId_unitId_assignments_assignmentId_end", "summary": "Einheitszuweisung beenden", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "assignmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_assignment_end", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/{ownerGuildId}/{unitId}/assignments/{assignmentId}/reassign": { "post": { "operationId": "POST_platform_units_ownerGuildId_unitId_assignments_assignmentId_reassign", "summary": "Einheitszuweisung ändern", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } }, { "name": "unitId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } }, { "name": "assignmentId", "in": "path", "required": true, "description": "Pfadparameter", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Braucht Schreibrechte oder im Rangsystem `board.shared.edit`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "edit", "x-mdt-capability": "board.shared.edit", "x-mdt-audit": "platform.unit_assignment_reassign", "x-mdt-topics": [ "units" ], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/{ownerGuildId}/board-capabilities": { "post": { "operationId": "POST_platform_units_ownerGuildId_board_capabilities", "summary": "Lesende Berechtigungsprüfung für bis zu 100 Einheiten ( { \"unitIds\": [\"…\"] } ); gibt nur sichtbare IDs mit Aktionsfreigaben zurück (Browser-Sitzung, keine API-Schlüssel)", "tags": [ "Plattform" ], "parameters": [ { "name": "ownerGuildId", "in": "path", "required": true, "description": "Server-Id der besitzenden Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": "view", "x-mdt-capability": "board.shared.view", "x-mdt-audit": "platform.unit_board_capabilities_probe", "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/board-catalog": { "get": { "operationId": "GET_platform_units_board_catalog", "summary": "Beide Quellenkataloge in einer Antwort: unitSources und dispatcherSources , jeweils mit derselben Prüfung wie die Einzelrouten. Eine Quelle, die die Einheitenfreigabe verweigert, kann weiterhin unter dispatcherSources stehen (Browser-Sitzung, keine API-Schlüssel)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/platform/units/board-sources": { "get": { "operationId": "GET_platform_units_board_sources", "summary": "Für die Leitstelle freigegebene Partnerquellen auflisten (Browser-Sitzung, keine API-Schlüssel)", "tags": [ "Plattform" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Im Rangsystem fehlt `board.shared.view`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Rollout-Flag `sharedIncidentsUnitsEnabled` ist beim Eigentümer aus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": "view", "x-mdt-capability": "board.shared.view", "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": "sharedIncidentsUnitsEnabled" } }, "/global-admin/instances": { "get": { "operationId": "GET_global_admin_instances", "summary": "Alle Instanzen mit Metadaten (nur Bot-Besitzer, Sitzung)", "tags": [ "Globale Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/global-admin/instances/{guildId}": { "delete": { "operationId": "DELETE_global_admin_instances_guildId", "summary": "Beliebige Instanz vollständig löschen, Body { \"confirm\": \"\" } (nur Bot-Besitzer, Sitzung)", "tags": [ "Globale Administration" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/global-admin/instances/{guildId}/modules": { "put": { "operationId": "PUT_global_admin_instances_guildId_modules", "summary": "Beta-Module freischalten / Module verbergen, Body { \"moduleGrants\": [...], \"hiddenModules\": [...] } (nur Bot-Besitzer, Sitzung)", "tags": [ "Globale Administration" ], "parameters": [ { "name": "guildId", "in": "path", "required": true, "description": "Discord-Server-Id der Instanz", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Datensatz nicht gefunden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/global-admin/modules": { "get": { "operationId": "GET_global_admin_modules", "summary": "Modul-Schlüssel und globale Beta-Liste (nur Bot-Besitzer, Sitzung)", "tags": [ "Globale Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null }, "put": { "operationId": "PUT_global_admin_modules", "summary": "Globale Beta-Liste setzen, Body { \"beta\": [...] } (nur Bot-Besitzer, Sitzung)", "tags": [ "Globale Administration" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Body oder Parameter ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Schlüssel oder Sitzung fehlt oder ist ungültig", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API-Schlüssel sind hier nicht zugelassen", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "session": [], "guildHeader": [] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object" } } } }, "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/docs": { "get": { "operationId": "GET_docs", "summary": "Diese Dokumentation im Browser (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "text/html": { "schema": { "type": "string" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null, "servers": [ { "url": "https://mdt.npdev.eu" } ] } }, "/docs/apidocs.md": { "get": { "operationId": "GET_docs_apidocs_md", "summary": "Diese Dokumentation als Markdown (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/docs/changelog.rss": { "get": { "operationId": "GET_docs_changelog_rss", "summary": "Neue, geänderte und entfernte Endpunkte als RSS-Feed (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/docs/llms.txt": { "get": { "operationId": "GET_docs_llms_txt", "summary": "Kompakte Referenz für KI-Assistenten, auch unter https://mdt.npdev.eu/llms.txt (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/docs/model.json": { "get": { "operationId": "GET_docs_model_json", "summary": "Datenmodell dieser Dokumentation: Endpunkte mit Recht, Capability, Audit-Aktion, Echtzeit-Themen, Modul und Rollout-Flag (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/docs/postman.json": { "get": { "operationId": "GET_docs_postman_json", "summary": "Postman-Sammlung (auch für Bruno und Insomnia) mit den Variablen baseUrl und apiKey (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } }, "/openapi.json": { "get": { "operationId": "GET_openapi_json", "summary": "OpenAPI-3.1-Beschreibung aller Endpunkte, aus derselben Quelle generiert (ohne Auth)", "tags": [ "Dokumentation" ], "parameters": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [], "x-mdt-need": null, "x-mdt-capability": null, "x-mdt-audit": null, "x-mdt-topics": [], "x-mdt-module": null, "x-mdt-rollout-flag": null } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "Instanz-API-Schlüssel (`stmp_…`), mit /apikey create im Discord oder in den Einstellungen erstellt" }, "session": { "type": "apiKey", "in": "cookie", "name": "better-auth.session_token", "description": "Browser-Sitzung nach Discord-Anmeldung (unter HTTPS mit dem Präfix `__Secure-`)" }, "guildHeader": { "type": "apiKey", "in": "header", "name": "x-guild-id", "description": "Instanz, auf die sich eine Sitzungsanfrage bezieht" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] } } } }