templategroup.massupdate
説明
object templategroup.massupdate(object parameters)
このメソッドは、複数のテンプレートグループの指定されたテンプレートを置き換えることができます。
このメソッドは、AdminおよびSuper adminタイプのユーザーのみ利用可能です。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
更新するテンプレートグループのIDと、更新対象のオブジェクトを含む(object)パラメータ。
| パラメータ | Type | 説明 |
|---|---|---|
| groups | object/array | 更新するテンプレートグループ。 テンプレートグループでは、 groupidプロパティのみを定義する必要があります。パラメータの動作: - 必須 |
| templates | object/array | 指定したテンプレートグループ上の現在のテンプレートを置き換えるテンプレート。 記載されたものを除く他のすべてのテンプレートは、テンプレートグループから除外されます。 テンプレートでは、 templateidプロパティのみを定義する必要があります。パラメータの動作: - 必須 |
戻り値
(object) groupidsプロパティの下に更新されたテンプレートグループのIDを含むオブジェクトを返します。
例
テンプレートグループ内のテンプレートを置き換える
テンプレートグループ内のすべてのテンプレートを、指定のテンプレートに置き換えます。
リクエスト :
{
"jsonrpc": "2.0",
"method": "templategroup.massupdate",
"params": {
"groups": [
{
"groupid": "8"
}
],
"templates": [
{
"templateid": "40050"
}
]
},
"id": 1
}
レスポンス :
{
"jsonrpc": "2.0",
"result": {
"groupids": [
"8",
]
},
"id": 1
}
参照
ソース
CTemplateGroup::massUpdate() in ui/include/classes/api/services/CTemplateGroup.php.