SHshapemaker
structures

Get Structure By Id

This endpoint retrieves a structure by its ID. The ID should be provided as a path parameter in the URL.

If a structure with the provided ID does not exist, the endpoint returns a 404 error.

get/v1/structures/{structure_id}

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

Path parameters

structure_idstring required

Response

Successful Response

idinteger required
uuidstring uuid4 required
namestring required
projectIdstring nullable
createdBystring required
createdAtstring date-time required
designStandardKey'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' | 'BDS_EN_01' | 'UNI_EN_01' | 'TIA_222_I' | 'TIA_222_H' | 'TIA_222_G' | 'TIA_222_F' | 'PN_EN_01' | 'ASNZS_01' required
sectionsstring[] nullable required
productIdstring nullable required
sourceMountDesignUuidstring nullable
mountDesignNamestring nullable
capacityStatus'UNKNOWN' | 'OVERLOADED' | 'UNDERLOADED' required
isStaleAnalysisboolean required
isInvalidatedAnalysisboolean
maxUtilizationPercentnumber nullable
productType'tower' | 'guyed_mast' | 'monopole' | 'rooftop' | 'hybrid' | 'mount' | 'unknown' required
organizationIdinteger required
analysisRunIdstring uuid4 nullable
draftCountinteger
versionSeqinteger
role'live' | 'draft' | 'snapshot'

Changes

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