templategroup.update

説明

object templategroup.update(object/array templates)

このメソッドは、既存のテンプレートグループを更新することができます。

このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。

パラメーター

(object/array) 更新するテンプレートグループのプロパティ。

groupidプロパティはテンプレートグループごとに定義する必要があり、その他のプロパティはオプションです。渡されたプロパティのみが更新され、他は一切変更されません。

戻り値

(object) groupidsプロパティの下に更新されたテンプレートグループのIDを含むオブジェクトを返します。

例

テンプレートグループの名前の変更

テンプレートグループの名前を"Templates/Databases"へ変更します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "templategroup.update",
    "params": {
        "groupid": "7",
        "name": "Templates/Databases"
    },
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": {
        "groupids": [
            "7"
        ]
    },
    "id": 1
}

ソース

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