Structural plates
Get List
Returns all items with optional filtering, pagination and sub-resource expansion.
Results are always sorted by Id ascending.
Pagination metadata is returned in response headers (Total-Count, Offset, Limit).
Expand defaults to none on list endpoints so payloads stay lean;
pass Expand=all to hydrate sub-resources. Sub-resource expansion is
opt-in per resource type — resources that don't define sub-resources ignore the parameter.
query Parameters
platesPlate Ids to filter by, in SG list format (e.g. "1,3-7,10").
Omit to return all plates.
theoryFilter by plate theory (Kirchoff or Mindlin).
Plate theory type for finite element analysis. Maps to SPACE GASS lookup table "Plate Theory".
materialFilter by material number.
offsetNumber of items to skip from the start of the result set. Default is 0.
limitMaximum number of items to return. Default is null (return all).
expandSub-resource expansion. Defaults to none; pass all to hydrate sub-resources.
Controls sub-resource hydration on entity GET endpoints.
Shared across every resource that supports expansion — a given resource's
metadata (expandable) lists which sub-resources All hydrates.
Get List › Responses
OK
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).
Create
Creates a new item. If a validator is registered, the item is validated before creation.
Create › Request Body
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).
Create › Responses
Created
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).
Get by Id
Expand defaults to all on the single-item endpoint; pass Expand=none
to suppress sub-resource hydration. Sub-resource expansion is opt-in per resource type —
resources that don't define sub-resources ignore the parameter.
path Parameters
idThe entity Id
query Parameters
expandSub-resource expansion. Defaults to all; pass none to suppress sub-resource hydration.
Controls sub-resource hydration on entity GET endpoints.
Shared across every resource that supports expansion — a given resource's
metadata (expandable) lists which sub-resources All hydrates.
Get by Id › Responses
OK
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).
Delete
Deletes the entity with the supplied Id. Returns 404 if no entity with that Id exists.
For entities whose delete cascades (Nodes, Members, Plates), returns 200 with a SpaceGassApi.Models.Dtos.Entity.DeleteResultDto listing every row removed — the entity itself, child rows that referenced it (loads, restraints, offsets, plate cuts, …), and any nodes left disconnected by the removal. Cleanup is best-effort, not transactional across datasheets: on failure the affected datasheets are reloaded from disk and the request fails.
For all other entities, returns 204 No Content and removes only the entity's own row.
path Parameters
idThe entity Id
Delete › Responses
OK
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.
Update
Updates an existing item. If a validator is registered, the update is validated first.
path Parameters
idThe entity Id
Update › Request Body
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).
Update › Responses
OK
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).
Get Direction
Gets the direction for a specific plate. Returns the active source (Angle, Node, or Axis) and all three underlying field values.
path Parameters
idThe plate Id
Get Direction › Responses
Returns the plate direction
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".
Set Direction
Sets the direction for a specific plate. Exactly one of dirAngle,
dirNode, or dirAxis must be supplied — the underlying datasheet row
enforces mutual exclusion, so the supplied field is written and SG's per-field
helper zeros the other two for the row.
A missing or empty body is rejected with 400 (PUT expects a meaningful payload).
Uses PUT because today every write replaces the full direction state (the mutex invariant zeros the other two fields). When SG stores a discriminator on the row, a sibling PATCH endpoint will be added that supports true single-field partial updates without touching the others.
path Parameters
idThe plate Id
Set Direction › Request Body
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".
Set Direction › Responses
Direction updated successfully
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".
Get Direction Metadata
Returns the schema for the plate-direction sub-resource: field definitions,
units resolved against current job units, and allowed values for enum fields.
Fields mirror the shape of the direction object on plate responses.
Get Direction Metadata › Responses
Returns direction schema metadata
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Get Metadata
Returns the resource metadata document — field schema, data types, units resolved against current job units, allowed values for enum fields, and validation bounds. Clients use this to drive UI, form validation, and schema introspection.
Get Metadata › Responses
OK
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Create Bulk
Creates multiple items in a bulk operation. If a validator is registered, all items are validated upfront before any are created.
query Parameters
continueOnErrorWhether to continue processing after individual failures
Create Bulk › Request Body
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).
Create Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Delete Bulk
Deletes multiple entities by Id. The body is a JSON array of integer Ids
(e.g. [1, 5, 10]) — consistent with every other bulk-delete endpoint
in the API (see CLAUDE.md "Query Parameter Conventions").
For cascading entities (Nodes, Members, Plates), continueOnError governs only the
per-Id existence pre-check: a missing Id is reported and, when false, aborts the
batch. The cascade itself is planned and executed as a single unit — if cleanup fails
mid-execution the entire batch is rolled back (affected datasheets are reloaded), so no
partial cascade is persisted.
query Parameters
continueOnErrorWhether to continue on error
Delete Bulk › Responses
Returns a bulk result whose succeeded entries each carry the deleted Id.
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Update Bulk
Updates multiple items in a bulk operation. Each item must include its Id in the request body. If a validator is registered, all items are validated upfront before any are updated.
query Parameters
continueOnErrorWhether to continue processing after individual failures
Update Bulk › Request Body
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).
Update Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.