Skip to main content

Forecasts Overview

Managing Forecasts API Endpoints​

Saving a Forecast​

To save a forecast, interact with the ForecastInput entity. Ensure the name property is provided; it's a mandatory field. If you omit the type property, the default value will be set to deterministic.

Example:

POST /v1/projects/:projectId/forecasts
Content-Type: application/json
{
    "name": "Example Forecast",
    "type": "deterministic",
}

Deleting a Forecast​

To delete a forecast, issue a DELETE request. Include the deleteTypeCurves query string to remove all specified forecasts associated with type-curves.

Example:

DELETE v1/projects/:projectId/forecasts/:forecastId?deleteTypeCurves=true

Updating a Forecast​

For updating an existing forecast, utilize the PATCH request. Provide the name property to modify the forecast's name. It's important to note that changing the forecast type from probabilistic to deterministic or vice versa is not possible in this endpoint, so the property will be ignored is provided.

Example:

PATCH v1/projects/:projectId:/forecasts/:forecastId
Content-Type: application/json
{
    "name": "Updated Forecast Name",
}