templategroup.update

説明

object templategroup.update(object/array templateGroups)

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

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

パラメータ

更新する (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.