ユニット一覧取得

ユニットの一覧を取得するためのAPIです。Manager画面で［ユニット］を選択したときの操作に相当します。

= 備考 =

ユニット一覧取得APIのcontent階層下のレスポンスパラメータは、ユニット詳細取得APIのレスポンスパラメータと同じです。
書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/units?クエリ形式のリクエスト'
リクエストパラメータ（クエリ形式）
項目名 リクエストパラメータ 型 値 省略値
ユニットID unitId 文字列 部分一致  
ユニット名 unitName 文字列

1文字以上、64文字以下

部分一致

  
集信ホスト名 shushinHostName 文字列

1文字以上、68文字以下のASCII文字（NULLを除く）

部分一致

  
集信ポート番号 shushinPort 数値

1～65535

完全一致

  
ソート順 sort 文字列

"+パラメータ名"　|　"-パラメータ名"

•　+：昇順

•　-：降順

複数のパラメータを指定する場合は「,」で区切ります。

 +unitName
ページ数 page 数値

0始まりで指定します。

ページ数が1の場合、0を指定します。

 0
1ページ当たりの項目数 size 数値   10
ソート順に指定できるパラメータ
項目名 パラメータ名
集信ホスト名 shushinHostName
集信ポート番号 shushinPort
ユニットID unitId
ユニット名 unitName
ユニットバージョン unitVersion
レスポンス 
{
   "content": [
   　　　{
      　　　"shushinHostName": "string",
      　　　"shushinPort": 0,
      　　　"unitId": "string",
   　　　   "unitName": "string",
      　　　"unitVersion": 0
   　　　}
   ],
   "first": true,
   "last": true,
   "number": 0,
   "numberOfElements": 0,
   "size": 0,
   "sort": [],
   "totalElements": 0,
   "totalPages": 0
}
レスポンスパラメータ

content階層下のパラメータについては、「ユニット詳細取得」の「レスポンスパラメータ」を参照してください。

また、ページ設定のパラメータ（first, last, number, numberOfElements, size, sort, totalElements, totalPages）については、「ページ設定に関するレスポンスパラメータ」を参照してください。