Acquire a list of managed units

This is an API function to acquire a list of units by specifying the ID of the user who manages the units. This API function corresponds to the operation on the screen that is displayed by clicking the [User] tab after selecting the [Security] on the operation screen of Manager.

Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/user/userId/unit?REQUESTINQUERYFORMAT'
= Remarks =

The response parameters of the following API functions are the same.

  • Acquire a list of managed Units
  • Attach Unit to be managed
Request parameter (Path format)
Item name Request parameter Type Value Default value
User ID userId String   Impossible to omit
Request parameter (Query format)
Item name Request parameter Type Value Default value
Unit ID unitId String Exact match  
Unit Name unitName String Exact match  
Host Name of Receiver shushinHostName String Exact match  
Port Number on Receiver shushinPort Integer    
Sort Order sort String

"+parameter-name" | "-paramater-name"

•　+: Ascending order

•　-: Descending order

If you specify multiple parameters, divide values by a comma (,).

 +unit.unitName
Number of pages page Integer

Specify a number from zero.

If the number of pages is 1, specify 0.

 0
Number of items per page size Integer   10
Parameters that can be set to Sort Order
Item name Parameter name
Host Name of Receiver unit.shushinHostName
Port Number on Receiver unit.shushinPort
Unit ID unit.unitId
Unit Name unit.unitName
Unit Version unit.unitVersion
Response
{
  "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
}
Response parameter
Item name Response parameter Type Value
Host Name of Receiver content unit shushinHostName String  
Port Number on Receiver shushinPort Integer  
Unit ID unitId String  
Unit Name unitName String  
Unit Version unitVersion Integer  

For details about the parameters for page settings (first, last, number, numberOfElements, size, sort, totalElements, totalPages), see Response parameters for page settings.