[comment]: # translation:outdated

[comment]: # ({6a93039d-6a93039d})
# graphprototype.get

[comment]: # ({/6a93039d-6a93039d})

[comment]: # ({27b69e53-27b69e53})
### 説明

`integer/array graphprototype.get(object parameters)`

このメソッドは、与えられたパラメータに従って、グラフの graph prototypes を取得することができます

::: noteclassic
このメソッドは、どのタイプのユーザーでも利用可能です。このメソッドを呼び出す許可は、ユーザーロール設定で取り消すことができます。<br>
詳しくは、[User roles](/manual/web_interface/frontend_sections/administration/user_roles)を参照してください。
:::

[comment]: # ({/27b69e53-27b69e53})

[comment]: # ({d66478b6-de0f74af})
### パラメータ

`(object)` 希望する出力を定義するパラメータ。

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

|パラメータ|[Type](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|discoveryids|string/array|Return only graph prototypes that belong to the given discovery rules.|
|graphids|string/array|Return only graph prototypes with the given IDs.|
|groupids|string/array|Return only graph prototypes that belong to hosts in the given host groups.|
|hostids|string/array|Return only graph prototypes that belong to the given hosts.|
|inherited|boolean|If set to `true` return only graph prototypes inherited from a template.|
|itemids|string/array|Return only graph prototypes that contain the given item prototypes.|
|templated|boolean|If set to `true` return only graph prototypes that belong to templates.|
|templateids|string/array|Return only graph prototypes that belong to the given templates.|
|selectDiscoveryRule|query|Return a [discoveryRule](/manual/api/reference/discoveryrule/object#lld_rule) property with the LLD rule that the graph prototype belongs to.|
|selectGraphItems|query|Return a [gitems](/manual/api/reference/graphitem/object) property with the graph items used in the graph prototype.|
|selectGroups|query|Return a [groups](/manual/api/reference/hostgroup/object) property with the host groups that the graph prototype belongs to.|
|selectHosts|query|Return a [hosts](/manual/api/reference/host/object) property with the hosts that the graph prototype belongs to.|
|selectItems|query|Return an `items` property with the [items](/manual/api/reference/item/object) and [item prototypes](/manual/api/reference/itemprototype/object) used in the graph prototype.|
|selectTemplates|query|Return a [templates](/manual/api/reference/template/object) property with the templates that the graph prototype belongs to.|
|filter|object|Return only those results that exactly match the given filter.<br><br>Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against.<br><br>Supports additional filters:<br>`host` - technical name of the host that the graph prototype belongs to;<br>`hostid` - ID of the host that the graph prototype belongs to.|
|sortfield|string/array|Sort the result by the given properties.<br><br>Possible values are: `graphid`, `name` and `graphtype`.|
|countOutput|boolean|These parameters being common for all `get` methods are described in detail in the [reference commentary](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/d66478b6-de0f74af})

[comment]: # ({7223bab1-7223bab1})
### 戻り値

`(integer/array)` 次のいずれかを返します:

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

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
#### LLD ルールから graph prototypes を取得する

LLD ルールからすべての graph prototypes を取得します。

Request:

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "graphprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "parent_itemid": "27426",
            "name": "Disk space usage {#FSNAME}",
            "width": "600",
            "height": "340",
            "yaxismin": "0.0000",
            "yaxismax": "0.0000",
            "templateid": "442",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "discover": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({62edff03-62edff03})
#### LLD ルールから graph prototypes を取得する

LLD ルールからすべての graph prototypes を取得します。

Request:

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "graphprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [
        {
            "graphid": "1017",
            "parent_itemid": "27426",
            "name": "Disk space usage {#FSNAME}",
            "width": "600",
            "height": "340",
            "yaxismin": "0.0000",
            "yaxismax": "0.0000",
            "templateid": "442",
            "show_work_period": "0",
            "show_triggers": "0",
            "graphtype": "2",
            "show_legend": "1",
            "show_3d": "1",
            "percent_left": "0.0000",
            "percent_right": "0.0000",
            "ymin_type": "0",
            "ymax_type": "0",
            "ymin_itemid": "0",
            "ymax_itemid": "0",
            "discover": "0"
        }
    ],
    "id": 1
}
```

[comment]: # ({/62edff03-62edff03})

[comment]: # ({e4f96e80-e4f96e80})
### 参照

-   [Discovery rule](/manual/api/reference/discoveryrule/object#discovery_rule)
-   [Graph item](/manual/api/reference/graphitem/object#graph_item)
-   [Item](/manual/api/reference/item/object#item)
-   [Host](/manual/api/reference/host/object#host)
-   [Host group](/manual/api/reference/hostgroup/object#host_group)
-   [Template](/manual/api/reference/template/object#template)

[comment]: # ({/e4f96e80-e4f96e80})

[comment]: # ({fc80fda8-fc80fda8})
### ソース

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

[comment]: # ({/fc80fda8-fc80fda8})