収集データの要求

この例では、「GET /dataエンドポイントを使用してコレクション・データを要求する方法と、応答を解釈する方法を示す。

データの要求

GET /dataエンドポイントを使用してコレクションデータを要求する場合、使用可能なクエリパラメータを使用して応答をフィルタリングできます。

パラメータ「application、「table、「cols」は各リクエストで必須であり、「nodesまたは「groups」も指定しなければならない。

さらに、時間値パラメータ 'timeFromと 'timeTill を指定することもできる。これらの時間値パラメーターの指定は、リクエストがリアルタイムデータではなく、履歴データであることを示している。時間値パラメーターの使い方の詳細は、リクエストに時間値を使うを参照のこと。

以下の例には、使用可能なクエリーパラメーターの一部が含まれています。

注：例では、見やすくするために各パラメーターを改行しています。

https://host:port/api/v1/data
?application=application
&table=table
&cols=column_1,column_2,column_n
&nodes=nodes
&timeFrom=YYYMMDDHHMMSS
&timeTill=YYYMMDDHHMMSS

ヒストリカルデータをリクエストするには、次の例に示すように、リクエストに「timeFrom」と「timeTillパラメータを含める：

https://host:port/api/v1/data
?application=KM5
&table=ASCPUUTIL
&cols=JOBNAME,JESJOBID,CPUPCT
&nodes=RSPLEXL4:RSD3:MVSSYS
&timeFrom=1230615073300000
&timeTill=1230615073540000

リアルタイムデータを要求するには、以下の例に示すように、時間値パラメーターを含めない：

https://host:port/api/v1/data
?application=KM5
&table=ASCPUUTIL
&cols=JOBNAME,JESJOBID,CPUPCT
&nodes=RSPLEXL4:RSD3:MVSSYS

ヒント：'colsパラメータにアスタリスク（*）を使用すると、すべての列を選択することができます。

回答の解釈

GET /dataリクエストに対するレスポンスは、以下の例に示すように、返されたレコードを表すオブジェクトの配列を含むJSONドキュメントである：

[
  {
    "JOBNAME": "CXPLEXL4",
    "JESJOBID": "STC05528",
    "CPUPCT": 70
  },
  {
    "JOBNAME": "RMFGAT",
    "JESJOBID": "STC06480",
    "CPUPCT": 9
  }
]

この例では、レスポンスは各レコードの要求されたカラムを返す： 'JOBNAME 、 'JESJOBID 、 'CPUPCT 。

カラムによっては、返される値の意味が直感的でないものもある。この例では、カラム「CPUPCT値である。値を解釈するには、'GET /system/tablesエンドポイントを使ってカラムの説明を調べることができる。この例では、以下のリクエストを入力する：

https://host:port/api/v1/system/tables?name=ASCPUUTIL

レスポンスにはテーブルのすべての列が含まれる。この例では、レスポンスはテーブル「ASCPUUTIL」のすべてのカラムのプロパティを返し、その中には「CPUPCTカラムも含まれる：

  {
    "NAME": "CPUPCT",
    "ATTRNAME": "CPU_Percent",
    "ATOMIZE": false,
    "VERSION": 1,
    "TYPE": "integer"
    "SCALE": 1
    "PRECISION": 4
  },

整数として定義されるカラムには、値を記述するための以下のプロパティが含まれます：

SCALEは数値の小数点以下の桁数
PRECISIONは番号の最大桁数

これらのプロパティを適用することで、返された値を意味のあるフォーマットされたデータに変換することができます。

例えば、（列「CPUPCT」のプロパティで定義されているように）スケール1と精度4を適用すると、生の値は以下のような意味のあるデータに変換される：

```
"CPUPCT": 70
```
は'7.0、つまりCPU使用率の7％を表している
```
"CPUPCT": 9
```
は'.9、つまりCPU使用率の0.9%を表す