🧾 Listeneinträge per REST API verwalten

🔍 Inhalt

• Voraussetzungen
• Authentifizierung
• Endpunkte im Überblick
• Listeneinträge erstellen & aktualisieren
• Einträge abrufen & löschen
• Status-Historie anzeigen
• Metadaten abfragen
• Technische Hinweise
• Tipps & Best Practices
• FAQ

Voraussetzungen

• 🔐 API-Zugangsdaten (HTTP Basic Auth)

• 📄 YAML-Datei der API-Spezifikation (für Swagger Editor)

• 🧪 Swagger UI, Postman oder anderes Automatisierungstool (z. B. Power Automate, Python)

• 🧭 Team-ID und List-ID (UUIDs)

---

Authentifizierung

Die API nutzt HTTP Basic Auth:

Authorization: Basic <Base64-encoded-username:password>

🔗 Endpunkte im Überblick

📋 Listeneinträge

Methode	Pfad	Beschreibung
GET	/exchange/list/{list-id}/{team-id}	Listeneinträge eines Teams abrufen
POST	/exchange/list/{list-id}/{team-id}	Neuen Eintrag erstellen
PUT	/exchange/list/{list-id}/{team-id}	Mehrere Einträge erstellen oder aktualisieren (Bulk)
GET	/exchange/list/{list-id}/{team-id}/{entry-id}	Einzelnen Eintrag abrufen
PUT	/exchange/list/{list-id}/{team-id}/{entry-id}	Eintrag aktualisieren oder anlegen
DELETE	/exchange/list/{list-id}/{team-id}/{entry-id}	Eintrag löschen
GET	/exchange/list/{list-id}/{team-id}/{entry-id}/status-history	Status-Historie eines Eintrags

📸 Screenshot: Endpunkte🧠 Metadaten

Methode	Pfad	Beschreibung
GET	/exchange/list/meta	Alle verfügbaren Listen abrufen
GET	/exchange/list/meta/{list-id}	Felder & Typen einer Liste abrufen

🆕 Eintrag erstellen (POST)

{
  "dataDescription": "<p>Beispielbeschreibung</p>",
  "dataStatus": 1,
  "data1": "2025-08-14",
  "responsibleTeam": "UUID-Team",
  "createdByTeam": "UUID-Team"
}

✨ Tipp: Nutzen Sie data1–data10 flexibel für Ihre Listenstruktur.

🔁 Eintrag aktualisieren (PUT)

{
  "dataStatus": 3,
  "dataStatusMessage": "abgeschlossen"
}

⚠️ Achtung: Wenn dataDone=true gesetzt ist, wird der Eintrag „eingefroren“ (read-only).

📄 Eintrag abrufen (GET)

GET /exchange/list/{list-id}/{team-id}/{entry-id}

❌ Eintrag löschen (DELETE)

DELETE /exchange/list/{list-id}/{team-id}/{entry-id}

📊 Status-Historie anzeigen

GET /exchange/list/{list-id}/{team-id}/{entry-id}/status-history

Gibt alle Statusänderungen mit Datum und UUID zurück.

🧭 Metadaten abfragen

• Alle verfügbaren Listen:
  /exchange/list/meta

• Felder & Strukturen einer Liste:
  /exchange/list/meta/{list-id}

✨ Tipp: Ideal für dynamische UIs oder automatisierte Felderkennung.

📌 Technische Hinweise

• Format: Content-Type: application/vs.v2.0+json

• Jeder Eintrag erhält eine eindeutige dataId

• Kaskadierungen möglich: Eintrag für anderes Team erstellen

• Zeitstempel createdOn, modifiedOn, doneOn sind automatisch lesbar

✨ Tipps & Best Practices

• 🔄 Verwenden Sie PUT für wiederkehrende Updates (statt löschen + neu erstellen)

• 🗂 Nutzen Sie createdByTeam für Auswertungen über Teamgrenzen hinweg

• 💡 Holen Sie sich alle Listenfelder vorab über /meta/{list-id} zur Validierung

❓ FAQ

Kann ich Einträge für andere Teams anlegen?
-> Ja, über das Feld responsibleTeam.

Wozu dient dataDone?
-> Damit kann ein Eintrag dauerhaft gesperrt werden. Änderungen sind dann nicht mehr möglich.

Welche Felder sind Pflicht?
-> Mindestens: dataDescription, responsibleTeam, createdByTeam. Weitere Felder hängen von der Listenkonfiguration ab.

Wie viele Datenfelder gibt es pro Eintrag?
-> Maximal 10 (data1 bis data10), konfigurierbar pro Liste.