POST scenario/run

Tries to run scenario

Request body model example and description

{
  "ScenarioName": "myscenario",
  "ScenarioId": 123,
  "ScheduleOptions": {
    "ScheduledScenarioRuns": [
      {
        "ScheduleDay": "sample string 1",
        "StartDate": "sample string 2",
        "EndDate": "sample string 3",
        "RunAtHour": 1,
        "RunAtMinute": 1
      },
      {
        "ScheduleDay": "sample string 1",
        "StartDate": "sample string 2",
        "EndDate": "sample string 3",
        "RunAtHour": 1,
        "RunAtMinute": 1
      },
      {
        "ScheduleDay": "sample string 1",
        "StartDate": "sample string 2",
        "EndDate": "sample string 3",
        "RunAtHour": 1,
        "RunAtMinute": 1
      }
    ],
    "RunImmediately": true
  }
}

Name	Type	Required	Description
ScenarioName	String	No	Scenario name to be executed. Could be empty if ScenarioId is set
ScenarioId	Integer	No	Scenario Id to be executed. Could be empty if ScenarioName is set
ScheduleOptions	Object	No	Schedule options. Pass null to run with default options saved in scenario.

;

Response body model example and description

{
  "run_ids": [
    1,
    2,
    3
  ],
  "result": true,
  "messages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "exception": "An exception was encountered during execution: {exception details...}"
}

Name	Type	Description
run_ids	Array	The IDs of the scenario runs
result	Boolean	The result of operation
messages	Array	The list of error messages in case of error(s)
exception	String	Any exception that arose during the function call. In case no exception was thrown this will be an empty string.

;