Delete Prediction Model

Deletes a specified prediction model.

The Delete Prediction Model API deletes a prediction model and all the associated details.

Quick Start

This API has one required parameter, model_name, which specifies the prediction model to delete. For example:

/1/api/[async|sync]/deletepredictionmodel/v2?model_name=myprediction

This call deletes the myprediction model from Haven OnDemand.

You can find a list of your existing prediction models by using the List Resources API.

Tip: Prediction models must have unique names. If you try to train a prediction model twice under the same name, the second attempt returns an error. Use this API to delete the previous prediction training model if you want to keep the same name.

Synchronous
https://api.havenondemand.com/1/api/sync/deletepredictionmodel/v2
Asynchronous
https://api.havenondemand.com/1/api/async/deletepredictionmodel/v2
Authentication

This API requires an authentication token to be supplied in the following parameter:

Parameter Description
apikey The API key to use to authenticate the API request.
Parameters

This API accepts the following parameters:

Required
Name Type Description
model_name
resource The name of the model to delete.

This API returns a JSON response that is described by the model below. This single model is presented both as an easy to read abstract definition and as the formal JSON schema.

Asynchronous Use

Additional requests are required to get the result if this API is invoked asynchronously.

You can use /1/job/status/<job-id> to get the status of the job, including results if the job is finished.

You can also use /1/job/result/<job-id>, which waits until the job has finished and then returns the result.

Model
This is an abstract definition of the response that describes each of the properties that might be returned.
Delete Prediction Model Response {
model_name ( string ) The name of the model to delete.
deleted ( boolean ) Indicates whether the deletion process was successful.
}
Model Schema
This is a JSON schema that describes the syntax of the response. See json-schema.org for a complete reference.
{
    "type": "object",
    "properties": {
        "model_name": {
            "type": "string"
        },
        "deleted": {
            "type": "boolean"
        }
    },
    "required": [
        "model_name",
        "deleted"
    ]
}


If you would like to provide us with more information then please use the box below:

We will use your submission to help improve our product.