Entity- und System-Zustände und -Modi

⚠️ Sie sehen die Dokumentation für API-Version 2024-10-31. Die neueste Version ist 2026-05-04. Wesentliche Änderungen umfassen aktualisierte Terminologie (Asset → Organization, Entity → Taxpayer/Location).

Dieser Abschnitt gibt einen Überblick über den state und den mode, die den Lebenszyklus und das Betriebsverhalten der Ressourcen Entities und Systems definieren. Das nachfolgende Diagramm veranschaulicht die Übergänge zwischen diesen Zuständen und Modi und zeigt detailliert, wie sich die Ressource von der Erstellung bis zur Außerbetriebnahme entwickelt und wie sich ihre Betriebsmodi aufgrund interner Ereignisse oder externer API-Aufrufe anpassen.

Das Verständnis dieser Übergänge ist für ein effektives Ressourcenmanagement, einen reibungslosen Betrieb und die Lösung von Problemen wie ungültigen Anmeldeinformationen oder vorübergehenden Unterbrechungen unerlässlich.

Zustände

• Acquired: Anfangszustand der Ressource bei der Erstellung. In diesem Zustand können keine Operationen durchgeführt werden.
• Commissioned: Ressource ist bereit und voll funktionsfähig (vorausgesetzt, der Modus ist operativ).
• Decommissioned: Ressource ist nicht mehr betriebsbereit und kann keine Aufgaben ausführen. Dieser Zustand ist irreversibel.

Modi

• Inactive: Ressource ist inaktiv und nicht betriebsbereit.
• Operative: Ressource ist voll funktionsfähig und funktioniert wie vorgesehen.
• Suspended: Vorübergehend pausiert, was über einen API-Aufruf initiiert werden kann, z. B. wenn Anmeldeinformationen aktualisiert werden müssen.
• Degraded (noch nicht implementiert): Ressource ist betriebsbereit, aber vorübergehend nicht verfügbar, z. B. aufgrund ungültiger Anmeldeinformationen oder Fehler.

📘Note

Jeder Übergang wird entweder durch einen externen API-Aufruf ausgelöst oder erfolgt automatisch auf Basis der internen Systemlogik. PATCH bedeutet, dass ein externer API-Aufruf erforderlich ist, um den Übergang einzuleiten. INTERNAL bedeutet, dass der Übergang automatisch innerhalb des Systems ausgelöst wird. Bidirektionale Pfeile zeigen an, dass der Übergang in beide Richtungen erfolgen kann.

Zustandsübergänge

• Acquired → Commissioned: Erfordert einen API-Aufruf (PATCH) zur Aktualisierung der Ressource.
• Commissioned → Decommissioned: Wird durch einen API-Aufruf (PATCH) verwaltet, um die Ressource als nicht mehr in Betrieb zu markieren. Diese Zustandsänderung ist irreversibel.

Modusübergänge

• Inactive → Operative: Wechselt automatisch, wenn der Zustand über API-Aufruf auf Commissioned aktualisiert wird.
• Operative → Suspended: Kann aktiv über die API durchgeführt werden, z. B. um den Betrieb vorübergehend zu unterbrechen, während Anmeldeinformationen aktualisiert werden.
• Operative → Degraded (noch nicht implementiert): Wechselt automatisch, wenn Anmeldeinformationen ungültig sind oder ein Fehler auftritt.
• Degraded → Suspended (noch nicht implementiert): Sollte aktiv über die API aktualisiert werden, um Probleme wie ungültige Anmeldeinformationen zu beheben.
• Suspended → Operative: Kann über die API aktualisiert werden, nachdem Probleme behoben wurden, z. B. Aktualisierung von Anmeldeinformationen.
• Degraded → Operative (noch nicht implementiert): Kann automatisch übergehen, wenn Probleme mit der Ressource intern behoben werden.