Attach unit to be managed

This is an API function to attach unit to a user by specifying the user ID. 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.

= Remarks =

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

  • Acquire a list of managed units
  • Attach unit to be managed
Format

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

--header 'Accept: application/json'

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

-d '["unitIds","unitIds","unitIds",...]'

'http://HOSTNAME:PORTNUMBER/api/v1/user/userId/unit'

Request parameter (Path format)
Item name Request parameter Type Value Default value
User ID userId String   Impossible to omit
Request parameter (Array format)
Item name Request parameter Type Value Default value

Unit ID

unitIds

String  (Array)

• If you attach a user one Unit:

  ["Unit ID1"]

• If you attach a user more than one Unit (divide them with a comma):

  ["Unit ID1","Unit ID2"]

Impossible to omit
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

For details of the parameters under the content layer, see Response parameter described in Acquire a list of managed units.

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