Moving-load module — collection-level settings and the selected members/plates that moving loads are applied to
Get Elements to Load
Gets the members and plates currently selected to receive moving loads, as SG
list-strings (e.g. "1,3-7,10").
Get Elements to Load › Responses
Returns the selected elements
membersThe members selected to receive moving loads, in SG list-string format.
platesThe plates selected to receive moving loads, in SG list-string format.
Update Elements to Load
Partially updates the selected members/plates (SG list-strings, e.g. "1,3-7,10");
omit a field to keep it, or supply an empty string to clear that selection.
Update Elements to Load › Request Body
membersReplacement member selection in SG list-string format. Omit to keep current.
platesReplacement plate selection in SG list-string format. Omit to keep current.
Update Elements to Load › Responses
Returns the updated elements
membersThe members selected to receive moving loads, in SG list-string format.
platesThe plates selected to receive moving loads, in SG list-string format.
Get Elements to Load Metadata
Returns the schema for GET /job/loads/moving-loads/elements-to-load.
Get Elements to Load Metadata › Responses
Returns the elements schema
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Get Moving Load Settings
Gets the collection-level moving-load settings — generation flags, vertical-proximity tolerance, the loaded-area polygon, and the read-only length/force units.
Get Moving Load Settings › Responses
Returns the moving-load settings
retainLoadsRetain generated loads for deselected scenarios.
applyToClosestMemberApply member loads to the closest member only.
ignoreLoadsOnOneMemberIgnore loads that transfer load to just one member.
checkVerticalProximityCheck vertical proximity when applying loads to members.
verticalProximityMaximum vertical distance between a load and a member for the load to be applied.
keepLoadsWithinTravelPathKeep loads entirely within the ends of the travel path (crane-beam behaviour).
ignoreOutsideLoadedAreaIgnore loads that are outside the loading area.
loadedAreaThe loading-area clipping polygon as a 2-column (X, Y) table — a bare array of rows,
e.g. [[0, 0], [10, 0], [10, 5]]. Set on the dialog via "Select Loading Area".
See GET moving-loads/settings/loaded-area/metadata for column units and the maximum row count.
Update Moving Load Settings
Partially updates the collection-level settings (flags, vertical proximity, and the
loaded-area polygon); omitted fields keep their current value. Units are read-only —
change them via POST /job/units.
Update Moving Load Settings › Request Body
retainLoadsRetain generated loads for deselected scenarios. Omit to keep current.
applyToClosestMemberApply member loads to the closest member only. Omit to keep current.
ignoreLoadsOnOneMemberIgnore loads that transfer load to just one member. Omit to keep current.
checkVerticalProximityCheck vertical proximity when applying loads to members. Omit to keep current.
verticalProximityMaximum vertical distance for a load to be applied. Omit to keep current.
keepLoadsWithinTravelPathKeep loads entirely within the ends of the travel path (crane-beam behaviour). Omit to keep current.
ignoreOutsideLoadedAreaIgnore loads that are outside the loading area. Omit to keep current.
loadedAreaReplacement loading-area polygon as a 2-column (X, Y) table. When present, replaces the entire polygon; omit to keep the current polygon.
Update Moving Load Settings › Responses
Returns the updated settings
retainLoadsRetain generated loads for deselected scenarios.
applyToClosestMemberApply member loads to the closest member only.
ignoreLoadsOnOneMemberIgnore loads that transfer load to just one member.
checkVerticalProximityCheck vertical proximity when applying loads to members.
verticalProximityMaximum vertical distance between a load and a member for the load to be applied.
keepLoadsWithinTravelPathKeep loads entirely within the ends of the travel path (crane-beam behaviour).
ignoreOutsideLoadedAreaIgnore loads that are outside the loading area.
loadedAreaThe loading-area clipping polygon as a 2-column (X, Y) table — a bare array of rows,
e.g. [[0, 0], [10, 0], [10, 5]]. Set on the dialog via "Select Loading Area".
See GET moving-loads/settings/loaded-area/metadata for column units and the maximum row count.
Get Moving Load Settings Metadata
Returns the schema for GET /job/loads/moving-loads/settings.
Get Moving Load Settings Metadata › Responses
Returns the settings schema
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Generate Moving Loads
Validates the moving-load data and runs the generator synchronously, returning the
generated load cases and selection groups. Validation runs as part of the call (there is
no separate validate endpoint); a request whose data fails validation — or that supplies
an unknown loadCategory — is rejected with 400 before the engine runs.
Generation is selective by each scenario's include flag — included scenarios are
(re)generated and excluded scenarios keep their previously-generated results.
Generation serializes against analysis through the shared engine: a request is rejected
with 409 while another generation run or an analysis is already in progress. The
generated load cases are also readable through GET /job/loads/load-cases.
Supply loadCategory in the request body to tag every generated load case with an
existing load category (create it first via POST /job/loads/load-categories). The
body is optional — omit it (or omit loadCategory) and the API reuses or creates a
default "Moving loads" category.
Generate Moving Loads › Request Body optional
loadCategoryExisting load category Id to tag the generated load cases with.
Generate Moving Loads › Responses
Generation completed; returns the generated load cases and groups
generatedLoadCaseIdsThe Ids of all moving-load load cases present after generation.
generatedGroupsThe names of the load-case selection groups created for the generated cases.