WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
GET /models/{model id}/versions/{version}/mcs?{parameters}
Name | Value Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
allChildLevels | boolean |
Whether all child levels (in a tree structure) are returned.
|
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 |
|
Version |
integer |
The monitor model version |
|
MC Array |
array |
Array of monitoring contexts |
|
|
MCID |
string |
The monitoring context ID |
|
MC Display Name |
string |
The monitoring context display name |
|
Cube Name |
string |
The cube name |
|
Diagram Exists |
boolean |
Flag indicating whether the diagram exists for this KPI Context.
Valid values are "true" or "false" |
|
Child MCs |
array |
If allChildLevels=false or if allChildLevels is not specified,
an array of the MC's direct children including child MCID and MC Display
Name. If allChildLevels=true, a recursive array of all child monitoring
contexts |
{ "description": "Monitoring Context List", "type": "object", "properties": { "Model ID":{"type":"string"}, "Version":{"type":"integer"}, "MC Array": [ "MCID":{"type":"string"}, "MC Display Name":{"type":"string"}, "Cube Name":{"type":"string"}, "Diagram Exists":{"type":"boolean"}, "Child MCs":[ "MCID":{"type":"string", "MC Display Name":{"type":"string"}, "Cube Name":{"type":"string", "description":"returned only when allChildLevels=true" }, "Diagram Exists":{"type":"boolean" "description":"returned only when allChildLevels=true" }, "Child MCs":{"type":["object"], "description":"returned only when allChildLevels=true" } ] ] } }
Example content:
{ "Model ID":"OrderItem", "Version":20060803000000, "MC Array":[ { "MCID":"OrderItem_MC", "MC Display Name":"OrderItem MC", "Cube Name":"OrderItem MC", "Diagram Exists": true, "Child MCs":[ {"MCID":"OrderBook", "MC Display Name":"Order Book", "Cube Name":"OrderBook", "Diagram Exists": false, "Child MCs":[] }, {"MCID":"OrderMusic", "MC Display Name":"Order Music", "Cube Name":"OrderMusic", "Diagram Exists": true, "Child MCs":[] }, ] } { "MCID":"OrderItem_MC2", "MC Display Name":"OrderItem MC2", "Cube Name":"OrderItem MC2", "Diagram Exists": true, "Child MCs":[ {"MCID":"OrderBook2", "MC Display Name":"Order Book2", "Cube Name":"OrderBook2", "Diagram Exists": true, "Child MCs":[] } ] } ] }
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: Versioned Monitoring Contexts Resource