Interface IReloadTask

interface IReloadTask {
    appId: string;
    autoReload: boolean;
    autoReloadPartial: boolean;
    endDateTime: string;
    fortressId: string;
    id: string;
    lastExecutionTime: string;
    links: ILinksShort;
    log: string;
    nextExecutionTime: string;
    partial: boolean;
    recurrence: string[];
    spaceId: string;
    startDateTime: string;
    state: "Enabled" | "Disabled";
    tenantId: string;
    timeZone: string;
    type: string;
    userId: string;
}

Hierarchy (view full)

Properties

appId: string

The ID of the app.

autoReload: boolean

A flag that indicates whether a reload is triggered when data of the app is changed

Default

false
autoReloadPartial: boolean

A flag that indicates whether it is a partial reload or not for the auto reload

Default

false
endDateTime: string

The time that the task will stop recurring.

Default

empty string

Example

2022-09-18T14:45:00
fortressId: string

The fortress ID of the application

id: string

The ID of the task.

lastExecutionTime: string

The last time the task executed.

log: string

The reason why the task was disabled.

nextExecutionTime: string

The next time the task will execute.

partial: boolean

The task is partial reload or not

Default

false
recurrence: string[]

List of RECUR lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events

Example

"RRULE:FREQ=DAILY;BYHOUR=8;BYMINUTE=0;BYSECOND=0",
"RRULE:FREQ=WEEKLY;BYHOUR=10;BYMINUTE=0;BYSECOND=0"
spaceId: string

The space ID of the application

startDateTime: string

The time that the task execution start recurring. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.

Example

2022-09-18T14:45:00
state: "Enabled" | "Disabled"

Toggle for enabling and disabling the reload task

tenantId: string

The ID of the tenant who owns the task.

timeZone: string

The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. Europe/Zurich.) This field specifies the time zone in which the event start/end are expanded. If missing the start/end fields must specify a UTC offset in RFC3339 format.

Default

Europe/London
type: string

Deprecated

type of task being created - deprecated

userId: string

The ID of the user who owns the task.