Finesse MaintenanceMode API Parameters
Parameter |
Type |
Description |
Possible Values |
Notes |
---|---|---|---|---|
status |
String |
The state of the Finesse maintenance mode request. |
IN_PROGRESS: Maintenance request is received and accepted by the Cisco Finesse server. Cisco Finesse is waiting for all the agents to be connected to the alternate node. COMPLETED: All the agents have successfully logged in to the alternate node. Cisco Finesse has shut down the services. FAILED: The agent login to the alternate node is not completed or the maintenance mode is not completed within the configured time. |
— |
usersLoggedIn |
— |
The information about the users logged in at the time when the maintenance mode started. |
— |
— |
-->desktop |
Integer |
The total number of Finesse desktop users logged in. |
— |
— |
-->fippa |
Integer |
The total number of Finesse IP Phone Agent (IPPA) application users logged in. |
— |
— |
-->thirdpartyclients |
Integer |
The total number of users logged in from a third-party client. |
— |
— |
pendingUserDisconnections |
Integer |
The number of agents that are connected to the server in maintenance mode and scheduled to move to the alternate node. |
— |
— |
estimatedCompletionTime |
Integer |
The estimated time (in seconds) required to complete the maintenance operation. |
— |
— |