Starts a plan run (fast simulation) for the schedule

POST

/api/v1/{tenantId}/schedules/{scheduleId}/plan

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

Authorizations

• PluginBearer

Parameters

Path Parameters

tenantId

required

string

scheduleId

required

string

Request Body

object

threadCount

integer format: int32

nullable

runParameterValues

object

values

Array<object>

nullable

object

name

string

nullable

value

string

nullable

Responses

200

OK

object

planRunId

string

nullable

runningPlanRunId

string

nullable

400

Bad Request

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