Simulate execution plan for the first N execution cycles

POST 
/execution-strategy/:nameOrSid/simulate-execution

Simulate execution plan for the first N execution cycles

Request

Path Parameters

nameOrSid stringrequired
Example: 43c870a8-3816-4c66-89cb-2e96255dcb34

Header Parameters

Strategy-Secret stringrequired

The secret for the requested Strategy

application/json

Body

required

cycles numberrequired

Possible values: >= 1 and <= 100

Number of cycle to simulate

startDate date-time

Execution start date

dateFormat string

Date format to use

Responses

200

Execution plan simulation

application/json

Schema

Schema

simulatedCycles numberrequired

Number of cycle simulated

startDate stringrequired

Start date with format

timezone stringrequired

Used timezone

cycleEvents

object[]

required

Cycle events

Array [

cycle numberrequired

Cycle number

events

object

required

mainEvent

object

Cycle main event

date stringrequired

Event date with format

task stringrequired

Event task

status stringrequired

Possible values: [ONHOLD, PENDING, QUEUED, EXECUTING, PROCESSED, FAILED, CANCELED, PAUSED]

Event status

callback string

event callback

from string

Cycle from date

leadingUpEvents

object[]

Cycle leading up events

Array [

date stringrequired

Event date with format

task stringrequired

Event task

status stringrequired

Possible values: [ONHOLD, PENDING, QUEUED, EXECUTING, PROCESSED, FAILED, CANCELED, PAUSED]

Event status

callback string

event callback

]

onCreateEvents

object[]

Cycle on create events

Array [

date stringrequired

Event date with format

task stringrequired

Event task

status stringrequired

Possible values: [ONHOLD, PENDING, QUEUED, EXECUTING, PROCESSED, FAILED, CANCELED, PAUSED]

Event status

callback string

event callback

]

]

Example (from schema)

{
  "simulatedCycles": "5",
  "startDate": "Saturday, January 1, 2022 8:00 PM",
  "timezone": "Asia/Manila",
  "cycleEvents": [
    {
      "cycle": "2",
      "events": {
        "mainEvent": {
          "date": "string",
          "task": "string",
          "status": "ONHOLD",
          "callback": "string"
        },
        "from": "string",
        "leadingUpEvents": [
          {
            "date": "string",
            "task": "string",
            "status": "ONHOLD",
            "callback": "string"
          }
        ],
        "onCreateEvents": [
          {
            "date": "string",
            "task": "string",
            "status": "ONHOLD",
            "callback": "string"
          }
        ]
      }
    }
  ]
}

Loading...