Update export options for a prediction's power plant

PUT

Project

{projectId}

Prediction

{predictionId}

PowerPlant

ExportOptions

Update export options for a prediction's power plant

curl --request PUT \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exportSystem": true,
  "exportESS": true,
  "nodalExportOptions": [
    {
      "name": 1,
      "exportBlock": true,
      "exportArrays": true,
      "exportInverters": true,
      "exportDCFields": true
    },
    {
      "name": 2,
      "exportBlock": true,
      "exportArrays": true,
      "exportInverters": true,
      "exportDCFields": true
    }
  ]
}
'

{
  "message": "The request is invalid.",
  "modelState": {
    "latitude": [
      "The field Latitude must be between -90 and 90."
    ]
  }
}

Authorizations

Authorization

string

header

required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Path Parameters

projectId

integer

required

predictionId

integer

required

Body

application/json

exportSystem

boolean

exportESS

boolean

nodalExportOptions

object

The System Details page allows you to specify interconnection-related parameters including system availability, power plant output limits, and high-voltage (HV) transformation and transmission line details. These settings affect losses between the plant collection point and the energy meter (point of interconnection).

Response

Success

Get power plantRetrieves the power plant configuration for a prediction. Returns full PVPlant entity. **Parameters:** - `projectId` (path, required): The project ID. - `predictionId` (path, required): The prediction ID.

⌘I

Update export options for a prediction's power plant

curl --request PUT \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exportSystem": true,
  "exportESS": true,
  "nodalExportOptions": [
    {
      "name": 1,
      "exportBlock": true,
      "exportArrays": true,
      "exportInverters": true,
      "exportDCFields": true
    },
    {
      "name": 2,
      "exportBlock": true,
      "exportArrays": true,
      "exportInverters": true,
      "exportDCFields": true
    }
  ]
}
'

{
  "message": "The request is invalid.",
  "modelState": {
    "latitude": [
      "The field Latitude must be between -90 and 90."
    ]
  }
}