Create a design segment

Creates a new design segment (solar array) within an existing design. A design segment represents a grouping of solar modules configured with specific parameters such as azimuth, tilt, and shading characteristics.

Business Context: Design segments are used to define different arrays within a single solar installation. Each segment can have different orientations, tilt angles, and shading conditions, allowing for accurate modeling of complex roof structures and optimized energy production calculations.

Important: The associated design's project must be in "NEW" status to create segments. Projects in progress require creating a new primary design to update specifications.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schema for creating a new design segment (solar array) for a design.

uuid
required

The unique identifier of the design this segment belongs to.

uuid
required

The unique identifier of the module product for this segment.

string
required
length ≤ 255

Human-readable name for this segment.

integer
required
≥ 1

The number of modules in this segment.

string
enum
required

The supported design array types.

Allowed:
float
required
0 to 360

The array azimuth in degrees.

float
required
0 to 90

The array tilt in degrees.

float
required
0 to 100

The array shading percentage.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/ld+json