Auto Predict

You can use this REST API to schedule predictions using the Auto Predict job.

With Auto Predict, administrators can define a prediction to predict future performance based on historical data and schedule a job to run that prediction definition, automating the prediction process. For details about Auto Predict, see Setting Up Predictions to Run Automatically in Administering Planning.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Job Types.

Required Roles

Service Administrator

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.

Table 8-30 Import Exchange Rates

Name	Description	Required	Default
jobType	Auto Predict	Yes	None
jobName	The name used to define Auto Predict in the user interface in Overview, then Actions, and then Auto Predict. This name will be used for the job execution. Important: You must use the exact name of a job that is already defined in Planning as described in Managing Jobs. Example: Prediction1	Yes	None
forceRun	If this is set to true, the job will always execute. If not, the job executes only for the first time. In subsequent attempts, if there is no change in the job definition, this message displays: "Auto Prediction definition hasn't changed since the last time the Auto Predict job ran; the job will not execute. If you want to run the Auto Predict definition, for example if there are new actual values, you can run the Auto Predict definition from the Auto Predict page. From the Actions menu, click Actions and then click Run."	No	False
paginatedDim	Speeds up an Auto Predict job by running predictions in parallel in separate prediction threads. For the parallel jobs to be efficient, choose a dimension that will result in evenly spread data for each prediction thread. Example: Entity	No	False

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payload

Example 1: Executes the Auto Predict job ASO->BSO.

{
    "jobType": "Auto Predict",
    "jobName": "ASO->BSO",
    "parameters": {
        "forceRun": true,
        "paginatedDim": "Entity"
    }
}