管理対象ユニット一覧取得

ユーザーIDを指定して、当該ユーザーの管理対象となっているユニットの一覧を取得するためのAPIです。Manager画面で［セキュリティ］を選択した後、［ユーザー］タブを選択したときに表示される画面での操作に相当します。

書式
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIキー'
            'http://ホスト名:ポート番号/api/v1/user/userId/unit?クエリ形式のリクエスト'
= 備考 =

次のAPIのレスポンスパラメータは同じです。

  • 管理対象ユニット一覧取得API
  • 管理対象ユニットアタッチAPI
リクエストパラメータ（パス形式）
項目名 リクエストパラメータ 型 値 省略値
ユーザーID userId 文字列   省略不可
リクエストパラメータ（クエリ形式）
項目名 リクエストパラメータ 型 値 省略値
ユニットID unitId 文字列 完全一致  
ユニット名 unitName 文字列 完全一致  
集信ホスト名 shushinHostName 文字列 完全一致  
集信ポート番号 shushinPort 数値    
ソート順 sort 文字列

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

•　+：昇順

•　-：降順

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

 +unit.unitName
ページ数 page 数値

0始まりで指定します。

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

 0
1ページ当たりの項目数 size 数値   10
ソート順に指定できるパラメータ
項目名 パラメータ名
集信ホスト名 unit.shushinHostName
集信ポート番号 unit.shushinPort
ユニットID unit.unitId
ユニット名 unit.unitName
ユニットバージョン unit.unitVersion
レスポンス
{
  "content": [
     {
        "unit": {
           "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 unit shushinHostName 文字列  
集信ポート番号 shushinPort 数値  
ユニットID unitId 文字列  
ユニット名 unitName 文字列  
ユニットバージョン unitVersion 数値  

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