Jump to: navigation, search

Component Utilization Reporting Service

This report provides current utilization information for the MCP, CCP, and RM components in the system. Each report contains a manifest section.

Web Service Endpoint

This report is available at the web service endpoint /ems-rs/RT/components/usage.

Input Parameters

This report accepts the following Request URI parameters:

Parameter Description
comp-id This describes the set of Components that the report will contain. If the comp-id is not specified, then results for all components in the system are returned.

Output Format

The output for this report is organized as a sequence of <comp-usage> elements within enclosing elements <comp-usage-report> </comp-usage-report>. Each <compe-usage> element contains information about a single component. It contains information about the number of currently in-progress calls, number of calls arriving this hour, and today, peak number of calls seen today for the component with the time at which the peak occurred, plus various other information. It conforms to the RelaxNG schema ComponentUsageReport.rng. Download the GVP RNG Schemas An example report body for this report is as follows:

  <comp-usage-report>
    <comp-usage>
      <component href="/components/211" name="CCP_153_RS" type="CCP" /> 
      <calls>
        <in-progress count="0" /> 
        <arrived last-updated="2010-02-04T16:40:40.095Z">
          <this-hour count="0" /> 
          <today count="8">
            <calls type="NEWCALL" count="6" /> 
            <calls type="EXTERNAL" count="1" /> 
            <calls type="CREATECCXML" count="1" /> 
          </today>
        </arrived>
        <peak today="4" time="2010-02-04T16:39:41.73Z" last-updated="2010-02-04T16:40:40.095Z">
          <calls type="NEWCALL" count="2" /> 
          <calls type="EXTERNAL" count="1" /> 
          <calls type="CREATECCXML" count="1" /> 
        </peak>
      </calls>
    </comp-usage>
    <comp-usage> . . . </comp-usage>
  </comp-usage-report>
This page was last edited on July 17, 2020, at 16:12.
Comments or questions about this documentation? Contact us for support!