WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
GET /models/{model id}/versions/{version}/kpis?{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.
|
||||||
sortby | string |
The column used to sort the key performance indicators (KPIs)
for the model and version. Valid values are 'KPIDisplayName',
'UserID', 'ViewAccess' and 'KPIOrigin'.
|
||||||
order | string |
The order in which the sort should be conducted.
Valid values are 'asc' and 'desc'.
|
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 |
number |
The monitor model version |
KPI Display Name |
string |
The key performance indicator (KPI) display name |
KPI Origin |
string |
The key performance indicator (KPI) description. Valid values
are "modeled" and "runtime" |
User ID |
string |
The user ID of the key performance indicator (KPI) owner |
KPI Context ID |
string |
The key performance indicator (KPI) context ID |
KPI Description |
string |
The key performance indicator (KPI) description |
KPI Data Type |
string |
The key performance indicator (KPI) data type. Valid values are
"decimal" and "duration" |
Target |
number |
The key performance indicator (KPI) target value. If the data
type is "duration", the target is in milliseconds |
Target Localized |
string |
The key performance indicator (KPI) target value in localized
format. For example, duration KPIs are displayed as #d, #h, #m, #s |
KPI Calc Method |
string |
The key performance indicator (KPI) calculation method. Valid
values are "aggregated" and "calculated" |
Aggregated Metric ID |
string |
The ID of the aggregated metric |
Aggregated Metric Name |
string |
The name of the aggregated metric |
Aggregated Function |
string |
The aggregated function. Valid values are "avg",
"sum", "min", "max", "count", and "stddev" |
Version Aggregation |
string |
The scope of the metric aggregation, whether it is for instances
within the same model version as the KPI or for instances across all model
versions. Valid values are "singleVersion"” and
"allVersions". |
View Access |
string |
The view access, whether the KPI can be viewed by others or not.
Valid values are "public" and "personal". |
KPI Calc Method |
string |
KPI calculation method. Valid values are "aggregated" and "calculated" |
Calculated KPI Expression |
string |
Calculated KPI Expression. For example, "sumPrice div countPrice" |
Enable KPI Prediction |
boolean |
Flag to indicate if KPI Prediction is
enabled. Valid values are “true” and
“false” |
Enable KPI History |
boolean |
Flag to indicate if KPI History is enabled. Valid values are “true” and “false” |
{ "description": "KPI Context List", "type": ["object"], "properties": { { "Model ID": {"type":"string"}, "Version": {"type":"integer"}, "User ID": {"type":"string"}, "KPI ID": {"type":"string"}, "KPI Display Name": {"type":"string"}, "KPI Origin": {"type":"string"}, "KPI Context ID": {"type":"string"}, "KPI Description": {"type":"string"}, "Aggregated Metric ID": {"type":"string"}, "Aggregated Metric Name": {"type":"string"}, "KPI Data Type": {"type":"string"}, "KPI Calc Type": {"type":"string"}, "Calculated KPI Expression":{"type":"string"}, "Target": {"type":"number"}, "Target Localized": {"type":"string"}, "KPI Calc Method": {"type":"string"}, "Aggregated Function": {"type":"string"}, "Version Aggregation": {"type":"string"}, "View Access": {"type":"string"}, "Enable KPI Prediction":{"type":"string"}, Enable KPI History":{"type":"string"}, } } }
Example content:
[ { "Model ID":"OrderItem", "Version":20060803000000, "User ID":"", "KPI ID":"AveragePriceBeginFebruary2007", "KPI Display Name":"AveragePriceBeginFebruary2007" "KPI Origin":"modeled", "KPI Data Type":"decimal", "KPI Context ID":"TimePeriodKPIs", "KPI Description":null, "Aggregated Metric ID":"itemPrice", "Aggregated Function":"avg", "KPI Calc Method":"aggregated", "Target":null, "Target Localized":null, "Calculated KPI Expression":null, "Version Aggregation":"singleVersion", "View Access":"public", "Aggregated Metric Name":"Item Price", "Enable KPI Prediction":false, "Enable KPI History":true, } ]
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: KPI List Resource