scheduling task resource reload on-time-schedule
qlik scheduling task resource reload on-time-schedule
Create a time-scheduled reload task
Synopsis
Creates a reload task for the app that runs on a recurring time schedule.
This is a convenience wrapper over POST /scheduling/tasks; the full task
definition is generated server-side. Use POST /scheduling/tasks for advanced
configurations.
The schedule is evaluated in timezone. The first run is the next occurrence of
recurrence after the task is created; creating a task never runs it immediately.
A task is created disabled unless enabled is true.
Errors:
400CHO-001: the request body or the pathidis invalid. This includes anameordescriptionover its maximum length.400CHO-017: the schedule was rejected:recurrenceortimezoneis invalid,endDateTimeis not afterstartDateTime, orendDateTimeis in the past.403CHO-003: the app does not exist, is not accessible, or the caller lacksapp:reloadon it.404: not returned for a missing app, which gets403as above. Kept for compatibility.422CHO-014: the app already has the maximum number of tasks.CHO-018: the caller has reached the per-user task quota, when one is configured.424CHO-013: the task could not be stored. Nothing is created.503CHO-024: the scheduler is temporarily unavailable. Nothing is created.
qlik scheduling task resource reload on-time-schedule <resourceId> [flags]Options
--description string A human-readable description of the task's purpose. --enabled Whether the task is enabled. A disabled task never runs on its own. Defaults to ˋfalseˋ. --endDateTime string The local date and time in ˋtimezoneˋ when the schedule ends, in the same format as ˋstartDateTimeˋ; any offset or ˋZˋ is ignored in the same way. It must be after ˋstartDateTimeˋ and in the future. Omit it for a schedule with no end. -f, --file file Read request body from the specified file -h, --help help for on-time-schedule --interval int Duration in seconds to wait between retries, at least 1 (default 1) --name string (Required) The name that identifies the task. --partial Whether the reload is partial. -q, --quiet Return only IDs from the command --raw Return original response from server without any processing --recurrence string (Required) An RFC 5545 recurrence rule prefixed with ˋRRULE:ˋ, for example ˋRRULE:FREQ=DAILY;BYHOUR=9;BYMINUTE=0;BYSECOND=0ˋ to run every day at 09:00:00. ˋFREQˋ is required. The scheduler also enforces these limits: - The shortest frequency is ˋMINUTELYˋ; ˋSECONDLYˋ is not supported. - ˋCOUNTˋ is at most 100. - ˋINTERVALˋ is at most 1000 for ˋMINUTELYˋ and ˋHOURLYˋ, 548 for ˋDAILYˋ, 78 for ˋWEEKLYˋ, 18 for ˋMONTHLYˋ and 2 for ˋYEARLYˋ. - An ˋINTERVALˋ greater than 1 cannot be combined with the ˋBY*ˋ part of the same unit, for example ˋFREQ=MINUTELY;INTERVAL=5;BYMINUTE=10ˋ. - ˋDTSTARTˋ, ˋUNTILˋ, ˋEXDATEˋ and ˋRDATEˋ are not supported; use ˋstartDateTimeˋ and ˋendDateTimeˋ instead.
Time-of-day parts that are left out (ˋBYHOURˋ, ˋBYMINUTEˋ, ˋBYSECONDˋ) are taken from ˋstartDateTimeˋ, or from the creation time when ˋstartDateTimeˋ is omitted. Set them explicitly to run at a fixed time of day. --retry int Number of retries to do before failing, max 10 --startDateTime string The local date and time in ˋtimezoneˋ when the schedule starts, in the format ˋYYYY-MM-DDThh:mm:ssˋ. Any offset or ˋZˋ is ignored: the value is always read as wall-clock time in ˋtimezoneˋ, so ˋ2026-11-02T09:00:00Zˋ with ˋtimezoneˋ set to ˋEurope/Stockholmˋ means 09:00 Stockholm time. Defaults to the time the task is created. Occurrences before the task is created are skipped, not caught up, but they still count towards ˋCOUNTˋ. --timezone string An IANA time zone name, such as ˋEurope/Stockholmˋ, used to evaluate ˋrecurrenceˋ, ˋstartDateTimeˋ and ˋendDateTimeˋ. Defaults to ˋUTCˋ.Options inherited from parent commands
-c, --config string path/to/config.yml where parameters can be set instead of on the command line --context string Name of the context used when connecting to Qlik Associative Engine --headers stringToString HTTP headers to use when connecting to Qlik Associative Engine (default []) --insecure Allow connecting to hosts with self-signed certificates --json Returns output in JSON format, if possible. Disables verbose and traffic output -s, --server string URL to Qlik Cloud or directly to a Qlik Associative Engine --server-type string The type of server you are using: cloud, Windows (Enterprise on Windows) or engine -v, --verbose Log extra information