Analysis runs and settings
Get Buckling Analysis Results Info
Returns a lightweight pre-flight summary describing whether buckling analysis results are stored for this job and which load cases they cover.
query Parameters
loadCasesOptional load case filter in SG list format. Omit for all model cases.
Get Buckling Analysis Results Info › Responses
Returns the buckling analysis results info.
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.
Get Buckling Analysis Settings
Returns the current Buckling Analysis settings.
Get Buckling Analysis Settings › Responses
OK
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.
Update Buckling Analysis Settings
Partially updates the Buckling Analysis settings. Only fields included in the request body are updated; omitted fields remain unchanged.
Update Buckling Analysis Settings › Request Body
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.
Update Buckling Analysis Settings › Responses
OK
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.
Get Dynamic Frequency Analysis Results Info
Returns a lightweight pre-flight summary describing whether dynamic frequency analysis results are stored for this job and which load cases they cover.
query Parameters
loadCasesOptional load case filter in SG list format. Omit for all model cases.
Get Dynamic Frequency Analysis Results Info › Responses
Returns the dynamic frequency analysis results info.
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.
Get Dynamic Frequency Analysis Settings
Returns the current Dynamic Frequency Analysis settings.
Get Dynamic Frequency Analysis Settings › Responses
OK
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.
Update Dynamic Frequency Analysis Settings
Partially updates the Dynamic Frequency Analysis settings. Only fields included in the request body are updated; omitted fields remain unchanged.
Update Dynamic Frequency Analysis Settings › Request Body
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.
Update Dynamic Frequency Analysis Settings › Responses
OK
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.
List Analysis Runs
Lists the current analysis run (if any) and recent run history. History is capped at the 10 most recent runs.
List Analysis Runs › Responses
OK
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.
Get Analysis Run Status
Gets the current status of an analysis run. Use this to poll for completion.
path Parameters
runIdThe unique run ID returned when the analysis was started
Get Analysis Run Status › Responses
OK
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.
Get Analysis Run Result
Gets a summary of the completed analysis run. Returns 409 Conflict if the analysis is still running.
For actual result data (reactions, displacements, etc.), use the query endpoints:
- GET /api/v1/job/query/analysis/static/node-reactions
- GET /api/v1/job/query/analysis/static/node-displacements
path Parameters
runIdThe unique run ID
Get Analysis Run Result › Responses
OK
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.
Get Static Analysis Results Info
Returns a lightweight pre-flight summary describing whether static analysis
results are stored for this job and which load cases they cover.
Use this before issuing a static results query to decide whether the query
is worth issuing, and to derive a follow-up POST /static/run-* body
for the cases that still need to be analysed.
hasResults is sourced from the result file's header — no datasheet load.
Linear and Non-Linear Static share the same result files, so this endpoint
covers both modes.
query Parameters
loadCasesOptional load case filter in SG list format (e.g. "1,3-7,10").
Omit to query against every load case in the model.
Get Static Analysis Results Info › Responses
Returns the static analysis results info.
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.
Get Static Analysis Settings
Returns the current Static Analysis settings. These settings are shared between Linear Static and Non-Linear Static analysis types.
Get Static Analysis Settings › Responses
OK
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.
Update Static Analysis Settings
Partially updates the Static Analysis settings. Only fields included in the request body are updated; omitted fields remain unchanged. These settings are shared between Linear Static and Non-Linear Static analysis types.
Update Static Analysis Settings › Request Body
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.
Update Static Analysis Settings › Responses
OK
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.
Run Buckling Analysis
Starts a Buckling Analysis run. The analysis executes asynchronously in the background. Poll the returned status URL to track progress. Only one analysis can run at a time.
The request body is optional. If provided, only fields included are applied as setting overrides before the analysis starts; omitted fields remain unchanged.
Run Buckling Analysis › Request Body optional
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.
Run Buckling Analysis › Responses
Accepted
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.
Run Dynamic Frequency Analysis
Starts a Dynamic Frequency Analysis run. The analysis executes asynchronously in the background. Poll the returned status URL to track progress. Only one analysis can run at a time.
The request body is optional. If provided, only fields included are applied as setting overrides before the analysis starts; omitted fields remain unchanged.
Run Dynamic Frequency Analysis › Request Body optional
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.
Run Dynamic Frequency Analysis › Responses
Accepted
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.
Run Linear Static Analysis
Starts a Linear Static Analysis run. The analysis executes asynchronously in the background. Poll the returned status URL to track progress. Only one analysis can run at a time.
The request body is optional. If provided, only fields included are applied as setting overrides before the analysis starts; omitted fields remain unchanged. If omitted, the analysis runs with the current job settings as-is.
Once complete, results are available via the query endpoints (e.g., GET /api/v1/job/query/analysis/static/node-reactions).
Run Linear Static Analysis › Request Body optional
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.
Run Linear Static Analysis › Responses
Accepted
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.
Run Non-Linear Static Analysis
Starts a Non-Linear Static Analysis run. The analysis executes asynchronously in the background. Uses the same settings as Linear Static (shared via GET/PATCH /static/settings).
The request body is optional. If provided, only fields included are applied as setting overrides before the analysis starts; omitted fields remain unchanged.
Run Non-Linear Static Analysis › Request Body optional
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.
Run Non-Linear Static Analysis › Responses
Accepted
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.