ユニット情報更新

ユニットの情報を更新するためのAPIです。Manager画面で[ユニット]を選択した後、ユニットを選択したときに表示される画面での操作に相当します。

= 備考 =

次のAPIのJSON形式のリクエストパラメータは同じです。

  • ユニット作成API
  • ユニット情報更新API

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

  • ユニット作成API
  • ユニット情報更新API
  • ユニット詳細取得API
書式

curl -X PUT --header 'Content-Type: application/json'

--header 'Accept: application/json'

--header 'X-API-KEY:APIキー'

-d 'JSON形式のリクエストボディ'

'http://ホスト名:ポート番号/api/v1/units/unitId'

リクエストボディ(JSON形式)

{

"shushinHostName": "string",

"shushinPort": 0,

"unitName": "string"

}

リクエストパラメータ(JSON形式)
項目名 リクエストパラメータ 省略値
集信ホスト名 shushinHostName 文字列 1文字以上、68文字以下のASCII文字(NULLを除く)  
集信ポート番号 shushinPort 数値 1~65535  
ユニット名 unitName 文字列 1文字以上、64文字以下  
リクエストパラメータ(パス形式)
項目名 リクエストパラメータ 省略値
ユニットID unitId 文字列   省略不可
レスポンス

{

   "shushinHostName": "string",

   "shushinPort": 0,

   "unitId": "string",

   "unitName": "string",

   "unitVersion": 0

}

レスポンスパラメータ

レスポンスパラメータについては、「ユニット詳細取得」「レスポンスパラメータ」を参照してください。