WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
GET /models/{model id}/mcs/{mc id}/instances/{instance id}?{parameters}
Name | Value Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
locale | string |
The locale. This value consists of lowercase ISO language
code (ISO 639) and the uppercase ISO country code (ISO 3166) joined by an
underscore (for example, en_US). Results will be returned in the locale specified.
If no locale is specified, the locale of the REST server will be used.
|
||||||
timezoneoffset | integer |
The amount of time in minutes to add
to or subtract from the Greenwich Mean Time (GMT) time in order to get the
local time. The timezone offset will be applied to the "localized" value for
any Time/DateTime type metrics that are returned.
|
||||||
returnchildren | boolean |
New to 6.2 and later releases. Whether to return the child instance data. If true, all immediate children of the instance will be returned in the result.
|
None.
The default content-type is application/json.
The following table lists all parameters in the JSON output:
Parameter Name |
Type |
Description |
||
Model ID |
string |
The monitor model ID |
||
MCID |
string |
The monitoring context ID |
||
Instance ID |
string |
The instance ID |
||
Metric ID Array |
array |
The IDs(strings) of a list of metrics including localized metrics |
||
Instance Data |
JSON |
Instance JSON object |
||
|
Instance ID |
string |
The instance ID |
|
|
Version |
integer |
The monitoring context version |
|
|
Metric Data |
array |
List of metric values. Each element in this array corresponds
to the metric id at the same index in the Metric ID Array. |
|
|
Children |
array |
Child instance array. This array is returned if returnchildren=true or is not
set in the HTTP request header. |
|
|
|
Child MC ID |
string |
The child monitoring context ID |
|
|
Child Instance IDs |
array of integers |
Child instance ids sorted in ascending order |
{ "description": "Cross Version Monitoring Context Instance", "type": "object", "properties": { "Model ID":{"type":"string"}, "MCID":{"type":"string"}, "Instance ID":{"type":"string"}, "Metric ID Array":{"type":["string"]}, "Instance Data": { "Instance ID":{"type":"string"}, "Metric Data": {"type":["any"]}, "Children" :[ "description": "This array is returned if and only if returnchildren=true." { "Child MC ID": {"type":"string"}, "Child Instance IDs": {"type":["number"]} } ] } } }
Example content:
{ "Model ID":"OrderItem", "MCID":"OrderItem_MC", "Instance ID":"21", "Metric ID Array":["customerID", "customerName", "itemPrice","itemPrice Localized","orderDate","orderDate Localized] "Instance Data":{ "Metric Data": ["123","Store 1", "19.99","$19.99","2008-03-05 13:30:00","March 5,2008 18:30:00"], "Children" : [ { "Child MC ID": "OrderBook", "Child Instance IDs": [101, 102, 201, 202] } { "Child MC ID": "OrderMusic", "Child Instance IDs": [303, 304] } ] } }
The default content-type is application/json.
{ "description": "REST error response", "type": "object", "properties": { "Status Code" : {"type":"integer"}, "Error" : {"type":"string"}, } }
Code | Description |
---|---|
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.
|
6.1
Parent Topic: Cross-version Monitoring Context Instance Resource