Moving Load Travel Paths

Endpoint/api/v1

Reusable routes (ordered stations) referenced by moving-load scenario loads

List

GET

/api/v1

/job/loads/moving-loads/travel-paths

Lists the items in this catalog for the current job, ordered by Id. Supports offset/limit pagination; the response carries Total-Count, Offset, and Limit headers.

List › query Parameters

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

expand

string · enum

Whether to hydrate each item's sub-resources inline. Defaults to None for the list.

Controls sub-resource hydration on entity GET endpoints. Shared across every resource that supports expansion — a given resource's metadata (expandable) lists which sub-resources All hydrates.

Enum values:

None

All

List › Responses

Returns the items

object[]

A moving-load travel path — a named, ordered list of stations defining the route a vehicle or pressure travels along. Stations are hydrated inline only when `expand=All`.

id

integer · int32

The item Id.

Example: 1

name

string | null

The travel-path name. Unique across all travel paths.

Example: Lane 1 centreline

hasStations

boolean

Whether the travel path has any stations.

Example: true

array | null

The travel path's stations, in order. Populated only when expand=All; otherwise omitted.

Create

POST

/api/v1

/job/loads/moving-loads/travel-paths

Creates a new catalog item. Supply id to choose the Id, or omit it to have the next available Id auto-assigned.

Create › Request Body

Creates a new travel-path header. Stations are set via `PUT moving-loads/travel-paths/{id}/stations`.

id

integer | null · int32 · min: 1 · max: 2147483647

The Id to assign to the new item.

Example: 1

name

string | null

The travel-path name. Must be unique across all travel paths.

Example: Lane 1 centreline

Create › Responses

Returns the created item

A moving-load travel path — a named, ordered list of stations defining the route a vehicle or pressure travels along. Stations are hydrated inline only when `expand=All`.

id

integer · int32

The item Id.

Example: 1

name

string | null

The travel-path name. Unique across all travel paths.

Example: Lane 1 centreline

hasStations

boolean

Whether the travel path has any stations.

Example: true

array | null

The travel path's stations, in order. Populated only when expand=All; otherwise omitted.

Get

GET

/api/v1

/job/loads/moving-loads/travel-paths/{id}

Gets a single catalog item by Id.

Get › path Parameters

id

integer · int32 · required

The item Id

Get › query Parameters

expand

string · enum

Whether to hydrate the item's sub-resources inline. Defaults to All for a single fetch.

Controls sub-resource hydration on entity GET endpoints. Shared across every resource that supports expansion — a given resource's metadata (expandable) lists which sub-resources All hydrates.

Enum values:

None

All

Get › Responses

Returns the item

A moving-load travel path — a named, ordered list of stations defining the route a vehicle or pressure travels along. Stations are hydrated inline only when `expand=All`.

id

integer · int32

The item Id.

Example: 1

name

string | null

The travel-path name. Unique across all travel paths.

Example: Lane 1 centreline

hasStations

boolean

Whether the travel path has any stations.

Example: true

array | null

The travel path's stations, in order. Populated only when expand=All; otherwise omitted.

Delete

DELETE

/api/v1

/job/loads/moving-loads/travel-paths/{id}

Deletes a catalog item. Only unused items can be deleted.

Delete › path Parameters

id

integer · int32 · required

The item Id

Delete › Responses

Deleted

No data returned

Update

PATCH

/api/v1

/job/loads/moving-loads/travel-paths/{id}

Partially updates a catalog item; omitted fields keep their current value.

Update › path Parameters

id

integer · int32 · required

The item Id

Update › Request Body

Partial update for a travel-path header. Omitted properties keep their current value.

id

integer · int32

The Id of the item to update.

Example: 1

name

string | null

Replacement travel-path name. Must remain unique. Omit to keep current.

Example: Lane 1 centreline

Update › Responses

Returns the updated item

A moving-load travel path — a named, ordered list of stations defining the route a vehicle or pressure travels along. Stations are hydrated inline only when `expand=All`.

id

integer · int32

The item Id.

Example: 1

name

string | null

The travel-path name. Unique across all travel paths.

Example: Lane 1 centreline

hasStations

boolean

Whether the travel path has any stations.

Example: true

array | null

The travel path's stations, in order. Populated only when expand=All; otherwise omitted.

Get Travel Path Stations

GET

/api/v1

/job/loads/moving-loads/travel-paths/{id}/stations

Gets the ordered stations of a travel path.

Get Travel Path Stations › path Parameters

id

integer · int32 · required

The travel-path Id

Get Travel Path Stations › Responses

Returns the stations

object[]

One station on a travel path — a point in space, optionally relative to a node. This shape is used both when reading a path's stations and as the element of the `PUT moving-loads/travel-paths/{id}/stations` body, which replaces the entire list.

nodeKey

integer | null · int32

The node this station is relative to.

Example: 5

x

number · double

X coordinate (or X offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

y

number · double

Y coordinate (or Y offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

z

number · double

Z coordinate (or Z offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

radius

number · double

Arc radius into this station from the previous one.

Example: 0

Set Travel Path Stations

PUT

/api/v1

/job/loads/moving-loads/travel-paths/{id}/stations

Replaces the travel path's stations wholesale (Set semantics).

Set Travel Path Stations › path Parameters

id

integer · int32 · required

The travel-path Id

Set Travel Path Stations › Request Body

object[]

nodeKey

integer | null · int32

The node this station is relative to.

Example: 5

x

number · double

X coordinate (or X offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

y

number · double

Y coordinate (or Y offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

z

number · double

Z coordinate (or Z offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

radius

number · double

Arc radius into this station from the previous one.

Example: 0

Set Travel Path Stations › Responses

Returns the stored stations

object[]

nodeKey

integer | null · int32

The node this station is relative to.

Example: 5

x

number · double

X coordinate (or X offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

y

number · double

Y coordinate (or Y offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

z

number · double

Z coordinate (or Z offset from SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadStationDto.NodeKey when a node is set).

Example: 0

radius

number · double

Arc radius into this station from the previous one.

Example: 0

Get Metadata

GET

/api/v1

/job/loads/moving-loads/travel-paths/metadata

Returns the schema for this catalog resource.

Get Metadata › Responses

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

Next Id

GET

/api/v1

/job/loads/moving-loads/travel-paths/next

Gets the next available (unused) Id for this catalog resource.

Next Id › query Parameters

start

integer · int32

The Id value to start searching from (inclusive). Defaults to 1.

Default: 1

Next Id › Responses

Returns the next available Id

integer · int32

Get Travel Path Stations Metadata

GET

/api/v1

/job/loads/moving-loads/travel-paths/stations/metadata

Returns the schema for a travel-path station.

Get Travel Path Stations Metadata › Responses

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

Create Bulk

POST

/api/v1

/job/loads/moving-loads/travel-paths/bulk

Creates multiple catalog items in one call; they persist with a single save.

Create Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Create Bulk › Request Body

object[]

Creates a new travel-path header. Stations are set via `PUT moving-loads/travel-paths/{id}/stations`.

id

integer | null · int32 · min: 1 · max: 2147483647

The Id to assign to the new item.

Example: 1

name

string | null

The travel-path name. Must be unique across all travel paths.

Example: Lane 1 centreline

Create Bulk › Responses

Returns the bulk result (created items + per-item errors)

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/loads/moving-loads/travel-paths/bulk

curl --request POST \
  --url /api/v1/job/loads/moving-loads/travel-paths/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Lane 1 centreline"
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Lane 1 centreline"
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "Lane 1 centreline",
      "hasStations": true,
      "stations": [
        {
          "nodeKey": 5,
          "x": 0,
          "y": 0,
          "z": 0,
          "radius": 0
        }
      ]
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Delete Bulk

DELETE

/api/v1

/job/loads/moving-loads/travel-paths/bulk

Deletes multiple catalog items by Id. The body is a JSON array of integer Ids (e.g. [1, 5, 10]). An item referenced by a scenario load fails with an in-use error rather than being deleted.

Delete Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Delete Bulk › Request Body

integer[]

Delete Bulk › Responses

Returns the bulk result (deleted Ids + per-item errors)

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.

Update Bulk

PATCH

/api/v1

/job/loads/moving-loads/travel-paths/bulk

Partially updates multiple catalog items in one call; each body item carries the id of the item to update. They persist with a single save.

Update Bulk › query Parameters

continueOnError

boolean

Whether to continue processing after individual failures

Default: false

Update Bulk › Request Body

object[]

Partial update for a travel-path header. Omitted properties keep their current value.

id

integer · int32

The Id of the item to update.

Example: 1

name

string | null

Replacement travel-path name. Must remain unique. Omit to keep current.

Example: Lane 1 centreline

Update Bulk › Responses

Returns the bulk result (updated items + per-item errors)

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/loads/moving-loads/travel-paths/bulk

curl --request PATCH \
  --url /api/v1/job/loads/moving-loads/travel-paths/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Lane 1 centreline"
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Lane 1 centreline"
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "Lane 1 centreline",
      "hasStations": true,
      "stations": [
        {
          "nodeKey": 5,
          "x": 0,
          "y": 0,
          "z": 0,
          "radius": 0
        }
      ]
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Moving Load Pressures Analysis