Update

PUT v1/alarms/id

Description

Update an alarm.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_enoent,ENOENT

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_unexpected_arg

SM_unexpected_query_param

SM_version_name

Request

Parameter Type JSON Type Description Mandatory Deprecated
id NsObjectID string Identifier for the alarm. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true  
remind_every NsAlarmRemindEvery number Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day. Frequency of alarm notification. true  
remind_every_unit NsPeriodUnit string enum Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day. Possible values: 'minutes', 'hours', 'days', 'weeks'. false  

JSON Request


            

{
   "data" : {
      "remind_every" : 2,
      "remind_every_unit" : "hours"
   }
}

        
         

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for the alarm. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
remind_every NsAlarmRemindEvery number Frequency of notification. This number and the remind_every_unit define how frequent one alarm notification is sent. For example, a value of 1 with the 'remind_every_unit' of 'days' results in one notification every day. Frequency of alarm notification.  
remind_every_unit NsPeriodUnit string enum Time unit over which to send the number of notification specified in 'remind_every'. For example, a value of 'days' with a 'remind_every' of '1' results in one notification every day. Possible values: 'minutes', 'hours', 'days', 'weeks'.  

JSON Response


            

{
    "data": {
        "ack_time": 1446079670,
        "activity": "Test message at warn level",
        "array": "g1a1",
        "category": "test",
        "curr_onset_event_id": "1800000000000004d3000000000000000000000001",
        "id": "3c00000000000004d3000000000000000000000001",
        "object_id": "",
        "object_name": "test",
        "object_type": "test",
        "onset_time": 1446079587,
        "remind_every": 1,
        "remind_every_unit": "days",
        "severity": "warning",
        "status": "acknowledged",
        "type": 1,
        "user_id": "1000000000000004d3000000000000000000000001",
        "user_name": "admin"
    }
}