Create Design

Create a new design for a project.


The returned design ID allows you to create a deep link into the Aurora application. That way, you can direct users to a specific design within a specific project. Please note, a design must always belong to a project. Therefore the project_id must always be provided. Optionally you can provide a site_model_design_id in the URI, referencing an existing design to act as a template. The created/returned design will in this case contain a copy of the site model of the provided design. Additionally you can assert the include_design flag to also copy the PV design.

🚧

The provided design (site_model_design_id) must be part of the project (project_id) and shading values do not currently carry over from the original design.

Path Params
uuid
required

The ID of the tenant to create the design in.

Query Params
uuid

Aurora Solar's ID of the design in the form of a string.

string

Inclusion of this param will copy the PV design in addition to the site model. Note that this is not a boolean; as long as the param is included (even if the value is false), it will take effect.

Body Params
design
object

Design to create.

Responses

404

Not Found

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