post https://example.com/dispatcher/v1/hooks/notifications/subscribe
Subscribe to get notifications for actions
If a subscription (to same action entity and endpoint) is already exist, the call will result in a CONFLICT response
The below table describes the request parameters:
Parameter | Type | Mandatory | Description |
---|---|---|---|
entityTypeName | String | true | Should be one of the valid entity types of the BioT system. Supported entity type names are: |
usage-session | |||
generic-entity | |||
caregiver | |||
patient | |||
organization | |||
organization-user | |||
device | |||
device-alert | |||
command | |||
patient-alert | |||
actionName | String | true | Should be one of the valid action types of the BioT system. Supported actions are: |
_operate | |||
_start | |||
_read | |||
_remoteResume | |||
_remoteStart | |||
_clear | |||
_create | |||
_assign | |||
_list | |||
_stop | |||
_generateCertificate | |||
_saveMeasurement | |||
_remotePause | |||
_updateAdmin | |||
_update | |||
_activateCertificate | |||
_monitor | |||
_delete | |||
_logout | |||
_remoteStop | |||
_login | |||
_updateEnabledState | |||
_revokeCertificate | |||
_command | |||
_manage | |||
endpoint | String | true | A valid URI |
This API requires DISPATCHER_SUBSCRIPTIONS_SUBSCRIBE permission(s).