Documentation
Table of Contents
templategroup.get
説明
integer/array templategroup.get(object parameters)
このメソッドは、指定されたパラメーターに従ってテンプレートグループを取得できます。
このメソッドは、すべてのタイプのユーザーが利用できます。メソッドを呼び出す権限は、ユーザーの役割の設定で取り消すことができます。詳細はユーザーの役割を参照してください。
パラメータ
(object) は、必要な出力を定義するパラメータです。
このメソッドは以下のパラメータをサポートしています。
| パラメータ | 型 | 説明 |
|---|---|---|
| graphids | ID/array | 指定されたグラフを持つテンプレートを含むテンプレートグループのみを返します。 |
| groupids | ID/array | 指定されたテンプレートグループIDを持つテンプレートグループのみを返します。 |
| templateids | ID/array | 指定されたテンプレートを含むテンプレートグループのみを返します。 |
| triggerids | ID/array | 指定されたトリガーを持つテンプレートを含むテンプレートグループのみを返します。 |
| with_graphs | flag | グラフを持つテンプレートを含むテンプレートグループのみを返します。 |
| with_graph_prototypes | flag | グラフプロトタイプを持つテンプレートを含むテンプレートグループのみを返します。 |
| with_httptests | フラグ | Web チェックを含むテンプレートを含むテンプレート グループのみを返します。 |
| with_items | フラグ | アイテムを含むテンプレートを含むテンプレート グループのみを返します。with_simple_graph_items パラメータを上書きします。 |
| with_item_prototypes | フラグ | アイテム プロトタイプを含むテンプレートを含むテンプレート グループのみを返します。with_simple_graph_item_prototypes パラメータを上書きします。 |
| with_simple_graph_item_prototypes | フラグ | 作成が有効で、数値型の情報を持つアイテム プロトタイプを含むテンプレートを含むテンプレート グループのみを返します。 |
| with_simple_graph_items | フラグ | 数値アイテムを含むテンプレートを含むテンプレート グループのみを返します。 |
| with_templates | フラグ | テンプレートを含むテンプレート グループのみを返します。 |
| with_triggers | フラグ | トリガー付きのテンプレートを含むテンプレートグループのみを返します。 |
| selectTemplates | クエリ | テンプレートグループに属するテンプレートを含む templates プロパティを返します。count をサポートします。 |
| limitSelects | 整数 | サブセレクトによって返されるレコード数を制限します。 次のサブセレクトに適用されます: selectTemplates - 結果は template でソートされます。 |
| sortfield | 文字列/配列 | 指定されたプロパティで結果をソートします。 可能な値: groupid、name |
| countOutput | ブール値 | これらのパラメータについては、リファレンス解説 で説明されています。 |
| editable | ブール値 | |
| excludeSearch | ブール値 | |
| filter | オブジェクト | |
| limit | 整数 | |
| output | クエリ | |
| preservekeys | ブール値 | |
| search | オブジェクト | |
| searchByAny | ブール値 | |
| searchWildcardsEnabled | ブール値 | |
| sortorder | 文字列/配列 | |
| startSearch | ブール値 |
戻り値
(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.