Skip to main content
PUT
/
Project
/
{projectId}
/
Prediction
/
{predictionId}
/
ShadeScene
/
PVJData
Create/upload a shade scene from PVJ data
curl --request PUT \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/ShadeScene/PVJData \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 123,
  "name": "<string>",
  "createdDateUTC": "2023-11-07T05:31:56Z",
  "createdById": 123,
  "sceneSurfaceArea": 123,
  "dcFieldSurfaceArea": 123,
  "collectorCount": 123,
  "objectCount": 123,
  "orientationTargetDCField": 123,
  "calculationSettingsTargetDCField": 123,
  "siteTableCount": 123,
  "rotation": 123,
  "fractionalShadingPercentage": 123,
  "numberOfModuleFractions": 123
}
'
{
  "name": "Custom Shade Scene",
  "sceneSurfaceArea": 34952.621141703195,
  "dcFieldSurfaceArea": 14461.598249999997,
  "collectorCount": 177,
  "objectCount": 0,
  "orientationTargetDCField": 3387869,
  "calculationSettingsTargetDCField": 3387869,
  "rotation": false,
  "customTableRotationScheduleName": null,
  "customTableRotationUploadDate": null,
  "binType": 2,
  "collectorType": 0,
  "trackerRotationModel": 0,
  "shadingModel": 5,
  "fractionalShadingPercentage": 100,
  "numberOfModuleFractions": null,
  "shadeObjectType": 1
}

Documentation Index

Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt

Use this file to discover all available pages before exploring further.

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
id
integer
name
string
createdDateUTC
string<date-time>
createdById
integer
sceneSurfaceArea
number
dcFieldSurfaceArea
number
collectorCount
integer
objectCount
integer
orientationTargetDCField
integer
calculationSettingsTargetDCField
integer
siteTableCount
integer
rotation
number
binType
enum<integer>

ShadeSceneBinTypes

Available options:
0,
1,
2
collectorType
enum<integer>

CollectorType

Available options:
0,
1,
2
trackerRotationModel
enum<integer>

TrackerRotationModel

Available options:
0,
1,
2
shadingModel
enum<integer>

Shading3DModel

Available options:
0,
1
fractionalShadingPercentage
number
numberOfModuleFractions
integer
shadeObjectType
enum<integer>

ShadeObjectType

Available options:
0,
1

Response

Created shade scene

id
integer
name
string
createdDateUTC
string<date-time>
createdById
integer
sceneSurfaceArea
number
dcFieldSurfaceArea
number
collectorCount
integer
objectCount
integer
orientationTargetDCField
integer
calculationSettingsTargetDCField
integer
siteTableCount
integer
rotation
number
binType
enum<integer>

ShadeSceneBinTypes

Available options:
0,
1,
2
collectorType
enum<integer>

CollectorType

Available options:
0,
1,
2
trackerRotationModel
enum<integer>

TrackerRotationModel

Available options:
0,
1,
2
shadingModel
enum<integer>

Shading3DModel

Available options:
0,
1
fractionalShadingPercentage
number
numberOfModuleFractions
integer
shadeObjectType
enum<integer>

ShadeObjectType

Available options:
0,
1