Named filters — composite criteria across nodes, members, plates, sections, axis ranges, etc.
Get List
Returns all named filters in the open job. Filter by Id list or by
name substring (search). Results are sorted by Id ascending.
Pagination metadata is returned in response headers
(Total-Count, Offset, Limit).
query Parameters
filtersFilter Ids to return, in SG list format (e.g. "1,3-7,10").
Omit to return all filters.
searchSearch text matched case-insensitively against the filter name.
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. Filters have no expandable sub-resources in v1; the parameter is accepted for API consistency.
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
Returns the list of filters
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.
Create
Creates a new named filter. At least one sub-filter must be
active (or carry a non-default value) for the filter to be persisted.
If id is omitted, the next available slot (1..200) is assigned.
Create › Request Body
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.
Create › Responses
Filter created
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.
Get by Id
Returns a single named filter by Id. The response includes every
sub-filter (active or not) — inactive blocks have isActive = false
and default criterion fields.
path Parameters
idThe filter Id (1..200).
query Parameters
expandSub-resource expansion. No expandable sub-resources in v1.
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
Returns the 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.
Delete
Deletes a filter and all its sub-filter rows from the datasheet.
path Parameters
idThe filter 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
Partially updates a filter. Each sub-filter in the body is
itself partial — supplied fields are merged into the existing sub-filter;
omitted fields keep their current value. A null sub-filter on the wire
means "don't touch this sub-filter at all". To soft-deactivate a
sub-filter (preserving its data), send { "nodes": { "isActive": false } }.
To completely remove a filter, use DELETE.
path Parameters
idThe filter Id.
Update › Request Body
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.
Update › Responses
Returns the updated 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.
Get Axis Range Metadata
Shared schema for the X-Axis, Y-Axis and Z-Axis sub-filters
(all three use FilterAxisRangeDto on the parent).
Get Axis Range Metadata › Responses
Returns the Axis Range sub-filter schema
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 Materials Metadata
Returns the field schema for the Materials sub-filter.
Get Materials Metadata › Responses
Returns the Materials sub-filter schema
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 Members Metadata
Returns the field schema for the Members sub-filter.
Get Members Metadata › Responses
Returns the Members sub-filter schema
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 Nodes Metadata
Returns the field schema for the Nodes sub-filter.
Get Nodes Metadata › Responses
Returns the Nodes sub-filter schema
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Get Plate Cuts Metadata
Returns the field schema for the Plate Cuts sub-filter.
Get Plate Cuts Metadata › Responses
Returns the Plate Cuts sub-filter schema
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Get Plate Strips Metadata
Returns the field schema for the Plate Strips sub-filter.
Get Plate Strips Metadata › Responses
Returns the Plate Strips sub-filter schema
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Get Plate Thicknesses Metadata
Returns the field schema for the Plate Thicknesses sub-filter.
Get Plate Thicknesses Metadata › Responses
Returns the Plate Thicknesses sub-filter schema
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 Plates Metadata
Returns the field schema for the Plates sub-filter.
Get Plates Metadata › Responses
Returns the Plates sub-filter schema
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 Sections Metadata
Returns the field schema for the Sections sub-filter.
Get Sections Metadata › Responses
Returns the Sections sub-filter schema
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 Steel Connections Metadata
Returns the field schema for the Steel Connections sub-filter.
Get Steel Connections Metadata › Responses
Returns the Steel Connections sub-filter schema
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 Steel Members Metadata
Returns the field schema for the Steel Members sub-filter.
Get Steel Members Metadata › Responses
Returns the Steel Members sub-filter schema
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 top-level schema for a filter: id, name,
active, and the 13 sub-filter properties (each emitted
with the corresponding sub-filter DTO type name). For per-sub-filter field
schema, call the dedicated /filters/items/{sub-filter}/metadata
endpoint matching the sub-filter shape.
Get Metadata › Responses
Returns filter schema metadata
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Get Next Id
Returns the next unused filter Id, starting from start. The hard cap is 200 — caller should treat any value above that as "no slots available".
query Parameters
startThe Id to start searching from (inclusive). Defaults to 1.
Get Next Id › Responses
Returns the next available filter Id
Create Bulk
Creates multiple filters in a single request.
query Parameters
continueOnErrorIf true, process valid items even when some fail. Default: false.
Create Bulk › Request Body
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.
Create Bulk › Responses
Returns the bulk result
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Delete Bulk
Deletes multiple filters in a single request.
query Parameters
continueOnErrorIf true, continue processing remaining Ids after a failure. Default: false.
Delete Bulk › Responses
Returns the bulk result
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Update Bulk
Partially updates multiple filters in a single request.
query Parameters
continueOnErrorIf true, process valid items even when some fail. Default: false.
Update Bulk › Request Body
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.
Update Bulk › Responses
Returns the bulk result
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.