This endpoint allows partial updates to an existing AIE rule. Only the fields included in the request payload will be updated. All other fields will remain unchanged. All requests are validated before updates are applied. If validation fails, the update request will be rejected.
General Behavior:
- All requests are validated before updates are applied.
- Fields not included in the request remain unchanged.
User Profile and Privileges:
- Users must have AIE Rule Update/Edit privilege to modify a rule.
- Requests from users without the required privilege will return an authorization error.
- Rule updates may be restricted based on the user's profile permissions.
Rule Name Synchronization:
-
If syncWithRuleName = true:
- information.ruleName is required.
- The system automatically prefixes the rule name with "AIE:".
-
If syncWithRuleName = false:
- commonEvent.commonEventId must be provided.
- The rule links to the specified Common Event.
Alarm Configuration:
-
If only alarmOnEventOccurrence is provided:
- alarmAutoDrillDown is automatically set to the same value.
-
If both values are provided:
- alarmAutoDrillDown can be true or false only when alarmOnEventOccurrence = true.
Event Forwarding:
- If enableEventForwarding = false, the following fields will be ignored:
- notify
- decimalPlaces
- alarmOnEventOccurrence
- alarmAutoDrillDown
Event Suppression:
-
If enableSuppression = true and suppressionMultiple is not provided:
- suppressionMultiple will default to 1.
-
Set enableSuppression = false to disable suppression.
Expiration Date:
- Must be a future date.
- Past dates are not allowed.
- Pass null to remove the expiration date.
- If omitted, the current value remains unchanged.
Nullable Text Fields:
- Fields: briefDesc, additionalDetails, ruleGroup
- Pass null to clear the value.
- If omitted, the current value remains unchanged.
Enum Fields: These fields accept either integer values or camelCase string values.
riskRating / fpp:
- none (0)
- lowLow (1)
- lowMedium (2)
- lowHigh (3)
- mediumLow (4)
- mediumMedium (5)
- mediumHigh (6)
- highLow (7)
- highMedium (8)
- highHigh (9)
runtimePriority:
- low (0)
- normal (1)
- high (2)
edf:
- none (0)
- low (1)
- medium (2)
- high (3)
dataSegregationMode:
- none (0)
- logSourceEntity (1)
- logSourceRootEntity (2)
