WebSphere Business Monitor, Version 6.2
Operating Systems: AIX, HP-UX, Linux, Solaris, Windows
GET /models/{model id}/versions/{version}/kpis/config/{kpi id}/prediction_models/{prediction model id}
None.
None.
The default content-type is application/json.
The following table lists all parameters in the JSON output:
Parameter Name |
Type |
Description |
|
Prediction Model ID |
string |
ID of the KPI Prediction Model. |
|
Prediction Model Name |
string |
Name of the KPI Prediction Model. |
|
KPI ID |
string |
The key performance indicator (KPI) ID |
|
Model ID |
string |
The monitor model ID |
|
Version |
number |
The monitor model version |
|
KPI Prediction Horizon |
number |
Number of periods to predict into the future. |
|
Predict to Period End |
boolean |
Predict only to the end of the current period. This overrides the KPI Prediction Horizon. |
|
Prediction Interval Number |
number |
Number of intervals used in by the prediction time series
algorithm. Must be 1 in Monitor 6.2. |
|
Prediction Interval Unit |
string |
Unit used for the KPI Prediction Interval. Valid values are: hourly, daily, weekly, monthly, quarterly,
yearly |
|
Intervals Per Cycle |
number |
Number of seasons per cycle. |
|
Cycle Length Unit |
string |
Unit used for measuring the number of seasons per cycle. Valid values are: hours, days, weeks, months, quarters, years |
|
KPI Behavior |
string |
KPI behavior for the prediction interval. Valid values are running and absolute. |
|
Prediction Submodel ID |
string |
Model ID for the prediction model to use for making intra-period
predictions. |
|
Model Optimization Schedule |
string |
Period used to schedule the automated model optimization. Valid values are daily, weekly, monthly,
quarterly |
|
Creation User ID |
string |
Name of the user that created the KPI Prediction Model. |
|
Update User ID |
string |
Name of the user that last updated the KPI Prediction Model. |
|
Creation Time |
string |
Date/time that the KPI Prediction Model was created. |
|
Update Time |
string |
Date/time that the KPI Prediction Model was last updated. |
|
Time Last Optimized |
string |
Date/time that the KPI Prediction Model was fully refreshed. |
|
Prediction Model Valid |
boolean |
True/False indicating if the prediction model is valid. Changes in KPI properties can cause
prediction models to marked as invalid |
|
Warnings |
array |
Array of warning messages |
|
|
Warning |
string |
String containing a warning message for the KPI Prediction Model |
{ "description": "KPI prediction model details", "type":"object", "properties": { "Prediction Model ID":{"type":"string"}, "Prediction Model Name":{"type":"string"}, "KPI ID":{"type":"string"}, "Model ID":{"type":"string"}, "Version":{"type":"number"}, "KPI Prediction Horizon":{"type":"number"}, "Predict to Period End":{"type":"boolean"}, "Prediction Interval Number":{"type":"number"}, "Prediction Interval Unit":{"type":"string", "enum":["yearly", "quarterly", "monthly", "weekly", "daily", "hourly"]}, "Intervals Per Cycle":{"type":"number"}, "Cycle Length Unit":{"type":"string", "enum":["years", "months", "days", "hours", "minutes"]}, "KPI Behavior":{"type":"string", "enum":["running", "absolute"]}, "Prediction Submodel ID":{"type":"string"}, "Model Optimization Schedule":{"type":"string", "enum":["quarterly", "monthly", "weekly", "daily"]}, "Creation User ID":{"type":"string"}, "Update User ID":{"type":"string"}, "Creation Time":{"type":"string"}, "Update Time ":{"type":"string"}, "Time Last Optimized":{"type":"string"}, "Prediction Model Valid":{"type":"boolean"} "Warnings": [ { "Warning":{"type":"string"} } ] } }
Example content:
{ "Prediction Model ID":"dailyprediction", "Prediction Model Name":"Daily Predictions", "KPI ID":"avgPrice", "Model ID":"OrderItem", "Version":20060803000000, "KPI Prediction Horizon":3, "Predict to Period End":false, "Prediction Interval Number":3, "Prediction Interval Unit":"daily", "Intervals Per Cycle":5, "Cycle Length Unit":"days", "KPI Behavior":"running", "Prediction Submodel ID":"hourlyprediction", "Model Optimization Schedule":"daliy", "Creation User ID":"admin", "Update User ID":"admin", "Creation Time":"2008-01-01T12:00:00", "Update Time ":"2008-01-25T12:00:00", "Time Last Optimized":"2008-01-25T12:00:00", "Prediction Model Valid":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.2
Parent Topic: KPI Prediction Model Resource