WebSphere Business Monitor, Version 6.2 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


Monitoring Context Instance Data - Measure Values Resource - GET Method

Resource URI

GET /models/{model id}/versions/{version}/exportvalues?{parameters}

Parameters

Optional Parameters
NameValue TypeDescription
starttime string
Indicates a starting time for the measure aggregation, formatted as YYYYMMDDHHMMSS
endtime string
Indicates a ending time for the measure aggregation, formatted as YYYYMMDDHHMMSS.
timezone string
The timezone of starttime and endtime. Use a Java timezone identifier such as America/Los_Angeles.
versionaggregation string
Determines whether only instances from the specified version are aggregated, or instances across all versions.
ValueDescription
singleversion (default)
Use only the instances from the specified version.
allversions
Instances across all versions are used.

Request Content

The list of measures to export is based on any measures with tracking keys in the specified model version. The metric values that are aggregated can come from this version or all versions of the monitor model. Only completed instance metrics are aggregated into measures.

Note:

If starttime is not specified but endtime is, all completed instances with TerminationTime up to endtime will be aggregated.

If starttime is specified but endtime is not, all completed instances with TerminationTime from starttime on will be aggregated.

If both are specified, all completed instances with TerminationTime between starttime and endtime will be aggregated.

If neither are specified, all completed instances will be aggregated.

If either starttime or endtime is not valid, an error is returned.

If timezone is missing or not valid, starttime and endtime will be assumed to be in UTC.

Response Content

The export values from this URI are returned in a XML response, which WebSphere © Business Modeler can import. No JSON object is returned.

The default content-type is text/xml.

MIME Type: text/xml

Example content:

<runtimeData>

<measure>
<trackingKey>avgAccumulatingStopwatch</trackingKey>
<valueType>double</valueType>
<value>4778828000</value>
</measure>

<measure>
<trackingKey>avgCatalogActivityCounter</trackingKey>
<valueType>double</valueType>
<value>2</value>
</measure>

<measure>
<trackingKey>avgCustomerID</trackingKey>
<valueType>double</valueType>
<value>2</value>
</measure>

</runtimeData>

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{ "description": "REST error response", 
  "type": "object",
  "properties":
   { "Status Code" : {"type":"integer"},
     "Error" : {"type":"string"},
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - requested data returned. Note that the list may be empty.
403 Forbidden
Not authorized to request the resource.
404 Not Found
Resource not found or URL not supported.
400 Bad Request
The request contains invalid parameters or is missing parameters and inputs.
500 Internal Server Error
Internal error processing the request.

Available Since

6.1

Parent Topic: Measure Values Resource