Master-slave constraints between nodes
Get All
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).
query Parameters
SlavesSlave node Ids to filter by, in SG list format (e.g. "1,5-10,15").
Omit to return all constraints.
MasterNodeFilter by master node number — returns only constraints whose master node matches. Omit to return constraints regardless of master.
OffsetNumber of items to skip from the start of the result set. Default is 0.
LimitMaximum number of items to return. Default is null (return all).
Get All › Responses
OK
slaveNodeThe slave node number. This is the node whose DOFs are constrained to the master.
masterNodeThe master node number. The slave node's constrained DOFs follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (slave DOF is tied to master), 'R' = Released (slave DOF is free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidThe unique identifier for this constraint record.
Create
Creates a new attribute row. The body must include the parent Id (e.g. node, member).
Returns 409 if a row already exists for the supplied parent — PATCH instead, or DELETE first.
Returns 404 if the parent does not exist.
Create › Request Body
slaveNodeThe slave node number. Required in the request body.
masterNodeThe master node number. The slave node's constrained DOFs will follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (tied to master), 'R' = Released (free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidOptional GUID for this constraint record.
Create › Responses
Created
slaveNodeThe slave node number. This is the node whose DOFs are constrained to the master.
masterNodeThe master node number. The slave node's constrained DOFs follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (slave DOF is tied to master), 'R' = Released (slave DOF is free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidThe unique identifier for this constraint record.
Get Node Constraint
Gets the master-slave constraint for a specific slave node. Returns 404 if no constraint is defined for the node. Each node can be a slave in at most one constraint.
path Parameters
nodeIdThe slave node Id
Get Node Constraint › Responses
Returns the node constraint
slaveNodeThe slave node number. This is the node whose DOFs are constrained to the master.
masterNodeThe master node number. The slave node's constrained DOFs follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (slave DOF is tied to master), 'R' = Released (slave DOF is free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidThe unique identifier for this constraint record.
Update Node Constraint
Partially updates the master-slave constraint for a specific slave node.
Only provided fields are updated; omitted fields remain unchanged.
The constraint must already exist — use POST /node-constraints to create one.
If masterNode is supplied it must reference an existing node and not equal the slave.
path Parameters
nodeIdThe slave node Id
Update Node Constraint › Request Body
slaveNodeThe slave node number that identifies which constraint to update. Required for bulk PATCH; ignored for single-node PATCH (route value wins).
masterNodeThe master node number.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (tied to master), 'R' = Released (free).
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidOptional GUID for this constraint record.
Update Node Constraint › Responses
Constraint updated successfully
slaveNodeThe slave node number. This is the node whose DOFs are constrained to the master.
masterNodeThe master node number. The slave node's constrained DOFs follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (slave DOF is tied to master), 'R' = Released (slave DOF is free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidThe unique identifier for this constraint record.
Get Metadata
Returns the schema for the resource: field definitions, units resolved against current job units, and allowed values for enum fields.
Get Metadata › Responses
OK
resourceTypeIdentifies entity types managed by the API. Kept separate from SGFileID to allow for future API-only entities that may not have a formal SPACE GASS FileID.
countCurrent count of items in this resource. Null for sub-resources whose count does not apply uniformly.
maxIdMaximum Id currently in use (single-int Id entities only).
nextIdNext available Id (single-int Id entities only).
Field definitions describing the resource's wire shape. Each entry corresponds
to a property on the read DTO; jsonName matches the JSON key clients see.
Create Bulk
Creates multiple attribute rows in a single request. Each item must include its parent Id in the body. Returns 409 (per-item error) for any row whose parent already has an attribute.
query Parameters
continueOnErrorCreate Bulk › Request Body
slaveNodeThe slave node number. Required in the request body.
masterNodeThe master node number. The slave node's constrained DOFs will follow this node's motion.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (tied to master), 'R' = Released (free). Example: "FFFRRR" constrains translations only; "FFFFFF" constrains all 6 DOFs.
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidOptional GUID for this constraint record.
Create Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Delete Bulk
Deletes multiple attribute rows by parent Id. The body is a JSON array of integer parent Ids.
query Parameters
continueOnErrorDelete Bulk › Responses
OK
succeededSuccessfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.
Update Bulk
Updates multiple attribute rows in a single request. Each item must include its parent Id. Per-item 404 reported as a bulk error if no row exists for the supplied parent.
query Parameters
continueOnErrorUpdate Bulk › Request Body
slaveNodeThe slave node number that identifies which constraint to update. Required for bulk PATCH; ignored for single-node PATCH (route value wins).
masterNodeThe master node number.
constraintCodeA 6-character string defining which degrees of freedom are constrained. Each character position maps to a DOF: UX, UY, UZ, RX, RY, RZ (left to right). 'F' = Fixed (tied to master), 'R' = Released (free).
axesCoordinate axis system used for master-slave constraint equations. Maps to SPACE GASS lookup table "Constraint Axes".
xVectorX component of the constraint axis direction vector.
yVectorY component of the constraint axis direction vector.
zVectorZ component of the constraint axis direction vector.
guidOptional GUID for this constraint record.
Update Bulk › Responses
OK
Successfully processed items.
Errors from failed items.
errorsTruncatedTrue when the bulk operation stopped accumulating errors after reaching SpaceGassApi.Models.Dtos.Entity.BulkResultDto`1.ErrorMessageCap. Further failures may exist beyond what is reported.