templategroup.get

説明

integer/array templategroup.get(object parameters)

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

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

パラメータ

(object) 目的の出力を定義するパラメータ。

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

Parameter Type Description
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 これらのパラメータは reference commentary で説明されています。
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.