Temperature change and gradient loads applied to members and plates
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
ElementTypeFilter by element type (member or plate). Returns only thermal loads for the specified element type. Omit to return both member and plate thermal loads.
Element type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
ElementsElement Ids to filter by, in SG list format (e.g. "1,3-7,10").
The meaning depends on ElementType — member Id for members, plate Id for plates.
Omit to return thermal loads for all elements.
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
elementIdThe Id of the element this load is applied to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
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.
elementIdThe Id of the element to apply this load to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
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 Thermal Load
Gets the thermal load for a specific member in a load case.
path Parameters
caseIdThe load case number
memberIdThe member number
Get Member Thermal Load › Responses
Returns the member thermal load
elementIdThe Id of the element this load is applied to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
Update Member Thermal Load
Updates an existing member thermal load. Only provided fields are updated. The load case must be a Primary load case.
path Parameters
caseIdThe load case number
memberIdThe member number
Update Member Thermal Load › Request Body
caseThe load case number.
loadCategoryLoad category for grouping/organization.
elementIdThe element Id (member number or plate number).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
Update Member Thermal Load › Responses
Returns the updated member thermal load
elementIdThe Id of the element this load is applied to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local 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.
Get Plate Thermal Load
Gets the thermal load for a specific plate in a load case.
path Parameters
caseIdThe load case number
plateIdThe plate number
Get Plate Thermal Load › Responses
Returns the plate thermal load
elementIdThe Id of the element this load is applied to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
Update Plate Thermal Load
Updates an existing plate thermal load. Only provided fields are updated. The load case must be a Primary load case.
path Parameters
caseIdThe load case number
plateIdThe plate number
Update Plate Thermal Load › Request Body
caseThe load case number.
loadCategoryLoad category for grouping/organization.
elementIdThe element Id (member number or plate number).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
Update Plate Thermal Load › Responses
Returns the updated plate thermal load
elementIdThe Id of the element this load is applied to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
caseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
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.
elementIdThe Id of the element to apply this load to (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
loadCategoryLoad category for grouping/organization.
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local Z axis.
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 thermal loads. Case, element, and elementType 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.
elementIdThe element Id (member number or plate number, depending on ElementType).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
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 thermal loads. Each item must include case, element, and elementType 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.
elementIdThe element Id (member number or plate number).
elementTypeElement type discriminator for thermal loads. Determines whether a thermal load applies to a member or plate element. Maps to SPACE GASS lookup table "Element Type".
thermalLoadThe uniform temperature change applied to the element.
yThermalGradientThe thermal gradient about the local Y axis.
zThermalGradientThe thermal gradient about the local 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.