Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

notification-rule-controller

Get notification rule by id (getNotificationRuleById)

Fetches notification rule info by rule's id. In addition to regular notification rule fields, there are templateName and deliveryMethods in the response.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

get/api/notification/rule/{id}

Path parameters

idstring uuid required

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

namestring required
enabledboolean
triggerType'ENTITY_ACTION' | 'ALARM' | 'ALARM_COMMENT' | 'ALARM_ASSIGNMENT' | 'DEVICE_ACTIVITY' | 'RULE_ENGINE_COMPONENT_LIFECYCLE_EVENT' | 'EDGE_CONNECTION' | 'EDGE_COMMUNICATION_FAILURE' | 'NEW_PLATFORM_VERSION' | 'ENTITIES_LIMIT' | 'API_USAGE_LIMIT' | 'RATE_LIMITS' | 'TASK_PROCESSING_FAILURE' | 'RESOURCES_SHORTAGE' required
templateNamestring
deliveryMethodsstring[]

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_RULE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "templateId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_TEMPLATE"
  }
}