Gravitational acceleration loads applied to the structure's own weight
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
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
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
accelerationXGravitational acceleration in the global X direction.
accelerationYGravitational acceleration in the global Y direction.
accelerationZGravitational acceleration in the global Z direction.
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.
loadCategoryLoad category for grouping/organization.
accelerationXGravitational acceleration in the global X direction.
accelerationYGravitational acceleration in the global Y direction.
accelerationZGravitational acceleration in the global Z direction.
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 Self Weight Load
Gets the self-weight load for a specific load case. Returns 404 if no self-weight load exists for that case.
path Parameters
caseIdThe load case number
Get Self Weight Load › Responses
Returns the self-weight load
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
accelerationXGravitational acceleration in the global X direction.
accelerationYGravitational acceleration in the global Y direction.
accelerationZGravitational acceleration in the global Z direction.
Update Self Weight Load
Updates an existing self-weight load. Only provided fields are updated.
path Parameters
caseIdThe load case number
Update Self Weight Load › Request Body
caseThe load case number.
loadCategoryLoad category for grouping/organization.
accelerationXGravitational acceleration in the global X direction.
accelerationYGravitational acceleration in the global Y direction.
accelerationZGravitational acceleration in the global Z direction.
Update Self Weight Load › Responses
Returns the updated self-weight load
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
accelerationXGravitational acceleration in the global X direction.
accelerationYGravitational acceleration in the global Y direction.
accelerationZGravitational acceleration in the global Z direction.
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.
loadCategoryLoad category for grouping/organization.
accelerationXGravitational acceleration in the global X direction.
accelerationYGravitational acceleration in the global Y direction.
accelerationZGravitational acceleration in the global Z direction.
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