Manage Device
Change an ADC device from an unmanaged state to managed state. The device goes through a configuration sync process before getting managed.
URL: /adc-device-manage
Type: PUT
Parameters
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id received after login | string |
| Query | Gwkey | Tenant Key. Needed only in case of multitenant installations | string |
| Query | gwsource** | Source from which the request is triggered (Eg: web, external) | String |
| Payload | deviceName** | Name of the device(s) to manage | String[] |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 202 | Accepted | State change to manage the device has been initiated |
| 403 | Forbidden | Selected device(s) are not in the unmanaged state. The operation cannot be performed |
| 400 | Bad Request | The device name is mandatory. Value cannot be null or empty |
| 404 | Not Found | Device not found |
Sample Request/Response
Use Case
Change the state of devices ADC_DEVICE_1 and ADC_DEVICE_2 from unmanaged to managed.
Request URL
http://appviewxapi.com/avxapi/adc-device-manage?gwkey=f000ca01&gwsource=external
Request Payload
{
"payload": {
"deviceName": [
"ADC_DEVICE_1",
" ADC_DEVICE_1"
]
}
Response
202 Accepted
{
"response": "State change to manage the device has been initiated.",
"message": "State change to manage the device has been initiated.",
"appStatusCode": null,
"tags": null,
"headers": null
}