Materials

Endpoint/api/v1

Structural materials

Get List

GET

/api/v1

/job/structure/materials

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.

Get List › query Parameters

materials

string

Material Ids to filter by, in SG list format (e.g. "1,3-7,10"). Omit to return all materials.

Example: 1,3-7,10

offset

integer · int32 · min: 0 · max: 2147483647

Number of items to skip from the start of the result set. Default is 0.

limit

integer · int32 · min: 1 · max: 2147483647

Maximum number of items to return. Default is null (return all).

expand

string · enum

Sub-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.

Enum values:

None

All

Get List › Responses

object[]

DTO for reading a material entity.

id

integer · int32 · min: 1 · max: 2147483647 · required

Primary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue

Example: 1

name

string | null

Material name.

youngsModulus

number · double

Young's modulus.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double

Mass density.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number · double

Concrete compressive strength.

source

string · enum

Indicates whether a section or material was user-defined or imported from a library.

Enum values:

User

Library

library

string | null

Library name. Empty for user-defined materials.

Create

POST

/api/v1

/job/structure/materials

Creates a new item. If a validator is registered, the item is validated before creation.

Create › Request Body

DTO for creating a new user-defined material.

name

string · minLength: 1 · required

Material name.

id

integer | null · int32 · min: 1 · max: 2147483647

Primary 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.

Example: 1

youngsModulus

number · double · min: 5e-324 · max: 1.7976931348623157e+308

Young's modulus. Must be greater than zero.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double · min: 5e-324 · max: 1.7976931348623157e+308

Mass density. Must be greater than zero.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number | null · double

Concrete compressive strength.

Create › Responses

Created

DTO for reading a material entity.

id

integer · int32 · min: 1 · max: 2147483647 · required

Primary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue

Example: 1

name

string | null

Material name.

youngsModulus

number · double

Young's modulus.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double

Mass density.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number · double

Concrete compressive strength.

source

string · enum

Indicates whether a section or material was user-defined or imported from a library.

Enum values:

User

Library

library

string | null

Library name. Empty for user-defined materials.

Get by Id

GET

/api/v1

/job/structure/materials/{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.

Get by Id › path Parameters

id

integer · int32 · required

The entity Id

Get by Id › query Parameters

expand

string · enum

Sub-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.

Enum values:

None

All

Get by Id › Responses

DTO for reading a material entity.

id

integer · int32 · min: 1 · max: 2147483647 · required

Primary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue

Example: 1

name

string | null

Material name.

youngsModulus

number · double

Young's modulus.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double

Mass density.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number · double

Concrete compressive strength.

source

string · enum

Indicates whether a section or material was user-defined or imported from a library.

Enum values:

User

Library

library

string | null

Library name. Empty for user-defined materials.

Delete

DELETE

/api/v1

/job/structure/materials/{id}

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.

Delete › path Parameters

id

integer · int32 · required

The entity Id

Delete › Responses

Summary of a cascade delete: everything removed when a Node, Member, or Plate was deleted — the entity itself plus every child row that referenced it and any nodes transitively orphaned by the removal. Only entity types that actually had rows removed are present; the rest are omitted.

nodes

array | null

Ids of nodes removed (the requested node(s) plus any orphaned by member/plate removal).

members

array | null

Ids of members removed because one of their end nodes was deleted.

plates

array | null

Ids of plates removed because one of their corner nodes was deleted.

nodeRestraints

array | null

Node Ids whose restraint row was removed.

nodeConstraints

array | null

Slave-node Ids of constraint rows removed (a constraint is dropped if either its slave or master node is deleted).

memberOffsets

array | null

Member Ids whose offset row was removed.

plateCuts

array | null

Ids of plate cuts removed (a cut references two plates and two nodes).

plateStrips

array | null

Ids of plate strips removed (a strip references two plates and two nodes).

array | null

Composite keys (case + node) of node loads removed.

array | null

Composite keys (case + node) of prescribed displacements removed.

array | null

Composite keys (case + node) of lumped mass loads removed.

array | null

Composite keys (case + member + subLoad) of member concentrated loads removed.

array | null

Composite keys (case + member + subLoad) of member distributed loads removed.

array | null

Composite keys (case + member + subLoad) of member distributed moments removed.

array | null

Composite keys (case + member) of member prestress loads removed.

array | null

Composite keys (case + plate) of plate pressure loads removed.

array | null

Composite keys (case + element + elementType) of thermal loads removed.

membersDirectionReset

array | null

Ids 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.

platesDirectionReset

array | null

Ids 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.

totalRemoved

integer · int32

Total number of rows removed across all entity types.

DELETE/job/structure/materials/{id}

curl --request DELETE \
  --url /api/v1/job/structure/materials/:id

shell

Example Responses

{
  "nodes": [
    0
  ],
  "members": [
    0
  ],
  "plates": [
    0
  ],
  "nodeRestraints": [
    0
  ],
  "nodeConstraints": [
    0
  ],
  "memberOffsets": [
    0
  ],
  "plateCuts": [
    0
  ],
  "plateStrips": [
    0
  ],
  "nodeLoads": [
    {
      "loadCase": 0,
      "node": 0
    }
  ],
  "prescribedDisplacements": [
    {
      "loadCase": 0,
      "node": 0
    }
  ],
  "lumpedMassLoads": [
    {
      "loadCase": 0,
      "node": 0
    }
  ],
  "memberConcentratedLoads": [
    {
      "loadCase": 0,
      "member": 0,
      "subLoad": 0
    }
  ],
  "memberDistributedLoads": [
    {
      "loadCase": 0,
      "member": 0,
      "subLoad": 0
    }
  ],
  "memberDistributedMoments": [
    {
      "loadCase": 0,
      "member": 0,
      "subLoad": 0
    }
  ],
  "memberPrestressLoads": [
    {
      "loadCase": 0,
      "member": 0
    }
  ],
  "platePressureLoads": [
    {
      "loadCase": 0,
      "plate": 0
    }
  ],
  "thermalLoads": [
    {
      "loadCase": 0,
      "elementId": 0,
      "elementType": "Member"
    }
  ],
  "membersDirectionReset": [
    0
  ],
  "platesDirectionReset": [
    0
  ],
  "totalRemoved": 0
}

json

application/json

Update

PATCH

/api/v1

/job/structure/materials/{id}

Updates an existing item. If a validator is registered, the update is validated first.

Update › path Parameters

id

integer · int32 · required

The entity Id

Update › Request Body

DTO for updating an existing material. All fields are optional to support partial updates.

id

integer | null · int32 · min: 1 · max: 2147483647

Primary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.

Example: 1

name

string | null

Material name.

youngsModulus

number | null · double · min: 5e-324 · max: 1.7976931348623157e+308

Young's modulus. Must be greater than zero if provided.

poissonsRatio

number | null · double

Poisson's ratio (unitless).

massDensity

number | null · double · min: 5e-324 · max: 1.7976931348623157e+308

Mass density. Must be greater than zero if provided.

thermalCoeff

number | null · double

Thermal expansion coefficient.

concreteStrength

number | null · double

Concrete compressive strength.

Update › Responses

DTO for reading a material entity.

id

integer · int32 · min: 1 · max: 2147483647 · required

Primary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue

Example: 1

name

string | null

Material name.

youngsModulus

number · double

Young's modulus.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double

Mass density.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number · double

Concrete compressive strength.

source

string · enum

Indicates whether a section or material was user-defined or imported from a library.

Enum values:

User

Library

library

string | null

Library name. Empty for user-defined materials.

Get Metadata

GET

/api/v1

/job/structure/materials/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

Metadata describing an API resource — entity, sub-resource, or result set. Returned from `GET …/metadata` endpoints so clients can introspect the shape, units, and valid values of the data without hitting a live endpoint.

resourceType

string · enum

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.

Enum values:

Nodes

Members

Plates

PlateCuts

PlateStrips

Solids

NodeLoads

MemberConcentratedLoads

count

integer | null · int32

Current count of items in this resource. Null for sub-resources whose count does not apply uniformly.

maxId

integer | null · int32

Maximum Id currently in use (single-int Id entities only).

nextId

integer | null · int32

Next available Id (single-int Id entities only).

array | null

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.

Next Id

GET

/api/v1

/job/structure/materials/next

Gets the next available (unused) Id for this entity type.

Next Id › query Parameters

start

integer · int32

The Id value to start searching from (inclusive). Defaults to 1.

Default: 1

Next Id › Responses

integer · int32

Create Bulk

POST

/api/v1

/job/structure/materials/bulk

Creates multiple items in a bulk operation. If a validator is registered, all items are validated upfront before any are created.

Create Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Create Bulk › Request Body

object[]

DTO for creating a new user-defined material.

name

string · minLength: 1 · required

Material name.

id

integer | null · int32 · min: 1 · max: 2147483647

Primary 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.

Example: 1

youngsModulus

number · double · min: 5e-324 · max: 1.7976931348623157e+308

Young's modulus. Must be greater than zero.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double · min: 5e-324 · max: 1.7976931348623157e+308

Mass density. Must be greater than zero.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number | null · double

Concrete compressive strength.

Create Bulk › Responses

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.

POST/job/structure/materials/bulk

curl --request POST \
  --url /api/v1/job/structure/materials/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "name",
    "youngsModulus": 5e-324,
    "poissonsRatio": 0,
    "massDensity": 5e-324,
    "thermalCoeff": 0,
    "concreteStrength": 0
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "name",
    "youngsModulus": 5e-324,
    "poissonsRatio": 0,
    "massDensity": 5e-324,
    "thermalCoeff": 0,
    "concreteStrength": 0
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "name",
      "youngsModulus": 0,
      "poissonsRatio": 0,
      "massDensity": 0,
      "thermalCoeff": 0,
      "concreteStrength": 0,
      "source": "User",
      "library": "library"
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Delete Bulk

DELETE

/api/v1

/job/structure/materials/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.

Delete Bulk › query Parameters

continueOnError

boolean

Whether to continue on error

Default: false

Delete Bulk › Request Body

integer[]

Delete Bulk › Responses

Returns a bulk result whose succeeded entries each carry the deleted Id.

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True 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

PATCH

/api/v1

/job/structure/materials/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.

Update Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Update Bulk › Request Body

object[]

DTO for updating an existing material. All fields are optional to support partial updates.

id

integer | null · int32 · min: 1 · max: 2147483647

Primary identifier of the entity to update. Optional for single updates (Id comes from route), required for bulk updates.

Example: 1

name

string | null

Material name.

youngsModulus

number | null · double · min: 5e-324 · max: 1.7976931348623157e+308

Young's modulus. Must be greater than zero if provided.

poissonsRatio

number | null · double

Poisson's ratio (unitless).

massDensity

number | null · double · min: 5e-324 · max: 1.7976931348623157e+308

Mass density. Must be greater than zero if provided.

thermalCoeff

number | null · double

Thermal expansion coefficient.

concreteStrength

number | null · double

Concrete compressive strength.

Update Bulk › Responses

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.

PATCH/job/structure/materials/bulk

curl --request PATCH \
  --url /api/v1/job/structure/materials/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "name",
    "youngsModulus": 5e-324,
    "poissonsRatio": 0,
    "massDensity": 5e-324,
    "thermalCoeff": 0,
    "concreteStrength": 0
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "name",
    "youngsModulus": 5e-324,
    "poissonsRatio": 0,
    "massDensity": 5e-324,
    "thermalCoeff": 0,
    "concreteStrength": 0
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "name",
      "youngsModulus": 0,
      "poissonsRatio": 0,
      "massDensity": 0,
      "thermalCoeff": 0,
      "concreteStrength": 0,
      "source": "User",
      "library": "library"
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Create Library Material

POST

/api/v1

/job/structure/materials/library

Creates a material by looking it up in a SPACE GASS material library. All material properties (Young's modulus, Poisson's ratio, mass density, thermal coefficient, concrete strength) are populated from the library — the caller provides only the material name and library.

Create Library Material › Request Body

DTO for creating a new library-sourced material. All material properties (Young's modulus, Poisson's ratio, etc.) are resolved from the library — the caller provides only the material name and library.

name

string · minLength: 1 · required

Material item name within the library.

Example: Steel(AS)

library

string · minLength: 1 · required

Library name.

Example: AustralianMaterials

id

integer | null · int32 · min: 1 · max: 2147483647

Primary 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.

Example: 1

Create Library Material › Responses

Material created

DTO for reading a material entity.

id

integer · int32 · min: 1 · max: 2147483647 · required

Primary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue

Example: 1

name

string | null

Material name.

youngsModulus

number · double

Young's modulus.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double

Mass density.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number · double

Concrete compressive strength.

source

string · enum

Indicates whether a section or material was user-defined or imported from a library.

Enum values:

User

Library

library

string | null

Library name. Empty for user-defined materials.

Create Library Materials Bulk

POST

/api/v1

/job/structure/materials/library/bulk

Creates multiple library-sourced materials in a single request. Each material is resolved from the SPACE GASS material library by (name, library).

Create Library Materials Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Create Library Materials Bulk › Request Body

object[]

name

string · minLength: 1 · required

Material item name within the library.

Example: Steel(AS)

library

string · minLength: 1 · required

Library name.

Example: AustralianMaterials

id

integer | null · int32 · min: 1 · max: 2147483647

Primary 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.

Example: 1

Create Library Materials Bulk › Responses

Bulk operation completed (check succeeded/errors arrays)

Result of a bulk operation.

array | null

Successfully processed items.

array | null

Errors from failed items.

errorsTruncated

boolean

True when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.

POST/job/structure/materials/library/bulk

curl --request POST \
  --url /api/v1/job/structure/materials/library/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Steel(AS)",
    "library": "AustralianMaterials"
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Steel(AS)",
    "library": "AustralianMaterials"
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "name",
      "youngsModulus": 0,
      "poissonsRatio": 0,
      "massDensity": 0,
      "thermalCoeff": 0,
      "concreteStrength": 0,
      "source": "User",
      "library": "library"
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Replace With Library Material

PUT

/api/v1

/job/structure/materials/{id}/library

Replaces the material at the given Id with a library-sourced material. The existing row is deleted and a new row is created at the same Id, resolved from the SPACE GASS material library by (name, library). Use this to convert a User material to a Library material, or to re-resolve an existing Library material against a different library entry. Any id in the request body is ignored — the route Id wins.

Replace With Library Material › path Parameters

id

integer · int32 · required

The Id of the material to replace

Replace With Library Material › Request Body

name

string · minLength: 1 · required

Material item name within the library.

Example: Steel(AS)

library

string · minLength: 1 · required

Library name.

Example: AustralianMaterials

id

integer | null · int32 · min: 1 · max: 2147483647

Primary 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.

Example: 1

Replace With Library Material › Responses

Material replaced

DTO for reading a material entity.

id

integer · int32 · min: 1 · max: 2147483647 · required

Primary identifier - must be unique, no duplicates allowed. Range: 1 to int.MaxValue

Example: 1

name

string | null

Material name.

youngsModulus

number · double

Young's modulus.

poissonsRatio

number · double

Poisson's ratio (unitless).

massDensity

number · double

Mass density.

thermalCoeff

number · double

Thermal expansion coefficient.

concreteStrength

number · double

Concrete compressive strength.

source

string · enum

Indicates whether a section or material was user-defined or imported from a library.

Enum values:

User

Library

library

string | null

Library name. Empty for user-defined materials.

Sections Nodes