AccelerationUnit
Acceleration unit. Members mirror SPACE GASS SgAcceleration.
AccessModeStatus
accessModeCurrent operational mode of the API.
availableAccessModesThe access modes the API can currently operate in — i.e. which
targets POST /service/access-mode can be expected to accept.
pendingAccessModeCurrent operational mode of the API.
reasonIfAccessModePendingHuman-readable explanation of the pending access-mode transition (e.g. "Job open — release on close").
AccessModeUpdate
accessModeCurrent operational mode of the API.
AllowedValue
valueThe exact string token the wire accepts and returns for this enum value
(the C# enum identifier, e.g. "CompressionOnly"). Use this directly in
request bodies — it matches what comes back on reads.
labelHuman-readable label for display (e.g. "Compression only"). Pulled from
[Description] or [Display(Name=…)] on the enum member when present,
otherwise falls back to the enum identifier.
AnalysisInfo
hasResultsTrue when any analysis of this type has been run and at least one case has stored results. Determined from the file header — does not require loading the full result datasheet.
Per-case result status, optionally restricted to the caller-supplied
loadCases filter. Every requested case appears in the array; each
entry's SpaceGassApi.Models.Dtos.Analysis.AnalysisLoadCaseInfoDto.HasResults indicates whether
result data is available.
notAnalyzedSG list-format string of load case Ids that exist in the model but have
not been analysed for this analysis type. When the caller supplied a
cases filter, this is the intersection of that filter with the
not-analysed set — ready to paste straight back into the relevant
POST /job/analysis/.../run body.
Omitted when every relevant case has been analysed.
AnalysisLoadCaseInfo
loadCaseThe load case Id.
hasResultsWhether this case has stored results for the analysis type.
When false, the remaining fields are omitted.
solverMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
isNonLinearWhether this case was analysed non-linearly. Populated for static analysis cases that have results; omitted otherwise.
modesNumber of buckling or dynamic modes computed for this case. Populated for buckling/dynamic analysis cases that have results; omitted otherwise.
AnalysisLoadCaseProgress
countTotal number of load cases
indexCurrent load case index (0-based)
idCurrent load case identifier
AnalysisLogMessage
levelLog level for analysis messages
textThe message text
timestampWhen the message was received
AnalysisOptimizationMethod
Optimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
AnalysisProgress
totalStepsTotal number of analysis steps/phases discovered so far. Inferred dynamically from solver messages (the solver does not declare total steps upfront).
currentStepCurrent step being processed (0-based index)
iterationPercentageIteration progress percentage (0-100) for the current solver iteration
stepPercentagesPer-step percentage completion. Array index corresponds to step index.
stepLabelsPer-step labels/names (e.g., "Assembling geometric data", "Solving stiffness matrix"). Array index corresponds to step index. Null entries mean no label received yet.
loadCaseStatusLive load case status string, updated as load cases are processed. e.g., starts as "55" then becomes "40 (29/55)" during analysis. Null if no load case information is available.
Load case progress information
statusTextCurrent status text from the solver (e.g., "Analysing..", "Saving results..")
Log messages from the solver (info, warnings, errors). Includes error/warning messages (from negative textIndex) and completion info.
AnalysisResultsSummary
hasStaticResultsWhether static analysis results exist (linear or non-linear).
hasBucklingResultsWhether buckling analysis results exist.
hasDynamicResultsWhether dynamic frequency analysis results exist.
hasSpectralResultsWhether spectral response analysis results exist.
hasHarmonicResultsWhether harmonic response analysis results exist.
hasTransientResultsWhether transient dynamic analysis results exist.
AnalysisRun
runIdUnique identifier for this run
analysisTypeSPACEGASS analysis types. Values map to the SPACEGASS internal SGAnalysisType IDs.
statusStatus of an analysis run through its lifecycle.
startedAtWhen the run was initiated
completedAtWhen the run finished. Null if still running.
elapsedTimeTotal elapsed time as a formatted string (e.g., "00:01:23.456"). Live-computed while Running or Cancelling, stored after completion. Null while Queued.
errorMessageError message if the run failed
warningsWarning messages generated during the analysis
headerHeader describing the analysis type (e.g., "Non-Linear Static Analysis (64-bit)"). Available while running (from live progress) and after completion (persisted on run).
Static analysis parameters as label→value pairs. Set during analysis initialisation and do not change during execution. e.g., { "Input data:": "4.6 Mb (Mem)", "Degrees of freedom:": "26244", "Load cases:": "55" } Available while running (from live progress) and after completion (persisted on run).
Convergence history from non-linear analysis iterations. Available while running (from live progress) and after completion (persisted on run). Null for linear analyses or before any convergence is reached.
Live progress data from the analysis solver. Captured via Windows messages from SGSolver.EXE to the display proxy window.
AnalysisRunResult
runIdUnique identifier for this run
analysisTypeSPACEGASS analysis types. Values map to the SPACEGASS internal SGAnalysisType IDs.
statusStatus of an analysis run through its lifecycle.
elapsedTimeTotal elapsed time as a formatted string
warningsWarning messages generated during the analysis
errorMessageError message if the run failed
Convergence history from non-linear analysis iterations. Null for linear analyses or if no convergence was recorded.
AnalysisRunStatus
Status of an analysis run through its lifecycle.
AnalysisType
SPACEGASS analysis types. Values map to the SPACEGASS internal SGAnalysisType IDs.
AngleType
Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".
AxesType
Coordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
AxialForceDistribution
Axial force distribution method for buckling analysis.
BucklingEffectiveLength
loadCaseLoad case ID.
modeBuckling mode number.
memberMember key.
pcrCritical buckling load. Unit: Force (see GET /job/units).
lengthMember length. Unit: Length (see GET /job/units).
lyEffective length about Y axis. Unit: Length (see GET /job/units).
lzEffective length about Z axis. Unit: Length (see GET /job/units).
BucklingEffectiveLengthQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
BucklingLoadFactor
loadCaseLoad case ID.
modeBuckling mode number.
warningAnalysis engine warning message (empty if none).
loadFactorBuckling load factor.
toleranceConvergence tolerance.
iterationsNumber of iterations to converge.
nodeAtMaxTransNode key at maximum translation.
transAxisAxis of maximum translation.
nodeAtMaxRotnNode key at maximum rotation.
rotnAxisAxis of maximum rotation.
BucklingLoadFactorQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
BucklingSettings
loadCasesLoad cases to include in the analysis, in SG list format (e.g. "1,3,5-10").
Omit or pass an empty string to include all load cases (default).
Maximum 50 entries (individual numbers and ranges each count as entries).
retainLoadCasesWhether to retain results of other load cases during analysis. When true, results from previously analysed load cases are preserved.
checkNonExistentLoadCasesWhether to check for non-existent load cases referenced in the analysis. When true, warnings are generated for missing load cases.
stabilizeUnrestrainedNodesWhether to stabilize unrestrained nodes during analysis. When true, temporary restraints are added to prevent instability.
tensionCompressionOnlyControls how tension-only and compression-only members are handled during analysis.
reversalIterationsNumber of iterations before disabling reversal of tension/compression-only members. Only relevant when TensionCompressionOnly is Activated.
toleranceConvergence tolerance for the buckling analysis.
upperLimitUpper limit for the load factor in buckling analysis.
lowerLimitLower limit for the load factor in buckling analysis.
modesNumber of buckling modes to compute.
extraIterationsWhether to perform extra iterations for improved mode shape accuracy.
axialForceDistributionAxial force distribution method for buckling analysis.
optimizationMethodOptimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
optimizationAxisAxis used for optimization in analysis.
optimizationXX coordinate or X component of the optimization vector.
optimizationYY coordinate or Y component of the optimization vector.
optimizationZZ coordinate or Z component of the optimization vector.
solverTypeMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
drillingStiffnessDrilling stiffness multiplier for plate elements.
plateTypePlate element formulation type.
theoryEigensolver theory used for buckling analysis.
BucklingSettingsUpdate
loadCasesretainLoadCasescheckNonExistentLoadCasesstabilizeUnrestrainedNodestensionCompressionOnlyControls how tension-only and compression-only members are handled during analysis.
reversalIterationstoleranceupperLimitlowerLimitmodesextraIterationsaxialForceDistributionAxial force distribution method for buckling analysis.
optimizationMethodOptimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
optimizationAxisAxis used for optimization in analysis.
optimizationXoptimizationYoptimizationZsolverTypeMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
drillingStiffnessplateTypePlate element formulation type.
theoryEigensolver theory used for buckling analysis.
BucklingTheory
Eigensolver theory used for buckling analysis.
BulkDeleted
idThe Id of the deleted item.
BulkDeletedBulkResult
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.
BulkError
indexIndex of the item in the original request (0-based).
idEntity Id of the failed item (for single-Id entities).
idsId values of the failed item (for multi-Id entities).
errorError message describing what went wrong.
errorsDetailed SPACE GASS validation messages for this item, when available.
Populated from SpaceGassException.SpaceGassErrors so callers see
the exact field-level diagnostic ("Restraint Code: Valid characters are FRSVPN")
without needing a follow-up call to GET /job/errors/last.
CombinationLoadCaseCreate
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).
CombinationLoadCaseItem
loadCaseComponent load case number.
multiplyingFactorMultiplying factor applied to the component load case (default: 1.0).
CombinationLoadCaseUpdate
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.
ConstraintAxes
Coordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
ConvergenceEntry
iterationSequential iteration number (1-based)
percentageConvergence percentage achieved at this iteration (e.g., 98.177)
DeleteResult
nodesIds of nodes removed (the requested node(s) plus any orphaned by member/plate removal).
membersIds of members removed because one of their end nodes was deleted.
platesIds of plates removed because one of their corner nodes was deleted.
nodeRestraintsNode Ids whose restraint row was removed.
nodeConstraintsSlave-node Ids of constraint rows removed (a constraint is dropped if either its slave or master node is deleted).
memberOffsetsMember Ids whose offset row was removed.
plateCutsIds of plate cuts removed (a cut references two plates and two nodes).
plateStripsIds of plate strips removed (a strip references two plates and two nodes).
Composite keys (case + node) of node loads removed.
Composite keys (case + node) of prescribed displacements removed.
Composite keys (case + node) of lumped mass loads removed.
Composite keys (case + member + subLoad) of member concentrated loads removed.
Composite keys (case + member + subLoad) of member distributed loads removed.
Composite keys (case + member + subLoad) of member distributed moments removed.
Composite keys (case + member) of member prestress loads removed.
Composite keys (case + plate) of plate pressure loads removed.
Composite keys (case + element + elementType) of thermal loads removed.
membersDirectionResetIds of surviving members whose direction reference pointed at a deleted node and was therefore reverted to the default orientation (angle 0). These members were not removed.
platesDirectionResetIds of surviving plates whose direction reference pointed at a deleted node and was therefore reverted to the default orientation (angle 0). These plates were not removed.
totalRemovedTotal number of rows removed across all entity types.
DirectionAxis
Direction axis for member orientation. Maps to SPACE GASS lookup table "Direction Axis".
DirectionSource
Indicates which field defines a member or plate's direction.
Setting one source zeros the other two direction fields.
Values align with SG's SGLookupAxisDirection enum in CommonEnums.vb.
DirectionUpdate
dirAngleDirection angle for orientation. Mutually exclusive with dirNode and dirAxis.
dirNodeDirection node Id for orientation. Mutually exclusive with dirAngle and dirAxis.
dirAxisDirection axis for member orientation. Maps to SPACE GASS lookup table "Direction Axis".
DynamicFrequencySettings
loadCasesLoad cases to include in the analysis, in SG list format (e.g. "1,3,5-10").
Omit or pass an empty string to include all load cases (default).
Maximum 50 entries (individual numbers and ranges each count as entries).
retainLoadCasesWhether to retain results of other load cases during analysis. When true, results from previously analysed load cases are preserved.
checkNonExistentLoadCasesWhether to check for non-existent load cases referenced in the analysis. When true, warnings are generated for missing load cases.
stabilizeUnrestrainedNodesWhether to stabilize unrestrained nodes during analysis. When true, temporary restraints are added to prevent instability.
toleranceConvergence tolerance for the frequency analysis.
upperLimitUpper limit for the frequency range.
lowerLimitLower limit for the frequency range.
frequencyShiftFrequency shift value for the eigensolver.
modesNumber of dynamic modes to compute.
extraIterationsWhether to perform extra iterations for improved mode shape accuracy.
optimizationMethodOptimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
optimizationAxisAxis used for optimization in analysis.
optimizationXX coordinate for optimization.
optimizationYY coordinate for optimization.
optimizationZZ coordinate for optimization.
solverTypeMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
drillingStiffnessDrilling stiffness multiplier for plate elements.
plateTypePlate element formulation type.
DynamicFrequencySettingsUpdate
loadCasesretainLoadCasescheckNonExistentLoadCasesstabilizeUnrestrainedNodestoleranceupperLimitlowerLimitfrequencyShiftmodesextraIterationsoptimizationMethodOptimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
optimizationAxisAxis used for optimization in analysis.
optimizationXoptimizationYoptimizationZsolverTypeMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
drillingStiffnessplateTypePlate element formulation type.
EntityId
Identifies 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.
ErrorList
errorsList of error messages
countNumber of errors
ErrorResponse
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
ErrorSource
Source 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.
ExpandOption
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.
FieldMetadata
jsonNameWire-format property key — the JSON object key a client sees in a GET response body. This is the authoritative public identifier for the field.
dataTypeData type: "Integer" | "Double" | "String" | "Enum" | "Boolean" | "Guid". For enums, see SpaceGassApi.Models.Dtos.Common.FieldMetadataDto.AllowedValues for the permitted values.
unitsResolved unit label based on the current job units — e.g. "mm", "kN", "kN/mm^2". Null when the field has no units.
minMinimum allowed value for this field (as a string; use dataType to determine how to parse it).
Null if no minimum constraint applies.
maxMaximum allowed value for this field (as a string; use dataType to determine how to parse it).
Null if no maximum constraint applies.
defaultDefault value when the field is omitted on create.
maxLengthMaximum length for string fields (characters). Null for non-string fields.
descriptionOptional hint text for this field, useful for UI labels and tooltips. Null when not available.
For enum-backed fields, the permitted values with their wire tokens and display labels.
Use value in request bodies; label is for display only. Null for non-enum fields.
FileOpeningStatus
filePathThe file path that was checked
statusStatus of a job file for opening, based on .sg file and ATS file states
descriptionHuman-readable description of the status
recommendedActionRecommended action to take based on the status
canOpenSafelyWhether the file can be opened safely without force options
Filter
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
nameFilter name (the label shown in the SG UI). Persisted on every sub-filter row in the datasheet — a filter with no active sub-filters has no datasheet rows and effectively does not exist.
Sub-filter carrying a list of node Ids and a node-type categorical filter.
Maps to SG SGFilterType.Nodes.
Sub-filter carrying a list of member Ids and a member-type categorical filter.
Maps to SG SGFilterType.Members.
Sub-filter carrying a list of plate Ids and a plate-type categorical filter.
Maps to SG SGFilterType.Plates.
Sub-filter carrying a list of section Ids. No sub-type — sections
are filtered by Id alone.
Maps to SG SGFilterType.Sections.
Sub-filter carrying a list of plate-thickness values (not Ids).
Maps to SG SGFilterType.Thicknesses.
Sub-filter carrying a list of material Ids. No sub-type.
Maps to SG SGFilterType.Materials.
Sub-filter carrying a list of steel-member Ids and a design-state
categorical filter.
Maps to SG SGFilterType.SteelMembers.
Sub-filter carrying a list of steel-connection Ids. No sub-type
(the SG-side enum slot is unused; UpdateFromDatasheetItem never
reads it back).
Maps to SG SGFilterType.SteelConnections.
Sub-filter carrying a coordinate-range criterion (one axis).
Maps to SG SGFilterType.XAxis / YAxis / ZAxis — three sibling
properties at the parent level use this shape.
Sub-filter carrying a coordinate-range criterion (one axis).
Maps to SG SGFilterType.XAxis / YAxis / ZAxis — three sibling
properties at the parent level use this shape.
Sub-filter carrying a coordinate-range criterion (one axis).
Maps to SG SGFilterType.XAxis / YAxis / ZAxis — three sibling
properties at the parent level use this shape.
Sub-filter carrying a list of plate-strip Ids and a strip-type
categorical filter.
Maps to SG SGFilterType.PlateStrip.
Sub-filter carrying a list of plate-cut Ids and a cut-type
categorical filter.
Maps to SG SGFilterType.PlateCut.
FilterAxisRange
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
limitLowLower bound of the range. Unit: Length (see GET /job/units).
limitHighUpper bound of the range. Unit: Length (see GET /job/units).
lowInclusiveWhether the lower bound is inclusive (true: value >= limitLow)
or strict (false: value > limitLow).
highInclusiveWhether the upper bound is inclusive (true: value <= limitHigh)
or strict (false: value < limitHigh).
FilterAxisRangeUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
limitLowLower bound of the range. Unit: Length.
limitHighUpper bound of the range. Unit: Length.
lowInclusiveWhether the lower bound is inclusive.
highInclusiveWhether the upper bound is inclusive.
FilterBulkResult
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.
FilterCreate
nameFilter name. Required.
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.
Partial update for the Nodes sub-filter.
Partial update for the Members sub-filter.
Partial update for the Plates sub-filter.
Partial update for the Sections sub-filter.
Partial update for the Plate Thicknesses sub-filter.
Partial update for the Materials sub-filter.
Partial update for the Steel Members sub-filter.
Partial update for the Steel Connections sub-filter.
Partial update for an axis-range sub-filter (X, Y or Z).
Partial update for an axis-range sub-filter (X, Y or Z).
Partial update for an axis-range sub-filter (X, Y or Z).
Partial update for the Plate Strips sub-filter.
Partial update for the Plate Cuts sub-filter.
FilterMaterials
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
materialsMaterial Ids in SG list format. Empty string means no Id criterion.
FilterMaterialsUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
materialsFilterMemberType
Member type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_MemberType verbatim — richer than the
entity-property SpaceGassApi.Models.Enums.MemberType because the filter UI surfaces
member-state categories (Duplicated, Rotated, Along axis, FreeEnd, ...)
that are not member-create options.
FilterMembers
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
membersMember Ids in SG list format. Empty string means no Id criterion.
memberTypeMember type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_MemberType verbatim — richer than the
entity-property SpaceGassApi.Models.Enums.MemberType because the filter UI surfaces
member-state categories (Duplicated, Rotated, Along axis, FreeEnd, ...)
that are not member-create options.
FilterMembersUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
membersmemberTypeMember type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_MemberType verbatim — richer than the
entity-property SpaceGassApi.Models.Enums.MemberType because the filter UI surfaces
member-state categories (Duplicated, Rotated, Along axis, FreeEnd, ...)
that are not member-create options.
FilterMode
Whether a sub-filter block includes or excludes matching entities.
FilterNodeType
Node type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_NodeType enum verbatim — integer values
and labels match SG so the filter datasheet round-trips cleanly.
Richer than the entity-property NodeType (which only has
All / Restrained) because the filter UI surfaces every
fine-grained boundary-condition flavour.
FilterNodes
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
nodesNode Ids in SG list format (e.g. "1,5-10,15"). Empty string means no Id criterion.
nodeTypeNode type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_NodeType enum verbatim — integer values
and labels match SG so the filter datasheet round-trips cleanly.
Richer than the entity-property NodeType (which only has
All / Restrained) because the filter UI surfaces every
fine-grained boundary-condition flavour.
FilterNodesUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
nodesnodeTypeNode type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_NodeType enum verbatim — integer values
and labels match SG so the filter datasheet round-trips cleanly.
Richer than the entity-property NodeType (which only has
All / Restrained) because the filter UI surfaces every
fine-grained boundary-condition flavour.
FilterPlateCutType
Plate-cut categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateCutType verbatim (identical
members to SpaceGassApi.Models.Enums.Filters.FilterPlateStripType at the SG layer, but
kept as a distinct type so future SG additions don't require an
API refactor).
FilterPlateCuts
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
plateCutsPlate-cut Ids in SG list format. Empty string means no Id criterion.
plateCutTypePlate-cut categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateCutType verbatim (identical
members to SpaceGassApi.Models.Enums.Filters.FilterPlateStripType at the SG layer, but
kept as a distinct type so future SG additions don't require an
API refactor).
FilterPlateCutsUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
plateCutsplateCutTypePlate-cut categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateCutType verbatim (identical
members to SpaceGassApi.Models.Enums.Filters.FilterPlateStripType at the SG layer, but
kept as a distinct type so future SG additions don't require an
API refactor).
FilterPlateStripType
Plate-strip categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateStripType verbatim.
FilterPlateStrips
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
plateStripsPlate-strip Ids in SG list format. Empty string means no Id criterion.
plateStripTypePlate-strip categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateStripType verbatim.
FilterPlateStripsUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
plateStripsplateStripTypePlate-strip categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateStripType verbatim.
FilterPlateThicknesses
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
plateThicknessesPlate thicknesses to match against. Values are in the model's Length unit. Maximum 10 values; empty array means no thickness criterion.
FilterPlateThicknessesUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
plateThicknessesPlate-thickness values to match. Unit: Length (see GET /job/units).
Maximum 10 values. Supplying an empty array clears the criterion.
FilterPlateType
Plate type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateType verbatim. Richer than
the entity-property SpaceGassApi.Models.Enums.PlateType / SpaceGassApi.Models.Enums.PlateTheory
because the filter surface includes validity / orientation states.
FilterPlates
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
platesPlate Ids in SG list format. Empty string means no Id criterion.
plateTypePlate type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateType verbatim. Richer than
the entity-property SpaceGassApi.Models.Enums.PlateType / SpaceGassApi.Models.Enums.PlateTheory
because the filter surface includes validity / orientation states.
FilterPlatesUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
platesplateTypePlate type categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_PlateType verbatim. Richer than
the entity-property SpaceGassApi.Models.Enums.PlateType / SpaceGassApi.Models.Enums.PlateTheory
because the filter surface includes validity / orientation states.
FilterSections
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
sectionsSection Ids in SG list format. Empty string means no Id criterion.
FilterSectionsUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
sectionsFilterSteelConnections
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
steelConnectionsSteel-connection Ids in SG list format. Empty string means no Id criterion.
FilterSteelConnectionsUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
steelConnectionsFilterSteelMemberType
Steel-member design-state categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_SteelMemberTypes verbatim — note SG's enum
name is plural; the API name is singular for consistency with the other
Filter*Type enums.
FilterSteelMembers
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
steelMembersSteel-member Ids in SG list format. Empty string means no Id criterion.
steelMemberTypeSteel-member design-state categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_SteelMemberTypes verbatim — note SG's enum
name is plural; the API name is singular for consistency with the other
Filter*Type enums.
FilterSteelMembersUpdate
isActiveWhether this sub-filter participates in the filter.
modeWhether a sub-filter block includes or excludes matching entities.
steelMemberssteelMemberTypeSteel-member design-state categories available as a Filter resource criterion.
Mirrors SG's SGItemFilter_SteelMemberTypes verbatim — note SG's enum
name is plural; the API name is singular for consistency with the other
Filter*Type enums.
FilterUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
nameFilter name. Null to keep the current name.
Partial update for the Nodes sub-filter.
Partial update for the Members sub-filter.
Partial update for the Plates sub-filter.
Partial update for the Sections sub-filter.
Partial update for the Plate Thicknesses sub-filter.
Partial update for the Materials sub-filter.
Partial update for the Steel Members sub-filter.
Partial update for the Steel Connections sub-filter.
Partial update for an axis-range sub-filter (X, Y or Z).
Partial update for an axis-range sub-filter (X, Y or Z).
Partial update for an axis-range sub-filter (X, Y or Z).
Partial update for the Plate Strips sub-filter.
Partial update for the Plate Cuts sub-filter.
FrictionNormalAxis
Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
FrictionNormalDirection
Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
Job
Read DTO for job headings (text properties).
Read DTO for job-level settings. Groups configuration properties that apply to the job as a whole.
Unit settings for the current job.
JobFile
nameFile name only (e.g. "Bridge_Design_v2.sg").
pathFull file path (e.g. "C:/Projects/Bridge_Design_v2.sg").
sourceEnum representing the source of a job file
JobFileOpeningStatus
Status of a job file for opening, based on .sg file and ATS file states
JobFilePreviewInfo
filePathThe file path that was queried
fileNameThe file name without path
fileSizeBytesFile size in bytes
lastModifiedLast modified date of the file
versionThe SPACE GASS version that was used to save the file
licenseeNameThe licensee name that was used when saving the file
designerThe designer name when the file was saved
projectHeadingThe project heading/title
jobHeadingThe job heading/title
notesJob notes
dateSavedDate and time the file was saved
computerNameComputer name where the file was saved
userNameUser name who saved the file
compressionCompression type used when saving the file
hasPreviewImageWhether a preview image is available
previewImageBase64The preview image as a base64-encoded PNG string. Only populated if includeImage parameter is true.
previewImageDataUrlThe preview image as a Data URL (data:image/png;base64,...). Can be used directly in HTML img src attribute. Only available if includeImage parameter is true and image exists.
JobFileSource
Enum representing the source of a job file
JobForceAccessOption
Options for forcing access to a job file that is in a locked or unsaved state. Used when temporary files exist from a previous session that was not properly closed.
JobHeadings
projectHeadingProject heading
headingJob heading
designerInitialsDesigner initials
notesJob notes
JobHeadingsUpdate
projectHeadingProject heading. Omit to leave unchanged.
headingJob heading. Omit to leave unchanged.
designerInitialsDesigner initials. Omit to leave unchanged.
notesJob notes. Omit to leave unchanged.
JobSettings
verticalAxisVertical (gravity) axis direction for the job. Determines which global axis is treated as the vertical/gravity direction. Maps to SPACE GASS CommonEnums.SGVerticalAxis (YAxis=2, ZAxis=3). Only YAxis and ZAxis are valid choices in SPACE GASS.
JobState
isOpenWhether a job is currently loaded in memory.
isNewWhether this is a new job that has never been saved. If true, provide a filePath when calling POST /save.
isModifiedWhether the job has unsaved modifications.
openedAtWhen the job was opened (null if not open).
File information for the current job.
JobStatus
Read DTO for job responses. Model counts and file state are available via GET /job/status (JobStatusDto).
Current session/file state of the job.
Summary counts of structural entities in the current job — geometry, boundary conditions, and section/material properties.
Summary counts of load-related entities in the current job — load case management and all applied load types.
Summary of which analysis types have stored results for the current job. Values are read from Fortran result-file headers on disk — a lightweight header-only read that does not load result datasheets.
Summary of which steel design types have stored results for the current job. Values are read from Fortran result-file headers on disk — a lightweight header-only read that does not load result datasheets.
accessModeCurrent operational mode of the API.
LastError
errorThe last error message (null if no errors)
hasErrorWhether there is an error
LengthUnit
Length unit. Members mirror SPACE GASS SGLength
(NetCommon/CommonEnums.vb); integer values and identifiers must stay in
lock-step with it. The System.ComponentModel.DescriptionAttribute carries the display
label (mirrors gcUNITS_LABEL_*).
LicenseStatus
isRegisteredTrue when this machine has a SPACE GASS registration the API supports (TitanCloud or Titan LM). False indicates either an unsupported lock type (e.g. legacy SGREG.DAT registration) or no registration at all. Always check this before SpaceGassApi.Models.Dtos.License.LicenseStatusDto.IsLicensed: an unregistered API is blocked at the registration step, before any license acquire is attempted.
registrationTypeOutcome of probing the machine for a SPACE GASS registration.
Mirrors the precedence used by desktop SPACE GASS in
NETLicenses\Licenses.vb::RegistrationSetupCheck: legacy SGREG.DAT
short-circuits before any Titan-type probing, then TitanCloud, then Titan LM.
registrationDetailHuman-readable explanation of the registration state. Always populated. For TitanCloud / TitanLM it confirms the registration is active; for Unsupported / Unregistered it explains what the operator should do to fix it.
isLicensedTrue when a validated licence session is active. Independent of the
read/write seat — true even in ReadOnly / session-only mode.
isRoamingTrue when the active Titan LM session is backed by an offline roaming licence file (no live LM server connection). Always false for TitanCloud and for non-roaming Titan LM. Operator-facing signal so dashboards can tell which path is in use.
organizationCompany or organisation name from the license server.
licenseIdLicense ID from the license server (the company registration number).
errorMessageLast error message when the license is not active; null otherwise.
isJobOpenWhether a job is currently open (Tier 2 SPACE GASS core held).
jobOpenedAtUTC timestamp when the current job was opened (and the SPACE GASS
licence seat became active), or null when no job is open.
activeModulesNames of module licenses currently active for this API instance.
entitlementsNames of modules this company / user is entitled to (has purchased), whether or not they are currently acquired. Analogous to the SPACE GASS desktop "Help > About" dialog's licensed-module list. Empty if the backend query failed (see SpaceGassApi.Models.Dtos.License.LicenseStatusDto.ErrorMessage).
LoadAxes
Coordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
LoadCase
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.
LoadCaseBulkResult
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.
LoadCaseCreate
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).
LoadCaseGroup
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
titleGroup title.
loadCaseListComma-separated list of load case numbers and ranges (e.g., "1,3,5-10").
LoadCaseGroupBulkResult
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.
LoadCaseGroupCreate
titleGroup title.
loadCaseList^[\d,\- ]+$ · requiredComma-separated list of load case numbers and ranges (e.g., "1,3,5-10"). Valid characters: digits, commas, hyphens, spaces.
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.
LoadCaseGroupUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
titleGroup title.
loadCaseList^[\d,\- ]+$Comma-separated list of load case numbers and ranges (e.g., "1,3,5-10").
LoadCaseModesWarning
loadCaseLoad case Id this entry applies to.
modesMode numbers the caller requested but the analysis did not produce for this case. SG list-format string.
LoadCaseType
Type of load case in the structural model. Read-only — computed internally by SPACE GASS based on assigned loads.
LoadCaseUpdate
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).
LoadCategory
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
titleCategory title.
sourceSource (read-only, set automatically by the application).
versionVersion (read-only, set automatically by the application).
usernameUsername (read-only, set automatically by the application).
notesNotes (supports multi-line text).
LoadCategoryBulkResult
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.
LoadCategoryCreate
titleCategory 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.
notesNotes (supports multi-line text).
LoadCategoryUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
titleCategory title.
notesNotes (supports multi-line text).
LoadPositionUnits
Position units for member load placement along a member. Maps to SPACE GASS lookup table "Load Units".
LoadingType
Loading type for non-linear static analysis. Only used for non-linear static analysis.
LoadsSummary
loadCasesNumber of primary load cases defined.
loadCaseGroupsNumber of load case groups.
loadCategoriesNumber of load categories (e.g. dead, live, wind).
combinationLoadCasesNumber of combination load cases.
nodeLoadsNumber of point loads applied to nodes.
memberConcentratedLoadsNumber of concentrated (point) loads applied to members.
memberDistributedLoadsNumber of distributed (UDL/trapezoidal) loads applied to members.
memberTorsionLoadsNumber of torsion loads applied to members.
memberPrestressLoadsNumber of prestress loads applied to members.
plateLoadsNumber of pressure/distributed loads applied to plates.
prescribedDisplacementsNumber of prescribed displacement constraints.
selfWeightLoadsNumber of self-weight load definitions.
thermalLoadsNumber of thermal (temperature) load definitions.
lumpedMassLoadsNumber of lumped mass definitions for dynamic analysis.
LumpedMassLoad
nodeThe node number this lumped mass is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
tmxTranslational mass in the global X direction.
tmyTranslational mass in the global Y direction.
tmzTranslational mass in the global Z direction.
rmxRotational mass inertia about the global X axis.
rmyRotational mass inertia about the global Y axis.
rmzRotational mass inertia about the global Z axis.
LumpedMassLoadBulkResult
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.
LumpedMassLoadCreate
loadCaseThe load case number to create this load in.
nodeThe node number to apply this lumped mass to.
loadCategoryLoad category for grouping/organization.
tmxTranslational mass in the global X direction.
tmyTranslational mass in the global Y direction.
tmzTranslational mass in the global Z direction.
rmxRotational mass inertia about the global X axis.
rmyRotational mass inertia about the global Y axis.
rmzRotational mass inertia about the global Z axis.
LumpedMassLoadKey
loadCaseThe load case number.
nodeThe node number.
LumpedMassLoadKeyBulkResult
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.
LumpedMassLoadUpdate
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
nodeThe node number.
tmxTranslational mass in the global X direction.
tmyTranslational mass in the global Y direction.
tmzTranslational mass in the global Z direction.
rmxRotational mass inertia about the global X axis.
rmyRotational mass inertia about the global Y axis.
rmzRotational mass inertia about the global Z axis.
MassDensityUnit
Mass density unit. Members mirror SPACE GASS SgMassDensity.
Material
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
nameMaterial name.
youngsModulusYoung's modulus.
poissonsRatioPoisson's ratio (unitless).
massDensityMass density.
thermalCoeffThermal expansion coefficient.
concreteStrengthConcrete compressive strength.
sourceIndicates whether a section or material was user-defined or imported from a library.
libraryLibrary name. Empty for user-defined materials.
MaterialBulkResult
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.
MaterialLibraryCreate
nameMaterial item name within the library.
libraryLibrary name.
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.
MaterialStrengthUnit
Material strength unit (yield stress, ultimate stress, etc.). Members mirror
SPACE GASS SgMaterialStrength.
MaterialUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
nameMaterial name.
youngsModulusYoung's modulus. Must be greater than zero if provided.
poissonsRatioPoisson's ratio (unitless).
massDensityMass density. Must be greater than zero if provided.
thermalCoeffThermal expansion coefficient.
concreteStrengthConcrete compressive strength.
MaterialUserCreate
nameMaterial name.
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.
youngsModulusYoung's modulus. Must be greater than zero.
poissonsRatioPoisson's ratio (unitless).
massDensityMass density. Must be greater than zero.
thermalCoeffThermal expansion coefficient.
concreteStrengthConcrete compressive strength.
MatrixType
Stiffness matrix type for non-linear static analysis. Only used for non-linear static analysis.
Member
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
nodeANode at end A of the member.
nodeBNode at end B of the member.
typeMember element type. Determines the structural behavior of the member. Maps to SPACE GASS lookup table "Member Type".
sectionSection number assigned to this member.
materialMaterial number assigned to this member.
cableLengthCable length (for Cable type members). Unit: Length (see GET /job/units).
gapTensionLimitGap tension limit (for Gap type members). Unit: Force (see GET /job/units).
gapCompressionLimitGap compression limit (for Gap type members). Unit: Force (see GET /job/units).
fuseTensionLimitFuse tension limit (for Fuse type members). Unit: Force (see GET /job/units).
fuseCompressionLimitFuse compression limit (for Fuse type members). Unit: Force (see GET /job/units).
DTO for reading member direction data.
Direction defines the orientation of the member's local coordinate system.
Always present on every member — the parent MemberDto's id is authoritative.
DTO for reading member release data.
Releases define fixity codes and spring stiffness at each end of a member.
Always present on every member, so the owning member Id
is not duplicated here — the parent MemberDto's id is authoritative when
returned inline, and the route parameter is authoritative on the standalone endpoint.
hasOffsetsTrue when this member has an explicit offsets row defined (rigid end zones at A/B).
False means the member has no offsets (end rigid zones zero).
Use ?expand=all to include the full offsets object.
DTO for reading member offset data. Offsets define rigid end zones at each end of a member. Top-level entity attribute keyed on the parent member.
MemberBulkResult
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.
MemberConcentratedLoad
memberThe member number this load is applied to.
subLoadThe auto-assigned sub-load number within the member+case combination.
loadCaseThe 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".
positionPosition of the load along the member.
fxForce in the local/global X direction.
fyForce in the local/global Y direction.
fzForce in the local/global Z direction.
mxMoment about the local/global X axis.
myMoment about the local/global Y axis.
mzMoment about the local/global Z axis.
MemberConcentratedLoadBulkResult
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.
MemberConcentratedLoadCreate
loadCaseThe 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".
positionPosition of the load along the member.
fxForce in the local/global X direction.
fyForce in the local/global Y direction.
fzForce in the local/global Z direction.
mxMoment about the local/global X axis.
myMoment about the local/global Y axis.
mzMoment about the local/global Z axis.
MemberConcentratedLoadKey
loadCaseThe load case number.
memberThe member number.
subLoadThe sub-load number.
MemberConcentratedLoadKeyBulkResult
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.
MemberConcentratedLoadUpdate
loadCaseThe 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".
positionPosition of the load along the member.
fxForce in the local/global X direction.
fyForce in the local/global Y direction.
fzForce in the local/global Z direction.
mxMoment about the local/global X axis.
myMoment about the local/global Y axis.
mzMoment about the local/global Z axis.
MemberCreate
nodeANode at end A of the member.
nodeBNode at end B of the member.
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.
typeMember element type. Determines the structural behavior of the member. Maps to SPACE GASS lookup table "Member Type".
sectionSection number assigned to this member.
materialMaterial number assigned to this member.
DTO for updating the direction on a member or plate (partial-update semantics).
cableLengthCable length (for Cable type members). Unit: Length (see GET /job/units).
gapTensionLimitGap tension limit (for Gap type members). Unit: Force (see GET /job/units).
gapCompressionLimitGap compression limit (for Gap type members). Unit: Force (see GET /job/units).
fuseTensionLimitFuse tension limit (for Fuse type members). Unit: Force (see GET /job/units).
fuseCompressionLimitFuse compression limit (for Fuse type members). Unit: Force (see GET /job/units).
DTO for partial updates to a member release. Only fields included in the request are updated; omit a field to keep its current value.
MemberDirection
sourceIndicates which field defines a member or plate's direction.
Setting one source zeros the other two direction fields.
Values align with SG's SGLookupAxisDirection enum in CommonEnums.vb.
dirAngleDirection angle for member orientation.
dirNodeDirection node for member orientation.
dirAxisDirection axis for member orientation. Maps to SPACE GASS lookup table "Direction Axis".
MemberDistributedLoad
memberThe member number this load is applied to.
subLoadThe auto-assigned sub-load number within the member+case combination.
loadCaseThe 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.
MemberDistributedLoadBulkResult
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.
MemberDistributedLoadCreate
loadCaseThe 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.
MemberDistributedLoadKey
loadCaseThe load case number.
memberThe member number.
subLoadThe sub-load number.
MemberDistributedLoadKeyBulkResult
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.
MemberDistributedLoadUpdate
loadCaseThe 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.
MemberDistributedMoment
memberThe member number this load is applied to.
subLoadThe auto-assigned sub-load number within the member+case combination.
loadCaseThe 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 moment along the member.
finishPositionFinish position of the distributed moment along the member.
mxStartDistributed moment intensity about X axis at the start position.
mxFinishDistributed moment intensity about X axis at the finish position.
myStartDistributed moment intensity about Y axis at the start position.
myFinishDistributed moment intensity about Y axis at the finish position.
mzStartDistributed moment intensity about Z axis at the start position.
mzFinishDistributed moment intensity about Z axis at the finish position.
MemberDistributedMomentBulkResult
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.
MemberDistributedMomentCreate
loadCaseThe 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 moment along the member.
finishPositionFinish position of the distributed moment along the member.
mxStartDistributed moment intensity about X axis at the start position.
mxFinishDistributed moment intensity about X axis at the finish position.
myStartDistributed moment intensity about Y axis at the start position.
myFinishDistributed moment intensity about Y axis at the finish position.
mzStartDistributed moment intensity about Z axis at the start position.
mzFinishDistributed moment intensity about Z axis at the finish position.
MemberDistributedMomentKey
loadCaseThe load case number.
memberThe member number.
subLoadThe sub-load number.
MemberDistributedMomentKeyBulkResult
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.
MemberDistributedMomentUpdate
loadCaseThe 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 moment along the member.
finishPositionFinish position of the distributed moment along the member.
mxStartDistributed moment intensity about X axis at the start position.
mxFinishDistributed moment intensity about X axis at the finish position.
myStartDistributed moment intensity about Y axis at the start position.
myFinishDistributed moment intensity about Y axis at the finish position.
mzStartDistributed moment intensity about Z axis at the start position.
mzFinishDistributed moment intensity about Z axis at the finish position.
MemberEndForce
loadCaseLoad case ID.
memberMember key.
nodeNode keys at start and end of member.
fxAxial force at each node. Unit: Force (see GET /job/units).
fyShear force in Y at each node. Unit: Force (see GET /job/units).
fzShear force in Z at each node. Unit: Force (see GET /job/units).
mxTorsion moment at each node. Unit: Moment (see GET /job/units).
myBending moment about Y at each node. Unit: Moment (see GET /job/units).
mzBending moment about Z at each node. Unit: Moment (see GET /job/units).
finalCableLengthFinal cable length at each node. Unit: Length (see GET /job/units).
MemberEndForceQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
MemberIntermediateDisplacement
loadCaseLoad case ID.
memberMember key.
stationStation index at each output point.
locationDistance along member at each station. Unit: Length (see GET /job/units).
txGlobalGlobal translational X displacement at each station. Unit: Translation (see GET /job/units).
tyGlobalGlobal translational Y displacement at each station. Unit: Translation (see GET /job/units).
tzGlobalGlobal translational Z displacement at each station. Unit: Translation (see GET /job/units).
txLocalLocal translational X displacement at each station. Unit: Translation (see GET /job/units).
tyLocalLocal translational Y displacement at each station. Unit: Translation (see GET /job/units).
tzLocalLocal translational Z displacement at each station. Unit: Translation (see GET /job/units).
MemberIntermediateDisplacementQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
MemberIntermediateForce
loadCaseLoad case ID.
memberMember key.
stationStation index at each output point.
locationDistance along member at each station. Unit: Length (see GET /job/units).
fxAxial force at each station. Unit: Force (see GET /job/units).
fyShear force in Y at each station. Unit: Force (see GET /job/units).
fzShear force in Z at each station. Unit: Force (see GET /job/units).
mxTorsion moment at each station. Unit: Moment (see GET /job/units).
myBending moment about Y at each station. Unit: Moment (see GET /job/units).
mzBending moment about Z at each station. Unit: Moment (see GET /job/units).
MemberIntermediateForceQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
MemberOffset
memberThe member Id this offset applies to.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
MemberOffsetBulkResult
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.
MemberOffsetCreate
memberThe member Id to create the offset for. Required in the request body.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
MemberOffsetUpdate
memberThe member Id whose offset is being updated. Required for bulk PATCH; ignored for single-member PATCH (route value wins).
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
MemberPrestressLoad
memberThe member number this prestress is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
prestressPrestress force applied to the member.
MemberPrestressLoadBulkResult
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.
MemberPrestressLoadCreate
loadCaseThe load case number to create this load in.
memberThe member number to apply this prestress to.
loadCategoryLoad category for grouping/organization.
prestressPrestress force applied to the member.
MemberPrestressLoadKey
loadCaseThe load case number.
memberThe member number.
MemberPrestressLoadKeyBulkResult
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.
MemberPrestressLoadUpdate
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
memberThe member number.
prestressPrestress force applied to the member.
MemberRelease
fixityCodeAtAFixity code at end A of the member.
fixityCodeAtBFixity code at end B of the member.
txStiffnessAtATranslational X spring stiffness at end A. Unit: Force/Length (see GET /job/units).
tyStiffnessAtATranslational Y spring stiffness at end A. Unit: Force/Length (see GET /job/units).
tzStiffnessAtATranslational Z spring stiffness at end A. Unit: Force/Length (see GET /job/units).
rxStiffnessAtARotational X spring stiffness at end A. Unit: Moment/Radian (see GET /job/units).
ryStiffnessAtARotational Y spring stiffness at end A. Unit: Moment/Radian (see GET /job/units).
rzStiffnessAtARotational Z spring stiffness at end A. Unit: Moment/Radian (see GET /job/units).
txStiffnessAtBTranslational X spring stiffness at end B. Unit: Force/Length (see GET /job/units).
tyStiffnessAtBTranslational Y spring stiffness at end B. Unit: Force/Length (see GET /job/units).
tzStiffnessAtBTranslational Z spring stiffness at end B. Unit: Force/Length (see GET /job/units).
rxStiffnessAtBRotational X spring stiffness at end B. Unit: Moment/Radian (see GET /job/units).
ryStiffnessAtBRotational Y spring stiffness at end B. Unit: Moment/Radian (see GET /job/units).
rzStiffnessAtBRotational Z spring stiffness at end B. Unit: Moment/Radian (see GET /job/units).
MemberReleaseUpdate
fixityCodeAtAFixity code at end A of the member.
fixityCodeAtBFixity code at end B of the member.
txStiffnessAtATranslational X spring stiffness at end A. Unit: Force/Length (see GET /job/units).
tyStiffnessAtATranslational Y spring stiffness at end A. Unit: Force/Length (see GET /job/units).
tzStiffnessAtATranslational Z spring stiffness at end A. Unit: Force/Length (see GET /job/units).
rxStiffnessAtARotational X spring stiffness at end A. Unit: Moment/Radian (see GET /job/units).
ryStiffnessAtARotational Y spring stiffness at end A. Unit: Moment/Radian (see GET /job/units).
rzStiffnessAtARotational Z spring stiffness at end A. Unit: Moment/Radian (see GET /job/units).
txStiffnessAtBTranslational X spring stiffness at end B. Unit: Force/Length (see GET /job/units).
tyStiffnessAtBTranslational Y spring stiffness at end B. Unit: Force/Length (see GET /job/units).
tzStiffnessAtBTranslational Z spring stiffness at end B. Unit: Force/Length (see GET /job/units).
rxStiffnessAtBRotational X spring stiffness at end B. Unit: Moment/Radian (see GET /job/units).
ryStiffnessAtBRotational Y spring stiffness at end B. Unit: Moment/Radian (see GET /job/units).
rzStiffnessAtBRotational Z spring stiffness at end B. Unit: Moment/Radian (see GET /job/units).
MemberStress
loadCaseLoad case ID.
memberMember key.
stationStation index at each output point.
positionFractional position along member (0.0 to 1.0).
nAxial stress at each station. Unit: Stress (see GET /job/units).
vyShear stress in Y at each station. Unit: Stress (see GET /job/units).
vzShear stress in Z at each station. Unit: Stress (see GET /job/units).
mxTorsion stress at each station. Unit: Stress (see GET /job/units).
myTopBending stress about Y (top fibre) at each station. Unit: Stress (see GET /job/units).
myBtmBending stress about Y (bottom fibre) at each station. Unit: Stress (see GET /job/units).
mzTopBending stress about Z (top fibre) at each station. Unit: Stress (see GET /job/units).
mzBtmBending stress about Z (bottom fibre) at each station. Unit: Stress (see GET /job/units).
nMyTopCombined axial + My stress (top fibre) at each station. Unit: Stress (see GET /job/units).
nMyBtmCombined axial + My stress (bottom fibre) at each station. Unit: Stress (see GET /job/units).
nMzTopCombined axial + Mz stress (top fibre) at each station. Unit: Stress (see GET /job/units).
nMzBtmCombined axial + Mz stress (bottom fibre) at each station. Unit: Stress (see GET /job/units).
MemberStressQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
MemberType
Member element type. Determines the structural behavior of the member. Maps to SPACE GASS lookup table "Member Type".
MemberUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
nodeANode at end A of the member.
nodeBNode at end B of the member.
typeMember element type. Determines the structural behavior of the member. Maps to SPACE GASS lookup table "Member Type".
sectionSection number assigned to this member.
materialMaterial number assigned to this member.
DTO for updating the direction on a member or plate (partial-update semantics).
cableLengthCable length (for Cable type members). Unit: Length (see GET /job/units).
gapTensionLimitGap tension limit (for Gap type members). Unit: Force (see GET /job/units).
gapCompressionLimitGap compression limit (for Gap type members). Unit: Force (see GET /job/units).
fuseTensionLimitFuse tension limit (for Fuse type members). Unit: Force (see GET /job/units).
fuseCompressionLimitFuse compression limit (for Fuse type members). Unit: Force (see GET /job/units).
DTO for partial updates to a member release. Only fields included in the request are updated; omit a field to keep its current value.
ModeShape
loadCaseLoad case ID.
modeMode number.
nodeNode keys.
txTranslational X displacement at each node. Unit: Translation (see GET /job/units).
tyTranslational Y displacement at each node. Unit: Translation (see GET /job/units).
tzTranslational Z displacement at each node. Unit: Translation (see GET /job/units).
rxRotational X displacement at each node. Unit: Rotation (see GET /job/units).
ryRotational Y displacement at each node. Unit: Rotation (see GET /job/units).
rzRotational Z displacement at each node. Unit: Rotation (see GET /job/units).
ModeShapeQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
MomentUnit
Moment unit. Members mirror SPACE GASS SgMoment.
MovingLoadCombination
scenarioFactorFactor applied to the scenario's generated load cases in the combination.
combineWithLoadCaseThe load case combined with the scenario's generated cases.
loadCaseFactorFactor applied to SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadCombinationDto.CombineWithLoadCase in the combination.
startingCombinationCaseThe first combination case number generated for this combination ("Starting Comb Case" in the dialog).
MovingLoadElementsToLoad
membersThe members selected to receive moving loads, in SG list-string format.
platesThe plates selected to receive moving loads, in SG list-string format.
MovingLoadElementsToLoadUpdate
membersReplacement member selection in SG list-string format. Omit to keep current.
platesReplacement plate selection in SG list-string format. Omit to keep current.
MovingLoadGenerateRequest
loadCategoryExisting load category Id to tag the generated load cases with.
MovingLoadGenerationResult
generatedLoadCaseIdsThe Ids of all moving-load load cases present after generation.
generatedGroupsThe names of the load-case selection groups created for the generated cases.
MovingLoadPressure
idThe item Id.
nameThe pressure name. Unique across all pressures.
widthPatch width, perpendicular to the travel path.
lengthPatch length, along the travel path.
pxPressure component along global X.
pyPressure component along global Y.
pzPressure component along global Z.
loadSpacingSpacing between discretised load points within the patch.
MovingLoadPressureBulkResult
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.
MovingLoadPressureCreate
idThe Id to assign to the new item.
nameThe pressure name. Must be unique across all pressures.
widthPatch width, perpendicular to the travel path.
lengthPatch length, along the travel path. 0 means stationary, full-length.
pxPressure component along global X.
pyPressure component along global Y.
pzPressure component along global Z.
loadSpacingSpacing between discretised load points within the patch.
MovingLoadPressureUpdate
idThe Id of the item to update.
nameReplacement name. Must remain unique. Omit to keep current.
widthReplacement patch width. Omit to keep current.
lengthReplacement patch length (0 = stationary, full-length). Omit to keep current.
pxReplacement global-X pressure. Omit to keep current.
pyReplacement global-Y pressure. Omit to keep current.
pzReplacement global-Z pressure. Omit to keep current.
loadSpacingReplacement load spacing. Omit to keep current.
MovingLoadScenario
idThe item Id.
nameThe scenario name. Unique across all scenarios.
includeWhether this scenario is included when load cases are generated.
startingLoadCaseThe first load case number generated for this scenario.
timeIntervalTime between generated snapshots as a vehicle/pressure travels.
hasLoadsWhether the scenario has any load rows.
hasCombinationsWhether the scenario has any combination rows.
The scenario's load rows. Populated only when expand=All; otherwise omitted.
The scenario's combination rows. Populated only when expand=All; otherwise omitted.
MovingLoadScenarioBulkResult
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.
MovingLoadScenarioCreate
idThe Id to assign to the new item.
nameThe scenario name. Must be unique across all scenarios.
includeWhether this scenario is included when load cases are generated.
startingLoadCaseThe first load case number generated for this scenario.
timeIntervalTime between generated snapshots.
The scenario's load rows, in order. Optional — supply to create the scenario and its loads in one call; omit to set them later via PUT .../{id}/loads.
The scenario's combination rows. Optional — supply inline, or omit and set them later via PUT .../{id}/combinations.
MovingLoadScenarioLoad
loadTypeDiscriminates a moving-load scenario load between a vehicle run and a pressure run.
Mirrors SPACE GASS MLScenarioLoadType (NETSpaceGass/Loads/Moving/MLCommon.vb).
vehicleIdThe vehicle Id this load uses.
pressureIdThe pressure Id this load uses.
travelPathIdThe travel-path Id this load travels along.
speedTravel speed along the path.
delayDelay before the vehicle/pressure starts moving.
startPositionStarting position measured along the travel path.
loadFactorMultiplier applied to the load magnitudes.
laneFactorLane factor applied to the load.
dynamicFactorDynamic amplification factor applied to the load.
generateStationaryLcControls which load cases a scenario load's stationary loads are generated into.
Mirrors SPACE GASS MLGenerateStationary (NETSpaceGass/Loads/Moving/MLCommon.vb).
MovingLoadScenarioUpdate
idThe Id of the item to update.
nameReplacement scenario name. Must remain unique. Omit to keep current.
includeWhether the scenario is included in generation. Omit to keep current.
startingLoadCaseThe first generated load case number. Omit to keep current.
timeIntervalTime between generated snapshots (seconds). Omit to keep current.
MovingLoadSettings
retainLoadsRetain generated loads for deselected scenarios.
applyToClosestMemberApply member loads to the closest member only.
ignoreLoadsOnOneMemberIgnore loads that transfer load to just one member.
checkVerticalProximityCheck vertical proximity when applying loads to members.
verticalProximityMaximum vertical distance between a load and a member for the load to be applied.
keepLoadsWithinTravelPathKeep loads entirely within the ends of the travel path (crane-beam behaviour).
ignoreOutsideLoadedAreaIgnore loads that are outside the loading area.
loadedAreaThe loading-area clipping polygon as a 2-column (X, Y) table — a bare array of rows,
e.g. [[0, 0], [10, 0], [10, 5]]. Set on the dialog via "Select Loading Area".
See GET moving-loads/settings/loaded-area/metadata for column units and the maximum row count.
MovingLoadSettingsUpdate
retainLoadsRetain generated loads for deselected scenarios. Omit to keep current.
applyToClosestMemberApply member loads to the closest member only. Omit to keep current.
ignoreLoadsOnOneMemberIgnore loads that transfer load to just one member. Omit to keep current.
checkVerticalProximityCheck vertical proximity when applying loads to members. Omit to keep current.
verticalProximityMaximum vertical distance for a load to be applied. Omit to keep current.
keepLoadsWithinTravelPathKeep loads entirely within the ends of the travel path (crane-beam behaviour). Omit to keep current.
ignoreOutsideLoadedAreaIgnore loads that are outside the loading area. Omit to keep current.
loadedAreaReplacement loading-area polygon as a 2-column (X, Y) table. When present, replaces the entire polygon; omit to keep the current polygon.
MovingLoadStation
nodeKeyThe node this station is relative to.
xX coordinate (or X offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).
yY coordinate (or Y offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).
zZ coordinate (or Z offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).
radiusArc radius into this station from the previous one.
MovingLoadStationaryOption
Controls which load cases a scenario load's stationary loads are generated into.
Mirrors SPACE GASS MLGenerateStationary (NETSpaceGass/Loads/Moving/MLCommon.vb).
MovingLoadTravelPath
idThe item Id.
nameThe travel-path name. Unique across all travel paths.
hasStationsWhether the travel path has any stations.
The travel path's stations, in order. Populated only when expand=All; otherwise omitted.
MovingLoadTravelPathBulkResult
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.
MovingLoadTravelPathCreate
idThe Id to assign to the new item.
nameThe travel-path name. Must be unique across all travel paths.
MovingLoadTravelPathUpdate
idThe Id of the item to update.
nameReplacement travel-path name. Must remain unique. Omit to keep current.
MovingLoadType
Discriminates a moving-load scenario load between a vehicle run and a pressure run.
Mirrors SPACE GASS MLScenarioLoadType (NETSpaceGass/Loads/Moving/MLCommon.vb).
MovingLoadVehicle
idThe item Id.
nameThe vehicle name. Unique across all vehicles.
sourceOrigin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource
(NETSpaceGass/Loads/Moving/MLCommon.vb).
libraryThe name of the library the vehicle was imported from.
The vehicle's wheel loads.
The units a vehicle's wheel loads are stored in. Independent of the job-level units.
MovingLoadVehicleBulkResult
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.
MovingLoadVehicleCreate
idThe Id to assign to the new item.
nameThe vehicle name. Must be unique across all vehicles.
The vehicle's wheel loads. Must contain at least one wheel.
The units a vehicle's wheel loads are stored in. Independent of the job-level units.
MovingLoadVehicleLibraryCreate
idThe Id to assign to the new item.
nameThe vehicle item name within the library.
libraryThe library name to import from.
MovingLoadVehicleSource
Origin of a moving-load vehicle. Mirrors SPACE GASS MLVehicleSource
(NETSpaceGass/Loads/Moving/MLCommon.vb).
MovingLoadVehicleUpdate
idThe Id of the item to update.
nameReplacement vehicle name. Must remain unique. Omit to keep current.
Replacement wheel loads. When present, replaces the entire wheel-load list. Omit to keep current.
NaturalFrequency
loadCaseLoad case ID.
modeMode number.
warningAnalysis engine warning message (empty if none).
naturalFrequencyNatural frequency. Unit: Hz.
naturalPeriodNatural period. Unit: seconds.
frequencyToleranceFrequency convergence tolerance.
iterationsNumber of iterations to converge.
massPartXMass participation factor in X direction.
massPartYMass participation factor in Y direction.
massPartZMass participation factor in Z direction.
NaturalFrequencyQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
Node
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
xX coordinate. Unit: Length (see GET /job/units).
yY coordinate. Unit: Length (see GET /job/units).
zZ coordinate. Unit: Length (see GET /job/units).
hasConstraintTrue when this node is the slave side of a master-slave constraint.
A node can be the slave of at most one constraint.
Use ?expand=all to include the full constraint object.
hasRestraintTrue when this node has an explicit restraint row defined. False means the node uses default restraints (all DOFs free, no spring stiffness).
DTO for reading a node constraint (master-slave constraint). Defines a kinematic relationship between a slave node and a master node. The slave node's degrees of freedom are tied to the master node according to the constraint code. Top-level entity attribute keyed on the slave node — each node can be a slave in at most one constraint.
DTO for reading a node restraint. Restraints define boundary conditions at nodes (fixed, released, spring, etc.) using a 6-character restraint code (FRSVPN). Top-level entity attribute keyed on the parent node.
NodeBulkResult
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.
NodeConstraint
slaveNodeThe slave node number. This is the node whose DOFs are constrained to the master.
masterNodeThe master node number. The slave node's constrained DOFs follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (slave DOF is tied to master), 'R' = Released (slave DOF is free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidThe unique identifier for this constraint record.
NodeConstraintBulkResult
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.
NodeConstraintCreate
slaveNodeThe slave node number. Required in the request body.
masterNodeThe master node number. The slave node's constrained DOFs will follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (tied to master), 'R' = Released (free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidOptional GUID for this constraint record.
NodeConstraintUpdate
slaveNodeThe slave node number that identifies which constraint to update. Required for bulk PATCH; ignored for single-node PATCH (route value wins).
masterNodeThe master node number.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (tied to master), 'R' = Released (free).
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidOptional GUID for this constraint record.
NodeCreate
xX coordinate. Unit: Length (see GET /job/units).
yY coordinate. Unit: Length (see GET /job/units).
zZ coordinate. Unit: Length (see GET /job/units).
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.
NodeDisplacement
loadCaseLoad case ID.
nodeNode key.
txTranslational X displacement. Unit: Translation (see GET /job/units).
tyTranslational Y displacement. Unit: Translation (see GET /job/units).
tzTranslational Z displacement. Unit: Translation (see GET /job/units).
rxRotational X displacement. Unit: Rotation (see GET /job/units).
ryRotational Y displacement. Unit: Rotation (see GET /job/units).
rzRotational Z displacement. Unit: Rotation (see GET /job/units).
NodeDisplacementQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
NodeLoad
nodeThe node number this load is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
fxForce in the global X direction.
fyForce in the global Y direction.
fzForce in the global Z direction.
mxMoment about the global X axis.
myMoment about the global Y axis.
mzMoment about the global Z axis.
NodeLoadBulkResult
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.
NodeLoadCreate
loadCaseThe load case number to create this load in.
nodeThe node number to apply this load to.
loadCategoryLoad category for grouping/organization.
fxForce in the global X direction.
fyForce in the global Y direction.
fzForce in the global Z direction.
mxMoment about the global X axis.
myMoment about the global Y axis.
mzMoment about the global Z axis.
NodeLoadKey
loadCaseThe load case number.
nodeThe node number.
NodeLoadKeyBulkResult
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.
NodeLoadUpdate
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
nodeThe node number.
fxForce in the global X direction.
fyForce in the global Y direction.
fzForce in the global Z direction.
mxMoment about the global X axis.
myMoment about the global Y axis.
mzMoment about the global Z axis.
NodeReaction
loadCaseLoad case ID.
nodeNode key.
fxReaction force in X direction. Unit: Force (see GET /job/units).
fyReaction force in Y direction. Unit: Force (see GET /job/units).
fzReaction force in Z direction. Unit: Force (see GET /job/units).
mxReaction moment about X axis. Unit: Moment (see GET /job/units).
myReaction moment about Y axis. Unit: Moment (see GET /job/units).
mzReaction moment about Z axis. Unit: Moment (see GET /job/units).
NodeReactionQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
NodeRestraint
nodeThe node Id this restraint applies to.
restraintCode6-character restraint code for TX,TY,TZ,RX,RY,RZ. Each character: F=Fixed (prevents movement), R=Released (allows movement), S=Spring (movement governed by a spring stiffness), V=Variable spring (multiple stiffnesses via a stiffness-vs-deflection table), P=Plastic (upper force/moment limit on the reaction), N=Friction (upper limit on reaction proportional to the normal-axis reaction).
activeDirection6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.
generalRestraintWhether this is the general restraint for the model.
txStiffnessTranslational X spring stiffness. Unit: Force/Length (see GET /job/units).
tyStiffnessTranslational Y spring stiffness. Unit: Force/Length (see GET /job/units).
tzStiffnessTranslational Z spring stiffness. Unit: Force/Length (see GET /job/units).
rxStiffnessRotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).
ryStiffnessRotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).
rzStiffnessRotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).
xFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
yFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
zFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
xFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
yFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
zFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
xFrictionFactorX-axis friction factor.
yFrictionFactorY-axis friction factor.
zFrictionFactorZ-axis friction factor.
txPlasticLimitTranslational X plastic limit. Unit: Force (see GET /job/units).
tyPlasticLimitTranslational Y plastic limit. Unit: Force (see GET /job/units).
tzPlasticLimitTranslational Z plastic limit. Unit: Force (see GET /job/units).
rxPlasticLimitRotational X plastic limit. Unit: Moment (see GET /job/units).
ryPlasticLimitRotational Y plastic limit. Unit: Moment (see GET /job/units).
rzPlasticLimitRotational Z plastic limit. Unit: Moment (see GET /job/units).
txVariableTableVariable-spring stiffness table for translational X. Points are (deflection, stiffness).
tyVariableTableVariable-spring stiffness table for translational Y. Points are (deflection, stiffness).
tzVariableTableVariable-spring stiffness table for translational Z. Points are (deflection, stiffness).
rxVariableTableVariable-spring stiffness table for rotational X. Points are (rotation, stiffness).
ryVariableTableVariable-spring stiffness table for rotational Y. Points are (rotation, stiffness).
rzVariableTableVariable-spring stiffness table for rotational Z. Points are (rotation, stiffness).
NodeRestraintBulkResult
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.
NodeRestraintCreate
nodeThe node Id to create the restraint for. Required in the request body.
restraintCode6-character restraint code for TX,TY,TZ,RX,RY,RZ. Each character is one of: F = Fixed (prevents movement); R = Released (allows movement); S = Spring (movement governed by a spring stiffness); V = Variable spring (multiple stiffnesses via a stiffness-vs-deflection table); P = Plastic (upper force/moment limit on the reaction); N = Friction (upper limit proportional to the normal-axis reaction).
activeDirection6-character active direction code for TX,TY,TZ,RX,RY,RZ.
txStiffnessTranslational X spring stiffness. Unit: Force/Length (see GET /job/units).
tyStiffnessTranslational Y spring stiffness. Unit: Force/Length (see GET /job/units).
tzStiffnessTranslational Z spring stiffness. Unit: Force/Length (see GET /job/units).
rxStiffnessRotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).
ryStiffnessRotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).
rzStiffnessRotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).
xFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
yFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
zFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
xFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
yFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
zFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
xFrictionFactorX-axis friction factor.
yFrictionFactorY-axis friction factor.
zFrictionFactorZ-axis friction factor.
txPlasticLimitTranslational X plastic limit. Unit: Force (see GET /job/units).
tyPlasticLimitTranslational Y plastic limit. Unit: Force (see GET /job/units).
tzPlasticLimitTranslational Z plastic limit. Unit: Force (see GET /job/units).
rxPlasticLimitRotational X plastic limit. Unit: Moment (see GET /job/units).
ryPlasticLimitRotational Y plastic limit. Unit: Moment (see GET /job/units).
rzPlasticLimitRotational Z plastic limit. Unit: Moment (see GET /job/units).
txVariableTableVariable-spring stiffness table for translational X.
tyVariableTableVariable-spring stiffness table for translational Y.
tzVariableTableVariable-spring stiffness table for translational Z.
rxVariableTableVariable-spring stiffness table for rotational X.
ryVariableTableVariable-spring stiffness table for rotational Y.
rzVariableTableVariable-spring stiffness table for rotational Z.
NodeRestraintUpdate
nodeThe node number that identifies which restraint to update. Required for bulk PATCH; ignored for single-node PATCH (route value wins).
restraintCode6-character restraint code for TX,TY,TZ,RX,RY,RZ. Each character: F=Fixed (prevents movement), R=Released (allows movement), S=Spring (movement governed by a spring stiffness), V=Variable spring (multiple stiffnesses via a stiffness-vs-deflection table), P=Plastic (upper force/moment limit on the reaction), N=Friction (upper limit on reaction proportional to the normal-axis reaction).
activeDirection6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.
txStiffnessTranslational X spring stiffness. Unit: Force/Length (see GET /job/units).
tyStiffnessTranslational Y spring stiffness. Unit: Force/Length (see GET /job/units).
tzStiffnessTranslational Z spring stiffness. Unit: Force/Length (see GET /job/units).
rxStiffnessRotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).
ryStiffnessRotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).
rzStiffnessRotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).
xFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
yFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
zFrictionNormalAxisFriction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".
xFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
yFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
zFrictionNormalDirectionFriction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".
xFrictionFactorX-axis friction factor.
yFrictionFactorY-axis friction factor.
zFrictionFactorZ-axis friction factor.
txPlasticLimitTranslational X plastic limit. Unit: Force (see GET /job/units).
tyPlasticLimitTranslational Y plastic limit. Unit: Force (see GET /job/units).
tzPlasticLimitTranslational Z plastic limit. Unit: Force (see GET /job/units).
rxPlasticLimitRotational X plastic limit. Unit: Moment (see GET /job/units).
ryPlasticLimitRotational Y plastic limit. Unit: Moment (see GET /job/units).
rzPlasticLimitRotational Z plastic limit. Unit: Moment (see GET /job/units).
txVariableTableVariable-spring stiffness table for translational X.
tyVariableTableVariable-spring stiffness table for translational Y.
tzVariableTableVariable-spring stiffness table for translational Z.
rxVariableTableVariable-spring stiffness table for rotational X.
ryVariableTableVariable-spring stiffness table for rotational Y.
rzVariableTableVariable-spring stiffness table for rotational Z.
NodeTypeFilter
Filters nodes by type (e.g., restrained only).
NodeUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
xX coordinate. Unit: Length (see GET /job/units).
yY coordinate. Unit: Length (see GET /job/units).
zZ coordinate. Unit: Length (see GET /job/units).
NonLinearTheory
Non-linear static analysis theory type. Only used for non-linear static analysis.
OpenJobRequest
filePathFull path to the .sg job file to open.
forceOptionOptions for forcing access to a job file that is in a locked or unsaved state. Used when temporary files exist from a previous session that was not properly closed.
OpenSampleRequest
fileNameSample file name (e.g. "Portal Frame.SG"). Use GET /api/v1/file/samples to list available samples.
Plate
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
nodeANode at corner A of the plate.
nodeBNode at corner B of the plate.
nodeCNode at corner C of the plate.
nodeDNode at corner D of the plate. 0 indicates a triangular (3-node) plate.
materialMaterial number assigned to this plate.
actualThicknessActual thickness of the plate. Unit: Section Properties (see GET /job/units).
membraneThicknessMembrane thickness of the plate. Unit: Section Properties (see GET /job/units).
bendingThicknessBending thickness of the plate. Unit: Section Properties (see GET /job/units).
shearThicknessShear thickness of the plate. Unit: Section Properties (see GET /job/units).
DTO for reading plate direction data.
Direction defines the orientation of the plate's local coordinate system.
Always present on every plate — the parent PlateDto's id is authoritative.
theoryPlate theory type for finite element analysis. Maps to SPACE GASS lookup table "Plate Theory".
offsetPlate offset. Unit: Length (see GET /job/units).
PlateBulkResult
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.
PlateCreate
nodeANode at corner A of the plate.
nodeBNode at corner B of the plate.
nodeCNode at corner C of the plate.
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.
nodeDNode at corner D of the plate. Omit or set to 0 for a triangular (3-node) plate.
materialMaterial number assigned to this plate.
actualThicknessActual thickness of the plate. Unit: Section Properties (see GET /job/units).
membraneThicknessMembrane thickness of the plate. Unit: Section Properties (see GET /job/units).
bendingThicknessBending thickness of the plate. Unit: Section Properties (see GET /job/units).
shearThicknessShear thickness of the plate. Unit: Section Properties (see GET /job/units).
DTO for updating the direction on a member or plate (partial-update semantics).
theoryPlate theory type for finite element analysis. Maps to SPACE GASS lookup table "Plate Theory".
offsetPlate offset. Unit: Length (see GET /job/units).
PlateCut
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
startPlateStart plate number for the cut.
endPlateEnd plate number for the cut.
startNodeStart node number for the cut.
endNodeEnd node number for the cut.
titleUser-defined title for the plate cut.
startOffsetLongitudinalLongitudinal offset at the start of the cut.
startOffsetTransverseTransverse offset at the start of the cut.
endOffsetLongitudinalLongitudinal offset at the end of the cut.
endOffsetTransverseTransverse offset at the end of the cut.
outOfPlaneToleranceOut-of-plane tolerance for the cut.
PlateCutBulkResult
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.
PlateCutCreate
startPlateStart plate number for the cut.
endPlateEnd plate number for the cut.
startNodeStart node number for the cut.
endNodeEnd node number for the cut.
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.
titleUser-defined title for the plate cut.
startOffsetLongitudinalLongitudinal offset at the start of the cut.
startOffsetTransverseTransverse offset at the start of the cut.
endOffsetLongitudinalLongitudinal offset at the end of the cut.
endOffsetTransverseTransverse offset at the end of the cut.
outOfPlaneToleranceOut-of-plane tolerance for the cut.
PlateCutUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
titleUser-defined title for the plate cut.
startPlateStart plate number for the cut.
endPlateEnd plate number for the cut.
startNodeStart node number for the cut.
endNodeEnd node number for the cut.
startOffsetLongitudinalLongitudinal offset at the start of the cut.
startOffsetTransverseTransverse offset at the start of the cut.
endOffsetLongitudinalLongitudinal offset at the end of the cut.
endOffsetTransverseTransverse offset at the end of the cut.
outOfPlaneToleranceOut-of-plane tolerance for the cut.
PlateDirection
sourceIndicates which field defines a member or plate's direction.
Setting one source zeros the other two direction fields.
Values align with SG's SGLookupAxisDirection enum in CommonEnums.vb.
dirAngleDirection angle for plate orientation.
dirNodeDirection node for plate orientation.
dirAxisDirection axis for member orientation. Maps to SPACE GASS lookup table "Direction Axis".
PlateElementForce
loadCaseLoad case ID.
platePlate key.
fxMembrane force in X. Unit: Force/Length (see GET /job/units).
fyMembrane force in Y. Unit: Force/Length (see GET /job/units).
fxyMembrane shear force. Unit: Force/Length (see GET /job/units).
mxBending moment about X. Unit: Moment/Length (see GET /job/units).
myBending moment about Y. Unit: Moment/Length (see GET /job/units).
mxyTwisting moment. Unit: Moment/Length (see GET /job/units).
vxzTransverse shear in XZ. Unit: Force/Length (see GET /job/units).
vyzTransverse shear in YZ. Unit: Force/Length (see GET /job/units).
mxTopBending moment about X at top surface. Unit: Moment/Length (see GET /job/units).
myTopBending moment about Y at top surface. Unit: Moment/Length (see GET /job/units).
mxBtmBending moment about X at bottom surface. Unit: Moment/Length (see GET /job/units).
myBtmBending moment about Y at bottom surface. Unit: Moment/Length (see GET /job/units).
PlateElementForceQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
PlateNodalForce
loadCaseLoad case ID.
platePlate key.
nodeNode keys at each corner of the plate element.
fxForce in X at each node. Unit: Force (see GET /job/units).
fyForce in Y at each node. Unit: Force (see GET /job/units).
fzForce in Z at each node. Unit: Force (see GET /job/units).
mxMoment about X at each node. Unit: Moment (see GET /job/units).
myMoment about Y at each node. Unit: Moment (see GET /job/units).
mzMoment about Z at each node. Unit: Moment (see GET /job/units).
PlateNodalForceQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
PlatePressureLoad
plateThe plate number this pressure load is applied to.
loadCaseThe 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".
pxPressure in the X direction of the selected axes.
pyPressure in the Y direction of the selected axes.
pzPressure in the Z direction of the selected axes.
PlatePressureLoadBulkResult
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.
PlatePressureLoadCreate
loadCaseThe load case number to create this load in.
plateThe plate number to apply this pressure 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".
pxPressure in the X direction of the selected axes.
pyPressure in the Y direction of the selected axes.
pzPressure in the Z direction of the selected axes.
PlatePressureLoadKey
loadCaseThe load case number.
plateThe plate number.
PlatePressureLoadKeyBulkResult
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.
PlatePressureLoadUpdate
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
plateThe plate number.
axesCoordinate axes type for distributed loads and plate pressure loads. Maps to SPACE GASS lookup table "L/GI/GP Axes".
pxPressure in the X direction of the selected axes.
pyPressure in the Y direction of the selected axes.
pzPressure in the Z direction of the selected axes.
PlateStress
loadCaseLoad case ID.
platePlate key.
sxTopNormal stress in X at top surface. Unit: Stress (see GET /job/units).
syTopNormal stress in Y at top surface. Unit: Stress (see GET /job/units).
txyTopShear stress XY at top surface. Unit: Stress (see GET /job/units).
sxpTopPrincipal stress in X at top surface. Unit: Stress (see GET /job/units).
sypTopPrincipal stress in Y at top surface. Unit: Stress (see GET /job/units).
tmaxTopMaximum shear stress at top surface. Unit: Stress (see GET /job/units).
svmTopVon Mises stress at top surface. Unit: Stress (see GET /job/units).
paTopPrincipal angle at top surface. Unit: Rotation (see GET /job/units).
sxBtmNormal stress in X at bottom surface. Unit: Stress (see GET /job/units).
syBtmNormal stress in Y at bottom surface. Unit: Stress (see GET /job/units).
txyBtmShear stress XY at bottom surface. Unit: Stress (see GET /job/units).
sxpBtmPrincipal stress in X at bottom surface. Unit: Stress (see GET /job/units).
sypBtmPrincipal stress in Y at bottom surface. Unit: Stress (see GET /job/units).
tmaxBtmMaximum shear stress at bottom surface. Unit: Stress (see GET /job/units).
svmBtmVon Mises stress at bottom surface. Unit: Stress (see GET /job/units).
paBtmPrincipal angle at bottom surface. Unit: Rotation (see GET /job/units).
txzTransverse shear stress in XZ. Unit: Stress (see GET /job/units).
tyzTransverse shear stress in YZ. Unit: Stress (see GET /job/units).
PlateStressQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
PlateStrip
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
startPlateStart plate number for the strip.
endPlateEnd plate number for the strip.
startNodeStart node number for the strip.
endNodeEnd node number for the strip.
titleUser-defined title for the plate strip.
uniformWidthWhether the strip has uniform width along its length.
widthUniform width of the strip.
startWidthLeftLeft width at the start of the strip.
startWidthRightRight width at the start of the strip.
endWidthLeftLeft width at the end of the strip.
endWidthRightRight width at the end of the strip.
startOffsetLongitudinalLongitudinal offset at the start of the strip.
startOffsetTransverseTransverse offset at the start of the strip.
endOffsetLongitudinalLongitudinal offset at the end of the strip.
endOffsetTransverseTransverse offset at the end of the strip.
transverseIncrementTransverse increment spacing along the strip.
outOfPlaneToleranceOut-of-plane tolerance for the strip.
PlateStripBulkResult
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.
PlateStripCreate
startPlateStart plate number for the strip.
endPlateEnd plate number for the strip.
startNodeStart node number for the strip.
endNodeEnd node number for the strip.
uniformWidthWhether the strip has uniform width along its length.
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.
titleUser-defined title for the plate strip.
widthUniform width of the strip.
startWidthLeftLeft width at the start of the strip.
startWidthRightRight width at the start of the strip.
endWidthLeftLeft width at the end of the strip.
endWidthRightRight width at the end of the strip.
startOffsetLongitudinalLongitudinal offset at the start of the strip.
startOffsetTransverseTransverse offset at the start of the strip.
endOffsetLongitudinalLongitudinal offset at the end of the strip.
endOffsetTransverseTransverse offset at the end of the strip.
transverseIncrementTransverse increment spacing along the strip.
outOfPlaneToleranceOut-of-plane tolerance for the strip.
PlateStripUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
titleUser-defined title for the plate strip.
startPlateStart plate number for the strip.
endPlateEnd plate number for the strip.
startNodeStart node number for the strip.
endNodeEnd node number for the strip.
uniformWidthWhether the strip has uniform width along its length.
widthUniform width of the strip.
startWidthLeftLeft width at the start of the strip.
startWidthRightRight width at the start of the strip.
endWidthLeftLeft width at the end of the strip.
endWidthRightRight width at the end of the strip.
startOffsetLongitudinalLongitudinal offset at the start of the strip.
startOffsetTransverseTransverse offset at the start of the strip.
endOffsetLongitudinalLongitudinal offset at the end of the strip.
endOffsetTransverseTransverse offset at the end of the strip.
transverseIncrementTransverse increment spacing along the strip.
outOfPlaneToleranceOut-of-plane tolerance for the strip.
PlateTheory
Plate theory type for finite element analysis. Maps to SPACE GASS lookup table "Plate Theory".
PlateUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
nodeANode at corner A of the plate.
nodeBNode at corner B of the plate.
nodeCNode at corner C of the plate.
nodeDNode at corner D of the plate. Set to 0 for a triangular (3-node) plate.
materialMaterial number assigned to this plate.
actualThicknessActual thickness of the plate. Unit: Section Properties (see GET /job/units).
membraneThicknessMembrane thickness of the plate. Unit: Section Properties (see GET /job/units).
bendingThicknessBending thickness of the plate. Unit: Section Properties (see GET /job/units).
shearThicknessShear thickness of the plate. Unit: Section Properties (see GET /job/units).
DTO for updating the direction on a member or plate (partial-update semantics).
theoryPlate theory type for finite element analysis. Maps to SPACE GASS lookup table "Plate Theory".
offsetPlate offset. Unit: Length (see GET /job/units).
PrescribedDisplacement
nodeThe node number this displacement is applied to.
loadCaseThe load case number this load belongs to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
PrescribedDisplacementBulkResult
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.
PrescribedDisplacementCreate
loadCaseThe load case number to create this load in.
nodeThe node number to apply this displacement to.
loadCategoryLoad category for grouping/organization.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
PrescribedDisplacementKey
loadCaseThe load case number.
nodeThe node number.
PrescribedDisplacementKeyBulkResult
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.
PrescribedDisplacementUpdate
loadCaseThe load case number.
loadCategoryLoad category for grouping/organization.
nodeThe node number.
txPrescribed translation in the global X direction.
tyPrescribed translation in the global Y direction.
tzPrescribed translation in the global Z direction.
rxPrescribed rotation about the global X axis.
ryPrescribed rotation about the global Y axis.
rzPrescribed rotation about the global Z axis.
PropertySource
Indicates whether a section or material was user-defined or imported from a library.
QueryWarnings
loadCasesNotAnalyzedLoad case Ids that exist in the model but produced no result rows for this query
— typically because the analysis has not been run for those cases.
SG list-format string (e.g. "2,5-7") — already intersected against the
caller's original filter, ready to paste back into POST /job/analysis/run's
loadCases field.
Per-case list of modes the caller requested that did not produce result rows
for that specific case. Each analysed case can compute a different number of
modes, so a flattened across-cases warning would hide gaps. Each entry names
the case and the SG list-format string of missing mode numbers for it.
Informational — to resolve, raise the analysis modes count to at least
the largest missing mode number and re-run.
ReactionSummary
loadCaseLoad case Id.
summaryTypeIdentifies which per-load-case equilibrium total a reaction summary row holds.
fxForce component in X direction. Unit: Force (see GET /job/units).
fyForce component in Y direction. Unit: Force (see GET /job/units).
fzForce component in Z direction. Unit: Force (see GET /job/units).
mxMoment component about X axis. Unit: Moment (see GET /job/units).
myMoment component about Y axis. Unit: Moment (see GET /job/units).
mzMoment component about Z axis. Unit: Moment (see GET /job/units).
ReactionSummaryQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
ReactionSummaryType
Identifies which per-load-case equilibrium total a reaction summary row holds.
RegistrationStatus
Outcome of probing the machine for a SPACE GASS registration.
Mirrors the precedence used by desktop SPACE GASS in
NETLicenses\Licenses.vb::RegistrationSetupCheck: legacy SGREG.DAT
short-circuits before any Titan-type probing, then TitanCloud, then Titan LM.
ResourceMetadata
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.
SaveJobRequest
filePathTarget file path. Omit to save to current location. Required if the job is new (never saved before).
Section
idPrimary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue
nameSection name.
libraryLibrary name.
markSection mark / designation.
aCross-sectional area.
jTorsion constant.
iySecond moment of area about the principal Y axis.
izSecond moment of area about the principal Z axis.
ayShear area in the Y direction.
azShear area in the Z direction.
principalAnglePrincipal axis rotation angle.
sourceIndicates whether a section or material was user-defined or imported from a library.
shapesNumber of shapes in the section (1 for a standard library section).
areaFactorArea modification factor.
torsionFactorTorsion modification factor.
iyFactorIy modification factor.
izFactorIz modification factor.
angleTypeAngle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".
transposedWhether the section's principal axes are swapped (transposed shape).
SectionBulkResult
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.
SectionLibraryCreate
nameSection item name within the library.
libraryLibrary name.
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.
markSection mark / designation.
angleTypeAngle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".
transposedWhether the section's principal axes are swapped (transposed shape).
ayShear area in the Y direction.
azShear area in the Z direction.
areaFactorArea modification factor.
torsionFactorTorsion modification factor.
iyFactorIy modification factor.
izFactorIz modification factor.
SectionPropertiesUnit
Unit for section properties (area, moment of inertia, etc.). Members mirror
SPACE GASS SgSectionProperties (NetCommon/CommonEnums.vb).
SectionUpdate
idPrimary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.
nameSection name.
markSection mark / designation.
aCross-sectional area.
jTorsion constant.
iySecond moment of area about the principal Y axis.
izSecond moment of area about the principal Z axis.
ayShear area in the Y direction.
azShear area in the Z direction.
principalAnglePrincipal axis rotation angle.
areaFactorArea modification factor.
torsionFactorTorsion modification factor.
iyFactorIy modification factor.
izFactorIz modification factor.
SectionUserCreate
nameSection name.
aCross-sectional area.
jTorsion constant.
iySecond moment of area about the principal Y axis.
izSecond moment of area about the principal Z axis.
ayShear area in the Y direction.
azShear area in the Z direction.
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.
markSection mark / designation.
principalAnglePrincipal axis rotation angle.
areaFactorArea modification factor.
torsionFactorTorsion modification factor.
iyFactorIy modification factor.
izFactorIz modification factor.
SelfWeightLoad
loadCaseThe 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.
SelfWeightLoadBulkResult
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.
SelfWeightLoadCreate
loadCaseThe 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.
SelfWeightLoadUpdate
loadCaseThe 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.
ServiceInfo
apiPathThe API base URL (scheme, host, and path base).
spaceGassVersionSPACE GASS version number in format "X.XX.XXXX (ProgramType)".
SetGeneralRestraintRequest
nodeThe node to promote as the general restraint, or null to clear.
SolverType
Matrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
StaticSettings
loadCasesLoad cases to include in the analysis, in SG list format (e.g. "1,3,5-10").
Omit or pass an empty string to include all load cases (default).
Maximum 50 entries (individual numbers and ranges each count as entries).
retainLoadCasesWhether to retain results of other load cases during analysis. When true, results from previously analysed load cases are preserved.
checkNonExistentLoadCasesWhether to check for non-existent load cases referenced in the analysis. When true, warnings are generated for missing load cases.
stabilizeUnrestrainedNodesWhether to stabilize unrestrained nodes during analysis. When true, temporary restraints are added to prevent instability.
tensionCompressionOnlyControls how tension-only and compression-only members are handled during analysis.
reversalIterationsNumber of iterations before disabling reversal of tension/compression-only members. Only relevant when TensionCompressionOnly is Activated.
dampingFactorCable damping factor (%). Non-linear only.
dampingStepsNumber of damping relaxation steps. Non-linear only.
loadStepsNumber of load steps. Non-linear only.
loadStepIterationsNumber of iterations per load step.
convergenceAccuracyConvergence accuracy (%). Non-linear only.
frameBucklingCheckWhether to perform frame buckling check.
rotateLocalLoadsWhether to rotate local loads with member chord rotation. Non-linear only.
theoryNon-linear static analysis theory type. Only used for non-linear static analysis.
matrixTypeStiffness matrix type for non-linear static analysis. Only used for non-linear static analysis.
loadingLoading type for non-linear static analysis. Only used for non-linear static analysis.
deflectionsConvergenceWhether to include deflections in convergence check. Non-linear only.
residualsConvergenceWhether to include residuals in convergence check. Non-linear only.
pDeltaBigWhether to include big P-delta effect. Non-linear only.
pDeltaSmallWhether to include small P-delta effect. Non-linear only.
optimizationMethodOptimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
optimizationAxisAxis used for optimization in analysis.
optimizationXX coordinate or X component of the optimization vector. Only used when OptimizationAxis is Vector, or as angular coordinate for axis modes.
optimizationYY coordinate or Y component of the optimization vector.
optimizationZZ coordinate or Z component of the optimization vector.
solverTypeMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
drillingStiffnessDrilling stiffness multiplier for plate elements.
plateTypePlate element formulation type.
steppingMethodLoad stepping method for non-linear static analysis.
StaticSettingsUpdate
loadCasesretainLoadCasescheckNonExistentLoadCasesstabilizeUnrestrainedNodestensionCompressionOnlyControls how tension-only and compression-only members are handled during analysis.
reversalIterationsdampingFactordampingStepsloadStepsloadStepIterationsconvergenceAccuracyframeBucklingCheckrotateLocalLoadstheoryNon-linear static analysis theory type. Only used for non-linear static analysis.
matrixTypeStiffness matrix type for non-linear static analysis. Only used for non-linear static analysis.
loadingLoading type for non-linear static analysis. Only used for non-linear static analysis.
deflectionsConvergenceresidualsConvergencepDeltaBigpDeltaSmalloptimizationMethodOptimization method for analysis bandwidth/profile reduction.
Integer values mirror SPACE GASS's AnalysisOptimizationTypes enum
(NetCommon/CommonEnums.vb). Used by static, buckling, and dynamic frequency analysis.
optimizationAxisAxis used for optimization in analysis.
optimizationXoptimizationYoptimizationZsolverTypeMatrix solver type used by the analysis engine.
Integer values mirror SPACE GASS's SGSolverType enum
(NetCommon/CommonEnums.vb): 0=Paradise, 1=Wavefront, 2=Watcom (legacy,
not exposed), 3=SG-X (cloud, dispatched externally — not yet supported
by the in-process API analysis path).
drillingStiffnessplateTypePlate element formulation type.
SteelCheckSummary
memberMember key (group key).
flagDesign check status flag.
sectionSection name used for the design check.
yieldYield stress. Unit: Stress (see GET /job/units).
totalLengthTotal member length. Unit: Length (see GET /job/units).
segmentLengthCritical segment length. Unit: Length (see GET /job/units).
failureFailure mode description.
criticalCaseLoad case ID of the critical case.
loadFactorDesign load factor (capacity ratio).
SteelCheckSummaryQueryResult
The query result rows.
Warnings returned when some requested load cases or modes did not have analysis results in the response. (Filter Ids that don't exist in the model are rejected up-front with HTTP 400 by the controller — they never reach this DTO.)
loadCasesNotAnalyzed is an SG list-format string that can be pasted straight
into POST /job/analysis/run's loadCases field to re-run only those
cases. modesNotAnalyzed is a per-case list — each analysed case can compute
a different number of modes, so the warning is keyed by case rather than flattened.
SteelDesignSummary
hasMemberDesignResultsWhether steel member design results exist (check or design).
hasConnectionDesignResultsWhether steel connection design results exist.
SteppingMethod
Load stepping method for non-linear static analysis.
StiffnessDirection
Identifies one of the six DOFs on a node restraint (Tx, Ty, Tz, Rx, Ry, Rz).
Integer values match SPACE GASS's NodeRestraint.StiffnessDirectionIndex
and the offset added to sgFRAME_RESTRAINTS_RestraintTable_Tx (27)
when indexing the per-DOF table fields.
StressUnit
Stress unit. Members mirror SPACE GASS SgStress.
StructureSummary
nodesNumber of nodes (joints/points) in the structure.
membersNumber of members (beam/column elements) in the structure.
platesNumber of plate/shell elements in the structure.
nodeRestraintsNumber of nodes with support restraint conditions.
memberOffsetsNumber of members with rigid end offsets.
nodeConstraintsNumber of master-slave node constraint definitions.
sectionsNumber of cross-section profiles defined.
materialsNumber of materials defined.
TableMetadata
tableNameHuman-readable title, e.g. "Stiffness vs Deflection".
Column metadata in the same order the values appear in each row of SpaceGassApi.Models.Dtos.Common.TableDto.Rows.
Each entry uses the same SpaceGassApi.Models.Dtos.Common.FieldMetadataDto shape as resource-level
metadata (jsonName, dataType, units, min, max,
description).
maxRowsMaximum number of rows the table accepts.
TemperatureUnit
Temperature unit. Members mirror SPACE GASS SgTemperature.
TensionCompressionOnlyMode
Controls how tension-only and compression-only members are handled during analysis.
ThermalElementType
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".
ThermalLoad
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".
loadCaseThe 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.
ThermalLoadBulkResult
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.
ThermalLoadCreate
loadCaseThe 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.
ThermalLoadElementId
loadCaseThe 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".
ThermalLoadElementIdBulkResult
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.
ThermalLoadUpdate
loadCaseThe 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.
TranslationUnit
Translation (displacement) unit. Members mirror SPACE GASS SgTranslation.
SG uses inch here (not in) to dodge the VB reserved word; we mirror
that so the wire token stays "inch".
Units
lengthLength unit. Members mirror SPACE GASS SGLength
(NetCommon/CommonEnums.vb); integer values and identifiers must stay in
lock-step with it. The System.ComponentModel.DescriptionAttribute carries the display
label (mirrors gcUNITS_LABEL_*).
sectionPropertiesUnit for section properties (area, moment of inertia, etc.). Members mirror
SPACE GASS SgSectionProperties (NetCommon/CommonEnums.vb).
materialStrengthMaterial strength unit (yield stress, ultimate stress, etc.). Members mirror
SPACE GASS SgMaterialStrength.
massDensityMass density unit. Members mirror SPACE GASS SgMassDensity.
temperatureTemperature unit. Members mirror SPACE GASS SgTemperature.
forceForce unit. Members mirror SPACE GASS SgForce.
momentMoment unit. Members mirror SPACE GASS SgMoment.
massMass unit. Members mirror SPACE GASS SgMass.
accelerationAcceleration unit. Members mirror SPACE GASS SgAcceleration.
translationTranslation (displacement) unit. Members mirror SPACE GASS SgTranslation.
SG uses inch here (not in) to dodge the VB reserved word; we mirror
that so the wire token stays "inch".
stressStress unit. Members mirror SPACE GASS SgStress.
ValidationError
fieldField or property name that caused the error
messageError message
codeError code for this specific validation
VehicleLoadUnits
lengthLength unit. Members mirror SPACE GASS SGLength
(NetCommon/CommonEnums.vb); integer values and identifiers must stay in
lock-step with it. The System.ComponentModel.DescriptionAttribute carries the display
label (mirrors gcUNITS_LABEL_*).
forceForce unit. Members mirror SPACE GASS SgForce.
momentMoment unit. Members mirror SPACE GASS SgMoment.
VehicleWheelLoad
xWheel position along the vehicle's local X axis.
yWheel position along the vehicle's local Y axis.
fxForce component along global X.
fyForce component along global Y.
fzForce component along global Z.
mxMoment component about global X.
myMoment component about global Y.
mzMoment component about global Z.