getScheduledtasks

Gets scheduled tasks

Requires authentication as administrator

Request
get /ScheduledTasks
Parameters
Name In Type Default Notes
IsHidden query

Optional filter tasks that are hidden, or not.
IsEnabled query

Optional filter tasks that are enabled, or not.
Responses
Status Code Type Description Samples
200 TaskInfo []

Operation successful. Returning a TaskInfo[] object.
400

Bad Request. Server cannot process request.
401

Unauthorized. Client needs to authenticate.
403

Forbidden. No permission for the reqested operation.
404

Resource not found or unavailable.
500

Server error.

Definitions

TaskInfo

Name Type Notes
Name string

The name.
State TaskState

Enum TaskState
CurrentProgressPercentage number (double)

The progress.
Id string

The id.
LastExecutionResult TaskResult

Class TaskExecutionInfo
Triggers TaskTriggerInfo[]

The triggers.
Description string

The description.
Category string

The category.
IsHidden boolean

A value indicating whether this instance is hidden.
Key string

The key.

TaskState

Enum Values
  • Idle
  • Cancelling
  • Running

TaskResult

Name Type Notes
StartTimeUtc string (date-time)

The start time UTC.
EndTimeUtc string (date-time)

The end time UTC.
Status TaskCompletionStatus

Enum TaskCompletionStatus
Name string

The name.
Key string

The key.
Id string

The id.
ErrorMessage string

The error message.
LongErrorMessage string

The long error message.

TaskCompletionStatus

Enum Values
  • Completed
  • Failed
  • Cancelled
  • Aborted

TaskTriggerInfo

Name Type Notes
Type string

The type.
TimeOfDayTicks integer (int64)

The time of day.
IntervalTicks integer (int64)

The interval.
SystemEvent SystemEvent

Enum SystemEvent
DayOfWeek DayOfWeek
MaxRuntimeTicks integer (int64)

The maximum runtime ticks.

SystemEvent

Enum Values
  • WakeFromSleep
  • DisplayConfigurationChange
  • NetworkChange

DayOfWeek

System.DayOfWeek
Enum Values
  • Sunday
  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday