Access Device Management

Modify the Device Type of any Access Device

PUT /api/v1/system/access_device_type/

Modify the Device Type of any Device in hte whole System

Authorization rights: System Admin.

Example request:

PUT /api/v1/tsystem/access_device_type/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "deviceName": "APIO Test Device",
   "deviceType": "Generic SIP Phone",
   "tenantId": "foo",
   "groupId": "fooGrp"
}
Request JSON Object:
  • deviceName (string) – The name of the Device to be adapted.

  • deviceType (string) – The new Device Type.

  • tenantId (string) – (Conditional) The Tenant Id of the tenant owning the Device. Must be present in case of Tenant or Group level device, must be absent otherwise.

  • groupId (string) – (Conditional) The Group Id of the tenant owning the Device. Must be present in case of Group level device, must be absent otherwise.

Example response:

Response:

Similar to GET list method response. Should be the instance!

Status Codes:

Warning

This API has to be used very carefully because it can have various potential side effects, generated by the Application Server itself, such as the loss of Custom Tags (if the new one does not allow them), the move from a static port assignment to a dynamic port assignment, ….

This API applies the change of the type only in the Application Server itself, it does not perform any of the additional logics provided in the “Advanced Access Devices” APIs.