triggerprototype.update
Description
object triggerprototype.update(object/array triggerPrototypes)
Cette méthode permet de mettre à jour des prototypes de déclencheur existants.
Cette méthode est disponible uniquement pour les types d’utilisateurs Admin et Super admin. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir User roles pour plus d’informations.
Paramètres
(object/array) Propriétés des prototypes de déclencheur à mettre à jour.
La propriété triggerid doit être définie pour chaque prototype de déclencheur, toutes les
autres propriétés sont facultatives. Seules les propriétés transmises seront
mises à jour, toutes les autres resteront inchangées.
En plus des propriétés standard des prototypes de déclencheur, la méthode accepte les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| dependencies | array | Déclencheurs et prototypes de déclencheur dont dépend le prototype de déclencheur. Pour les déclencheurs, seule la propriété triggerid doit être définie. |
| tags | array | Balises de prototype de déclencheur. |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des prototypes de déclencheur mis à jour sous la propriété triggerids.
Exemples
Activation d’un prototype de déclencheur
Activez un prototype de déclencheur, c’est-à-dire définissez son statut sur « 0 ».
{
"jsonrpc": "2.0",
"method": "triggerprototype.update",
"params": {
"triggerid": "13938",
"status": 0
},
"id": 1
}
Réponse :
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"13938"
]
},
"id": 1
}
Remplacement des tags de prototype de déclencheur
Remplace les tags d’un prototype de déclencheur.
{
"jsonrpc": "2.0",
"method": "triggerprototype.update",
"params": {
"triggerid": "17373",
"tags": [
{
"tag": "volume",
"value": "{#FSNAME}"
},
{
"tag": "type",
"value": "{#FSTYPE}"
}
]
},
"id": 1
}
Réponse :
{
"jsonrpc": "2.0",
"result": {
"triggerids": [
"17373"
]
},
"id": 1
}
Source
CTriggerPrototype::update() dans ui/include/classes/api/services/CTriggerPrototype.php.