SHshapemaker
structures

Add New Structure

This endpoint allows you to add a new structure to your organization. The details of the structure to be created should be provided in the request body.

The endpoint will create a new structure based on a template based on product id and preset id, and tag it with the provided tags.

post/v1/structures

Request

  • Base URL
    https://api.shapemaker.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /v1/auth

Request body

namestring
productIdstring nullable
presetIdstring nullable
tagsstring[] nullable
structureType'tower' | 'guyed_mast' | 'monopole' | 'rooftop' | 'hybrid' | 'mount' | 'unknown'

Response

Successful Response

idinteger required
uuidstring uuid4 required
namestring required
project_idstring nullable
created_bystring required
created_atstring date-time required
design_standard_key'EN_01' | 'MSZ_EN_01' | 'NS_EN_01' | 'DIN_EN_01' | 'NF_EN_01' | 'SFS_EN_01' | 'SS_EN_01' | 'BS_EN_01' | 'IS_EN_01' | 'TIA_222_I' | 'TIA_222_H' | 'TIA_222_G' | 'TIA_222_F' | 'PN_EN_01' | 'BDS_EN_01' | 'UNI_EN_01' | 'ASNZS_01' required

Alembic does not detect changes in enums, so the enum constraint has to be manually migrated when changing this enum

structure_type'tower' | 'guyed_mast' | 'monopole' | 'rooftop' | 'hybrid' | 'mount' required

Alembic does not detect changes in enums, so the enum constraint has to be manually migrated when changing this enum

product_idstring nullable required
capacity_status'UNKNOWN' | 'OVERLOADED' | 'UNDERLOADED' required
is_stale_analysisboolean required
is_invalidated_analysisboolean
max_utilization_percentnumber nullable
organization_idinteger required
analysis_run_idstring uuid4 nullable
draft_countinteger
version_seqinteger
role'live' | 'draft' | 'snapshot'

Changes

No recorded changes to this operation across all 1 revision of this API.