manual:api:reference:trigger:create

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

manual:api:reference:trigger:create [2015/11/19 14:52]
sasha [Source] fixed path
manual:api:reference:trigger:create [2020/08/25 12:53]
Line 1: Line 1:
-===== trigger.create ===== 
  
-==== Description ==== 
- 
-''​object trigger.create(object/​array **triggers**)''​ 
- 
-This method allows to create new triggers. 
- 
-==== Parameters ==== 
- 
-''​(object/​array)''​ Triggers to create. 
- 
-Additionally to the [[object#​trigger|standard trigger properties]] the method accepts the following parameters. 
- 
-^ Parameter ^ Type ^ Description ^ 
-| dependencies | array | Triggers that the trigger is dependent on. \\ \\ The triggers must have the ''​triggerid''​ property defined. | 
- 
-<note important>​The trigger expression has to be given in its expanded form.</​note>​ 
-==== Return values ==== 
- 
-''​(object)''​ Returns an object containing the IDs of the created triggers under the ''​triggerids''​ property. The order of the returned IDs matches the order of the passed triggers. 
- 
-==== Examples ==== 
- 
-=== Creating a trigger === 
- 
-Create a trigger with a single trigger dependency. 
- 
-Request: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​method":​ "​trigger.create",​ 
-    "​params":​ { 
-        "​description":​ "​Processor load is too high on {HOST.NAME}",​ 
-        "​expression":​ "​{Linux server:​system.cpu.load[percpu,​avg1].last()}>​5",​ 
-        "​dependencies":​ [ 
-            { 
-                "​triggerid":​ "​14062"​ 
-            } 
-        ] 
-    }, 
-    "​auth":​ "​038e1d7b1735c6a5436ee9eae095879e",​ 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-Response: 
-<code js> 
-{ 
-    "​jsonrpc":​ "​2.0",​ 
-    "​result":​ { 
-        "​triggerids":​ [ 
-            "​14102"​ 
-        ] 
-    }, 
-    "​id":​ 1 
-} 
-</​code>​ 
- 
-==== Source ==== 
- 
-CTrigger::​create() in //​frontends/​php/​include/​classes/​api/​services/​CTrigger.php//​.