template.massremove

説明

object template.massremove(object parameters)

このメソッドは、複数のテンプレートから関連オブジェクトを削除することができます。

このメソッドは 管理者 および スーパ管理者 ユーザータイプでのみ利用可能です。メソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object) 更新するテンプレートのIDと削除するオブジェクトを含むパラメータ。

パラメータ タイプ 説明
templateids ID/array 更新するテンプレートのID。

パラメータの動作:
- 必須
groupids ID/array 指定したテンプレートを削除するテンプレートグループのID。
macros string/array 指定したテンプレートから削除するユーザーマクロのID。
templateids_clear ID/array 指定したテンプレートからリンク解除およびクリアするテンプレートのID（上流）。
templateids_link ID/array 指定したテンプレートからリンク解除するテンプレートのID（上流）。

戻り値

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

例

テンプレートをグループから削除する

2つのテンプレートをグループ"2"から削除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "template.massremove",
    "params": {
        "templateids": [
            "10085",
            "10086"
        ],
        "groupids": "2"
    },
    "id": 1
}

レスポンス:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10085",
            "10086"
        ]
    },
    "id": 1
}

ホストからテンプレートのリンクを解除

テンプレート"10085"からテンプレート"10106"と"10104"のリンクを解除します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "template.massremove",
    "params": {
        "templateids": "10085",
        "templateids_link": [
            "10106",
            "10104"
        ]
    },
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": {
        "templateids": [
            "10085"
        ]
    },
    "id": 1
}

参照

ソース

CTemplate::massRemove() in ui/include/classes/api/services/CTemplate.php.