How to Enable/Disable Analytic Rules via the Nx Witness Server API

Sometimes users want to enable or disable an Analytic Event Rule via a camera input signal, I/O module, or soft trigger. For example, users may want to have an Analytics Event Rule be active only when an alarm is armed, soft trigger is pressed, or input from a camera is received. This can be accomplished through an API request.

Create an Analytics Event Rule

If you already have the desired Analytics Event Rule set up, skip ahead to the next section. Otherwise, create an Analytics Event Rule via the Rules Engine or API (see the How to create or modify Event Rule article).

Create Event Rules to Enable/Disable the Analytics Event

1. Visit https://<server_ip>:<server_port>/ec2/getEventRules in the browser.
2. Find and copy the parameters of the Event Rule you would like to control.
   Example:
   

   {
     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "eventType": "undefinedEvent",
     "eventResourceIds": [
       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
     ],
     "eventCondition": "string",
     "eventState": "inactive",
     "actionType": "undefinedAction",
     "actionResourceIds": [
       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
     ],
     "actionParams": "string",
     "aggregationPeriod": 0,
     "disabled": false,
     "comment": "string",
     "schedule": "string",
     "system": true
   }

3. Create an Event Rule to enable Event Rule A. Set it to be triggered via Soft Trigger, Input Signal on Camera, or I/O module.
4. In the Action column, open the Do dropdown menu and select Do HTTP request.
5. In the HTTP URL field, enter https://<server_ip>:<port>/ec2/saveEventRule
6. In the HTTP Content field, enter the body of the API POST request (the parameters from step 2). Change the value of the “disabled” parameter to false.
   Example:
   

   {
     "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
     "eventType": "undefinedEvent",
     "eventResourceIds": [
       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
     ],
     "eventCondition": "string",
     "eventState": "inactive",
     "actionType": "undefinedAction",
     "actionResourceIds": [
       "3fa85f64-5717-4562-b3fc-2c963f66afa6"
     ],
     "actionParams": "string",
     "aggregationPeriod": 0,
     "disabled": false,
     "comment": "string",
     "schedule": "string",
     "system": true
   }

7. Open the Content type dropdown and select application/json.
8. Open the Request type dropdown and select POST.
9. Enter the login and password.
10. Apply changes.
11. Create an Event Rule to disable Event Rule A. Set it to be triggered via Soft Trigger, Input Signal on Camera, or I/O module.
12. Repeat steps 4-6. Change the value of the “disabled” parameter in the HTTP Content field to true.
    Example:
    

    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "eventType": "undefinedEvent",
      "eventResourceIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "eventCondition": "string",
      "eventState": "inactive",
      "actionType": "undefinedAction",
      "actionResourceIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "actionParams": "string",
      "aggregationPeriod": 0,
      "disabled": true,
      "comment": "string",
      "schedule": "string",
      "system": true
    }

13. Repeat steps 7-9.
14. Apply changes.

For more information, please refer to How to start/stop recording using Nx Witness Generic Event.