template.massadd

説明

object template.massadd(object parameters)

このメソッドを使用すると、指定したテンプレートに複数の関連オブジェクトを同時に追加できます。

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

パラメータ

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

このメソッドは以下のパラメータを受け付けます。

パラメータ Type 説明
templates object/array 更新するテンプレート。

テンプレートでは、templateidプロパティのみを定義する必要があります。

パラメータの動作:
- 必須
groups object/array 指定したテンプレートに追加するテンプレートグループ。

テンプレートグループでは、groupidプロパティのみを定義する必要があります。
macros object/array 指定したテンプレート用に作成するユーザーマクロ。
templates_link object/array 指定したテンプレートにリンクするテンプレート。

テンプレートでは、templateidプロパティのみを定義する必要があります。

戻り値

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

例

グループをテンプレートにリンクする

テンプレートグループ「2」を2つのテンプレートに追加します。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "template.massadd",
    "params": {
        "templates": [
            {
                "templateid": "10085"
            },
            {
                "templateid": "10086"
            }
        ],
        "groups": [
            {
                "groupid": "2"
            }
        ]
    },
    "id": 1
}

レスポンス:

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

2つのテンプレートを1つのテンプレートにリンクする

テンプレート"10106"と"10104"をテンプレート"10073"にリンクします。

リクエスト:

{
    "jsonrpc": "2.0",
    "method": "template.massadd",
    "params": {
        "templates": [
            {
                "templateid": "10073"
            }
        ],
        "templates_link": [
            {
                "templateid": "10106"
            },
            {
                "templateid": "10104"
            }
        ]
    },
    "id": 1
}

Response:

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

関連項目

ソース

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