Prescribed displacements and rotations applied at nodes
Get List
Returns all loads with optional filtering and pagination.
Use the loadCases query parameter to filter by load cases — accepts SG list format
(e.g. "1,3-7,10"). Omit any list filter to match all.
Returns an empty array when no loads match the filter — never 404.
Results are sorted by LoadCase ascending, then by entity Id ascending.
Pagination metadata is returned in response headers (Total-Count, Offset, Limit).
query Parameters
nodesNode Ids to filter by, in SG list format (e.g. "1,5-10,12").
Returns only displacements applied to the specified nodes.
Omit to return displacements for all nodes.
loadCasesLoad cases to filter by, in SG list format (e.g. "1,3-7,10").
Returns only loads belonging to the specified load cases.
Omit to return loads for all load cases.
loadCategoryFilter by load category number. Returns only loads assigned to the specified category.
offsetNumber of items to skip from the start of the result set. Default is 0.
limitMaximum number of items to return. Default is null (return all).
Get List › Responses
OK
nodeThe node number this displacement is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Create
Creates a new load. The load case must exist and be a Primary load case.
Create › Request Body
loadCaseThe load case number to create this load in.
nodeThe node number to apply this displacement to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Create › Responses
Created
nodeThe node number this displacement is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Get Prescribed Displacement
Gets a specific prescribed displacement by its composite Id (case + node).
path Parameters
caseIdThe load case number
nodeIdThe node number
Get Prescribed Displacement › Responses
Returns the prescribed displacement
nodeThe node number this displacement is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Delete Prescribed Displacement
Deletes a specific prescribed displacement by its composite Id (case + node).
path Parameters
caseIdThe load case number
nodeIdThe node number
Delete Prescribed Displacement › Responses
Prescribed displacement deleted successfully
Update Prescribed Displacement
Updates an existing prescribed displacement. Only provided fields are updated. The load case must be a Primary load case.
path Parameters
caseIdThe load case number
nodeIdThe node number
Update Prescribed Displacement › Request Body
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
nodeThe node number.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Update Prescribed Displacement › Responses
Returns the updated prescribed displacement
nodeThe node number this displacement is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Get Metadata
Returns schema metadata for this load entity type: field definitions, count, and key structure. Field definitions include names, data types, units, and allowed value ranges.
Get Metadata › Responses
OK
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.
Create Bulk
Creates multiple loads in a bulk operation. All load cases referenced must exist and be Primary load cases.
query Parameters
continueOnErrorWhether to continue processing after individual failures
Create Bulk › Request Body
loadCaseThe load case number to create this load in.
nodeThe node number to apply this displacement to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Create Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Delete Bulk
Deletes multiple prescribed displacements. Both case and node are required for each entry — providing only a case does not delete all displacements for that case. The succeeded array echoes back the Ids of each successfully deleted displacement.
query Parameters
continueOnErrorWhether to continue on error
Delete Bulk › Request Body
loadCaseThe load case number.
nodeThe node number.
Delete Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Update Bulk
Updates multiple prescribed displacements. Each item must include case and node in the body. All load cases referenced must be Primary.
query Parameters
continueOnErrorWhether to continue processing after individual failures
Update Bulk › Request Body
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
nodeThe node number.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
Update Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.