Register   |  Login             

SCP API DETAILS

Alarm rule


post : /alarms/createAlarmRule/{userId}

post

Description

Create an Alarm rule

Response Model
                            {  
   id (long): Id of the specified warning,
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
alarms An object warning. Json format. body
                                                {  
   name (string): The name of the specified warning,
   type (string): Type of regulation warning (1; logical expression> = <,2:update interval),
   severity (string): Severity (1.2 ...),
   remark (string): The contents of the warning,
   value (string): Value warning (100, 50  ....),
   condition (string): Conditions warning (ALARM_STATUS ..),
   status (string): Alert status (1:operation, 0:inactive),
   expression (string): Expressions warning (>, =, <),
   objectType (string): The object warning (0:devices, 1:apps),
   groupDeviceId (string): Group deviceId,
   notificationList : [
	{
		type (byte): Type notify (1: web, 2: sms, 3: email),
		toReceiver (string): Receiver notify,
		subject (string): Subject notify,
		content (string): Content notify
	}
   ]
   
}
                                            
delete : /alarms/deleteAlarmRule/{userId}/{alarmRuleId}

delete

Description

Delete an Alarm Rule by Id

Response Model
                            {
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
alarmRuleId Alarm rule id path Long
userId User id path Long
get : /alarms/getAlarmRuleDetail/{userId}

get

Description

Get alarm rule by Id

Response Model
                            {  
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   id (long): Alarm rule id,
   name (in): Alarm rule name,
   type (byte): Alarm rule type,
   severity (byte): Severity (1.2. ..),
   remark (string): Alarm  rule content,
   value (string): Alarm rule value (100, 50   ....),
   condition (string): Alarm rule conditions (ALARM_STATUS ..),
   status ( byte): Alarm status (1:operation,0:inactive),
   createdate (string): Date created,
   objectType (short): The object alarm rule (0:devices,1:apps),
   userCreater (string): User created,
   groupDeviceId (string): Group device id,
   groupDeviceName (string): Group device name,
   notificationList : [
	{
		type (byte): Type notify (1: web, 2: sms, 3: email),
		toReceiver (string): Receiver notify,
		subject (string): Subject notify,
		content (string): Content notify
	}
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
alarmRuleId Alarm rule id query Long
get : /alarms/getAlarmRuleList/{userId}

get

Description

Get Alarm rule list

Response Model
                            {  
   total (integer): Total,
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   alarmRuleDTOList:[  
      {  
         id (long): Id of alarm rule,
         name (string): Alarm rule name,
         type (byte): Alarm rule type,
         status (byte): Status,
         createdate (string): Date created,
         userCreater (string): User created
      }
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
objectType Object type query Byte
searchKey Search by name specified warning query String
start recordings started query Integer
status Status query Byte
total Get the number of records query Integer
put : /alarms/updateAlarmRule/{userId}

put

Description

Update an Alarm rule

Response Model
                            
	id (long): Alarm rule id,
	errorCode (integer): Error code,
	errorDesc (string): Error description

                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
alarmRule Those defined alerts. Json format. body
                                                {  
   id (long): Alarm rule id,
   name (string): The name specified warning,
   type (string): Type of regulation warning (1; logical expression> = <,2:update interval),
   severity (string): Severity (1.2 ...),
   remark (string): The contents of the warning,
   value (string): Value warning (100, 50   ....),
   condition (string): Conditions warning (ALARM_STATUS ..),
   status (string): Status (1:operation, 0:inactive),
   expression (string): Expressions warning (>, =, <),
   objectType (string): The object warning (0:devices,1:apps),
   userId (long): User id,
   groupDeviceId (string): Group device id,
   notificationList : [
		{
			type (byte): Type notify (1: web, 2: sms, 3: email),
			toReceiver (string): Receiver notify,
			subject (string): Subject notify,
			content (string): Content notify
		}
   ]
}
                                            
put : /alarms/updateAlarmRuleStatus/{userId}/{alarmRuleId}

put

Description

Update the Alarm rule status

Response Model
                            {
   errorCode (integer): Error code returned,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
alarmRuleId Alarm rule id path Long
userId User id path Long
status Alert status query Integer
Contact Information

Vietnam Post and Telecommunication Industry Technology (VNPT Technology)

Tel
Fax
Address
(+84) 4 3748 0922
(+84) 4 3748 0925
No. 124 Hoang Quoc Viet Street, Nghia Tan Ward, Cau Giay District, Hanoi
Introduction

•      VNPT Technology Introduction
•      SCP Introduction

Partners

•      Introduction
•      Certification process

Developers

•      SCP Discovery
•      APIs
•      Guideline Documents
•      Libraries

Legal

•      Terms of use
•      Privacy Policy
•      License Agreement

Copyright © 2017 VNPT Technology. All rights reserved.