Distributed forces applied along a member
Get All
Gets all loads with optional filtering and pagination.
Use the cases 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 Case ascending, then by entity Id ascending.
Pagination metadata is returned in response headers (Total-Count, Offset, Limit).
query Parameters
MembersMember Ids to filter by, in SG list format (e.g. "1,3-7,10").
Returns only loads applied to the specified members.
Omit to return loads for all members.
CasesLoad cases to filter by, in SG list format (e.g. "1,3-7,10").
Returns only loads belonging to the specified cases.
Omit to return loads for all 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 All › Responses
OK
memberThe member number this load is applied to.
subLoadThe auto-assigned sub-load number within the member+case combination.
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
Create
Creates a new load. The load case must exist and be a Primary load case.
Create › Request Body
caseThe load case number to create this load in.
memberThe member number to apply this load to.
loadCategoryLoad category for grouping/organization.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
Create › Responses
Bad Request
titleA short, human-readable summary of the problem type
statusHTTP status code
detailA human-readable explanation specific to this occurrence
instanceA URI reference that identifies the specific occurrence
errorCodeMachine-readable error code for programmatic handling
sourceSource of the error. Serialised as its string identifier (e.g. "Infrastructure") on the wire
regardless of which JSON pipeline emits the response — the MVC AddJsonOptions string-enum
converter doesn't apply to direct HttpResponse.WriteAsJsonAsync writes (used by
GlobalExceptionHandler), so the converter is declared on the enum itself.
List of errors describing what went wrong. Always populated on the wire — falls back to a single entry derived from SpaceGassApi.Models.Dtos.Common.ErrorResponseDto.Detail / SpaceGassApi.Models.Dtos.Common.ErrorResponseDto.ErrorCode when no caller-supplied list is present, so clients can iterate uniformly. Multiple entries appear for validation failures (one entry per failed rule).
Additional context-specific data
timestampTimestamp when the error occurred
Get Member Distributed Load
Gets a specific member distributed load by its composite Id (case + member + subLoad).
path Parameters
caseIdThe load case number
memberIdThe member number
subLoadIdThe sub-load number
Get Member Distributed Load › Responses
Returns the member distributed load
memberThe member number this load is applied to.
subLoadThe auto-assigned sub-load number within the member+case combination.
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
Delete Member Distributed Load
Deletes a specific member distributed load by its composite Id (case + member + subLoad).
path Parameters
caseIdThe load case number
memberIdThe member number
subLoadIdThe sub-load number
Delete Member Distributed Load › Responses
Member distributed load deleted successfully
Update Member Distributed Load
Updates an existing member distributed load. Only provided fields are updated. The load case must be a Primary load case.
path Parameters
caseIdThe load case number
memberIdThe member number
subLoadIdThe sub-load number
Update Member Distributed Load › Request Body
caseThe load case number.
loadCategoryLoad category for grouping/organization.
memberThe member number.
subLoadThe sub-load number.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
Update Member Distributed Load › Responses
Returns the updated member distributed load
memberThe member number this load is applied to.
subLoadThe auto-assigned sub-load number within the member+case combination.
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
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
caseThe load case number to create this load in.
memberThe member number to apply this load to.
loadCategoryLoad category for grouping/organization.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
Create Bulk › Responses
Bad Request
titleA short, human-readable summary of the problem type
statusHTTP status code
detailA human-readable explanation specific to this occurrence
instanceA URI reference that identifies the specific occurrence
errorCodeMachine-readable error code for programmatic handling
sourceSource of the error. Serialised as its string identifier (e.g. "Infrastructure") on the wire
regardless of which JSON pipeline emits the response — the MVC AddJsonOptions string-enum
converter doesn't apply to direct HttpResponse.WriteAsJsonAsync writes (used by
GlobalExceptionHandler), so the converter is declared on the enum itself.
List of errors describing what went wrong. Always populated on the wire — falls back to a single entry derived from SpaceGassApi.Models.Dtos.Common.ErrorResponseDto.Detail / SpaceGassApi.Models.Dtos.Common.ErrorResponseDto.ErrorCode when no caller-supplied list is present, so clients can iterate uniformly. Multiple entries appear for validation failures (one entry per failed rule).
Additional context-specific data
timestampTimestamp when the error occurred
Delete Bulk
Deletes multiple member distributed loads. Case, member, and subLoad are all required for each entry. The succeeded array echoes back the Ids of each successfully deleted load.
query Parameters
continueOnErrorWhether to continue on error
Delete Bulk › Request Body
caseThe load case number.
memberThe member number.
subLoadThe sub-load 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 member distributed loads. Each item must include case, member, and subLoad in the body. All load cases referenced must be Primary.
query Parameters
continueOnErrorWhether to continue processing after individual failures
Update Bulk › Request Body
caseThe load case number.
loadCategoryLoad category for grouping/organization.
memberThe member number.
subLoadThe sub-load number.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
positionUnitsPosition units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
startPositionStart position of the distributed load along the member.
finishPositionFinish position of the distributed load along the member.
fxStartDistributed force intensity in X direction at the start position.
fxFinishDistributed force intensity in X direction at the finish position.
fyStartDistributed force intensity in Y direction at the start position.
fyFinishDistributed force intensity in Y direction at the finish position.
fzStartDistributed force intensity in Z direction at the start position.
fzFinishDistributed force intensity in Z direction at the finish position.
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.