Triggers the run events for specificed schedules

POST

/api/v1/{tenantId}/run-schedules

Plugin API access: this operation accepts a plugin JWT (PluginBearer) for its own tenant.

Authorizations

• PluginBearer

Parameters

Path Parameters

tenantId

required

string

Request Body

object

simulationSpeed

number format: float

schedulesToRun

Array<object>

nullable

object

scheduleId

string

nullable

threadCount

integer format: int32

startSettings

object

mode

string

Allowed values: now atDateTime atStartOfOtherScheduleThread atEndOfOtherScheduleThread

startDateTime

string format: date-time

nullable

predecessorScheduleThreadId

integer format: int64

nullable

predecessorThreadIndex

integer format: int32

nullable

useLastThread

boolean

runParameterValues

object

values

Array<object>

nullable

object

name

string

nullable

value

string

nullable

Responses

200

OK

object

startedRuns

Array<object>

nullable

object

scheduleId

string

nullable

threadId

integer format: int64

nullable

bookings

Array<object>

nullable

object

scheduleId

string

nullable

bookingId

string

nullable

startAtUtc

string format: date-time

400

Bad Request

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

404

Not Found

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

409

Conflict

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

429

Too Many Requests

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

503

Service Unavailable

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable

504

Gateway Timeout

object

message

string

nullable

code

string

nullable

retryable

boolean

nullable

field

string

nullable

data

nullable