RN 40420 - Web API changes - Swarming

develop/toc.yml

@@ -4061,6 +4061,8 @@ items:
             topicUid: AddBookingAttachmentV2
           - name: AddCommentToAlarm
             topicUid: AddCommentToAlarm
+          - name: AddCommentToAlarmV2
+            topicUid: AddCommentToAlarmV2
           - name: AddElementToPinned
             topicUid: AddElementToPinned
           - name: AddElementToRecent
@@ -4311,8 +4313,12 @@ items:
             topicUid: GetAlarmCountForService
           - name: GetAlarmDetails
             topicUid: GetAlarmDetails
+          - name: GetAlarmDetailsV2
+            topicUid: GetAlarmDetailsV2
           - name: GetAlarmHistory
             topicUid: GetAlarmHistory
+          - name: GetAlarmHistoryV2
+            topicUid: GetAlarmHistoryV2
           - name: GetAlarmPages
             topicUid: GetAlarmPages
           - name: GetAlarmPageUpdates
@@ -4397,6 +4403,8 @@ items:
             topicUid: GetCurrentAlarmByRootID
           - name: GetCurrentAlarmByRootIDV2
             topicUid: GetCurrentAlarmByRootIDV2
+          - name: GetCurrentAlarmByRootIDV3
+            topicUid: GetCurrentAlarmByRootIDV3
           - name: GetDashboardsForElement
             topicUid: GetDashboardsForElement
           - name: GetDashboardsForService
@@ -4855,6 +4863,8 @@ items:
             topicUid: LogOut
           - name: MaskAlarm
             topicUid: MaskAlarm
+          - name: MaskAlarmV2
+            topicUid: MaskAlarmV2
           - name: MaskElement
             topicUid: MaskElement
           - name: PauseElement
@@ -4865,6 +4875,8 @@ items:
             topicUid: ReconnectAppAndInfo
           - name: ReleaseOwnershipAlarm
             topicUid: ReleaseOwnershipAlarm
+          - name: ReleaseOwnershipAlarmV2
+            topicUid: ReleaseOwnershipAlarmV2
           - name: RemoveElementFromPinned
             topicUid: RemoveElementFromPinned
           - name: RemoveElementFromView
@@ -4915,6 +4927,8 @@ items:
             topicUid: SwitchRedundancyGroup
           - name: TakeOwnershipAlarm
             topicUid: TakeOwnershipAlarm
+          - name: TakeOwnershipAlarmV2
+            topicUid: TakeOwnershipAlarmV2
           - name: TestElementDeviceConnectivity
             topicUid: TestElementDeviceConnectivity
           - name: ToggleMatrixCrosspoint
@@ -4931,6 +4945,8 @@ items:
             topicUid: UnhideJobSectionDefinitionField
           - name: UnmaskAlarm
             topicUid: UnmaskAlarm
+          - name: UnmaskAlarmV2
+            topicUid: UnmaskAlarmV2
           - name: UnmaskElement
             topicUid: UnmaskElement
           - name: UpdateAlarmTemplate

develop/webservices/WS_v1/WS_Methods_v1/AddCommentToAlarm.md

@@ -6,6 +6,9 @@ uid: AddCommentToAlarm
 
 Use this method to add a comment to an alarm.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [AddCommentToAlarmV2](xref:AddCommentToAlarmV2) method instead.
+
 ## Input
 
 | Item       | Format  | Description                                          |

develop/webservices/WS_v1/WS_Methods_v1/AddCommentToAlarmV2.md

@@ -0,0 +1,23 @@
+---
+uid: AddCommentToAlarmV2
+---
+
+# AddCommentToAlarmV2
+
+Use this method to add a comment to an alarm.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item        | Format  | Description |
+|-------------|---------|-------------|
+| connection  | String  | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID       | Integer | The DataMiner Agent ID. |
+| elementID   | Integer | The element ID. |
+| rootAlarmID | Integer | The root alarm ID. |
+| comment     | String  | The comment to be added to the alarm. |
+
+## Output
+
+None.

develop/webservices/WS_v1/WS_Methods_v1/GetAlarmDetails.md

@@ -7,7 +7,10 @@ uid: GetAlarmDetails
 Use this method to retrieve the alarm details for a specified alarm.
 
 > [!NOTE]
-> Use the [GetAlarmHistory method](xref:GetAlarmHistory) to get the alarm details of a cleared non-root alarm.
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [GetAlarmDetailsV2](xref:GetAlarmDetailsV2) method instead.
+
+> [!NOTE]
+> Use the [GetAlarmHistory](xref:GetAlarmHistory) or [GetAlarmHistoryV2](xref:GetAlarmHistoryV2) method to get the alarm details of a cleared non-root alarm.
 
 ## Input
 

develop/webservices/WS_v1/WS_Methods_v1/GetAlarmDetailsV2.md

@@ -0,0 +1,27 @@
+---
+uid: GetAlarmDetailsV2
+---
+
+# GetAlarmDetailsV2
+
+Use this method to retrieve the alarm details for a specified alarm.
+
+> [!NOTE]
+> Use the [GetAlarmHistory method](xref:GetAlarmHistory) to get the alarm details of a cleared non-root alarm.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item       | Format  | Description                                           |
+|------------|---------|-------------------------------------------------------|
+| connection | String  | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID      | Integer | The DataMiner Agent ID.                               |
+| elementID  | Integer | The element ID.                                       |
+| alarmID    | Integer | The alarm ID.                                         |
+
+## Output
+
+| Item                    | Format    | Description                                    |
+|-------------------------|-----------|------------------------------------------------|
+| GetAlarmDetailsV2Result | [DMAAlarmDetails](xref:DMAAlarmDetails) | The alarm information for the specified alarm. |

develop/webservices/WS_v1/WS_Methods_v1/GetAlarmHistory.md

@@ -10,6 +10,9 @@ Use this method to retrieve:
 - all alarms in the alarm tree of a specific alarm, or
 - alarm details of a cleared non-root alarm.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [GetAlarmHistoryV2](xref:GetAlarmHistoryV2) method instead.
+
 ## Input
 
 | Item | Format | Description |

develop/webservices/WS_v1/WS_Methods_v1/GetAlarmHistoryV2.md

@@ -0,0 +1,29 @@
+---
+uid: GetAlarmHistoryV2
+---
+
+# GetAlarmHistoryV2
+
+Use this method to retrieve:
+
+- one specific alarm,
+- all alarms in the alarm tree of a specific alarm, or
+- alarm details of a cleared non-root alarm.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item | Format | Description |
+|--|--|--|
+| connection | String | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID      | Integer | The DMA ID. |
+| elementID  | Integer | The element ID. |
+| alarmID    | Integer | The ID of the specified alarm. This must be the ID of a root alarm of an alarm available in the cache. If you do not specify the root alarm ID and the alarm is not available in the cache, no results will be returned. |
+| requestFullTree | Boolean | Whether the method has to return only the specified alarm (FALSE) or all alarms in the alarm tree of the specified alarm (TRUE). |
+
+## Output
+
+| Item                    | Format                             | Description                                |
+|-------------------------|------------------------------------|--------------------------------------------|
+| GetAlarmHistoryV2Result | Array of [DMAAlarm](xref:DMAAlarm) | The alarm history for the specified alarm. |

develop/webservices/WS_v1/WS_Methods_v1/GetCurrentAlarmByRootIDV2.md

@@ -8,6 +8,9 @@ Use this method to retrieve the current alarm associated with a particular root
 
 Available from DataMiner 10.0.7 onwards.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [GetCurrentAlarmByRootIDV3](xref:GetCurrentAlarmByRootIDV3) method instead.
+
 ## Input
 
 | Item        | Format  | Description                                          |

develop/webservices/WS_v1/WS_Methods_v1/GetCurrentAlarmByRootIDV3.md

@@ -0,0 +1,24 @@
+---
+uid: GetCurrentAlarmByRootIDV3
+---
+
+# GetCurrentAlarmByRootIDV3
+
+Use this method to retrieve the current alarm associated with a particular root alarm ID, as well as the alarm cache status.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item        | Format  | Description                                           |
+|-------------|---------|-------------------------------------------------------|
+| connection  | String  | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID       | Integer | The DataMiner Agent ID.                               |
+| elementID   | Integer | The element ID.                                       |
+| rootAlarmID | Integer | The root alarm ID.                                    |
+
+## Output
+
+| Item | Format | Description |
+|--|--|--|
+| GetCurrentAlarmByRootIDV3Result | [DMAAlarm](xref:DMAAlarm) | The current alarm associated with the specified root alarm ID, as well as the alarm cache status. |

develop/webservices/WS_v1/WS_Methods_v1/MaskAlarm.md

@@ -6,6 +6,9 @@ uid: MaskAlarm
 
 Use this method to mask an alarm for a certain period of time.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [MaskAlarmV2](xref:MaskAlarmV2) method instead.
+
 ## Input
 
 | Item | Format | Description |

develop/webservices/WS_v1/WS_Methods_v1/MaskAlarmV2.md

@@ -0,0 +1,24 @@
+---
+uid: MaskAlarmV2
+---
+
+# MaskAlarmV2
+
+Use this method to mask an alarm for a certain period of time.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item | Format | Description |
+|--|--|--|
+| connection    | String | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID         | Integer | The DataMiner Agent ID. |
+| elementID     | Integer | The element ID. |
+| rootAlarmID   | Integer | The root alarm ID. |
+| clearInterval | Integer | The period of time (in seconds) during which the alarm will be masked.<br>Set to -1 if the alarm has to be masked until clearance. |
+| comment       | String | Extra information. |
+
+## Output
+
+None.

develop/webservices/WS_v1/WS_Methods_v1/ReleaseOwnershipAlarm.md

@@ -6,6 +6,9 @@ uid: ReleaseOwnershipAlarm
 
 Use this method to release ownership of an alarm.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [ReleaseOwnershipAlarmV2](xref:ReleaseOwnershipAlarmV2) method instead.
+
 ## Input
 
 | Item       | Format  | Description                                           |

develop/webservices/WS_v1/WS_Methods_v1/ReleaseOwnershipAlarmV2.md

@@ -0,0 +1,23 @@
+---
+uid: ReleaseOwnershipAlarmV2
+---
+
+# ReleaseOwnershipAlarmV2
+
+Use this method to release ownership of an alarm.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item        | Format  | Description |
+|-------------|---------|-------------|
+| connection  | String  | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID       | Integer | The DataMiner Agent ID. |
+| elementID   | Integer | The element ID. |
+| rootAlarmID | Integer | The root alarm ID. |
+| comment     | String  | Extra information. |
+
+## Output
+
+None.

develop/webservices/WS_v1/WS_Methods_v1/TakeOwnershipAlarm.md

@@ -6,6 +6,9 @@ uid: TakeOwnershipAlarm
 
 Use this method to take ownership of an alarm.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [TakeOwnershipAlarmV2](xref:TakeOwnershipAlarmV2) method instead.
+
 ## Input
 
 | Item       | Format  | Description                                           |

develop/webservices/WS_v1/WS_Methods_v1/TakeOwnershipAlarmV2.md

@@ -0,0 +1,23 @@
+---
+uid: TakeOwnershipAlarmV2
+---
+
+# TakeOwnershipAlarmV2
+
+Use this method to take ownership of an alarm.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item        | Format  | Description |
+|-------------|---------|-------------|
+| connection  | String  | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID       | Integer | The DataMiner Agent ID. |
+| elementID   | Integer | The element ID. |
+| rootAlarmID | Integer | The root alarm ID. |
+| comment     | String  | Extra information. |
+
+## Output
+
+None.

develop/webservices/WS_v1/WS_Methods_v1/UnmaskAlarm.md

@@ -6,6 +6,9 @@ uid: UnmaskAlarm
 
 Use this method to unmask an alarm.
 
+> [!NOTE]
+> From DataMiner 10.6.0/10.5.1 onwards, when Swarming is enabled, use the [UnmaskAlarmV2](xref:UnmaskAlarmV2) method instead.
+
 ## Input
 
 | Item       | Format  | Description                                           |

develop/webservices/WS_v1/WS_Methods_v1/UnmaskAlarmV2.md

@@ -0,0 +1,23 @@
+---
+uid: UnmaskAlarmV2
+---
+
+# UnmaskAlarmV2
+
+Use this method to unmask an alarm.
+
+Available from DataMiner 10.4.11 onwards.
+
+## Input
+
+| Item        | Format  | Description |
+|-------------|---------|-------------|
+| connection  | String  | The connection ID. See [ConnectApp](xref:ConnectApp). |
+| dmaID       | Integer | The DataMiner Agent ID. |
+| elementID   | Integer | The element ID. |
+| rootAlarmID | Integer | The root alarm ID. |
+| comment     | String  | Extra information. |
+
+## Output
+
+None.

release-notes/Web_apps/Web_apps_Feature_Release_10.4/Web_apps_Feature_Release_10.4.11.md

@@ -14,6 +14,23 @@ uid: Web_apps_Feature_Release_10.4.11
 
 ## New features
 
+#### Web API: New methods capable of dealing with new alarm IDs [ID 40240]
+
+<!-- MR 10.3.0 [CU20] / 10.4.0 [CU8] - FR 10.4.11 -->
+
+On a DataMiner System with Swarming enabled (from DataMiner 10.6.0/10.5.1 onwards), the following new methods will have to be used instead of their existing counterpart:
+
+|New method | Existing counterpart |
+|---|---|
+| AddCommentToAlarmV2 | AddCommentToAlarm |
+| GetAlarmDetailsV2   | GetAlarmDetails   |
+| GetAlarmHistoryV2   | GetAlarmHistory   |
+| GetCurrentAlarmByRootIDV3 | GetCurrentAlarmByRootIDV2 |
+| MaskAlarmV2               | MaskAlarm |
+| ReleaseOwnershipAlarmV2 | ReleaseOwnershipAlarm |
+| TakeOwnershipAlarmV2    | TakeOwnershipAlarm    |
+| UnmaskAlarmV2           | UnmaskAlarm           |
+
 #### Low-Code Apps - Time range component: New 'Set value' action [ID 40569]
 
 <!-- MR 10.3.0 [CU20] / 10.4.0 [CU8] - FR 10.4.11 -->