Acquire a list of units

This is an API function to acquire a list of units. This API function corresponds to the operation on the screen that is displayed by selecting the [Unit] on the operation screen of Manager.

= Remarks =

The response parameters under the content layer of this API function are the same as the response parameters of the acquire unit details API function.
Format
curl -X GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/units?REQUESTINQUERYFORMAT'
Request parameter (Query format)
Item name Request parameter Type Value Default value
Unit ID unitId String Partial match  
Unit Name unitName String

Maximum 64 characters

Partial match

  
Host Name of Receiver shushinHostName String

Maximum 68 ASCII characters (without NULL)

Partial match

  
Port Number on Receiver shushinPort Integer

1 to 65535

Exact match

  
Sort Order sort String

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

•　+: Ascending order

•　-: Descending order

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

 +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 shushinHostName
Port Number on Receiver shushinPort
Unit ID unitId
Unit Name unitName
Unit Version unitVersion
Response
{
   "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
}
Response parameter

For details of the parameters under the content layer, see Response parameter described in Acquire unit details.

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