<back to all web services

ManageScheduleTask

The following routes are available for this service:
PUT/RestApi/sitefinity/scheduling/scheduled-tasks
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum SchedulingTaskCommand : string
{
    case Restart = 'Restart';
    case Stop = 'Stop';
    case Resume = 'Resume';
    case Delete = 'Delete';
    case Start = 'Start';
}

class ManageScheduleTask implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $TaskId=null,
        /** @var SchedulingTaskCommand|null */
        public ?SchedulingTaskCommand $Operation=null,
        /** @var string|null */
        public ?string $Hash=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['TaskId'])) $this->TaskId = $o['TaskId'];
        if (isset($o['Operation'])) $this->Operation = JsonConverters::from('SchedulingTaskCommand', $o['Operation']);
        if (isset($o['Hash'])) $this->Hash = $o['Hash'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->TaskId)) $o['TaskId'] = $this->TaskId;
        if (isset($this->Operation)) $o['Operation'] = JsonConverters::to('SchedulingTaskCommand', $this->Operation);
        if (isset($this->Hash)) $o['Hash'] = $this->Hash;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ManageScheduleTask DTOs

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

HTTP + OTHER

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

PUT /RestApi/sitefinity/scheduling/scheduled-tasks HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TaskId":"String","Operation":"Restart","Hash":"String"}