Units

Endpoint/api/v1

Download schema

Unit settings sub-resource of the job

Get Units

GET

/api/v1

/job/units

Gets the current unit settings for the job.

Get Units › Responses

Returns the current units

Unit settings for the current job.

length

string · enum

Length unit. Members mirror SPACE GASS SGLength (NetCommon/CommonEnums.vb); integer values and identifiers must stay in lock-step with it. The System.ComponentModel.DescriptionAttribute carries the display label (mirrors gcUNITS_LABEL_*).

Enum values:

sectionProperties

string · enum

Unit for section properties (area, moment of inertia, etc.). Members mirror SPACE GASS SgSectionProperties (NetCommon/CommonEnums.vb).

Enum values:

materialStrength

string · enum

Material strength unit (yield stress, ultimate stress, etc.). Members mirror SPACE GASS SgMaterialStrength.

Enum values:

Ksf

Psf

Ksi

Psi

MPa

kPa

kgperm2

massDensity

string · enum

Mass density unit. Members mirror SPACE GASS SgMassDensity.

Enum values:

Kperft3

Kperin3

lbperft3

lbperin3

Tperm3

Tpercm3

Tpermm3

kgperm3

temperature

string · enum

Temperature unit. Members mirror SPACE GASS SgTemperature.

Enum values:

degF

degC

force

string · enum

Force unit. Members mirror SPACE GASS SgForce.

Enum values:

moment

string · enum

Moment unit. Members mirror SPACE GASS SgMoment.

Enum values:

Kft

Kin

lbft

lbin

kNm

kNcm

kNmm

mass

string · enum

Mass unit. Members mirror SPACE GASS SgMass.

Enum values:

acceleration

string · enum

Acceleration unit. Members mirror SPACE GASS SgAcceleration.

Enum values:

ftpersec2

inpersec2

mpersec2

cmpersec2

mmpersec2

kNperkg

translation

string · enum

Translation (displacement) unit. Members mirror SPACE GASS SgTranslation. SG uses inch here (not in) to dodge the VB reserved word; we mirror that so the wire token stays "inch".

Enum values:

inch

stress

string · enum

Stress unit. Members mirror SPACE GASS SgStress.

Enum values:

Ksf

Psf

Ksi

Psi

MPa

kPa

kgperm2

Get Units Metadata

GET

/api/v1

/job/units/metadata

Returns the schema for GET /job/units — one entry per unit property with the full list of allowedValues (SPACE GASS unit tokens + display labels). Use this to drive a units-picker UI without round-tripping to Swagger.

Get Units Metadata › Responses

Returns the units schema

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.

Job Settings

Get Units

GET

/api/v1

/job/units

Gets the current unit settings for the job.

Get Units › Responses

Returns the current units

Unit settings for the current job.

length

string · enum

Enum values:

sectionProperties

string · enum

Unit for section properties (area, moment of inertia, etc.). Members mirror SPACE GASS SgSectionProperties (NetCommon/CommonEnums.vb).

Enum values:

materialStrength

string · enum

Material strength unit (yield stress, ultimate stress, etc.). Members mirror SPACE GASS SgMaterialStrength.

Enum values:

Ksf

Psf

Ksi

Psi

MPa

kPa

kgperm2

massDensity

string · enum

Mass density unit. Members mirror SPACE GASS SgMassDensity.

Enum values:

Kperft3

Kperin3

lbperft3

lbperin3

Tperm3

Tpercm3

Tpermm3

kgperm3

temperature

string · enum

Temperature unit. Members mirror SPACE GASS SgTemperature.

Enum values:

degF

degC

force

string · enum

Force unit. Members mirror SPACE GASS SgForce.

Enum values:

moment

string · enum

Moment unit. Members mirror SPACE GASS SgMoment.

Enum values:

Kft

Kin

lbft

lbin

kNm

kNcm

kNmm

mass

string · enum

Mass unit. Members mirror SPACE GASS SgMass.

Enum values:

acceleration

string · enum

Acceleration unit. Members mirror SPACE GASS SgAcceleration.

Enum values:

ftpersec2

inpersec2

mpersec2

cmpersec2

mmpersec2

kNperkg

translation

string · enum

Translation (displacement) unit. Members mirror SPACE GASS SgTranslation. SG uses inch here (not in) to dodge the VB reserved word; we mirror that so the wire token stays "inch".

Enum values:

inch

stress

string · enum

Stress unit. Members mirror SPACE GASS SgStress.

Enum values:

Ksf

Psf

Ksi

Psi

MPa

kPa

kgperm2

Get Units Metadata

GET

/api/v1

/job/units/metadata

Get Units Metadata › Responses

Returns the units schema

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.