Sign in

v1

latestOpenAPI 3.0.02026-07-241010520.6 KB
Design Assets

Create Design Asset

Create a new asset for a design.

A design can have a number of images or documents such as installation instructions, data sheets or other supporting materials. An associated file can be a pdf, jpg, jpeg, png, gif, or webp file. Any other file formats will be rejected. The maximum size of an individual file is 25 MB. You may upload up to 20 assets per design. New assets will overwrite old assets with the same name and asset type, and new Racking Bill of Materials will always overwrite pre-existing ones, as only 1 is allowed per design.

post/tenants/{tenant_id}/designs/{design_id}/assets

Path parameters

tenant_idstring uuid required

The ID of the tenant to create the asset in.

design_idstring uuid required

The ID of the design to associate the asset with.

Query parameters

asset_type'Racking Spec Sheet' | 'Racking Install Manual' | 'Racking Certification' | 'Racking CAD File' | 'Racking Engineering Report' | 'Racking Bill of Materials' required

Describes the type of asset being uploaded.

Headers

Content-Dispositionstring required

Describes the uploaded content, including the filename of the asset. Must follow format: 'attachment; filename="<file_name>.<file_extension>"'

Response

Asset successfully created.

Example response

{
  "asset": {
    "url": "http://some-host.com/some-path/file2.png",
    "filename": "mounting_hardware_spec_sheet.pdf",
    "taken_at": "2023-07-11 18:43:18 UTC",
    "asset_type": "Racking Spec Sheet"
  }
}