<back to all web services

GetScheduledTasks

The following routes are available for this service:
GET/RestApi/sitefinity/scheduling/scheduled-tasks
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class OrderByType(str, Enum):
    SCHEDULED_FOR = 'ScheduledFor'
    LAST_EXECUTION_DATE = 'LastExecutionDate'
    STATUS = 'Status'
    NAME_ASC = 'NameAsc'
    NAME_DESC = 'NameDesc'


class FilterByType(str, Enum):
    ALL = 'All'
    PENDING = 'Pending'
    STARTED = 'Started'
    STOPPED = 'Stopped'
    FAILED = 'Failed'
    RECURRING = 'Recurring'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetScheduledTasks:
    skip: int = 0
    take: int = 0
    search_term: Optional[str] = None
    order_by: Optional[OrderByType] = None
    filter_by: Optional[FilterByType] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduledTaskViewModel:
    task_id: Optional[str] = None
    name: Optional[str] = None
    title: Optional[str] = None
    status: Optional[str] = None
    error_message: Optional[str] = None
    recurring_interval: Optional[str] = None
    scheduled_for_date: datetime.datetime = datetime.datetime(1, 1, 1)
    last_execution_time: Optional[datetime.datetime] = None
    hash: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetScheduledTasksResponse:
    items: Optional[List[ScheduledTaskViewModel]] = None
    total_count: int = 0

Python GetScheduledTasks DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /RestApi/sitefinity/scheduling/scheduled-tasks HTTP/1.1 
Host: www.asg.com.au 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TotalCount":0}