PUT api/scheduledtask/{id}

Save scheduled task. Update scheduled task

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Identifier of Scheduled Task	globally unique identifier	Required

Body Parameters

Scheduled task object

ScheduledTask

Name	Description	Type	Additional information
ID		globally unique identifier	None.
AccountID	Tenant or Administrator ID	globally unique identifier	None.
Data	Parameters to pass to the task	Dictionary of string [key] and Object [value]	None.
DataBytes		Collection of byte	None.
DataFormat		integer	None.
DataCompression		integer	None.
ScheduleType	Schedule type	ScheduleType	None.
CronExpression	When ScheduleType is Cron, the background service uses this to schedule the task	string	None.
CronExpressionDescription	User-readable Cron expression description	string	None.
Starts	When the tasks's ScheduleType is OnceOff, this is the time the task should run. If set to null, the task should run immediately	date	None.
Task	Task type identifier	string	None.
Description	Display, or user-friendly description	string	None.
LastRun	The last time (UTC) the task ran to completion	date	None.
Created	Date and time (UTC) the ScheduledTask was created	date	None.
TimeZone	Account's time zone	TimeZoneInfo	None.
Registered	This task has been scheduled by the BackgroundService	boolean	None.
Default	This is a default scheduled task	boolean	None.
Account		string	Relation. This field may not always be loaded or used for updates.

Request Formats

application/json, text/json

Sample:

{
  "id": "9c6dc317-6bf8-46dc-aa1e-11e243344c44",
  "accountID": "7c29ce4f-20ab-47f9-8ed8-69ae7f68da5c",
  "data": {
    "$id": "2",
    "sample string 1": {
      "$id": "3"
    },
    "sample string 3": {
      "$id": "4"
    }
  },
  "dataBytes": "QEA=",
  "dataFormat": 1,
  "dataCompression": 1,
  "scheduleType": 0,
  "cronExpression": "sample string 3",
  "cronExpressionDescription": "sample string 4",
  "starts": "2025-06-14T06:17:01.9595636",
  "task": "sample string 5",
  "description": "sample string 6",
  "lastRun": "2025-06-14T06:17:01.9595636",
  "created": "2025-06-14T06:17:01.9595636",
  "registered": true,
  "default": true,
  "account": "sample string 10"
}

application/xml, text/xml

Sample:

<ScheduledTask xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EziManager.Models.ScheduledTasks">
  <Account>sample string 10</Account>
  <AccountID>7c29ce4f-20ab-47f9-8ed8-69ae7f68da5c</AccountID>
  <Created>2025-06-14T06:17:01.9595636+00:00</Created>
  <CronExpression>sample string 3</CronExpression>
  <CronExpressionDescription>sample string 4</CronExpressionDescription>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Data>
  <DataBytes>QEA=</DataBytes>
  <DataCompression>1</DataCompression>
  <DataFormat>1</DataFormat>
  <Default>true</Default>
  <Description>sample string 6</Description>
  <ID>9c6dc317-6bf8-46dc-aa1e-11e243344c44</ID>
  <LastRun>2025-06-14T06:17:01.9595636+00:00</LastRun>
  <Registered>true</Registered>
  <ScheduleType>Cron</ScheduleType>
  <Starts>2025-06-14T06:17:01.9595636+00:00</Starts>
  <Task>sample string 5</Task>
  <TimeZone xmlns:d2p1="http://schemas.datacontract.org/2004/07/System" i:nil="true" />
</ScheduledTask>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.