Settings

Endpoint/api/v1

Download schema

Job-level settings sub-resource (vertical axis, etc.)

Get Settings

GET

/api/v1

/job/settings

Gets job-level settings (vertical axis, etc.) for the current job. These properties apply to the job as a whole.

Get Settings › Responses

Returns the settings

Read DTO for job-level settings. Groups configuration properties that apply to the job as a whole.

verticalAxis

string · enum

Vertical (gravity) axis direction for the job. Determines which global axis is treated as the vertical/gravity direction. Maps to SPACE GASS CommonEnums.SGVerticalAxis (YAxis=2, ZAxis=3). Only YAxis and ZAxis are valid choices in SPACE GASS.

Enum values:

YAxis

ZAxis

Get Settings Metadata

GET

/api/v1

/job/settings/metadata

Returns the schema for GET /job/settings — field definitions with allowedValues for enum-backed fields (e.g. verticalAxis).

Get Settings Metadata › Responses

Returns the settings 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.

Units Sections

Get Settings

GET

/api/v1

/job/settings

Gets job-level settings (vertical axis, etc.) for the current job. These properties apply to the job as a whole.

Get Settings › Responses

Returns the settings

Read DTO for job-level settings. Groups configuration properties that apply to the job as a whole.

verticalAxis

string · enum

Enum values:

YAxis

ZAxis

Get Settings Metadata

GET

/api/v1

/job/settings/metadata

Returns the schema for GET /job/settings — field definitions with allowedValues for enum-backed fields (e.g. verticalAxis).

Get Settings Metadata › Responses

Returns the settings 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.