Run

Start a Run

post/runs/{runId}/start

Request

Base URL
https://api.server.test/v1
Auth
none declared
TypeScript
https://skmtc.dev/natlabrockies/apis/alfalfa-boptest-unified-virtual-building-control-api-abuvbca/docs/runs/:runId/start/post.ts
A function with typed inputs. Its response is checked against the schema.

runIdstring required

Example:7cf4afb6-9c15-431f-9f50-11bca0870f77

ID of run

startDatetimestring date-time required

Start Time

endDatetimestring date-time required

End Time

timescalenumber

Time multiplier determining simulation speed

externalClockboolean

When true the Run will only advance when triggered via the API

realtimeboolean

Simulate the model in realtime

{
  "timescale": 1,
  "externalClock": true
}

The run was started

No recorded changes to this operation across all 4 revisions of this API.