trend.get
説明
integer/array trend.get(object parameters)
このメソッドは、指定されたパラメータに従ってトレンドデータを取得することができます。
このメソッドは、すべてのタイプのユーザーが利用できます。
このメソッドを呼び出す権限は、ユーザーロールの設定で取り消すことができます。
詳細はユーザーロールを参照してください。
パラメーター
(object) 取得したい出力を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | タイプ | 説明 |
|---|---|---|
| itemids | ID/array | 指定したアイテムIDのトレンドのみを返します。 |
| time_from | timestamp | 指定した時刻以降に収集された値のみを返します。 |
| time_till | timestamp | 指定した時刻以前に収集された値のみを返します。 |
| countOutput | boolean | 取得したオブジェクトの数をカウントします。 |
| limit | integer | 取得するオブジェクトの数を制限します。 |
| output | query | 返すTrendオブジェクトのプロパティを設定します。 |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
アイテムのトレンドデータの取得
{
"jsonrpc": "2.0",
"method": "trend.get",
"params": {
"output": [
"itemid",
"clock",
"num",
"value_min",
"value_avg",
"value_max"
],
"itemids": [
"23715"
],
"limit": "1"
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "23715",
"clock": "1446199200",
"num": "60",
"value_min": "0.165",
"value_avg": "0.2168",
"value_max": "0.35"
}
],
"id": 1
}ソース
CTrend::get() in ui/include/classes/api/services/CTrend.php.