triggerprototype.update

Leírás

objektum triggerprototype.update(object/array triggerPrototypes)

Ez a módszer lehetővé teszi a meglévő trigger prototípusok frissítését.

Ez a módszer csak az Admin és a Kiemelt rendszergazda számára érhető el felhasználói típusok. A metódus meghívására vonatkozó engedélyek felhasználói szerepkörben visszavonhatók beállítások. Lásd: User roles további információért.

Paraméterek

(objektum/tömb) Trigger prototípus tulajdonságok frissítendő.

A "triggerid" tulajdonságot minden trigger prototípushoz meg kell határozni a többi tulajdonság nem kötelező. Csak az átadott tulajdonságok lesznek frissítve, az összes többi változatlan marad.

A standard trigger prototípuson kívül property a metódus elfogadja a következőket paramétereket.

Paraméter Típus Leírás
dependencies array Triggerek és triggerprototípusok, amelyektől a trigger prototípus függ.

A triggereknél meg kell adni a triggerid tulajdonságot.
tags array Tigger prototípus címkék.

::: Fontos A trigger kifejezést meg kell adni benne kiterjesztett formában, és tartalmaznia kell legalább egy elem prototípusát. :::

Visszatérési értékek

(object) Egy objektumot ad vissza, amely tartalmazza a frissített trigger azonosítóit prototípusok a triggerids tulajdonság alatt.

Példák

Enabling a trigger prototype

Enable a trigger prototype, that is, set its status to 0.

Request:

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

Response:

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

Replacing trigger prototype tags

Replace tags for one trigger prototype.

Request:

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

Response:

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

Forrás

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