SHshapemaker
structures

Calculate Linear Placements

This endpoint previews the equivalent rows of placements before they are saved, or lists why they can't be analysed.

post/v1/structures/{structure_id}/linear_placements/calculate

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

Request body

idstring required
linearAncillaryIdinteger required
parentIdstring nullable
tenantIdinteger nullable
startAtMnumber required
endAtMnumber required
azimuthDegnumber nullable
shieldingFactornumber nullable
latticeMountingLegsIndicesinteger[] nullable
fromLeftMmnumber nullable
fromFloorMmnumber nullable
status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL'
clampWeightKgPerMnumber
shouldAnalyseboolean
namestring nullable

Response

Successful Response

issuesstring[] required
coverWeightsKgPerMobject
misplacedIdsstring[]
tenantColorsobject

Changes

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