Skip to main content
GET
/
Project
/
{projectId}
/
Prediction
/
{predictionId}
/
ShadeScene
/
Properties
/
{dcFieldNumber}
Get shade scene properties for a DC field
curl --request GET \
  --url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/ShadeScene/Properties/{dcFieldNumber} \
  --header 'Authorization: Bearer <token>'
{
  "id": 4297,
  "name": "Custom Shade Scene",
  "createdDateUTC": "2025-11-25T16:48:08.357",
  "createdById": 8903,
  "sceneSurfaceArea": 34952.621141703195,
  "dcFieldSurfaceArea": 14461.598249999997,
  "collectorCount": 177,
  "objectCount": 0,
  "orientationTargetDCField": 3387869,
  "calculationSettingsTargetDCField": 3387869,
  "siteTableCount": 177,
  "rotation": false,
  "customTableRotationScheduleName": null,
  "customTableRotationUploadDate": null,
  "binType": 2,
  "collectorType": 0,
  "trackerRotationModel": 0,
  "shadingModel": 6,
  "fractionalShadingPercentage": 100,
  "numberOfModuleFractions": 2,
  "shadeObjectType": 1,
  "siteExceedsTableLimit": false
}

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
​
dcFieldNumber
integer
required

Response

Shade scene properties

​
id
integer
​
name
string
​
createdDateUTC
string

ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.

​
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