List operation

This operation enables administrators to retrieve a list of all available JMX counters in Cisco Finesse Tomcat and Cisco Finesse Notification Service. Note that the default service is Cisco Finesse Tomcat.

URI:

https://<FQDN>/finesse/api/performance

Example URI:

https://finesse1.xyz.com/finesse/api/performance

Security Constraints:

Administrators can use this API.

HTTP Method:

POST

Content Type:

Application/JSON

Input/Output Format:

JSON

HTTP Request:

List Example for Cisco Finesse Tomcat:
Code Snippet
Copy
{
   "type" : "list"
}
List Example for Cisco Finesse Notification Service:
Code Snippet
Copy{
"type" : "list",
"service": "openfire"
}

HTTP Response:

200: Success

401: Unauthorized

403: Forbidden

500: Internal Server Error

Example Response:

Code Snippet
Copy
{
  "request": {
    "type": "list"
  },
  "value": {
    "com.cisco.ccbu": {
      "category=AWSSubsystem,component0=AWS Subsystem State Counter": {
        "attr": {
          "AWS CTI Adapter State": {
            "rw": false,
            "type": "java.lang.String",
            "desc": "AWS CTI Adapter State"
          },
          "AWS System State": {
            "rw": false,
            "type": "java.lang.String",
            "desc": "AWS System State"
          },
          "AWS Core State": {
            "rw": false,
            "type": "java.lang.String",
            "desc": "AWS Core State"
          }
        },
        "class": "com.cisco.ccbu.finesse.subsystem.AWSSystemStateMBean",
        "desc": "AWS Subsystem State Counter"
      },
      "category=AWSSubsystem,component0=AWS Statistics Counter": {
        "attr": {
          "TaskEventsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Task events since start"
          },
          "MediaStateChangeTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total number of media state changes since start"
          },
          "FailedUnacceptedIndicationsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Interrupt Unaccepted Indications failed at CCE"
          },
          "FailedHeartBeatsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Failed heartbeats during the interval"
          },
          "AWSHeartbeatInterval": {
            "rw": false,
            "type": "int",
            "desc": "AWS Heartbeat Interval"
          },
          "TotalPublishedQueueEvents": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Queue events published"
          },
          "AlertingCallsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total Alerting calls since start"
          },
          "MediaStateChangeInterval": {
            "rw": false,
            "type": "long",
            "desc": "Total number of media state changes during last interval"
          },
          "AgentInterruptsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Agent Interrupts received by Finesse"
          },
          "BeginCallsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total Begin calls since start"
          },
          "NumOfActiveAgentsLoggedIn": {
            "rw": false,
            "type": "int",
            "desc": "Number of Agents Logged In with XMPP Presence as Available in the current side"
          },
          "TaskEventsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Task events during the interval"
          },
          "ActiveCallsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total Active calls since start"
          },
          "AWSHeartbeatRetryNum": {
            "rw": false,
            "type": "int",
            "desc": "AWS Heartbeat Retry Number"
          },
          "TotalCallsInSystem": {
            "rw": false,
            "type": "long",
            "desc": "Total number of calls in the system"
          },
          "FailedCallsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total Failed calls since start"
          },
          "DroppedCallsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Dropped calls during the interval"
          },
          "ServerState": {
            "rw": false,
            "type": "java.lang.String",
            "desc": "Server State"
          },
          "FailedCallsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Failed calls during the interval"
          },
          "TotalTasksInSystem": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Tasks in the system"
          },
          "AlertingCallsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Alerting calls during the interval"
          },
          "ActiveCallsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Active calls during the interval"
          },
          "FailedInterruptAcceptedIndicationsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Interrupt Accepted Indications failed at CCE"
          },
          "BeginCallsInterval": {
            "rw": false,
            "type": "long",
            "desc": "Begin calls during the interval"
          },
          "DroppedCallsTotal": {
            "rw": false,
            "type": "long",
            "desc": "Total Dropped calls since start"
          },
          "FailedHeartBeatsCount": {
            "rw": false,
            "type": "long",
            "desc": "Total number of Failed heartbeats"
          },
          "NumOfAgentsLoggedIn": {
            "rw": false,
            "type": "int",
            "desc": "Number of Agents Logged In"
          }
        },
        "class": "com.cisco.ccbu.finesse.core.AWSStatisticsMBean",
        "desc": "AWS Statistics Counter"
      }
    },
    "java.lang": {
      "type=Memory": {
        "op": {
          "gc": {
            "args": [],
            "ret": "void",
            "desc": "gc"
          }
        },
        "attr": {
          "ObjectPendingFinalizationCount": {
            "rw": false,
            "type": "int",
            "desc": "ObjectPendingFinalizationCount"
          },
          "Verbose": {
            "rw": true,
            "type": "boolean",
            "desc": "Verbose"
          },
          "HeapMemoryUsage": {
            "rw": false,
            "type": "javax.management.openmbean.CompositeData",
            "desc": "HeapMemoryUsage"
          },
          "NonHeapMemoryUsage": {
            "rw": false,
            "type": "javax.management.openmbean.CompositeData",
            "desc": "NonHeapMemoryUsage"
          },
          "ObjectName": {
            "rw": false,
            "type": "javax.management.ObjectName",
            "desc": "ObjectName"
          }
        },
        "class": "sun.management.MemoryImpl",
        "desc": "Information on the management interface of the MBean"
      }
    }
  },
  "timestamp": 1667212345,
  "status": 200
}