Load cases
List Load Cases
Returns all load cases in the open job. Type is read-only and computed by SPACE GASS
based on assigned loads (Primary, Combination, Step, Unused). Filter by type, by
case-Id list, or by title substring. Results are sorted by Id ascending.
Pagination metadata is returned in response headers (Total-Count, Offset, Limit).
Pass Expand=all to hydrate combinationItems on combination cases (otherwise the
hasCombinationItems indicator is populated but the array is omitted from the wire).
query Parameters
CasesLoad case Ids to filter by, in SG list format (e.g. "1,3-7,10").
Omit to return all load cases.
TitleSearchSearch text to filter by title (case-insensitive contains).
TypeFilter by load case type (Primary, Combination, Step, Unused).
Type of load case in the structural model. Read-only — computed internally by SPACE GASS based on assigned loads.
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).
ExpandSub-resource expansion. Defaults to none; pass all to hydrate combination items on combination cases.
Controls sub-resource hydration on entity GET endpoints.
Shared across every resource that supports expansion — a given resource's
metadata (expandable) lists which sub-resources All hydrates.
List Load Cases › Responses
Returns the list of load cases
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
titleLoad case title.
notesLoad case notes (supports multi-line text).
typeType of load case in the structural model. Read-only — computed internally by SPACE GASS based on assigned loads.
hasCombinationItemsTrue when this case has at least one combination item defined.
Only meaningful for cases where Type is Combination.
Use ?expand=all to include the full combinationItems array.
The combination items (component case + multiplying factor rows) that make up this case.
Populated only when ?expand=all is passed AND hasCombinationItems is true;
omitted from the wire otherwise.
Create Load Case
Creates a new load case. The case is initially type Unused until loads are
assigned to it (or until combination items are added via POST /combination-load-cases,
which creates the case as type Combination).
Create Load Case › Request Body
titleLoad case title.
idPrimary identifier - must be unique, no duplicates allowed. Optional - will be auto-assigned to next available number if not provided. If provided, must not already exist in the model.
notesLoad case notes (supports multi-line text).
Create Load Case › Responses
Load case created
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
titleLoad case title.
notesLoad case notes (supports multi-line text).
typeType of load case in the structural model. Read-only — computed internally by SPACE GASS based on assigned loads.
hasCombinationItemsTrue when this case has at least one combination item defined.
Only meaningful for cases where Type is Combination.
Use ?expand=all to include the full combinationItems array.
The combination items (component case + multiplying factor rows) that make up this case.
Populated only when ?expand=all is passed AND hasCombinationItems is true;
omitted from the wire otherwise.
Get Load Case
Gets a single load case by Id. Expand defaults to all, which hydrates
combinationItems for combination cases; pass Expand=none to suppress.
path Parameters
idThe load case Id
query Parameters
ExpandSub-resource expansion. Defaults to all.
Controls sub-resource hydration on entity GET endpoints.
Shared across every resource that supports expansion — a given resource's
metadata (expandable) lists which sub-resources All hydrates.
Get Load Case › Responses
Returns the load case
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
titleLoad case title.
notesLoad case notes (supports multi-line text).
typeType of load case in the structural model. Read-only — computed internally by SPACE GASS based on assigned loads.
hasCombinationItemsTrue when this case has at least one combination item defined.
Only meaningful for cases where Type is Combination.
Use ?expand=all to include the full combinationItems array.
The combination items (component case + multiplying factor rows) that make up this case.
Populated only when ?expand=all is passed AND hasCombinationItems is true;
omitted from the wire otherwise.
Delete Load Case
Removes the title, notes and metadata for the load case. Does not delete the actual loads assigned to the case or its combination items — the case may still appear in listings if it has loads assigned to it.
path Parameters
idThe load case Id
Delete Load Case › Responses
Load case deleted
Update Load Case
Partially updates a load case (title, notes). Only fields supplied in the body are changed; omitted fields are left as-is.
path Parameters
idThe load case Id
Update Load Case › Request Body
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
titleLoad case title.
notesLoad case notes (supports multi-line text).
Update Load Case › Responses
Returns the updated load case
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
titleLoad case title.
notesLoad case notes (supports multi-line text).
typeType of load case in the structural model. Read-only — computed internally by SPACE GASS based on assigned loads.
hasCombinationItemsTrue when this case has at least one combination item defined.
Only meaningful for cases where Type is Combination.
Use ?expand=all to include the full combinationItems array.
The combination items (component case + multiplying factor rows) that make up this case.
Populated only when ?expand=all is passed AND hasCombinationItems is true;
omitted from the wire otherwise.
Get Load Case Metadata
Returns the schema for a load case: field definitions, units resolved against current
job units, and allowed values for enum fields (e.g. type).
Get Load Case Metadata › Responses
Returns load case schema metadata
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 Load Cases (Bulk)
Creates multiple load cases in a single request. Validation runs upfront on the whole
request; if any item fails and continueOnError is false (default), the entire
request is rejected. With continueOnError=true, valid items are created and
failures are reported per-item in the response.
query Parameters
continueOnErrorIf true, process valid items even when some fail. Default: false.
Create Load Cases (Bulk) › Request Body
titleLoad case title.
idPrimary identifier - must be unique, no duplicates allowed. Optional - will be auto-assigned to next available number if not provided. If provided, must not already exist in the model.
notesLoad case notes (supports multi-line text).
Create Load Cases (Bulk) › Responses
Returns the bulk result (check the errors array for partial failures)
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 Load Cases (Bulk)
Deletes multiple load cases by Id. The body is a JSON array of integer Ids
(e.g. [1, 5, 10]). As with DELETE /{id}, this removes the
title/notes/metadata only — assigned loads and combination items are preserved.
query Parameters
continueOnErrorIf true, continue processing remaining Ids after a failure. Default: false.
Delete Load Cases (Bulk) › Responses
Returns the bulk result
succeededSuccessfully 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 Load Cases (Bulk)
Partially updates multiple load cases. Each item must include its id.
Validation runs upfront; with continueOnError=false (default) any failure
rejects the whole request. With continueOnError=true, valid items are updated
and failures are reported per-item.
query Parameters
continueOnErrorIf true, process valid items even when some fail. Default: false.
Update Load Cases (Bulk) › Request Body
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
titleLoad case title.
notesLoad case notes (supports multi-line text).
Update Load Cases (Bulk) › Responses
Returns the bulk result
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.