Member rigid end zones (offsets at each end)
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
MembersMember Ids to filter offsets by, in SG list format (e.g. "1,5-10,15").
Omit to return all offsets.
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
memberThe member Id this offset applies to.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
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
memberThe member Id to create the offset for. Required in the request body.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
Create › Responses
Created
memberThe member Id this offset applies to.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
Get Member Offsets
Gets the offsets row for a specific member — rigid end zones at each end. Returns 404 if no offsets row exists for the member.
path Parameters
memberIdThe member Id
Get Member Offsets › Responses
Returns the member offsets
memberThe member Id this offset applies to.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
Delete Member Offsets
Deletes the offsets row for a specific member. After deletion the member has no explicit offsets — both ends fall back to default behaviour (no rigid end zones). Returns 404 if no offsets row exists.
path Parameters
memberIdThe member Id
Delete Member Offsets › Responses
Offsets deleted successfully
Update Member Offsets
Partially updates the offsets for a specific member.
Only fields included in the request are changed; omitted fields keep their current value.
The offsets row must already exist — use POST /member-offsets to create one.
path Parameters
memberIdThe member Id
Update Member Offsets › Request Body
memberThe member Id whose offset is being updated. Required for bulk PATCH; ignored for single-member PATCH (route value wins).
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
Update Member Offsets › Responses
Offsets updated successfully
memberThe member Id this offset applies to.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
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
memberThe member Id to create the offset for. Required in the request body.
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
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
memberThe member Id whose offset is being updated. Required for bulk PATCH; ignored for single-member PATCH (route value wins).
axesCoordinate axes type (Local or Global). Maps to SPACE GASS lookup table "L/G Axes".
xOffsetAtAX offset at end A. Unit: Length (see GET /job/units).
yOffsetAtAY offset at end A. Unit: Length (see GET /job/units).
zOffsetAtAZ offset at end A. Unit: Length (see GET /job/units).
xOffsetAtBX offset at end B. Unit: Length (see GET /job/units).
yOffsetAtBY offset at end B. Unit: Length (see GET /job/units).
zOffsetAtBZ offset at end B. Unit: Length (see GET /job/units).
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.