Modify unit details

This is an API function to modify details of a 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 =

The request parameters in JSON format of the following API functions are the same.

  • Create unit
  • Modify unit details

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

  • Create unit
  • Modify unit details
  • Acquire unit details
Format
curl -X PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/units/unitId'
Request body (JSON format)
{
   "shushinHostName": "string",
   "shushinPort": 0,
   "unitName": "string"
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
Host Name of Receiver shushinHostName String Maximum 68 ASCII characters (without NULL)  
Port Number on Receiver shushinPort Integer 1 to 65535  
Unit Name unitName String Maximum 64 characters  
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

For details of the response parameters, see Response parameter described in Acquire unit details.