Skip to main content
GET
Get shade scene properties for a DC field

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