Combination load cases
List Combination Load Cases
Returns all combination load cases (load cases of type Combination) in the open job.
Filter 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).
Expand defaults to none on this list endpoint; pass Expand=all to hydrate
each case's combinationItems array (otherwise hasCombinationItems is populated
but the array is omitted from the wire).
query Parameters
CasesCombination case Ids to filter by, in SG list format (e.g. "1,3-7,10").
Omit to return all combination cases.
TitleSearchSearch text to filter by title (case-insensitive contains).
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.
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 Combination Load Cases › Responses
Returns the list of combination 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 Combination Load Case
Creates a combination load case (case + items) in a single atomic call. The
combinationItems list is required and must contain at least one item; on
failure during item creation the parent case row is rolled back so the operation is
all-or-nothing. Each component case must exist and be of type Primary, Combination
or Unused (Step cases are rejected); no item may reference the parent case
(self-reference); item case values must be unique within the request.
Create Combination Load Case › Request Body
titleLoad case title.
The component cases and their multiplying factors that make up this combination case.
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 Combination Load Case › Responses
Combination 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 Combination Items
Gets the combination items for a specific combination case. Returns 404 if no combination case exists with the supplied Id (Primary, Step or Unused load cases are not exposed by this endpoint).
path Parameters
combinationCaseThe combination case Id
Get Combination Items › Responses
Returns the combination items
caseComponent load case number.
multiplyingFactorMultiplying factor applied to the component load case (default: 1.0).
Set Combination Items
Replaces the combination items for a combination case atomically. The case must already exist and be of type Combination. All standard item rules apply: non-empty list, no duplicates, no self-reference, and every component case must exist and be of type Primary, Combination or Unused (Step cases are rejected).
path Parameters
combinationCaseThe combination case Id
Set Combination Items › Request Body
caseComponent load case number.
multiplyingFactorMultiplying factor applied to the component load case (default: 1.0).
Set Combination Items › Responses
Items set successfully
caseComponent load case number.
multiplyingFactorMultiplying factor applied to the component load case (default: 1.0).
Get Combination Load Case
Gets a single combination load case by Id. Returns 404 if no case exists with that Id
or if the case is not of type Combination (Primary, Step and Unused cases are
not exposed by this endpoint — use GET /load-cases/{id} for those).
Expand defaults to all, which hydrates combinationItems;
pass Expand=none to suppress.
path Parameters
idThe combination 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 Combination Load Case › Responses
Returns the combination 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.
Update Combination Load Case
Partially updates a combination load case. Only fields supplied in the body are
changed; omitted fields are left as-is. The optional combinationItems field is
a full-replace when provided — it must be a non-empty list, and the same item rules
from create apply (existence, type, no self-reference, no duplicates). Omit
combinationItems to leave the existing items untouched. To remove all items,
delete the case (DELETE /{id}).
path Parameters
idThe combination load case Id
Update Combination 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).
Replacement combination items for this case. Omit to leave items unchanged.
Update Combination Load Case › Responses
Returns the updated combination 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 Items Metadata
Returns the schema for a single combination item: field definitions, units resolved against current job units, and allowed values for enum fields.
Get Items Metadata › Responses
Returns combination-item 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.
Get Combination Load Case Metadata
Returns the schema for a combination load case: field definitions, units resolved
against current job units, and allowed values for enum fields. The item DTO schema
(component case + multiplying factor) is available at GET /combination-load-cases/items/metadata.
Get Combination Load Case Metadata › Responses
Returns combination 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.
Get Next Combination Load Case Id
Returns the next available (unused) load case Id, starting from start. The Id space is shared with regular load cases — combination cases and primary cases cannot have the same Id.
query Parameters
startThe Id to start searching from (inclusive). Defaults to 1.
Get Next Combination Load Case Id › Responses
Returns the next available Id
Create Combination Load Cases (Bulk)
Creates multiple combination load cases in a single request. Each item is a full
case + items payload; validation runs upfront on the whole request. With
continueOnError=false (default) any failure rejects the whole request; with
continueOnError=true, valid items are created and failures are reported per-item.
Each created case is atomic individually (case + items, with rollback on failure).
query Parameters
continueOnErrorIf true, process valid items even when some fail. Default: false.
Create Combination Load Cases (Bulk) › Request Body
titleLoad case title.
The component cases and their multiplying factors that make up this combination case.
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 Combination 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.
Delete Combination Load Cases (Bulk)
Deletes multiple combination load cases by Id. The body is a JSON array of integer Ids
(e.g. [10, 11, 12]). Each deletion removes the case and its items atomically.
query Parameters
continueOnErrorIf true, continue processing remaining Ids after a failure. Default: false.
Delete Combination 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 Combination Load Cases (Bulk)
Partially updates multiple combination load cases. Each item must include its id.
As with the single-item PATCH, an optional combinationItems list on a row
performs a full-replace of that case's items. Validation runs upfront on the whole
request; with continueOnError=true, valid rows are applied and failures are reported per-item.
query Parameters
continueOnErrorIf true, process valid items even when some fail. Default: false.
Update Combination 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).
Replacement combination items for this case. Omit to leave items unchanged.
Update Combination 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.