Skip to main content

Entity and System States and Modes

This section provides an overview of the States and Modes that define the lifecycle and operational behavior of the resources Entities and System The diagram below illustrates the transitions between these states and modes, detailing how the resource evolves from creation to decommissioning and how its operational modes adapt based on internal events or external API calls.

Understanding these transitions is essential for managing resources effectively, ensuring smooth operations, and resolving issues like invalid credentials or temporary pauses.

States​

  • Acquired: Initial state of the resource upon creation. Operations cannot be performed in this state.
  • Commissioned: Resource is ready and fully operational (provided that the mode is operative).
  • Decommissioned: Resource is no longer operational and cannot perform any tasks. This state is irreversible.

Modes​

  • Inactive: Resource is inactive and not operational.
  • Operative: Resource is fully functional and operating as intended.
  • Suspended: Temporarily paused, which can be initiated via an API call, e.g. when credentials need to be updated.
  • Degraded: Resource is operational but temporarily unavailable, e.g. due to invalid credentials or errors.
Entity Resource State and Mode
note

Each transition is triggered either by an external API call or occurs automatically based on internal system logic. PATCH indicates that an external API call is required to initiate the transition. INTERNAL indicates that the transition is triggered automatically within the system. Bidirectional arrows indicate that the transition can occur both ways.

State Transitions​

  • Acquired → Commissioned: Requires an API call (PATCH) to update the resource.
  • Commissioned → Decommissioned: Managed through an API call (PATCH) to mark the resource as no longer in use. This state change is irreversible.

Mode Transitions​

  • Inactive → Operative: Transitions automatically if state is updated to Commissioned via API call.
  • Operative → Suspended: Can be actively performed via the API, e.g. to temporarily suspend operations while updating credentials.
  • Operative → Degraded: Transitions automatically if credentials are invalid or an error occurs.
  • Degraded → Suspended: Should be actively updated via the API to address issues like invalid credentials.
  • Suspended → Operative: Can be updated via the API after resolving issues, e.g. updating credentials.
  • Degraded → Operative: Can transition automatically when issues with the resource are resolved internally.