Documentation

Stop Schedule by Schedule ID

Description

'Stop Schedule by Schedule ID' endpoint stops an already running schedule identified by the ScheduleId. On the successful stop of a schedule, the endpoint will return ‘true’.

The ScheduleId used as input can be obtained from the Get All Schedules endpoint

Request URL

http://{controllerMachine}:{controllerPort}/api/v3/schedules/{scheduleId}/stop

Input parameters

Field	Type	Description	Comments
scheduleid	string	Unique identifier for Schedule	scheduleId can be fetched from response body of Get Schedule, it is referred as ‘Id’ there.

Examples

Curl

curl -X PUT --header 'Accept: application/json' --header 'AccessKey: Mo87Nc4qDAtzJNDb' 'http://{controllerMachine}:{controllerPort}/api/v3/schedules/39f2b3e3-fa24-43e7-a2d6-38815128ac6c/stop'

PowerShell

$headers = @{}

$headers.Add("AccessKey","Mo87Nc4qDAtzJNDb")

$ScheduleID="39f2b3e3-fa24-43e7-a2d6-38815128ac6c"

Invoke-WebRequest -Uri "http://{controllerMachine}:{controllerPort}/api/v3/schedules/$ScheduleID/stop" -ContentType "application/json" -Headers $headers -Method PUT

Response

Returns true after stopping the schedule

{
"$id": "1",
"OperationCompleted": true
}

Response object

Field	Type	Description	Values
OperationCompleted	string	Returns ‘true’ if schedule is stopped else ‘false’	true, false

Response Code

200 (OK)

404 (Not Found)

401 (Unauthorized)

400 (Bad Request)

405 (Method Not Allowed)

500 (Internal Server Error)