triggerprototype.update

Beschrijving

object triggerprototype.update(object/array triggerPrototypes)

Deze methode maakt het mogelijk om bestaande triggervoorbeelden bij te werken.

Deze methode is alleen beschikbaar voor gebruikers met het type Admin en Super admin. Rechten om deze methode aan te roepen kunnen worden ingetrokken in gebruikersrolinstellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object/array) Eigenschappen van triggervoorbeelden die bijgewerkt moeten worden.

De eigenschap triggerid moet gedefinieerd zijn voor elk triggervoorbeeld, alle andere eigenschappen zijn optioneel. Alleen de opgegeven eigenschappen worden bijgewerkt, alle andere blijven ongewijzigd.

Naast de standaard triggervoorbeeld eigenschappen accepteert de methode de volgende parameters.

Parameter Type Omschrijving
dependencies array Triggers en triggervoorbeelden waar het triggervoorbeeld van afhankelijk is.

De triggers moeten de eigenschap triggerid gedefinieerd hebben.
tags array Tags van het triggervoorbeeld.

De triggeruitdrukking moet in uitgebreide vorm worden opgegeven en moet ten minste één itemvoorbeeld bevatten.

Retourwaarden

(object) Retourneert een object dat de ID's van de bijgewerkte trigger bevat prototypes onder de eigenschap triggerids.

Voorbeelden

Inschakelen van een triggervoorbeeld

Schakel een triggervoorbeeld in, dat wil zeggen, zet de status op "0".

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.update",
           "params": {
               "triggerid": "13938",
               "status": 0
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "triggerids": [
                   "13938"
               ]
           },
           "id": 1
       }

Vervangen van triggervoorbeeld tags

Vervang tags voor één triggervoorbeeld.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "triggerprototype.update",
           "params": {
               "triggerid": "17373",
               "tags": [
                   {
                       "tag": "volume",
                       "value": "{#FSNAME}"
                   },
                   {
                       "tag": "type",
                       "value": "{#FSTYPE}"
                   }
               ]
           },
           "id": 1
       }

Reactie:

{
           "jsonrpc": "2.0",
           "result": {
               "triggerids": [
                   "17373"
               ]
           },
           "id": 1
       }

Bron

CTriggerPrototype::update() in ui/include/classes/api/services/CTriggerPrototype.php.