Subscriptions

Requirement: GET /{entity}/cyclic-subscriptions REQ_INTEROP_025

status: verified tags: Subscriptions is verified by: TEST_TestMultiCollectionSubscriptions_test_list_subscriptions, TEST_TestScenarioSubscriptions_test_02_list_subscriptions_returns_created_ones, TEST_TestScenarioSubscriptions_test_07_empty_list_after_delete, TEST_TestScenarioSubscriptions_test_30_cyclic_subscriptions_work_on_components

The endpoint shall list all configured cyclic data subscriptions on the addressed entity.

Requirement: GET /{entity}/cyclic-subscriptions/{id} REQ_INTEROP_026

status: verified tags: Subscriptions is verified by: TEST_TestMultiCollectionSubscriptions_test_get_subscription, TEST_TestScenarioSubscriptions_test_03_get_single_subscription, TEST_TestScenarioSubscriptions_test_24_get_nonexistent_subscription_returns_404

The endpoint shall return the configuration and status of the addressed cyclic subscription.

Requirement: PUT /{entity}/cyclic-subscriptions/{id} REQ_INTEROP_027

status: verified tags: Subscriptions is verified by: TEST_TestMultiCollectionSubscriptions_test_update_subscription_interval, TEST_TestScenarioSubscriptions_test_04_update_subscription_interval, TEST_TestScenarioSubscriptions_test_05_update_subscription_duration, TEST_TestScenarioSubscriptions_test_26_update_nonexistent_subscription_returns_404

The endpoint shall update the configuration of the addressed cyclic subscription on the entity.

Requirement: DELETE /{entity}/cyclic-subscriptions/{id} REQ_INTEROP_028

status: verified tags: Subscriptions is verified by: TEST_TestMultiCollectionSubscriptions_test_delete_subscription, TEST_TestScenarioSubscriptions_test_06_delete_subscription_returns_204, TEST_TestScenarioSubscriptions_test_12_sse_stream_closes_on_subscription_delete, TEST_TestScenarioSubscriptions_test_25_delete_nonexistent_subscription_returns_404

The endpoint shall delete the addressed cyclic subscription from the entity.

Requirement: POST /{entity}/cyclic-subscriptions REQ_INTEROP_089

status: verified tags: Subscriptions is verified by: TEST_CyclicSubscriptionJsonTest_ContainsAllRequiredFields, TEST_CyclicSubscriptionJsonTest_ServerLevelUpdateResource, TEST_IntervalParsingTest_ParsesValidIntervals, TEST_ParseResourceUriTest_DataCollectionWithTopic, TEST_ParseResourceUriTest_UpdateStatusUri, TEST_TestMultiCollectionSubscriptions_test_configurations_subscription_create, TEST_TestMultiCollectionSubscriptions_test_data_subscription_create, TEST_TestMultiCollectionSubscriptions_test_faults_subscription_create, TEST_TestMultiCollectionSubscriptions_test_logs_subscription_create, TEST_TestMultiCollectionSubscriptions_test_logs_subscription_sse_stream, TEST_TestScenarioSubscriptions_test_01_create_subscription_returns_201_with_correct_schema, TEST_TestScenarioSubscriptions_test_20_create_with_invalid_interval_returns_400, TEST_TestScenarioSubscriptions_test_21_create_with_zero_duration_returns_400, TEST_TestScenarioSubscriptions_test_22_create_with_unsupported_protocol_returns_400, TEST_TestScenarioSubscriptions_test_23_create_with_invalid_resource_uri_returns_400, TEST_TestScenarioSubscriptions_test_27_create_for_nonexistent_entity_returns_404, TEST_TestScenarioSubscriptions_test_30_cyclic_subscriptions_work_on_components, TEST_TransportRegistryTest_RegisterAndLookup

The endpoint shall create a new cyclic data subscription on the addressed entity, specifying the observed resource URI, delivery interval (fast/normal/slow), transport protocol (SSE), and subscription duration in seconds. On success it shall return 201 with the subscription ID, observed resource, event source URI, protocol, and interval.

Requirement: GET /{entity}/cyclic-subscriptions/{id}/events REQ_INTEROP_090

status: verified tags: Subscriptions is verified by: TEST_SseTransportProviderTest_ProtocolReturnsSse, TEST_SseTransportProviderTest_StartReturnsEventsUrl, TEST_SseTransportProviderTest_StopRemovesStream, TEST_TestMultiCollectionSubscriptions_test_logs_subscription_sse_stream, TEST_TestScenarioSubscriptions_test_10_sse_stream_returns_correct_headers, TEST_TestScenarioSubscriptions_test_11_sse_stream_delivers_periodic_data, TEST_TestScenarioSubscriptions_test_12_sse_stream_closes_on_subscription_delete, TEST_TestScenarioSubscriptions_test_28_sse_stream_for_nonexistent_subscription_returns_404

The endpoint shall open an SSE (Server-Sent Events) stream that delivers the current value of the subscribed data resource at the configured interval. Each event shall be an EventEnvelope containing a UTC timestamp and either a payload (ReadValue format) or an error (GenericError format). The stream shall auto-close when the subscription duration expires, the client disconnects, or the subscription is deleted.

Requirement: POST /{entity}/triggers REQ_INTEROP_029

status: verified tags: Subscriptions is verified by: TEST_ConditionEvaluator_OnChangeTo_ValidateParams_MissingTarget, TEST_ConditionEvaluator_OnChangeTo_ValidateParams_Valid, TEST_ConditionEvaluator_OnChange_ValidateParams, TEST_LoadPersistentTriggers_ExpiredTriggerMarkedTerminatedOnLoad, TEST_LoadPersistentTriggers_NewTriggerIdIsHigherThanRestoredId, TEST_LoadPersistentTriggers_ResetBehaviorDoesNotRestoreTriggers, TEST_LoadPersistentTriggers_RestoreBehaviorLoadsActiveTrigger, TEST_TestTriggersData_test_01_create_trigger_returns_201_with_correct_schema, TEST_TestTriggersFaults_test_01_create_fault_trigger_returns_201, TEST_TestTriggersHierarchy_test_01_component_trigger_created_successfully, TEST_TestTriggersLogs_test_01_create_logs_trigger, TEST_TestTriggersPersistent_test_01_create_persistent_trigger, TEST_TestTriggersUpdates_test_01_create_updates_trigger, TEST_TriggerErrorTest_InvalidParameterErrorFormat, TEST_TriggerErrorTest_InvalidResourceUriVendorError, TEST_TriggerManagerTest_Create_InvalidConditionType, TEST_TriggerManagerTest_Create_InvalidParams, TEST_TriggerManagerTest_Create_MaxTriggersExceeded, TEST_TriggerManagerTest_Create_ValidOnChangeTrigger, TEST_TriggerManagerTest_Hierarchy_AreaToApp, TEST_TriggerManagerTest_Hierarchy_ComponentToApp, TEST_TriggerManagerTest_LifetimeExpiry, TEST_TriggerManagerTest_SingleShot_RemovedAfterFiring, TEST_TriggerStore_FilePersistence, TEST_TriggerStore_SaveAndLoadRoundTrip, TEST_TriggerToJsonTest_ContainsAllRequiredFields, TEST_TriggerValidationTest_InvalidJsonPointer_Returns400, TEST_TriggerValidationTest_PathTooLong_Returns400, TEST_TriggerValidationTest_UnknownCollection_Returns400, TEST_TriggerValidationTest_UnsupportedProtocol_Returns400, TEST_TriggerValidationTest_VendorExtensionCollection_Accepted

The endpoint shall create a new trigger definition on the addressed entity.

Requirement: GET /{entity}/triggers REQ_INTEROP_030

status: verified tags: Subscriptions is verified by: TEST_TestTriggersData_test_02_list_triggers_returns_created_trigger, TEST_TestTriggersFaults_test_02_list_fault_triggers, TEST_TestTriggersHierarchy_test_05_list_triggers_on_area, TEST_TestTriggersLogs_test_02_list_logs_triggers, TEST_TestTriggersPersistent_test_02_trigger_listed_on_primary, TEST_TestTriggersUpdates_test_02_list_updates_triggers, TEST_TriggerErrorTest_InvalidParameterErrorFormat, TEST_TriggerManagerTest_List_ReturnsTriggersForEntity

The endpoint shall list all trigger definitions configured on the addressed entity.

Requirement: PUT /{entity}/triggers/{id} REQ_INTEROP_031

status: verified tags: Subscriptions is verified by: TEST_TestTriggersData_test_04_update_trigger_lifetime, TEST_TestTriggersFaults_test_04_update_fault_trigger_lifetime, TEST_TestTriggersLogs_test_04_update_logs_trigger_lifetime, TEST_TestTriggersUpdates_test_04_update_updates_trigger_lifetime, TEST_TriggerErrorTest_InvalidParameterErrorFormat, TEST_TriggerManagerTest_Update_ChangeLifetime

The endpoint shall update the addressed trigger definition on the entity.

Requirement: DELETE /{entity}/triggers/{id} REQ_INTEROP_032

status: verified tags: Subscriptions is verified by: TEST_TestTriggersData_test_05_delete_trigger_returns_204, TEST_TestTriggersData_test_12_sse_stream_closes_on_trigger_delete, TEST_TestTriggersFaults_test_05_delete_fault_trigger, TEST_TestTriggersHierarchy_test_06_delete_trigger_on_function, TEST_TestTriggersLogs_test_05_delete_logs_trigger, TEST_TestTriggersPersistent_test_06_delete_via_secondary_removes_from_store, TEST_TestTriggersUpdates_test_05_delete_updates_trigger, TEST_TriggerErrorTest_InvalidParameterErrorFormat, TEST_TriggerManagerTest_OnRemovedCallback, TEST_TriggerManagerTest_Remove_ExistingTrigger

The endpoint shall delete the addressed trigger definition from the entity.

Requirement: GET /{entity}/triggers/{id} REQ_INTEROP_096

status: verified tags: Subscriptions is verified by: TEST_TestTriggersData_test_03_get_single_trigger, TEST_TestTriggersFaults_test_03_get_fault_trigger, TEST_TestTriggersLogs_test_03_get_logs_trigger, TEST_TestTriggersPersistent_test_04_restored_trigger_fields_match, TEST_TestTriggersUpdates_test_03_get_updates_trigger, TEST_TriggerErrorTest_InvalidParameterErrorFormat, TEST_TriggerManagerTest_Get_Existing, TEST_TriggerToJsonTest_ContainsAllRequiredFields

The endpoint shall return the configuration and status of the addressed trigger definition.

Requirement: GET /{entity}/triggers/{id}/events REQ_INTEROP_097

status: verified tags: Subscriptions is verified by: TEST_ConditionEvaluator_EnterRange_NonNumericReturnsFalse, TEST_ConditionEvaluator_LeaveRange_NonNumericReturnsFalse, TEST_ResourceChangeNotifier_AsyncDispatchNonBlocking, TEST_ResourceChangeNotifier_SubscribeAndNotify, TEST_TestTriggersData_test_10_sse_stream_returns_correct_headers, TEST_TestTriggersData_test_11_sse_stream_delivers_data_events, TEST_TestTriggersData_test_12_sse_stream_closes_on_trigger_delete, TEST_TestTriggersData_test_27_events_for_nonexistent_trigger_returns_404, TEST_TestTriggersFaults_test_10_sse_endpoint_connects_and_streams, TEST_TestTriggersFaults_test_11_sse_fault_event_has_correct_headers, TEST_TestTriggersLogs_test_10_sse_endpoint_connects_for_log_trigger, TEST_TestTriggersLogs_test_11_sse_log_event_headers, TEST_TestTriggersUpdates_test_10_events_endpoint_returns_sse_headers, TEST_TestTriggersUpdates_test_11_events_for_nonexistent_trigger_returns_404, TEST_TriggerErrorTest_InvalidParameterErrorFormat, TEST_TriggerManagerTest_EventEnvelopeFormat, TEST_TriggerManagerTest_JsonPointer_ExtractsSubElement, TEST_TriggerManagerTest_Multishot_NotifyTwice, TEST_TriggerManagerTest_SingleShot_NotifyMatchingChange, TEST_TriggerSSETrackerTest_ClientLimitEnforced, TEST_TriggerToJsonTest_ContainsAllRequiredFields

The endpoint shall open an SSE (Server-Sent Events) stream that delivers trigger events when the configured condition fires. Each event shall be an EventEnvelope containing a UTC timestamp and a payload. The stream shall auto-close when the trigger is deleted, the client disconnects, or the trigger lifetime expires.