structures

Put Linear Placements

This endpoint makes the site's detailed linear ancillaries the ones in the request body, matched by id: missing ones are removed and unknown ids are added. Contents name their route by its id, which may be a new one. Each placement's equivalent rows (a route split by height where its contents change) replace the previous ones in the site's linear ancillaries.

put/v1/structures/{structure_id}/linear_placements

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

idstring required

linearAncillaryIdinteger required

parentIdstring nullable required

tenantIdinteger nullable required

tenantNamestring nullable required

startAtMnumber required

endAtMnumber required

azimuthDegnumber nullable required

shieldingFactornumber nullable required

latticeMountingLegsIndicesinteger[] nullable required

fromLeftMmnumber nullable required

fromFloorMmnumber nullable required

status'INSTALLED' | 'PLANNED' | 'REMOVED' | 'UNKNOWN' | 'MARKED FOR REMOVAL' required

clampWeightKgPerMnumber required

shouldAnalyseboolean required