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


KPI - KPI Prediction Model List and New Prediction Model Resource - POST Method

Create a new KPI prediction model.

Resource URI

POST /models/{model id}/versions/{version}/kpis/config/{kpi id}/prediction_models

Parameters

None.

Request Content

MIME Type: application/json

The HTTP request can have a payload which contains parameters. The following table lists all input parameters that can be sent in the HTTP payload in JSON format.

Parameter Name

Type

Description

Prediction Model ID

string

ID of the KPI Prediction Model. This parameter is optional when creating a new 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.   Valid values are ‘true’ and ‘false’.

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.  Not used in Monitor 6.2.

KPI Behavior

string

KPI behavior for the prediction interval.  Valid values are running and absolute.   Set automatically in Monitor 6.2.

Prediction Submodel ID

string

Model ID for the prediction model to use for making intra-period predictions.  Not used in Monitor 6.2.

Model Optimization Schedule

string

Period used to schedule the automated model optimization.  Valid values are hourly, daily, weekly, monthly, quarterly, yearly

 


+ View Schema
{ "description": "KPI prediction model create/update input", 
  "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"]},
  }
}

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",
}

Response Content

The default content-type is application/json.

MIME Type: 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.

 


+ View Schema
{ "description": "KPI prediction model create/update output", 
  "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"},
  }
}

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",
}

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: KPI Prediction Model List and New Prediction Model Resource