Acquire unit details

This is an API function to acquire details of a specified unit. This API function corresponds to the operation on the screen that is displayed by selecting a unit after selecting the [Unit] on the operation screen of Manager.

= Remarks =

It is the difference between the acquire a list of unit API function and this API function that the following parameters are not included in the response of this API function.

  • content layer (Parameters under the content layer of the acquire a list API function are the same as the parameters of the acquire details API function.)
  • first

  • last

  • number

  • numberOfElements

  • size

  • sort

  • totalElements

  • totalPages

Format

curl -X GET --header 'Accept: application/json'

--header 'X-API-KEY:APIKEY'

'http://HOSTNAME:PORTNUMBER/api/v1/units/unitId'

Request parameter (Path format)
Item name Request parameter Type Value Default value
Unit ID unitId String   Impossible to omit
Response

{

   "shushinHostName": "string",

   "shushinPort": 0,

   "unitId": "string",

   "unitName": "string",

   "unitVersion": 0

}

Response parameter
Item name Response parameter Type Value
Host Name of Receiver shushinHostName String  
Port Number on Receiver shushinPort Integer  
Unit ID unitId String  
Unit Name unitName String  
Unit Version unitVersion Integer