VirtualMetric - API Documentation

POST api/NotificationRule

Request Information

URI Parameters

None.

Body Parameters

NotificationRule

Name	Type	Additional information
ID	integer	None.
Name	string	None.
LanguageKey	string	None.
Ack	boolean	None.
Severity	byte	None.
Type	byte	None.
Group	integer	None.
Module	integer	None.
PartGroup	string	None.
Rules	string	None.
RuleQuery	string	None.
ResolveCondition	string	None.
ResolveConditionState	integer	None.
ResolveConditionQuery	string	None.
TriggerType	byte	None.
TimeFrame	integer	None.
Aggregation	byte	None.
FixCount	byte	None.
EventCount	integer	None.
ResolveTime	integer	None.
NotifyMode	byte	None.
StateChange	byte	None.
StateColumn	string	None.
NotificationDelivery	byte	None.
SeverityState	byte	None.
Reminder	integer	None.
Source	byte	None.
Affects	byte	None.
AppliesTo	byte	None.
Urgency	byte	None.
RuleState	byte	None.
Knowledgebase	integer	None.
Template	integer	None.
CustomString	string	None.
CustomCategory	string	None.
CustomSubcategory	string	None.
Scheduler	boolean	None.
ActiveHours	string	None.
HasPriority	boolean	None.
Mode	integer	None.
RefID	integer	None.
UserID	integer	None.
Interval	integer	None.
ParentGroup	integer	None.
RecordStatus	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "LanguageKey": "sample string 3",
  "Ack": true,
  "Severity": 64,
  "Type": 64,
  "Group": 7,
  "Module": 8,
  "PartGroup": "sample string 9",
  "Rules": "sample string 10",
  "RuleQuery": "sample string 11",
  "ResolveCondition": "sample string 12",
  "ResolveConditionState": 13,
  "ResolveConditionQuery": "sample string 14",
  "TriggerType": 64,
  "TimeFrame": 16,
  "Aggregation": 64,
  "FixCount": 64,
  "EventCount": 19,
  "ResolveTime": 20,
  "NotifyMode": 64,
  "StateChange": 64,
  "StateColumn": "sample string 23",
  "NotificationDelivery": 64,
  "SeverityState": 64,
  "Reminder": 26,
  "Source": 64,
  "Affects": 64,
  "AppliesTo": 64,
  "Urgency": 64,
  "RuleState": 64,
  "Knowledgebase": 32,
  "Template": 33,
  "CustomString": "sample string 34",
  "CustomCategory": "sample string 35",
  "CustomSubcategory": "sample string 36",
  "Scheduler": true,
  "ActiveHours": "sample string 38",
  "HasPriority": true,
  "Mode": 40,
  "RefID": 41,
  "UserID": 42,
  "Interval": 43,
  "ParentGroup": 44,
  "RecordStatus": 45
}

Response Information

Resource Description

NotificationRule

Name	Type	Additional information
ID	integer	None.
Name	string	None.
LanguageKey	string	None.
Ack	boolean	None.
Severity	byte	None.
Type	byte	None.
Group	integer	None.
Module	integer	None.
PartGroup	string	None.
Rules	string	None.
RuleQuery	string	None.
ResolveCondition	string	None.
ResolveConditionState	integer	None.
ResolveConditionQuery	string	None.
TriggerType	byte	None.
TimeFrame	integer	None.
Aggregation	byte	None.
FixCount	byte	None.
EventCount	integer	None.
ResolveTime	integer	None.
NotifyMode	byte	None.
StateChange	byte	None.
StateColumn	string	None.
NotificationDelivery	byte	None.
SeverityState	byte	None.
Reminder	integer	None.
Source	byte	None.
Affects	byte	None.
AppliesTo	byte	None.
Urgency	byte	None.
RuleState	byte	None.
Knowledgebase	integer	None.
Template	integer	None.
CustomString	string	None.
CustomCategory	string	None.
CustomSubcategory	string	None.
Scheduler	boolean	None.
ActiveHours	string	None.
HasPriority	boolean	None.
Mode	integer	None.
RefID	integer	None.
UserID	integer	None.
Interval	integer	None.
ParentGroup	integer	None.
RecordStatus	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Name": "sample string 2",
  "LanguageKey": "sample string 3",
  "Ack": true,
  "Severity": 64,
  "Type": 64,
  "Group": 7,
  "Module": 8,
  "PartGroup": "sample string 9",
  "Rules": "sample string 10",
  "RuleQuery": "sample string 11",
  "ResolveCondition": "sample string 12",
  "ResolveConditionState": 13,
  "ResolveConditionQuery": "sample string 14",
  "TriggerType": 64,
  "TimeFrame": 16,
  "Aggregation": 64,
  "FixCount": 64,
  "EventCount": 19,
  "ResolveTime": 20,
  "NotifyMode": 64,
  "StateChange": 64,
  "StateColumn": "sample string 23",
  "NotificationDelivery": 64,
  "SeverityState": 64,
  "Reminder": 26,
  "Source": 64,
  "Affects": 64,
  "AppliesTo": 64,
  "Urgency": 64,
  "RuleState": 64,
  "Knowledgebase": 32,
  "Template": 33,
  "CustomString": "sample string 34",
  "CustomCategory": "sample string 35",
  "CustomSubcategory": "sample string 36",
  "Scheduler": true,
  "ActiveHours": "sample string 38",
  "HasPriority": true,
  "Mode": 40,
  "RefID": 41,
  "UserID": 42,
  "Interval": 43,
  "ParentGroup": 44,
  "RecordStatus": 45
}