Node Restraints

Endpoint/api/v1

Node boundary conditions and spring stiffness

Get All

GET

/api/v1

/job/structure/node-restraints

Returns all attribute rows for this resource type, with optional filtering. Sorted by parent Id ascending. Pagination metadata is returned in response headers (Total-Count, Offset, Limit).

Get All › query Parameters

Nodes

string

Node Ids to filter restraints by, in SG list format (e.g. "1,5-10,15"). Omit to return all restraints.

Example: 1,5-10,15

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

Get All › Responses

object[]

DTO for reading a node restraint. Restraints define boundary conditions at nodes (fixed, released, spring, etc.) using a 6-character restraint code (FRSVPN). Top-level entity attribute keyed on the parent node.

node

integer · int32

The node Id this restraint applies to.

restraintCode

string | null

6-character restraint code for TX,TY,TZ,RX,RY,RZ. Each character: F=Fixed (prevents movement), R=Released (allows movement), S=Spring (movement governed by a spring stiffness), V=Variable spring (multiple stiffnesses via a stiffness-vs-deflection table), P=Plastic (upper force/moment limit on the reaction), N=Friction (upper limit on reaction proportional to the normal-axis reaction).

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

generalRestraint

boolean

Whether this is the general restraint for the model.

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X. Points are (deflection, stiffness).

tyVariableTable

array | null

Variable-spring stiffness table for translational Y. Points are (deflection, stiffness).

tzVariableTable

array | null

Variable-spring stiffness table for translational Z. Points are (deflection, stiffness).

rxVariableTable

array | null

Variable-spring stiffness table for rotational X. Points are (rotation, stiffness).

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y. Points are (rotation, stiffness).

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z. Points are (rotation, stiffness).

GET/job/structure/node-restraints

curl --request GET \
  --url /api/v1/job/structure/node-restraints

shell

Example Responses

[
  {
    "node": 0,
    "restraintCode": "restraintCode",
    "activeDirection": "activeDirection",
    "generalRestraint": true,
    "txStiffness": 0,
    "tyStiffness": 0,
    "tzStiffness": 0,
    "rxStiffness": 0,
    "ryStiffness": 0,
    "rzStiffness": 0,
    "xFrictionNormalAxis": "None",
    "yFrictionNormalAxis": "None",
    "zFrictionNormalAxis": "None",
    "xFrictionNormalDirection": "Either",
    "yFrictionNormalDirection": "Either",
    "zFrictionNormalDirection": "Either",
    "xFrictionFactor": 0,
    "yFrictionFactor": 0,
    "zFrictionFactor": 0,
    "txPlasticLimit": 0,
    "tyPlasticLimit": 0,
    "tzPlasticLimit": 0,
    "rxPlasticLimit": 0,
    "ryPlasticLimit": 0,
    "rzPlasticLimit": 0,
    "txVariableTable": [
      [
        0
      ]
    ],
    "tyVariableTable": [
      [
        0
      ]
    ],
    "tzVariableTable": [
      [
        0
      ]
    ],
    "rxVariableTable": [
      [
        0
      ]
    ],
    "ryVariableTable": [
      [
        0
      ]
    ],
    "rzVariableTable": [
      [
        0
      ]
    ]
  }
]

json

application/json

Create Node Restraint

POST

/api/v1

/job/structure/node-restraints

Creates a new restraint row for the supplied node. Body must include the parent node Id. Returns 409 if a restraint already exists for that node — caller must DELETE first or use PATCH to update. Returns 404 if the node does not exist. Variable-stiffness tables can be supplied inline; the corresponding restraintCode position must be 'V'.

Create Node Restraint › Request Body

DTO for creating a node restraint. POST is entity-style: 409 if a restraint already exists for the supplied node — caller must DELETE first or PATCH instead.

node

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

The node Id to create the restraint for. Required in the request body.

restraintCode

string · minLength: 1 · required

6-character restraint code for TX,TY,TZ,RX,RY,RZ. Each character is one of: F = Fixed (prevents movement); R = Released (allows movement); S = Spring (movement governed by a spring stiffness); V = Variable spring (multiple stiffnesses via a stiffness-vs-deflection table); P = Plastic (upper force/moment limit on the reaction); N = Friction (upper limit proportional to the normal-axis reaction).

Example: FFFRRR

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ.

Example: BBBBBB

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X.

tyVariableTable

array | null

Variable-spring stiffness table for translational Y.

tzVariableTable

array | null

Variable-spring stiffness table for translational Z.

rxVariableTable

array | null

Variable-spring stiffness table for rotational X.

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y.

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z.

Create Node Restraint › Responses

Restraint created successfully

node

integer · int32

The node Id this restraint applies to.

restraintCode

string | null

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

generalRestraint

boolean

Whether this is the general restraint for the model.

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X. Points are (deflection, stiffness).

tyVariableTable

array | null

Variable-spring stiffness table for translational Y. Points are (deflection, stiffness).

tzVariableTable

array | null

Variable-spring stiffness table for translational Z. Points are (deflection, stiffness).

rxVariableTable

array | null

Variable-spring stiffness table for rotational X. Points are (rotation, stiffness).

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y. Points are (rotation, stiffness).

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z. Points are (rotation, stiffness).

POST/job/structure/node-restraints

curl --request POST \
  --url /api/v1/job/structure/node-restraints \
  --header 'Content-Type: application/json' \
  --data '
{
  "node": 5,
  "restraintCode": "FFFRRR",
  "activeDirection": "BBBBBB",
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0
}
'

shell

Example Request Body

{
  "node": 5,
  "restraintCode": "FFFRRR",
  "activeDirection": "BBBBBB",
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0
}

json

Example Responses

{
  "node": 0,
  "restraintCode": "restraintCode",
  "activeDirection": "activeDirection",
  "generalRestraint": true,
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0,
  "txVariableTable": [
    [
      0
    ]
  ],
  "tyVariableTable": [
    [
      0
    ]
  ],
  "tzVariableTable": [
    [
      0
    ]
  ],
  "rxVariableTable": [
    [
      0
    ]
  ],
  "ryVariableTable": [
    [
      0
    ]
  ],
  "rzVariableTable": [
    [
      0
    ]
  ]
}

json

application/json

Get Node Restraint

GET

/api/v1

/job/structure/node-restraints/{nodeId}

Gets the restraint for a specific node — boundary conditions and spring stiffness. Returns 404 if no explicit restraint row exists for the node. Variable-stiffness tables for V-type DOFs are inlined on the response when present.

Get Node Restraint › path Parameters

nodeId

integer · int32 · required

The node Id

Get Node Restraint › Responses

Returns the node restraint

node

integer · int32

The node Id this restraint applies to.

restraintCode

string | null

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

generalRestraint

boolean

Whether this is the general restraint for the model.

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X. Points are (deflection, stiffness).

tyVariableTable

array | null

Variable-spring stiffness table for translational Y. Points are (deflection, stiffness).

tzVariableTable

array | null

Variable-spring stiffness table for translational Z. Points are (deflection, stiffness).

rxVariableTable

array | null

Variable-spring stiffness table for rotational X. Points are (rotation, stiffness).

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y. Points are (rotation, stiffness).

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z. Points are (rotation, stiffness).

GET/job/structure/node-restraints/{nodeId}

curl --request GET \
  --url /api/v1/job/structure/node-restraints/:nodeId

shell

Example Responses

{
  "node": 0,
  "restraintCode": "restraintCode",
  "activeDirection": "activeDirection",
  "generalRestraint": true,
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0,
  "txVariableTable": [
    [
      0
    ]
  ],
  "tyVariableTable": [
    [
      0
    ]
  ],
  "tzVariableTable": [
    [
      0
    ]
  ],
  "rxVariableTable": [
    [
      0
    ]
  ],
  "ryVariableTable": [
    [
      0
    ]
  ],
  "rzVariableTable": [
    [
      0
    ]
  ]
}

json

application/json

Delete Node Restraint

DELETE

/api/v1

/job/structure/node-restraints/{nodeId}

Deletes the restraint row for a specific node. After deletion the node has no explicit restraint — it falls back to default behaviour (all DOFs free, no spring stiffness). Returns 404 if no restraint row exists.

Delete Node Restraint › path Parameters

nodeId

integer · int32 · required

The node Id

Delete Node Restraint › Responses

Restraint deleted successfully

No data returned

Update Node Restraint

PATCH

/api/v1

/job/structure/node-restraints/{nodeId}

Partially updates the restraint for a specific node. Only fields included in the request are changed; omitted fields keep their current value. The restraint must already exist — use POST /node-restraints to create one. Variable-stiffness tables can be supplied inline; the corresponding restraintCode position must be 'V' (after the update is applied).

Update Node Restraint › path Parameters

nodeId

integer · int32 · required

The node Id

Update Node Restraint › Request Body

DTO for partial updates to a node restraint. Only fields included in the request are updated; omit a field to keep its current value.

node

integer | null · int32

The node number that identifies which restraint to update. Required for bulk PATCH; ignored for single-node PATCH (route value wins).

restraintCode

string | null

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

txStiffness

number | null · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number | null · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number | null · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number | null · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number | null · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number | null · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number | null · double

X-axis friction factor.

yFrictionFactor

number | null · double

Y-axis friction factor.

zFrictionFactor

number | null · double

Z-axis friction factor.

txPlasticLimit

number | null · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number | null · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number | null · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number | null · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number | null · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number | null · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X.

tyVariableTable

array | null

Variable-spring stiffness table for translational Y.

tzVariableTable

array | null

Variable-spring stiffness table for translational Z.

rxVariableTable

array | null

Variable-spring stiffness table for rotational X.

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y.

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z.

Update Node Restraint › Responses

Restraint updated successfully

node

integer · int32

The node Id this restraint applies to.

restraintCode

string | null

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

generalRestraint

boolean

Whether this is the general restraint for the model.

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X. Points are (deflection, stiffness).

tyVariableTable

array | null

Variable-spring stiffness table for translational Y. Points are (deflection, stiffness).

tzVariableTable

array | null

Variable-spring stiffness table for translational Z. Points are (deflection, stiffness).

rxVariableTable

array | null

Variable-spring stiffness table for rotational X. Points are (rotation, stiffness).

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y. Points are (rotation, stiffness).

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z. Points are (rotation, stiffness).

PATCH/job/structure/node-restraints/{nodeId}

curl --request PATCH \
  --url /api/v1/job/structure/node-restraints/:nodeId \
  --header 'Content-Type: application/json' \
  --data '
{
  "node": 0,
  "restraintCode": "restraintCode",
  "activeDirection": "activeDirection",
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0,
  "txVariableTable": [
    [
      0
    ]
  ],
  "tyVariableTable": [
    [
      0
    ]
  ],
  "tzVariableTable": [
    [
      0
    ]
  ],
  "rxVariableTable": [
    [
      0
    ]
  ],
  "ryVariableTable": [
    [
      0
    ]
  ],
  "rzVariableTable": [
    [
      0
    ]
  ]
}
'

shell

Example Request Body

{
  "node": 0,
  "restraintCode": "restraintCode",
  "activeDirection": "activeDirection",
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0,
  "txVariableTable": [
    [
      0
    ]
  ],
  "tyVariableTable": [
    [
      0
    ]
  ],
  "tzVariableTable": [
    [
      0
    ]
  ],
  "rxVariableTable": [
    [
      0
    ]
  ],
  "ryVariableTable": [
    [
      0
    ]
  ],
  "rzVariableTable": [
    [
      0
    ]
  ]
}

json

Example Responses

{
  "node": 0,
  "restraintCode": "restraintCode",
  "activeDirection": "activeDirection",
  "generalRestraint": true,
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0,
  "txVariableTable": [
    [
      0
    ]
  ],
  "tyVariableTable": [
    [
      0
    ]
  ],
  "tzVariableTable": [
    [
      0
    ]
  ],
  "rxVariableTable": [
    [
      0
    ]
  ],
  "ryVariableTable": [
    [
      0
    ]
  ],
  "rzVariableTable": [
    [
      0
    ]
  ]
}

json

application/json

Get Restraint Table Data

GET

/api/v1

/job/structure/node-restraints/{nodeId}/table/{direction}

Returns the variable-stiffness table for one DOF on a node restraint. 404 if the node has no restraint row, or if the table for that DOF is empty. Schema metadata (axis labels, units, bounds) is available at GET /node-restraints/table/{direction}/metadata.

Get Restraint Table Data › path Parameters

nodeId

integer · int32 · required

The node Id

direction

string · enum · required

The DOF (Tx, Ty, Tz, Rx, Ry, Rz)

Identifies one of the six DOFs on a node restraint (Tx, Ty, Tz, Rx, Ry, Rz). Integer values match SPACE GASS's NodeRestraint.StiffnessDirectionIndex and the offset added to sgFRAME_RESTRAINTS_RestraintTable_Tx (27) when indexing the per-DOF table fields.

Enum values:

Get Restraint Table Data › Responses

Returns the table

array[]

A generic 2D data table — row-major, where each row is an array of column values. Reused across the API for any tabular (X, Y, …) data such as restraint variable-stiffness curves, derived force-vs-deflection views, material curves, etc. Schema (column names, types, units, bounds) is returned by the resource's dedicated table-metadata endpoint and is not embedded here.

Set Restraint Table Data

POST

/api/v1

/job/structure/node-restraints/{nodeId}/table/{direction}

Creates or replaces the variable-stiffness table for one DOF on a node restraint. The node must already have a restraint row (POST /node-restraints to create one), and the corresponding character of restraintCode must be 'V'.

Body is a TableDto whose rows field is a list of 1–15 (x, y) pairs. X is deflection (translational) or rotation (rotational), Y is the spring stiffness. The first point's X must be 0 (the base stiffness anchor); X values must be unique; X and Y must be ≥ 0.

Set Restraint Table Data › path Parameters

nodeId

integer · int32 · required

The node Id

direction

string · enum · required

The DOF (Tx, Ty, Tz, Rx, Ry, Rz)

Enum values:

Set Restraint Table Data › Request Body

array[]

Set Restraint Table Data › Responses

Table created/replaced successfully

array[]

Clear Restraint Table Data

DELETE

/api/v1

/job/structure/node-restraints/{nodeId}/table/{direction}

Clears the variable-stiffness table for one DOF on a node restraint (writes Count = 0 — the binary field stays allocated but holds no points).

Clear Restraint Table Data › path Parameters

nodeId

integer · int32 · required

The node Id

direction

string · enum · required

The DOF (Tx, Ty, Tz, Rx, Ry, Rz)

Enum values:

Clear Restraint Table Data › Responses

Table cleared

No data returned

Get Metadata

GET

/api/v1

/job/structure/node-restraints/metadata

Returns the schema for the resource: field definitions, units resolved against current job units, and allowed values for enum fields.

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.

Get Restraint Table Metadata

GET

/api/v1

/job/structure/node-restraints/table/{direction}/metadata

Returns the schema for a variable-stiffness table on the given DOF — title, axis labels and units (resolved against current job units), per-axis bounds, and the maximum number of points the table accepts.

Metadata is the same for any restraint of a given direction; it does not depend on a specific node Id and is therefore not part of {nodeId:int}/table/....

Get Restraint Table Metadata › path Parameters

direction

string · enum · required

The DOF (Tx, Ty, Tz, Rx, Ry, Rz)

Enum values:

Get Restraint Table Metadata › Responses

Returns table metadata

Schema metadata for a generic 2D data table — display title, per-column metadata (reusing SpaceGassApi.Models.Dtos.Common.FieldMetadataDto for parity with the rest of the API's metadata responses), and the maximum number of rows the table accepts.

tableName

string | null

Human-readable title, e.g. "Stiffness vs Deflection".

array | null

Column metadata in the same order the values appear in each row of SpaceGassApi.Models.Dtos.Common.TableDto.Rows. Each entry uses the same SpaceGassApi.Models.Dtos.Common.FieldMetadataDto shape as resource-level metadata (jsonName, dataType, units, min, max, description).

maxRows

integer · int32

Maximum number of rows the table accepts.

Create Node Restraints (bulk)

POST

/api/v1

/job/structure/node-restraints/bulk

Creates multiple restraint rows in a single request. Each item must include its parent node Id. Per-item 409 is reported as a bulk error if a restraint already exists for the supplied node. Variable-stiffness tables can be supplied inline on each item.

Create Node Restraints (bulk) › query Parameters

continueOnError

boolean

If true, continue processing remaining items after a failure. Default: false.

Default: false

Create Node Restraints (bulk) › Request Body

object[]

DTO for creating a node restraint. POST is entity-style: 409 if a restraint already exists for the supplied node — caller must DELETE first or PATCH instead.

node

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

The node Id to create the restraint for. Required in the request body.

restraintCode

string · minLength: 1 · required

Example: FFFRRR

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ.

Example: BBBBBB

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X.

tyVariableTable

array | null

Variable-spring stiffness table for translational Y.

tzVariableTable

array | null

Variable-spring stiffness table for translational Z.

rxVariableTable

array | null

Variable-spring stiffness table for rotational X.

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y.

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z.

Create Node Restraints (bulk) › Responses

Returns bulk result (check errors array for partial failures)

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/node-restraints/bulk

curl --request POST \
  --url /api/v1/job/structure/node-restraints/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "node": 1,
    "restraintCode": "FFFRRR",
    "activeDirection": "BBBBBB",
    "txStiffness": 0,
    "tyStiffness": 0,
    "tzStiffness": 0,
    "rxStiffness": 0,
    "ryStiffness": 0,
    "rzStiffness": 0,
    "xFrictionNormalAxis": "None",
    "yFrictionNormalAxis": "None",
    "zFrictionNormalAxis": "None",
    "xFrictionNormalDirection": "Either",
    "yFrictionNormalDirection": "Either",
    "zFrictionNormalDirection": "Either",
    "xFrictionFactor": 0,
    "yFrictionFactor": 0,
    "zFrictionFactor": 0,
    "txPlasticLimit": 0,
    "tyPlasticLimit": 0,
    "tzPlasticLimit": 0,
    "rxPlasticLimit": 0,
    "ryPlasticLimit": 0,
    "rzPlasticLimit": 0,
    "txVariableTable": [
      [
        0
      ]
    ],
    "tyVariableTable": [
      [
        0
      ]
    ],
    "tzVariableTable": [
      [
        0
      ]
    ],
    "rxVariableTable": [
      [
        0
      ]
    ],
    "ryVariableTable": [
      [
        0
      ]
    ],
    "rzVariableTable": [
      [
        0
      ]
    ]
  }
]
'

shell

Example Request Body

[
  {
    "node": 1,
    "restraintCode": "FFFRRR",
    "activeDirection": "BBBBBB",
    "txStiffness": 0,
    "tyStiffness": 0,
    "tzStiffness": 0,
    "rxStiffness": 0,
    "ryStiffness": 0,
    "rzStiffness": 0,
    "xFrictionNormalAxis": "None",
    "yFrictionNormalAxis": "None",
    "zFrictionNormalAxis": "None",
    "xFrictionNormalDirection": "Either",
    "yFrictionNormalDirection": "Either",
    "zFrictionNormalDirection": "Either",
    "xFrictionFactor": 0,
    "yFrictionFactor": 0,
    "zFrictionFactor": 0,
    "txPlasticLimit": 0,
    "tyPlasticLimit": 0,
    "tzPlasticLimit": 0,
    "rxPlasticLimit": 0,
    "ryPlasticLimit": 0,
    "rzPlasticLimit": 0,
    "txVariableTable": [
      [
        0
      ]
    ],
    "tyVariableTable": [
      [
        0
      ]
    ],
    "tzVariableTable": [
      [
        0
      ]
    ],
    "rxVariableTable": [
      [
        0
      ]
    ],
    "ryVariableTable": [
      [
        0
      ]
    ],
    "rzVariableTable": [
      [
        0
      ]
    ]
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "node": 0,
      "restraintCode": "restraintCode",
      "activeDirection": "activeDirection",
      "generalRestraint": true,
      "txStiffness": 0,
      "tyStiffness": 0,
      "tzStiffness": 0,
      "rxStiffness": 0,
      "ryStiffness": 0,
      "rzStiffness": 0,
      "xFrictionNormalAxis": "None",
      "yFrictionNormalAxis": "None",
      "zFrictionNormalAxis": "None",
      "xFrictionNormalDirection": "Either",
      "yFrictionNormalDirection": "Either",
      "zFrictionNormalDirection": "Either",
      "xFrictionFactor": 0,
      "yFrictionFactor": 0,
      "zFrictionFactor": 0,
      "txPlasticLimit": 0,
      "tyPlasticLimit": 0,
      "tzPlasticLimit": 0,
      "rxPlasticLimit": 0,
      "ryPlasticLimit": 0,
      "rzPlasticLimit": 0,
      "txVariableTable": [
        [
          0
        ]
      ],
      "tyVariableTable": [
        [
          0
        ]
      ],
      "tzVariableTable": [
        [
          0
        ]
      ],
      "rxVariableTable": [
        [
          0
        ]
      ],
      "ryVariableTable": [
        [
          0
        ]
      ],
      "rzVariableTable": [
        [
          0
        ]
      ]
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Delete Bulk

DELETE

/api/v1

/job/structure/node-restraints/bulk

Deletes multiple attribute rows by parent Id. The body is a JSON array of integer parent Ids.

Delete Bulk › query Parameters

continueOnError

boolean

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 Node Restraints (bulk)

PATCH

/api/v1

/job/structure/node-restraints/bulk

Partially updates multiple restraints in a single request. Each item must include its parent node Id. Per-item 404 is reported as a bulk error if no row exists for the supplied node. Only provided fields are changed; omitted fields keep their current value.

Update Node Restraints (bulk) › query Parameters

continueOnError

boolean

If true, continue processing remaining items after a failure. Default: false.

Default: false

Update Node Restraints (bulk) › Request Body

object[]

DTO for partial updates to a node restraint. Only fields included in the request are updated; omit a field to keep its current value.

node

integer | null · int32

The node number that identifies which restraint to update. Required for bulk PATCH; ignored for single-node PATCH (route value wins).

restraintCode

string | null

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

txStiffness

number | null · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number | null · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number | null · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number | null · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number | null · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number | null · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number | null · double

X-axis friction factor.

yFrictionFactor

number | null · double

Y-axis friction factor.

zFrictionFactor

number | null · double

Z-axis friction factor.

txPlasticLimit

number | null · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number | null · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number | null · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number | null · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number | null · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number | null · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X.

tyVariableTable

array | null

Variable-spring stiffness table for translational Y.

tzVariableTable

array | null

Variable-spring stiffness table for translational Z.

rxVariableTable

array | null

Variable-spring stiffness table for rotational X.

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y.

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z.

Update Node Restraints (bulk) › Responses

Returns bulk result (check errors array for partial failures)

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/node-restraints/bulk

curl --request PATCH \
  --url /api/v1/job/structure/node-restraints/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "node": 0,
    "restraintCode": "restraintCode",
    "activeDirection": "activeDirection",
    "txStiffness": 0,
    "tyStiffness": 0,
    "tzStiffness": 0,
    "rxStiffness": 0,
    "ryStiffness": 0,
    "rzStiffness": 0,
    "xFrictionNormalAxis": "None",
    "yFrictionNormalAxis": "None",
    "zFrictionNormalAxis": "None",
    "xFrictionNormalDirection": "Either",
    "yFrictionNormalDirection": "Either",
    "zFrictionNormalDirection": "Either",
    "xFrictionFactor": 0,
    "yFrictionFactor": 0,
    "zFrictionFactor": 0,
    "txPlasticLimit": 0,
    "tyPlasticLimit": 0,
    "tzPlasticLimit": 0,
    "rxPlasticLimit": 0,
    "ryPlasticLimit": 0,
    "rzPlasticLimit": 0,
    "txVariableTable": [
      [
        0
      ]
    ],
    "tyVariableTable": [
      [
        0
      ]
    ],
    "tzVariableTable": [
      [
        0
      ]
    ],
    "rxVariableTable": [
      [
        0
      ]
    ],
    "ryVariableTable": [
      [
        0
      ]
    ],
    "rzVariableTable": [
      [
        0
      ]
    ]
  }
]
'

shell

Example Request Body

[
  {
    "node": 0,
    "restraintCode": "restraintCode",
    "activeDirection": "activeDirection",
    "txStiffness": 0,
    "tyStiffness": 0,
    "tzStiffness": 0,
    "rxStiffness": 0,
    "ryStiffness": 0,
    "rzStiffness": 0,
    "xFrictionNormalAxis": "None",
    "yFrictionNormalAxis": "None",
    "zFrictionNormalAxis": "None",
    "xFrictionNormalDirection": "Either",
    "yFrictionNormalDirection": "Either",
    "zFrictionNormalDirection": "Either",
    "xFrictionFactor": 0,
    "yFrictionFactor": 0,
    "zFrictionFactor": 0,
    "txPlasticLimit": 0,
    "tyPlasticLimit": 0,
    "tzPlasticLimit": 0,
    "rxPlasticLimit": 0,
    "ryPlasticLimit": 0,
    "rzPlasticLimit": 0,
    "txVariableTable": [
      [
        0
      ]
    ],
    "tyVariableTable": [
      [
        0
      ]
    ],
    "tzVariableTable": [
      [
        0
      ]
    ],
    "rxVariableTable": [
      [
        0
      ]
    ],
    "ryVariableTable": [
      [
        0
      ]
    ],
    "rzVariableTable": [
      [
        0
      ]
    ]
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "node": 0,
      "restraintCode": "restraintCode",
      "activeDirection": "activeDirection",
      "generalRestraint": true,
      "txStiffness": 0,
      "tyStiffness": 0,
      "tzStiffness": 0,
      "rxStiffness": 0,
      "ryStiffness": 0,
      "rzStiffness": 0,
      "xFrictionNormalAxis": "None",
      "yFrictionNormalAxis": "None",
      "zFrictionNormalAxis": "None",
      "xFrictionNormalDirection": "Either",
      "yFrictionNormalDirection": "Either",
      "zFrictionNormalDirection": "Either",
      "xFrictionFactor": 0,
      "yFrictionFactor": 0,
      "zFrictionFactor": 0,
      "txPlasticLimit": 0,
      "tyPlasticLimit": 0,
      "tzPlasticLimit": 0,
      "rxPlasticLimit": 0,
      "ryPlasticLimit": 0,
      "rzPlasticLimit": 0,
      "txVariableTable": [
        [
          0
        ]
      ],
      "tyVariableTable": [
        [
          0
        ]
      ],
      "tzVariableTable": [
        [
          0
        ]
      ],
      "rxVariableTable": [
        [
          0
        ]
      ],
      "ryVariableTable": [
        [
          0
        ]
      ],
      "rzVariableTable": [
        [
          0
        ]
      ]
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Set General Restraint

POST

/api/v1

/job/structure/node-restraints/set-general

Promotes a single node as the general restraint and atomically demotes every other row. Pass node = N to set node N as the general restraint; pass node = null to clear the flag from every node so no general restraint is set.

At most one node can be the general restraint at any time. The target node must already have a restraint row — use POST /node-restraints to create one first.

To observe which node (if any) is currently the general restraint, read generalRestraint on the node restraint DTO via GET /node-restraints or GET /node-restraints/{nodeId}.

Set General Restraint › Request Body

Request body for `POST job/structure/node-restraints/set-general`. Provide a node Id to promote that node as the general restraint (demoting every other row); pass `null` to clear the flag from every node.

node

integer | null · int32

The node to promote as the general restraint, or null to clear.

Example: 5

Set General Restraint › Responses

Returns the promoted restraint, or null when clearing.

node

integer · int32

The node Id this restraint applies to.

restraintCode

string | null

activeDirection

string | null

6-character active direction code for TX,TY,TZ,RX,RY,RZ. Each character: B=Both, P=Positive only, N=Negative only.

generalRestraint

boolean

Whether this is the general restraint for the model.

txStiffness

number · double

Translational X spring stiffness. Unit: Force/Length (see GET /job/units).

tyStiffness

number · double

Translational Y spring stiffness. Unit: Force/Length (see GET /job/units).

tzStiffness

number · double

Translational Z spring stiffness. Unit: Force/Length (see GET /job/units).

rxStiffness

number · double

Rotational X spring stiffness. Unit: Moment/Radian (see GET /job/units).

ryStiffness

number · double

Rotational Y spring stiffness. Unit: Moment/Radian (see GET /job/units).

rzStiffness

number · double

Rotational Z spring stiffness. Unit: Moment/Radian (see GET /job/units).

xFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

yFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

zFrictionNormalAxis

string · enum

Friction normal axis for restraint friction definitions. Maps to SPACE GASS lookup table "N/X/Y/Z Axes".

Enum values:

None

XAxis

YAxis

ZAxis

xFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

yFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

zFrictionNormalDirection

string · enum

Friction normal direction for restraint friction definitions. Maps to SPACE GASS lookup table "Normal Direction".

Enum values:

Either

PositiveOnly

NegativeOnly

xFrictionFactor

number · double

X-axis friction factor.

yFrictionFactor

number · double

Y-axis friction factor.

zFrictionFactor

number · double

Z-axis friction factor.

txPlasticLimit

number · double

Translational X plastic limit. Unit: Force (see GET /job/units).

tyPlasticLimit

number · double

Translational Y plastic limit. Unit: Force (see GET /job/units).

tzPlasticLimit

number · double

Translational Z plastic limit. Unit: Force (see GET /job/units).

rxPlasticLimit

number · double

Rotational X plastic limit. Unit: Moment (see GET /job/units).

ryPlasticLimit

number · double

Rotational Y plastic limit. Unit: Moment (see GET /job/units).

rzPlasticLimit

number · double

Rotational Z plastic limit. Unit: Moment (see GET /job/units).

txVariableTable

array | null

Variable-spring stiffness table for translational X. Points are (deflection, stiffness).

tyVariableTable

array | null

Variable-spring stiffness table for translational Y. Points are (deflection, stiffness).

tzVariableTable

array | null

Variable-spring stiffness table for translational Z. Points are (deflection, stiffness).

rxVariableTable

array | null

Variable-spring stiffness table for rotational X. Points are (rotation, stiffness).

ryVariableTable

array | null

Variable-spring stiffness table for rotational Y. Points are (rotation, stiffness).

rzVariableTable

array | null

Variable-spring stiffness table for rotational Z. Points are (rotation, stiffness).

POST/job/structure/node-restraints/set-general

curl --request POST \
  --url /api/v1/job/structure/node-restraints/set-general \
  --header 'Content-Type: application/json' \
  --data '{
  "node": 5
}'

shell

Example Request Body

{
  "node": 5
}

json

Example Responses

{
  "node": 0,
  "restraintCode": "restraintCode",
  "activeDirection": "activeDirection",
  "generalRestraint": true,
  "txStiffness": 0,
  "tyStiffness": 0,
  "tzStiffness": 0,
  "rxStiffness": 0,
  "ryStiffness": 0,
  "rzStiffness": 0,
  "xFrictionNormalAxis": "None",
  "yFrictionNormalAxis": "None",
  "zFrictionNormalAxis": "None",
  "xFrictionNormalDirection": "Either",
  "yFrictionNormalDirection": "Either",
  "zFrictionNormalDirection": "Either",
  "xFrictionFactor": 0,
  "yFrictionFactor": 0,
  "zFrictionFactor": 0,
  "txPlasticLimit": 0,
  "tyPlasticLimit": 0,
  "tzPlasticLimit": 0,
  "rxPlasticLimit": 0,
  "ryPlasticLimit": 0,
  "rzPlasticLimit": 0,
  "txVariableTable": [
    [
      0
    ]
  ],
  "tyVariableTable": [
    [
      0
    ]
  ],
  "tzVariableTable": [
    [
      0
    ]
  ],
  "rxVariableTable": [
    [
      0
    ]
  ],
  "ryVariableTable": [
    [
      0
    ]
  ],
  "rzVariableTable": [
    [
      0
    ]
  ]
}

json

application/json

Node Constraints Members