Creates a job to set maintenance mode for unified access points. For other device types should use PUT Schedule Maintenance Mode. Maintenance mode status for a unified AP can be retrieved with the response parameter "unifiedApInfo.maintenanceMode" from the API GET Wireless Access Point Details.
Since Product Version: 3.4
Resource Information
Rate Limiting? |
No |
Sorting? |
No |
Paging? |
No |
Filtering? |
No |
Group Filtering? |
No |
Aggregation? |
No |
Response Formats |
xml json |
User Group |
NBI Write |
HTTP Methods |
PUT |
Resource URL
/webacs/api/v4/op/configure/ap/scheduleMaintenanceModeRequest Parameters
Attribute | Source | Description |
---|---|---|
scheduledTime Date |
query |
Optional The time when the job will be launched. If the time is not specified the job will be started immediately. |
Request Payload Parameters
Attribute | Description |
---|---|
apIds Long[] |
Required List of unified AP IDs. |
maintenanceMode Boolean |
If true the maintenance mode will be on, if false the maintenance mode will be off. If the parameter is not specified it will be false. |
Response Parameters
Attribute | Description |
---|---|
errorMessage String |
Message returned if any exception comes |
jobName String |
Job name which is created by the system |
status ConfigureServiceJobStatus |
Job status
|
Sample Payloads
Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.
Sample XML Request Payload
https://172.20.127.108/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z
<?xml version="1.0" ?>
<apMaintenanceModeConfigDTO>
<apIds>
<apId>15</apId>
<apId>25</apId>
</apIds>
<maintenanceMode>true</maintenanceMode>
</apMaintenanceModeConfigDTO>
Sample JSON Request Payload
https://172.20.127.108/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode.json?scheduledTime=2038-01-19T03:14:17Z
{
"apMaintenanceModeConfigDTO" : {
"apIds" : {
"apId" : [ 15, 25 ]
},
"maintenanceMode" : true
}
}
Sample XML Response Payload
https://172.20.127.108/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z
<?xml version="1.0" ?>
<mgmtResponse responseType="operation" requestUrl="https://172.20.127.108/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z" rootUrl="https://172.20.127.108/webacs/api/v4/op">
<configureJobResultDTO>
<errorMessage>String value</errorMessage>
<jobName>String value</jobName>
<status>SUCCESS</status>
</configureJobResultDTO>
</mgmtResponse>
Sample JSON Response Payload
https://172.20.127.108/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode.json?scheduledTime=2038-01-19T03:14:17Z
{
"mgmtResponse" : {
"@requestUrl" : "https://172.20.127.108/webacs/api/v4/op/configure/ap/scheduleMaintenanceMode?scheduledTime=2038-01-19T03:14:17Z",
"@responseType" : "operation",
"@rootUrl" : "https://172.20.127.108/webacs/api/v4/op",
"configureJobResultDTO" : [ {
"errorMessage" : "String value",
"jobName" : "String value",
"status" : "SUCCESS"
} ]
}
}