templategroup.get

説明

integer/array templategroup.get(object parameters)

このメソッドは、指定されたパラメーターに従ってテンプレートグループを取得できます。

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

パラメーター

(object) 望ましい出力を定義するパラメーター。

このメソッドは以下のパラメーターをサポートします。

パラメーター タイプ 説明
graphids ID/array 指定したグラフを持つテンプレートを含むテンプレートグループのみを返します。
groupids ID/array 指定したテンプレートグループIDを持つテンプレートグループのみを返します。
templateids ID/array 指定したテンプレートを含むテンプレートグループのみを返します。
triggerids ID/array 指定したトリガーを持つテンプレートを含むテンプレートグループのみを返します。
with_graphs boolean グラフを持つテンプレートを含むテンプレートグループのみを返します。
with_graph_prototypes boolean グラフのプロトタイプを持つテンプレートを含むテンプレートグループのみを返します。
with_httptests boolean Web監視を持つテンプレートを含むテンプレートグループのみを返します。
with_items boolean アイテムを持つテンプレートを含むテンプレートグループのみを返します。

with_simple_graph_itemsパラメーターを上書きします。
with_item_prototypes boolean アイテムのプロトタイプを持つテンプレートを含むテンプレートグループのみを返します。

with_simple_graph_item_prototypesパラメーターを上書きします。
with_simple_graph_item_prototypes boolean 作成が有効で数値型の情報タイプを持つアイテムのプロトタイプを持つテンプレートを含むテンプレートグループのみを返します。
with_simple_graph_items boolean 数値アイテムを持つテンプレートを含むテンプレートグループのみを返します。
with_templates boolean テンプレートを含むテンプレートグループのみを返します。
with_triggers boolean トリガーを持つテンプレートを含むテンプレートグループのみを返します。
selectTemplates query テンプレートグループに属するテンプレートを持つtemplatesプロパティを返します。

countをサポートします。
limitSelects integer サブセレクトで返されるレコード数を制限します。

以下のサブセレクトに適用されます:
selectTemplates - 結果はtemplateでソートされます。
sortfield string/array 指定したプロパティで結果をソートします。

指定可能な値: groupid, name。
countOutput boolean これらのパラメーターはリファレンス解説で説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 以下のいずれかを返します。

  • オブジェクトの配列
  • countOutputパラメータが使用された場合は、取得したオブジェクトの数

例

名前によるデータの取得

"Templates/Databases"と"Templates/Modules"という名前の二つのテンプレートグループについて、全てのデータを取得します。

リクエスト :

{
    "jsonrpc": "2.0",
    "method": "templategroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Templates/Databases",
                "Templates/Modules"
            ]
        }
    },
    "id": 1
}

レスポンス :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "13",
            "name": "Templates/Databases",
            "uuid": "748ad4d098d447d492bb935c907f652f"
        },
        {
            "groupid": "8",
            "name": "Templates/Modules",
            "uuid": "57b7ae836ca64446ba2c296389c009b7"
        }
    ],
    "id": 1
}

参照

ソース

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