Sections

Endpoint/api/v1

Structural sections

Get All

GET

/api/v1

/job/structure/sections

Gets 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 All › query Parameters

Sections

string

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

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 All › Responses

object[]

DTO for reading a section 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

Section name.

Example: 360 UB 44.7

library

string | null

Library name.

Example: Aust300

mark

string | null

Section mark / designation.

Example: B1

a

number · double

Cross-sectional area.

Example: 5720

j

number · double

Torsion constant.

Example: 158000

iy

number · double

Second moment of area about the principal Y axis.

Example: 121000000

iz

number · double

Second moment of area about the principal Z axis.

Example: 8970000

ay

number · double

Shear area in the Y direction.

Example: 2720

az

number · double

Shear area in the Z direction.

Example: 2010

principalAngle

number · double

Principal axis rotation angle.

Example: 0

source

string · enum

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

Enum values:

User

Library

shapes

integer · int32

Number of shapes in the section (1 for a standard library section).

Example: 1

areaFactor

number · double

Area modification factor.

Example: 1

torsionFactor

number · double

Torsion modification factor.

Example: 1

iyFactor

number · double

Iy modification factor.

Example: 1

izFactor

number · double

Iz modification factor.

Example: 1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean

Whether the section's principal axes are swapped (transposed shape).

Example: false

Create

POST

/api/v1

/job/structure/sections

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

Create › Request Body

DTO for creating a user-defined section with explicit structural properties.

name

string · minLength: 1 · required

Section name.

Example: Custom-1

a

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

Cross-sectional area.

Example: 5720

j

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

Torsion constant.

Example: 158000

iy

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

Second moment of area about the principal Y axis.

Example: 121000000

iz

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

Second moment of area about the principal Z axis.

Example: 8970000

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

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

mark

string | null

Section mark / designation.

Example: B1

principalAngle

number | null · double

Principal axis rotation angle.

Example: 0

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

Create › Responses

Created

DTO for reading a section 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

Section name.

Example: 360 UB 44.7

library

string | null

Library name.

Example: Aust300

mark

string | null

Section mark / designation.

Example: B1

a

number · double

Cross-sectional area.

Example: 5720

j

number · double

Torsion constant.

Example: 158000

iy

number · double

Second moment of area about the principal Y axis.

Example: 121000000

iz

number · double

Second moment of area about the principal Z axis.

Example: 8970000

ay

number · double

Shear area in the Y direction.

Example: 2720

az

number · double

Shear area in the Z direction.

Example: 2010

principalAngle

number · double

Principal axis rotation angle.

Example: 0

source

string · enum

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

Enum values:

User

Library

shapes

integer · int32

Number of shapes in the section (1 for a standard library section).

Example: 1

areaFactor

number · double

Area modification factor.

Example: 1

torsionFactor

number · double

Torsion modification factor.

Example: 1

iyFactor

number · double

Iy modification factor.

Example: 1

izFactor

number · double

Iz modification factor.

Example: 1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean

Whether the section's principal axes are swapped (transposed shape).

Example: false

POST/job/structure/sections

curl --request POST \
  --url /api/v1/job/structure/sections \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "Custom-1",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "Custom-1",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}

json

Example Responses

{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "source": "User",
  "shapes": 1,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1,
  "angleType": "NotApplicable",
  "transposed": false
}

json

application/json

Get by Id

GET

/api/v1

/job/structure/sections/{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 section 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

Section name.

Example: 360 UB 44.7

library

string | null

Library name.

Example: Aust300

mark

string | null

Section mark / designation.

Example: B1

a

number · double

Cross-sectional area.

Example: 5720

j

number · double

Torsion constant.

Example: 158000

iy

number · double

Second moment of area about the principal Y axis.

Example: 121000000

iz

number · double

Second moment of area about the principal Z axis.

Example: 8970000

ay

number · double

Shear area in the Y direction.

Example: 2720

az

number · double

Shear area in the Z direction.

Example: 2010

principalAngle

number · double

Principal axis rotation angle.

Example: 0

source

string · enum

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

Enum values:

User

Library

shapes

integer · int32

Number of shapes in the section (1 for a standard library section).

Example: 1

areaFactor

number · double

Area modification factor.

Example: 1

torsionFactor

number · double

Torsion modification factor.

Example: 1

iyFactor

number · double

Iy modification factor.

Example: 1

izFactor

number · double

Iz modification factor.

Example: 1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean

Whether the section's principal axes are swapped (transposed shape).

Example: false

Delete

DELETE

/api/v1

/job/structure/sections/{id}

Delete › path Parameters

id

integer · int32 · required

The entity Id

Delete › Responses

No Content

No data returned

Update

PATCH

/api/v1

/job/structure/sections/{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 partially updating an existing section. All fields are optional — only fields present on the request are updated.

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

Section name.

Example: Custom-1

mark

string | null

Section mark / designation.

Example: B1

a

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

Cross-sectional area.

Example: 5720

j

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

Torsion constant.

Example: 158000

iy

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

Second moment of area about the principal Y axis.

Example: 121000000

iz

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

Second moment of area about the principal Z axis.

Example: 8970000

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

principalAngle

number | null · double

Principal axis rotation angle.

Example: 0

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

Update › Responses

DTO for reading a section 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

Section name.

Example: 360 UB 44.7

library

string | null

Library name.

Example: Aust300

mark

string | null

Section mark / designation.

Example: B1

a

number · double

Cross-sectional area.

Example: 5720

j

number · double

Torsion constant.

Example: 158000

iy

number · double

Second moment of area about the principal Y axis.

Example: 121000000

iz

number · double

Second moment of area about the principal Z axis.

Example: 8970000

ay

number · double

Shear area in the Y direction.

Example: 2720

az

number · double

Shear area in the Z direction.

Example: 2010

principalAngle

number · double

Principal axis rotation angle.

Example: 0

source

string · enum

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

Enum values:

User

Library

shapes

integer · int32

Number of shapes in the section (1 for a standard library section).

Example: 1

areaFactor

number · double

Area modification factor.

Example: 1

torsionFactor

number · double

Torsion modification factor.

Example: 1

iyFactor

number · double

Iy modification factor.

Example: 1

izFactor

number · double

Iz modification factor.

Example: 1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean

Whether the section's principal axes are swapped (transposed shape).

Example: false

PATCH/job/structure/sections/{id}

curl --request PATCH \
  --url /api/v1/job/structure/sections/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "Custom-1",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "Custom-1",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}

json

Example Responses

{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "source": "User",
  "shapes": 1,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1,
  "angleType": "NotApplicable",
  "transposed": false
}

json

application/json

Get Metadata

GET

/api/v1

/job/structure/sections/metadata

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/sections/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/sections/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 user-defined section with explicit structural properties.

name

string · minLength: 1 · required

Section name.

Example: Custom-1

a

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

Cross-sectional area.

Example: 5720

j

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

Torsion constant.

Example: 158000

iy

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

Second moment of area about the principal Y axis.

Example: 121000000

iz

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

Second moment of area about the principal Z axis.

Example: 8970000

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

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

mark

string | null

Section mark / designation.

Example: B1

principalAngle

number | null · double

Principal axis rotation angle.

Example: 0

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

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/sections/bulk

curl --request POST \
  --url /api/v1/job/structure/sections/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Custom-1",
    "mark": "B1",
    "a": 5720,
    "j": 158000,
    "iy": 121000000,
    "iz": 8970000,
    "ay": 2720,
    "az": 2010,
    "principalAngle": 0,
    "areaFactor": 1,
    "torsionFactor": 1,
    "iyFactor": 1,
    "izFactor": 1
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Custom-1",
    "mark": "B1",
    "a": 5720,
    "j": 158000,
    "iy": 121000000,
    "iz": 8970000,
    "ay": 2720,
    "az": 2010,
    "principalAngle": 0,
    "areaFactor": 1,
    "torsionFactor": 1,
    "iyFactor": 1,
    "izFactor": 1
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "360 UB 44.7",
      "library": "Aust300",
      "mark": "B1",
      "a": 5720,
      "j": 158000,
      "iy": 121000000,
      "iz": 8970000,
      "ay": 2720,
      "az": 2010,
      "principalAngle": 0,
      "source": "User",
      "shapes": 1,
      "areaFactor": 1,
      "torsionFactor": 1,
      "iyFactor": 1,
      "izFactor": 1,
      "angleType": "NotApplicable",
      "transposed": false
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Delete Bulk

DELETE

/api/v1

/job/structure/sections/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").

Delete Bulk › query Parameters

continueOnError

boolean

Whether to continue on error

Default: false

Delete Bulk › Request Body

integer[]

Delete Bulk › Responses

Result of a bulk operation.

succeeded

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/sections/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 partially updating an existing section. All fields are optional — only fields present on the request are updated.

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

Section name.

Example: Custom-1

mark

string | null

Section mark / designation.

Example: B1

a

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

Cross-sectional area.

Example: 5720

j

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

Torsion constant.

Example: 158000

iy

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

Second moment of area about the principal Y axis.

Example: 121000000

iz

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

Second moment of area about the principal Z axis.

Example: 8970000

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

principalAngle

number | null · double

Principal axis rotation angle.

Example: 0

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

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/sections/bulk

curl --request PATCH \
  --url /api/v1/job/structure/sections/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Custom-1",
    "mark": "B1",
    "a": 5720,
    "j": 158000,
    "iy": 121000000,
    "iz": 8970000,
    "ay": 2720,
    "az": 2010,
    "principalAngle": 0,
    "areaFactor": 1,
    "torsionFactor": 1,
    "iyFactor": 1,
    "izFactor": 1
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Custom-1",
    "mark": "B1",
    "a": 5720,
    "j": 158000,
    "iy": 121000000,
    "iz": 8970000,
    "ay": 2720,
    "az": 2010,
    "principalAngle": 0,
    "areaFactor": 1,
    "torsionFactor": 1,
    "iyFactor": 1,
    "izFactor": 1
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "360 UB 44.7",
      "library": "Aust300",
      "mark": "B1",
      "a": 5720,
      "j": 158000,
      "iy": 121000000,
      "iz": 8970000,
      "ay": 2720,
      "az": 2010,
      "principalAngle": 0,
      "source": "User",
      "shapes": 1,
      "areaFactor": 1,
      "torsionFactor": 1,
      "iyFactor": 1,
      "izFactor": 1,
      "angleType": "NotApplicable",
      "transposed": false
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Create Library Section

POST

/api/v1

/job/structure/sections/library

Creates a section by looking it up in a SPACE GASS section library. All structural properties (A, J, Iy, Iz, etc.) and cross-section shape data are populated from the library — the caller provides only the section name and library.

Create Library Section › Request Body

DTO for creating a library-sourced section. Structural properties (A, J, Iy, Iz, etc.) and cross-section shape data are resolved from the SPACE GASS section library by (name, library).

name

string · minLength: 1 · required

Section item name within the library.

Example: 360 UB 44.7

library

string · minLength: 1 · required

Library name.

Example: Aust300

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

mark

string | null

Section mark / designation.

Example: B1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean | null

Whether the section's principal axes are swapped (transposed shape).

Example: false

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

Create Library Section › Responses

Section created

DTO for reading a section 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

Section name.

Example: 360 UB 44.7

library

string | null

Library name.

Example: Aust300

mark

string | null

Section mark / designation.

Example: B1

a

number · double

Cross-sectional area.

Example: 5720

j

number · double

Torsion constant.

Example: 158000

iy

number · double

Second moment of area about the principal Y axis.

Example: 121000000

iz

number · double

Second moment of area about the principal Z axis.

Example: 8970000

ay

number · double

Shear area in the Y direction.

Example: 2720

az

number · double

Shear area in the Z direction.

Example: 2010

principalAngle

number · double

Principal axis rotation angle.

Example: 0

source

string · enum

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

Enum values:

User

Library

shapes

integer · int32

Number of shapes in the section (1 for a standard library section).

Example: 1

areaFactor

number · double

Area modification factor.

Example: 1

torsionFactor

number · double

Torsion modification factor.

Example: 1

iyFactor

number · double

Iy modification factor.

Example: 1

izFactor

number · double

Iz modification factor.

Example: 1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean

Whether the section's principal axes are swapped (transposed shape).

Example: false

POST/job/structure/sections/library

curl --request POST \
  --url /api/v1/job/structure/sections/library \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "angleType": "NotApplicable",
  "transposed": false,
  "ay": 2720,
  "az": 2010,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "angleType": "NotApplicable",
  "transposed": false,
  "ay": 2720,
  "az": 2010,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}

json

Example Responses

{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "source": "User",
  "shapes": 1,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1,
  "angleType": "NotApplicable",
  "transposed": false
}

json

application/json

Create Library Sections Bulk

POST

/api/v1

/job/structure/sections/library/bulk

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

Create Library Sections Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Create Library Sections Bulk › Request Body

object[]

DTO for creating a library-sourced section. Structural properties (A, J, Iy, Iz, etc.) and cross-section shape data are resolved from the SPACE GASS section library by (name, library).

name

string · minLength: 1 · required

Section item name within the library.

Example: 360 UB 44.7

library

string · minLength: 1 · required

Library name.

Example: Aust300

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

mark

string | null

Section mark / designation.

Example: B1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean | null

Whether the section's principal axes are swapped (transposed shape).

Example: false

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

Create Library Sections 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/sections/library/bulk

curl --request POST \
  --url /api/v1/job/structure/sections/library/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "360 UB 44.7",
    "library": "Aust300",
    "mark": "B1",
    "angleType": "NotApplicable",
    "transposed": false,
    "ay": 2720,
    "az": 2010,
    "areaFactor": 1,
    "torsionFactor": 1,
    "iyFactor": 1,
    "izFactor": 1
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "360 UB 44.7",
    "library": "Aust300",
    "mark": "B1",
    "angleType": "NotApplicable",
    "transposed": false,
    "ay": 2720,
    "az": 2010,
    "areaFactor": 1,
    "torsionFactor": 1,
    "iyFactor": 1,
    "izFactor": 1
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "360 UB 44.7",
      "library": "Aust300",
      "mark": "B1",
      "a": 5720,
      "j": 158000,
      "iy": 121000000,
      "iz": 8970000,
      "ay": 2720,
      "az": 2010,
      "principalAngle": 0,
      "source": "User",
      "shapes": 1,
      "areaFactor": 1,
      "torsionFactor": 1,
      "iyFactor": 1,
      "izFactor": 1,
      "angleType": "NotApplicable",
      "transposed": false
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Replace With Library Section

PUT

/api/v1

/job/structure/sections/{id}/library

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

Replace With Library Section › path Parameters

id

integer · int32 · required

The Id of the section to replace

Replace With Library Section › Request Body

DTO for creating a library-sourced section. Structural properties (A, J, Iy, Iz, etc.) and cross-section shape data are resolved from the SPACE GASS section library by (name, library).

name

string · minLength: 1 · required

Section item name within the library.

Example: 360 UB 44.7

library

string · minLength: 1 · required

Library name.

Example: Aust300

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

mark

string | null

Section mark / designation.

Example: B1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean | null

Whether the section's principal axes are swapped (transposed shape).

Example: false

ay

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

Shear area in the Y direction.

Example: 2720

az

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

Shear area in the Z direction.

Example: 2010

areaFactor

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

Area modification factor.

Example: 1

torsionFactor

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

Torsion modification factor.

Example: 1

iyFactor

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

Iy modification factor.

Example: 1

izFactor

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

Iz modification factor.

Example: 1

Replace With Library Section › Responses

Section replaced

DTO for reading a section 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

Section name.

Example: 360 UB 44.7

library

string | null

Library name.

Example: Aust300

mark

string | null

Section mark / designation.

Example: B1

a

number · double

Cross-sectional area.

Example: 5720

j

number · double

Torsion constant.

Example: 158000

iy

number · double

Second moment of area about the principal Y axis.

Example: 121000000

iz

number · double

Second moment of area about the principal Z axis.

Example: 8970000

ay

number · double

Shear area in the Y direction.

Example: 2720

az

number · double

Shear area in the Z direction.

Example: 2010

principalAngle

number · double

Principal axis rotation angle.

Example: 0

source

string · enum

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

Enum values:

User

Library

shapes

integer · int32

Number of shapes in the section (1 for a standard library section).

Example: 1

areaFactor

number · double

Area modification factor.

Example: 1

torsionFactor

number · double

Torsion modification factor.

Example: 1

iyFactor

number · double

Iy modification factor.

Example: 1

izFactor

number · double

Iz modification factor.

Example: 1

angleType

string · enum

Angle section type for structural sections. Maps to SPACE GASS lookup table "Angle Type".

Enum values:

NotApplicable

SingleType

ShortShort

LongLong

Starred

transposed

boolean

Whether the section's principal axes are swapped (transposed shape).

Example: false

PUT/job/structure/sections/{id}/library

curl --request PUT \
  --url /api/v1/job/structure/sections/:id/library \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "angleType": "NotApplicable",
  "transposed": false,
  "ay": 2720,
  "az": 2010,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "angleType": "NotApplicable",
  "transposed": false,
  "ay": 2720,
  "az": 2010,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1
}

json

Example Responses

{
  "id": 1,
  "name": "360 UB 44.7",
  "library": "Aust300",
  "mark": "B1",
  "a": 5720,
  "j": 158000,
  "iy": 121000000,
  "iz": 8970000,
  "ay": 2720,
  "az": 2010,
  "principalAngle": 0,
  "source": "User",
  "shapes": 1,
  "areaFactor": 1,
  "torsionFactor": 1,
  "iyFactor": 1,
  "izFactor": 1,
  "angleType": "NotApplicable",
  "transposed": false
}

json

application/json

Settings Materials