Moving Load Scenarios

Endpoint/api/v1

Moving-load scenarios — the vehicle/pressure loads along travel paths (with their loads and combinations) that generation runs over

List

GET

/api/v1

/job/loads/moving-loads/scenarios

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 named moving-load scenario. The scenario header carries its name, include flag, starting load case, and time interval. Its load rows and combination rows are nested collections, hydrated inline only when `expand=All`.

id

integer · int32

The item Id.

Example: 1

name

string | null

The scenario name. Unique across all scenarios.

Example: Truck northbound

include

boolean

Whether this scenario is included when load cases are generated.

Example: true

startingLoadCase

integer · int32

The first load case number generated for this scenario.

Example: 101

timeInterval

number · double

Time between generated snapshots as a vehicle/pressure travels.

Example: 0.5

hasLoads

boolean

Whether the scenario has any load rows.

Example: true

hasCombinations

boolean

Whether the scenario has any combination rows.

Example: false

array | null

The scenario's load rows. Populated only when expand=All; otherwise omitted.

array | null

The scenario's combination rows. Populated only when expand=All; otherwise omitted.

GET/job/loads/moving-loads/scenarios

curl --request GET \
  --url /api/v1/job/loads/moving-loads/scenarios

shell

Example Responses

[
  {
    "id": 1,
    "name": "Truck northbound",
    "include": true,
    "startingLoadCase": 101,
    "timeInterval": 0.5,
    "hasLoads": true,
    "hasCombinations": false,
    "loads": [
      {
        "loadType": "Vehicle",
        "vehicleId": 1,
        "pressureId": null,
        "travelPathId": 1,
        "speed": 16.7,
        "delay": 0,
        "startPosition": 0,
        "loadFactor": 1,
        "laneFactor": 1,
        "dynamicFactor": 1,
        "generateStationaryLc": "StartingLoadCase"
      }
    ],
    "combinations": [
      {
        "scenarioFactor": 1,
        "combineWithLoadCase": 1,
        "loadCaseFactor": 1.5,
        "startingCombinationCase": 201
      }
    ]
  }
]

json

application/json

Create

POST

/api/v1

/job/loads/moving-loads/scenarios

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 moving-load scenario. Load and combination rows may be supplied inline (created atomically with the scenario) or omitted and set later via `PUT moving-loads/scenarios/{id}/loads` / `.../combinations`.

id

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

The Id to assign to the new item.

Example: 1

name

string | null

The scenario name. Must be unique across all scenarios.

Example: Truck northbound

include

boolean

Whether this scenario is included when load cases are generated.

Example: true

startingLoadCase

integer · int32

The first load case number generated for this scenario.

Example: 101

timeInterval

number · double

Time between generated snapshots.

Example: 0.5

array | null

The scenario's load rows, in order. Optional — supply to create the scenario and its loads in one call; omit to set them later via PUT .../{id}/loads.

array | null

The scenario's combination rows. Optional — supply inline, or omit and set them later via PUT .../{id}/combinations.

Create › Responses

Returns the created item

id

integer · int32

The item Id.

Example: 1

name

string | null

The scenario name. Unique across all scenarios.

Example: Truck northbound

include

boolean

Whether this scenario is included when load cases are generated.

Example: true

startingLoadCase

integer · int32

The first load case number generated for this scenario.

Example: 101

timeInterval

number · double

Time between generated snapshots as a vehicle/pressure travels.

Example: 0.5

hasLoads

boolean

Whether the scenario has any load rows.

Example: true

hasCombinations

boolean

Whether the scenario has any combination rows.

Example: false

array | null

The scenario's load rows. Populated only when expand=All; otherwise omitted.

array | null

The scenario's combination rows. Populated only when expand=All; otherwise omitted.

POST/job/loads/moving-loads/scenarios

curl --request POST \
  --url /api/v1/job/loads/moving-loads/scenarios \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5,
  "loads": [
    {
      "loadType": "Vehicle",
      "vehicleId": 1,
      "pressureId": null,
      "travelPathId": 1,
      "speed": 16.7,
      "delay": 0,
      "startPosition": 0,
      "loadFactor": 1,
      "laneFactor": 1,
      "dynamicFactor": 1,
      "generateStationaryLc": "StartingLoadCase"
    }
  ],
  "combinations": [
    {
      "scenarioFactor": 1,
      "combineWithLoadCase": 1,
      "loadCaseFactor": 1.5,
      "startingCombinationCase": 201
    }
  ]
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5,
  "loads": [
    {
      "loadType": "Vehicle",
      "vehicleId": 1,
      "pressureId": null,
      "travelPathId": 1,
      "speed": 16.7,
      "delay": 0,
      "startPosition": 0,
      "loadFactor": 1,
      "laneFactor": 1,
      "dynamicFactor": 1,
      "generateStationaryLc": "StartingLoadCase"
    }
  ],
  "combinations": [
    {
      "scenarioFactor": 1,
      "combineWithLoadCase": 1,
      "loadCaseFactor": 1.5,
      "startingCombinationCase": 201
    }
  ]
}

json

Example Responses

{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5,
  "hasLoads": true,
  "hasCombinations": false,
  "loads": [
    {
      "loadType": "Vehicle",
      "vehicleId": 1,
      "pressureId": null,
      "travelPathId": 1,
      "speed": 16.7,
      "delay": 0,
      "startPosition": 0,
      "loadFactor": 1,
      "laneFactor": 1,
      "dynamicFactor": 1,
      "generateStationaryLc": "StartingLoadCase"
    }
  ],
  "combinations": [
    {
      "scenarioFactor": 1,
      "combineWithLoadCase": 1,
      "loadCaseFactor": 1.5,
      "startingCombinationCase": 201
    }
  ]
}

json

application/json

Get

GET

/api/v1

/job/loads/moving-loads/scenarios/{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

id

integer · int32

The item Id.

Example: 1

name

string | null

The scenario name. Unique across all scenarios.

Example: Truck northbound

include

boolean

Whether this scenario is included when load cases are generated.

Example: true

startingLoadCase

integer · int32

The first load case number generated for this scenario.

Example: 101

timeInterval

number · double

Time between generated snapshots as a vehicle/pressure travels.

Example: 0.5

hasLoads

boolean

Whether the scenario has any load rows.

Example: true

hasCombinations

boolean

Whether the scenario has any combination rows.

Example: false

array | null

The scenario's load rows. Populated only when expand=All; otherwise omitted.

array | null

The scenario's combination rows. Populated only when expand=All; otherwise omitted.

GET/job/loads/moving-loads/scenarios/{id}

curl --request GET \
  --url /api/v1/job/loads/moving-loads/scenarios/:id

shell

Example Responses

{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5,
  "hasLoads": true,
  "hasCombinations": false,
  "loads": [
    {
      "loadType": "Vehicle",
      "vehicleId": 1,
      "pressureId": null,
      "travelPathId": 1,
      "speed": 16.7,
      "delay": 0,
      "startPosition": 0,
      "loadFactor": 1,
      "laneFactor": 1,
      "dynamicFactor": 1,
      "generateStationaryLc": "StartingLoadCase"
    }
  ],
  "combinations": [
    {
      "scenarioFactor": 1,
      "combineWithLoadCase": 1,
      "loadCaseFactor": 1.5,
      "startingCombinationCase": 201
    }
  ]
}

json

application/json

Delete

DELETE

/api/v1

/job/loads/moving-loads/scenarios/{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/scenarios/{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 moving-load scenario header. All properties are optional; omitted properties keep their current value.

id

integer · int32

The Id of the item to update.

Example: 1

name

string | null

Replacement scenario name. Must remain unique. Omit to keep current.

Example: Truck northbound

include

boolean | null

Whether the scenario is included in generation. Omit to keep current.

Example: true

startingLoadCase

integer | null · int32

The first generated load case number. Omit to keep current.

Example: 101

timeInterval

number | null · double

Time between generated snapshots (seconds). Omit to keep current.

Example: 0.5

Update › Responses

Returns the updated item

id

integer · int32

The item Id.

Example: 1

name

string | null

The scenario name. Unique across all scenarios.

Example: Truck northbound

include

boolean

Whether this scenario is included when load cases are generated.

Example: true

startingLoadCase

integer · int32

The first load case number generated for this scenario.

Example: 101

timeInterval

number · double

Time between generated snapshots as a vehicle/pressure travels.

Example: 0.5

hasLoads

boolean

Whether the scenario has any load rows.

Example: true

hasCombinations

boolean

Whether the scenario has any combination rows.

Example: false

array | null

The scenario's load rows. Populated only when expand=All; otherwise omitted.

array | null

The scenario's combination rows. Populated only when expand=All; otherwise omitted.

PATCH/job/loads/moving-loads/scenarios/{id}

curl --request PATCH \
  --url /api/v1/job/loads/moving-loads/scenarios/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5
}
'

shell

Example Request Body

{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5
}

json

Example Responses

{
  "id": 1,
  "name": "Truck northbound",
  "include": true,
  "startingLoadCase": 101,
  "timeInterval": 0.5,
  "hasLoads": true,
  "hasCombinations": false,
  "loads": [
    {
      "loadType": "Vehicle",
      "vehicleId": 1,
      "pressureId": null,
      "travelPathId": 1,
      "speed": 16.7,
      "delay": 0,
      "startPosition": 0,
      "loadFactor": 1,
      "laneFactor": 1,
      "dynamicFactor": 1,
      "generateStationaryLc": "StartingLoadCase"
    }
  ],
  "combinations": [
    {
      "scenarioFactor": 1,
      "combineWithLoadCase": 1,
      "loadCaseFactor": 1.5,
      "startingCombinationCase": 201
    }
  ]
}

json

application/json

Get Scenario Combinations

GET

/api/v1

/job/loads/moving-loads/scenarios/{id}/combinations

Gets a scenario's combination rows in order.

Get Scenario Combinations › path Parameters

id

integer · int32 · required

The scenario Id

Get Scenario Combinations › Responses

Returns the combination rows

object[]

One row of a scenario's "Combining with other Load Cases" table (the desktop Scenario Properties dialog) — defines how the scenario's generated moving-load cases are combined with another load case to produce combination cases. Distinct from a standalone combination load case (`job/loads/combination-load-cases`): these rows are owned by the scenario and set wholesale via `PUT moving-loads/scenarios/{id}/combinations`.

scenarioFactor

number · double

Factor applied to the scenario's generated load cases in the combination.

Example: 1

combineWithLoadCase

integer · int32

The load case combined with the scenario's generated cases.

Example: 1

loadCaseFactor

number · double

Factor applied to SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadCombinationDto.CombineWithLoadCase in the combination.

Example: 1.5

startingCombinationCase

integer · int32

The first combination case number generated for this combination ("Starting Comb Case" in the dialog).

Example: 201

Set Scenario Combinations

PUT

/api/v1

/job/loads/moving-loads/scenarios/{id}/combinations

Replaces the scenario's combination rows wholesale (Set semantics).

Set Scenario Combinations › path Parameters

id

integer · int32 · required

The scenario Id

Set Scenario Combinations › Request Body

object[]

scenarioFactor

number · double

Factor applied to the scenario's generated load cases in the combination.

Example: 1

combineWithLoadCase

integer · int32

The load case combined with the scenario's generated cases.

Example: 1

loadCaseFactor

number · double

Factor applied to SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadCombinationDto.CombineWithLoadCase in the combination.

Example: 1.5

startingCombinationCase

integer · int32

The first combination case number generated for this combination ("Starting Comb Case" in the dialog).

Example: 201

Set Scenario Combinations › Responses

Returns the stored combination rows

object[]

scenarioFactor

number · double

Factor applied to the scenario's generated load cases in the combination.

Example: 1

combineWithLoadCase

integer · int32

The load case combined with the scenario's generated cases.

Example: 1

loadCaseFactor

number · double

Factor applied to SpaceGassApi.Models.Dtos.MovingLoads.MovingLoadCombinationDto.CombineWithLoadCase in the combination.

Example: 1.5

startingCombinationCase

integer · int32

The first combination case number generated for this combination ("Starting Comb Case" in the dialog).

Example: 201

Get Scenario Loads

GET

/api/v1

/job/loads/moving-loads/scenarios/{id}/loads

Gets a scenario's load rows in order.

Get Scenario Loads › path Parameters

id

integer · int32 · required

The scenario Id

Get Scenario Loads › Responses

Returns the load rows

object[]

One load row within a scenario — a vehicle or pressure run along a travel path. This shape is used both when reading a scenario's loads and as the element of the `PUT moving-loads/scenarios/{id}/loads` body, which replaces the entire list.

loadType

string · enum

Discriminates a moving-load scenario load between a vehicle run and a pressure run. Mirrors SPACE GASS MLScenarioLoadType (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

Vehicle

Pressure

vehicleId

integer | null · int32

The vehicle Id this load uses.

Example: 1

pressureId

integer | null · int32

The pressure Id this load uses.

Example: null

travelPathId

integer | null · int32

The travel-path Id this load travels along.

Example: 1

speed

number · double

Travel speed along the path.

Example: 16.7

delay

number · double

Delay before the vehicle/pressure starts moving.

Example: 0

startPosition

number · double

Starting position measured along the travel path.

Example: 0

loadFactor

number · double

Multiplier applied to the load magnitudes.

Example: 1

laneFactor

number · double

Lane factor applied to the load.

Example: 1

dynamicFactor

number · double

Dynamic amplification factor applied to the load.

Example: 1

generateStationaryLc

string · enum

Controls which load cases a scenario load's stationary loads are generated into. Mirrors SPACE GASS MLGenerateStationary (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

StartingLoadCase

AllLoadCases

Set Scenario Loads

PUT

/api/v1

/job/loads/moving-loads/scenarios/{id}/loads

Replaces the scenario's load rows wholesale (Set semantics).

Set Scenario Loads › path Parameters

id

integer · int32 · required

The scenario Id

Set Scenario Loads › Request Body

object[]

loadType

string · enum

Discriminates a moving-load scenario load between a vehicle run and a pressure run. Mirrors SPACE GASS MLScenarioLoadType (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

Vehicle

Pressure

vehicleId

integer | null · int32

The vehicle Id this load uses.

Example: 1

pressureId

integer | null · int32

The pressure Id this load uses.

Example: null

travelPathId

integer | null · int32

The travel-path Id this load travels along.

Example: 1

speed

number · double

Travel speed along the path.

Example: 16.7

delay

number · double

Delay before the vehicle/pressure starts moving.

Example: 0

startPosition

number · double

Starting position measured along the travel path.

Example: 0

loadFactor

number · double

Multiplier applied to the load magnitudes.

Example: 1

laneFactor

number · double

Lane factor applied to the load.

Example: 1

dynamicFactor

number · double

Dynamic amplification factor applied to the load.

Example: 1

generateStationaryLc

string · enum

Controls which load cases a scenario load's stationary loads are generated into. Mirrors SPACE GASS MLGenerateStationary (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

StartingLoadCase

AllLoadCases

Set Scenario Loads › Responses

Returns the stored load rows

object[]

loadType

string · enum

Discriminates a moving-load scenario load between a vehicle run and a pressure run. Mirrors SPACE GASS MLScenarioLoadType (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

Vehicle

Pressure

vehicleId

integer | null · int32

The vehicle Id this load uses.

Example: 1

pressureId

integer | null · int32

The pressure Id this load uses.

Example: null

travelPathId

integer | null · int32

The travel-path Id this load travels along.

Example: 1

speed

number · double

Travel speed along the path.

Example: 16.7

delay

number · double

Delay before the vehicle/pressure starts moving.

Example: 0

startPosition

number · double

Starting position measured along the travel path.

Example: 0

loadFactor

number · double

Multiplier applied to the load magnitudes.

Example: 1

laneFactor

number · double

Lane factor applied to the load.

Example: 1

dynamicFactor

number · double

Dynamic amplification factor applied to the load.

Example: 1

generateStationaryLc

string · enum

Controls which load cases a scenario load's stationary loads are generated into. Mirrors SPACE GASS MLGenerateStationary (NETSpaceGass/Loads/Moving/MLCommon.vb).

Enum values:

StartingLoadCase

AllLoadCases

PUT/job/loads/moving-loads/scenarios/{id}/loads

curl --request PUT \
  --url /api/v1/job/loads/moving-loads/scenarios/:id/loads \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "loadType": "Vehicle",
    "vehicleId": 1,
    "pressureId": null,
    "travelPathId": 1,
    "speed": 16.7,
    "delay": 0,
    "startPosition": 0,
    "loadFactor": 1,
    "laneFactor": 1,
    "dynamicFactor": 1,
    "generateStationaryLc": "StartingLoadCase"
  }
]
'

shell

Example Request Body

[
  {
    "loadType": "Vehicle",
    "vehicleId": 1,
    "pressureId": null,
    "travelPathId": 1,
    "speed": 16.7,
    "delay": 0,
    "startPosition": 0,
    "loadFactor": 1,
    "laneFactor": 1,
    "dynamicFactor": 1,
    "generateStationaryLc": "StartingLoadCase"
  }
]

json

Example Responses

[
  {
    "loadType": "Vehicle",
    "vehicleId": 1,
    "pressureId": null,
    "travelPathId": 1,
    "speed": 16.7,
    "delay": 0,
    "startPosition": 0,
    "loadFactor": 1,
    "laneFactor": 1,
    "dynamicFactor": 1,
    "generateStationaryLc": "StartingLoadCase"
  }
]

json

application/json

Get Scenario Combinations Metadata

GET

/api/v1

/job/loads/moving-loads/scenarios/combinations/metadata

Returns the schema for a scenario combination row.

Get Scenario Combinations Metadata › Responses

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

Get Scenario Loads Metadata

GET

/api/v1

/job/loads/moving-loads/scenarios/loads/metadata

Returns the schema for a scenario load row.

Get Scenario Loads Metadata › Responses

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

Get Metadata

GET

/api/v1

/job/loads/moving-loads/scenarios/metadata

Returns the schema for this catalog resource.

Get Metadata › Responses

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

Next Id

GET

/api/v1

/job/loads/moving-loads/scenarios/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

Create Bulk

POST

/api/v1

/job/loads/moving-loads/scenarios/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[]

id

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

The Id to assign to the new item.

Example: 1

name

string | null

The scenario name. Must be unique across all scenarios.

Example: Truck northbound

include

boolean

Whether this scenario is included when load cases are generated.

Example: true

startingLoadCase

integer · int32

The first load case number generated for this scenario.

Example: 101

timeInterval

number · double

Time between generated snapshots.

Example: 0.5

array | null

The scenario's load rows, in order. Optional — supply to create the scenario and its loads in one call; omit to set them later via PUT .../{id}/loads.

array | null

The scenario's combination rows. Optional — supply inline, or omit and set them later via PUT .../{id}/combinations.

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/scenarios/bulk

curl --request POST \
  --url /api/v1/job/loads/moving-loads/scenarios/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Truck northbound",
    "include": true,
    "startingLoadCase": 101,
    "timeInterval": 0.5,
    "loads": [
      {
        "loadType": "Vehicle",
        "vehicleId": 1,
        "pressureId": null,
        "travelPathId": 1,
        "speed": 16.7,
        "delay": 0,
        "startPosition": 0,
        "loadFactor": 1,
        "laneFactor": 1,
        "dynamicFactor": 1,
        "generateStationaryLc": "StartingLoadCase"
      }
    ],
    "combinations": [
      {
        "scenarioFactor": 1,
        "combineWithLoadCase": 1,
        "loadCaseFactor": 1.5,
        "startingCombinationCase": 201
      }
    ]
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Truck northbound",
    "include": true,
    "startingLoadCase": 101,
    "timeInterval": 0.5,
    "loads": [
      {
        "loadType": "Vehicle",
        "vehicleId": 1,
        "pressureId": null,
        "travelPathId": 1,
        "speed": 16.7,
        "delay": 0,
        "startPosition": 0,
        "loadFactor": 1,
        "laneFactor": 1,
        "dynamicFactor": 1,
        "generateStationaryLc": "StartingLoadCase"
      }
    ],
    "combinations": [
      {
        "scenarioFactor": 1,
        "combineWithLoadCase": 1,
        "loadCaseFactor": 1.5,
        "startingCombinationCase": 201
      }
    ]
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "Truck northbound",
      "include": true,
      "startingLoadCase": 101,
      "timeInterval": 0.5,
      "hasLoads": true,
      "hasCombinations": false,
      "loads": [
        {
          "loadType": "Vehicle",
          "vehicleId": 1,
          "pressureId": null,
          "travelPathId": 1,
          "speed": 16.7,
          "delay": 0,
          "startPosition": 0,
          "loadFactor": 1,
          "laneFactor": 1,
          "dynamicFactor": 1,
          "generateStationaryLc": "StartingLoadCase"
        }
      ],
      "combinations": [
        {
          "scenarioFactor": 1,
          "combineWithLoadCase": 1,
          "loadCaseFactor": 1.5,
          "startingCombinationCase": 201
        }
      ]
    }
  ],
  "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/scenarios/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/scenarios/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 moving-load scenario header. All properties are optional; omitted properties keep their current value.

id

integer · int32

The Id of the item to update.

Example: 1

name

string | null

Replacement scenario name. Must remain unique. Omit to keep current.

Example: Truck northbound

include

boolean | null

Whether the scenario is included in generation. Omit to keep current.

Example: true

startingLoadCase

integer | null · int32

The first generated load case number. Omit to keep current.

Example: 101

timeInterval

number | null · double

Time between generated snapshots (seconds). Omit to keep current.

Example: 0.5

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/scenarios/bulk

curl --request PATCH \
  --url /api/v1/job/loads/moving-loads/scenarios/bulk \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "id": 1,
    "name": "Truck northbound",
    "include": true,
    "startingLoadCase": 101,
    "timeInterval": 0.5
  }
]
'

shell

Example Request Body

[
  {
    "id": 1,
    "name": "Truck northbound",
    "include": true,
    "startingLoadCase": 101,
    "timeInterval": 0.5
  }
]

json

Example Responses

{
  "succeeded": [
    {
      "id": 1,
      "name": "Truck northbound",
      "include": true,
      "startingLoadCase": 101,
      "timeInterval": 0.5,
      "hasLoads": true,
      "hasCombinations": false,
      "loads": [
        {
          "loadType": "Vehicle",
          "vehicleId": 1,
          "pressureId": null,
          "travelPathId": 1,
          "speed": 16.7,
          "delay": 0,
          "startPosition": 0,
          "loadFactor": 1,
          "laneFactor": 1,
          "dynamicFactor": 1,
          "generateStationaryLc": "StartingLoadCase"
        }
      ],
      "combinations": [
        {
          "scenarioFactor": 1,
          "combineWithLoadCase": 1,
          "loadCaseFactor": 1.5,
          "startingCombinationCase": 201
        }
      ]
    }
  ],
  "errors": [
    {
      "index": 0,
      "id": 0,
      "ids": [
        0
      ],
      "error": "error",
      "errors": [
        "string"
      ]
    }
  ],
  "errorsTruncated": true
}

json

application/json

Moving Loads Moving Load Vehicles