Reload tasks
Reloads tasks allow you to schedule reloads of analytics applications in your tenant.
Endpoints
Finds and returns the tasks that the user has access to.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Header Parameters
- AuthorizationstringRequired
JWT containing tenant credentials.
Query Parameters
- appIdstring
The case sensitive string used to search for a task by app ID.
- limitinteger
The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).
- nextstring
The cursor to the next page of resources. Provide either the next or prev cursor, but not both.
- partialboolean
The boolean value used to search for a task is partial or not
- prevstring
The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.
Responses
200
application/json
Expected response to a valid request.
- application/jsonobject
application/json properties
- dataarray of objectsRequired
data properties
- appIdstringRequired
The ID of the app.
- partialboolean
The task is partial reload or not
- timeZonestringRequired
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.
- autoReloadboolean
A flag that indicates whether a reload is triggered when data of the app is changed
- recurrencearray of strings
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
- endDateTimestring
The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.
- startDateTimestring
The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.
- autoReloadPartialboolean
A flag that indicates whether it is a partial reload or not for the auto reload
- idstringRequired
The ID of the task.
- logstringDeprecated
The reason why the task was disabled.
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
-
-
- statestringRequired
Toggle for enabling and disabling the reload task
Can be one of: "Enabled""Disabled""Completed"
- userIdstringRequired
The ID of the user who owns the task.
- spaceIdstring
The space ID of the application
- migratedboolean
A flag indicating whether the task has been migrated to the new scheduling service.
- tenantIdstringRequired
The ID of the tenant who owns the task.
- fortressIdstringDeprecated
The fortress ID of the application
- disabledCodestring
The reason why the task was disabled.
Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTimestring
The last time the task executed.
- nextExecutionTimestring
The next time the task will execute.
-
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
-
- nextobject
next properties
- hrefstringRequired
-
- prevobject
prev properties
- hrefstringRequired
-
-
-
400
application/json
Bad Request.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
403
application/json
Forbidden, the requesting JWT does not allow for retrieval of this task.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
404
application/json
Not Found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
429
application/json
Too Many Requests.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
503
application/json
Service Unavailable.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/reload-tasks', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
qlik reload-task ls
Response
{ "data": [ { "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722", "partial": false, "timeZone": "America/Toronto", "autoReload": false, "recurrence": [ "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0", "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0" ], "endDateTime": "2022-10-12T23:59:00", "startDateTime": "2022-09-19T11:18:00", "autoReloadPartial": false, "id": "5be59decca62aa00097268a4", "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.", "links": { "self": { "href": "http://example.com" } }, "state": "Enabled", "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx", "spaceId": "602c2c2be2be220002a22a22", "migrated": false, "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w", "fortressId": "5c5b097116d25a0001a48b06", "disabledCode": "CONSECUTIVE-FAILURES", "lastExecutionTime": "2022-09-20T17:17:00Z", "nextExecutionTime": "2022-09-20T17:17:00Z" } ], "links": { "self": { "href": "http://example.com" }, "next": { "href": "http://example.com" }, "prev": { "href": "http://example.com" } }}
Creates a task for a specified app.
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Header Parameters
- AuthorizationstringRequired
JWT containing tenant credentials.
Request Body
Requiredapplication/json
Request body specifying the task parameters.
- application/jsonobject
application/json properties
- appIdstringRequired
The ID of the app.
- partialboolean
The task is partial reload or not
- timeZonestringRequired
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.
- autoReloadboolean
A flag that indicates whether a reload is triggered when data of the app is changed
- recurrencearray of strings
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
- endDateTimestring
The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.
- startDateTimestring
The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.
- autoReloadPartialboolean
A flag that indicates whether it is a partial reload or not for the auto reload
- typestringDeprecated
Type of task being created - only contains the "scheduled_reload" value. Type value is not used for creating a schedule reload. It has been deprecated since 2022-04-05.
Can be one of: "scheduled_reload"
-
Responses
201
application/json
Expected response to a valid request.
- application/jsonobject
application/json properties
- appIdstringRequired
The ID of the app.
- partialboolean
The task is partial reload or not
- timeZonestringRequired
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.
- autoReloadboolean
A flag that indicates whether a reload is triggered when data of the app is changed
- recurrencearray of strings
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
- endDateTimestring
The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.
- startDateTimestring
The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.
- autoReloadPartialboolean
A flag that indicates whether it is a partial reload or not for the auto reload
- idstringRequired
The ID of the task.
- logstringDeprecated
The reason why the task was disabled.
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
-
-
- statestringRequired
Toggle for enabling and disabling the reload task
Can be one of: "Enabled""Disabled""Completed"
- userIdstringRequired
The ID of the user who owns the task.
- spaceIdstring
The space ID of the application
- migratedboolean
A flag indicating whether the task has been migrated to the new scheduling service.
- tenantIdstringRequired
The ID of the tenant who owns the task.
- fortressIdstringDeprecated
The fortress ID of the application
- disabledCodestring
The reason why the task was disabled.
Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTimestring
The last time the task executed.
- nextExecutionTimestring
The next time the task will execute.
-
400
application/json
Bad Request.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
403
application/json
Forbidden, the requesting JWT does not allow for retrieval of this task.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
404
application/json
Not Found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
503
application/json
Service Unavailable.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks" \-X POST \-H "Authorization: Bearer <access_token>" \-H "Content-type: application/json" \-d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":false,"timeZone":"America/Toronto","autoReload":false,"recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0","RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"],"endDateTime":"2022-10-12T23:59:00","startDateTime":"2022-09-19T11:18:00","autoReloadPartial":false,"type":"scheduled_reload"}'
const https = require('https') const data = JSON.stringify({"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":false,"timeZone":"America/Toronto","autoReload":false,"recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0","RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"],"endDateTime":"2022-10-12T23:59:00","startDateTime":"2022-09-19T11:18:00","autoReloadPartial":false,"type":"scheduled_reload"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/reload-tasks', 'method': 'POST', 'headers': { 'Authorization': 'Bearer <access_token>', 'Content-type': 'application/json' } } const req = https.request(options) req.write(data)
qlik reload-task create \--appId="116dbfae-7fb9-4983-8e23-5ccd8c508722" \--endDateTime="2022-10-12T23:59:00" \--recurrence='"RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0","RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"' \--startDateTime="2022-09-19T11:18:00" \--timeZone="America/Toronto" \--type="scheduled_reload"
Request
{ "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722", "partial": false, "timeZone": "America/Toronto", "autoReload": false, "recurrence": [ "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0", "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0" ], "endDateTime": "2022-10-12T23:59:00", "startDateTime": "2022-09-19T11:18:00", "autoReloadPartial": false, "type": "scheduled_reload"}
Response
{ "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722", "partial": false, "timeZone": "America/Toronto", "autoReload": false, "recurrence": [ "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0", "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0" ], "endDateTime": "2022-10-12T23:59:00", "startDateTime": "2022-09-19T11:18:00", "autoReloadPartial": false, "id": "5be59decca62aa00097268a4", "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.", "links": { "self": { "href": "http://example.com" } }, "state": "Enabled", "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx", "spaceId": "602c2c2be2be220002a22a22", "migrated": false, "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w", "fortressId": "5c5b097116d25a0001a48b06", "disabledCode": "CONSECUTIVE-FAILURES", "lastExecutionTime": "2022-09-20T17:17:00Z", "nextExecutionTime": "2022-09-20T17:17:00Z"}
Finds and returns a task.
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Header Parameters
- AuthorizationstringRequired
JWT containing tenant credentials.
Path Parameters
- taskIdstringRequired
The unique identifier of the task.
Responses
200
application/json
Expected response to a valid request.
- application/jsonobject
application/json properties
- appIdstringRequired
The ID of the app.
- partialboolean
The task is partial reload or not
- timeZonestringRequired
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.
- autoReloadboolean
A flag that indicates whether a reload is triggered when data of the app is changed
- recurrencearray of strings
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
- endDateTimestring
The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.
- startDateTimestring
The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.
- autoReloadPartialboolean
A flag that indicates whether it is a partial reload or not for the auto reload
- idstringRequired
The ID of the task.
- logstringDeprecated
The reason why the task was disabled.
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
-
-
- statestringRequired
Toggle for enabling and disabling the reload task
Can be one of: "Enabled""Disabled""Completed"
- userIdstringRequired
The ID of the user who owns the task.
- spaceIdstring
The space ID of the application
- migratedboolean
A flag indicating whether the task has been migrated to the new scheduling service.
- tenantIdstringRequired
The ID of the tenant who owns the task.
- fortressIdstringDeprecated
The fortress ID of the application
- disabledCodestring
The reason why the task was disabled.
Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTimestring
The last time the task executed.
- nextExecutionTimestring
The next time the task will execute.
-
400
application/json
Bad Request.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
403
application/json
Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
404
application/json
Not Found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
429
application/json
Too Many Requests.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
503
application/json
Service Unavailable.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/reload-tasks/{taskId}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
qlik reload-task get <taskId>
Response
{ "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722", "partial": false, "timeZone": "America/Toronto", "autoReload": false, "recurrence": [ "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0", "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0" ], "endDateTime": "2022-10-12T23:59:00", "startDateTime": "2022-09-19T11:18:00", "autoReloadPartial": false, "id": "5be59decca62aa00097268a4", "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.", "links": { "self": { "href": "http://example.com" } }, "state": "Enabled", "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx", "spaceId": "602c2c2be2be220002a22a22", "migrated": false, "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w", "fortressId": "5c5b097116d25a0001a48b06", "disabledCode": "CONSECUTIVE-FAILURES", "lastExecutionTime": "2022-09-20T17:17:00Z", "nextExecutionTime": "2022-09-20T17:17:00Z"}
Updates an existing task
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Header Parameters
- AuthorizationstringRequired
JWT containing tenant credentials.
Path Parameters
- taskIdstringRequired
The unique identifier of the task.
Request Body
Requiredapplication/json
Request body specifying the task parameters.
- application/jsonobject
application/json properties
- appIdstring
The ID of the app.
- partialboolean
The task is partial reload or not
- timeZonestring
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.
- autoReloadboolean
A flag that indicates whether a reload is triggered when data of the app is changed
- recurrencearray of strings
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
- endDateTimestring
The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.
- startDateTimestring
The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.
- autoReloadPartialboolean
A flag that indicates whether it is a partial reload or not for the auto reload
- statestring
Toggle for enabling and disabling the reload task
Can be one of: "Enabled""Disabled""Completed"
-
Responses
200
application/json
Expected response to a valid request.
- application/jsonobject
application/json properties
- appIdstringRequired
The ID of the app.
- partialboolean
The task is partial reload or not
- timeZonestringRequired
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.
- autoReloadboolean
A flag that indicates whether a reload is triggered when data of the app is changed
- recurrencearray of strings
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
- endDateTimestring
The time that the task will stop recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted.
- startDateTimestring
The time that the task execution start recurring. If the time zone is missing, this is a combined date-time value expressing a time with a fixed UTC offset (formatted according to RFC3339). If a time zone is given, the zone offset must be omitted. Field startDateTime should not be before the Unix epoch 00:00:00 UTC on 1 January 1970. Note that the empty string value with the empty recurrence array indicates the scheduled job is not set.
- autoReloadPartialboolean
A flag that indicates whether it is a partial reload or not for the auto reload
- idstringRequired
The ID of the task.
- logstringDeprecated
The reason why the task was disabled.
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
-
-
- statestringRequired
Toggle for enabling and disabling the reload task
Can be one of: "Enabled""Disabled""Completed"
- userIdstringRequired
The ID of the user who owns the task.
- spaceIdstring
The space ID of the application
- migratedboolean
A flag indicating whether the task has been migrated to the new scheduling service.
- tenantIdstringRequired
The ID of the tenant who owns the task.
- fortressIdstringDeprecated
The fortress ID of the application
- disabledCodestring
The reason why the task was disabled.
Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTimestring
The last time the task executed.
- nextExecutionTimestring
The next time the task will execute.
-
400
application/json
Bad Request.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
403
application/json
Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
404
application/json
Not Found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
503
application/json
Service Unavailable.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \-X PUT \-H "Authorization: Bearer <access_token>" \-H "Content-type: application/json" \-d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":false,"timeZone":"America/Toronto","autoReload":false,"recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0","RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"],"endDateTime":"2022-10-12T23:59:00","startDateTime":"2022-09-19T11:18:00","autoReloadPartial":false,"state":"Disabled"}'
const https = require('https') const data = JSON.stringify({"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":false,"timeZone":"America/Toronto","autoReload":false,"recurrence":["RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0","RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"],"endDateTime":"2022-10-12T23:59:00","startDateTime":"2022-09-19T11:18:00","autoReloadPartial":false,"state":"Disabled"}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/reload-tasks/{taskId}', 'method': 'PUT', 'headers': { 'Authorization': 'Bearer <access_token>', 'Content-type': 'application/json' } } const req = https.request(options) req.write(data)
qlik reload-task update <taskId> \--appId="116dbfae-7fb9-4983-8e23-5ccd8c508722" \--endDateTime="2022-10-12T23:59:00" \--recurrence='"RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0","RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0"' \--startDateTime="2022-09-19T11:18:00" \--state="Disabled" \--timeZone="America/Toronto"
Request
{ "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722", "partial": false, "timeZone": "America/Toronto", "autoReload": false, "recurrence": [ "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0", "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0" ], "endDateTime": "2022-10-12T23:59:00", "startDateTime": "2022-09-19T11:18:00", "autoReloadPartial": false, "state": "Disabled"}
Response
{ "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722", "partial": false, "timeZone": "America/Toronto", "autoReload": false, "recurrence": [ "RRULE:FREQ=DAILY;INTERVAL=1;BYHOUR=11;BYMINUTE=18;BYSECOND=0", "RRULE:FREQ=WEEKLY;INTERVAL=2;BYDAY=MO,TU;BYHOUR=13;BYMINUTE=17;BYSECOND=0" ], "endDateTime": "2022-10-12T23:59:00", "startDateTime": "2022-09-19T11:18:00", "autoReloadPartial": false, "id": "5be59decca62aa00097268a4", "log": "Scheduled reload has been disabled since exceeded limit of 5 consecutive reload failures. Please fix error and re-enable schedule.", "links": { "self": { "href": "http://example.com" } }, "state": "Enabled", "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx", "spaceId": "602c2c2be2be220002a22a22", "migrated": false, "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w", "fortressId": "5c5b097116d25a0001a48b06", "disabledCode": "CONSECUTIVE-FAILURES", "lastExecutionTime": "2022-09-20T17:17:00Z", "nextExecutionTime": "2022-09-20T17:17:00Z"}
Deletes a task
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Header Parameters
- AuthorizationstringRequired
JWT containing tenant credentials.
Path Parameters
- taskIdstringRequired
The unique identifier of the task.
Responses
204
Task deleted successfully.
400
application/json
Bad Request.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
403
application/json
Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
404
application/json
Not Found.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestringRequired
- titlestringRequired
- detailstring
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \-X DELETE \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/reload-tasks/{taskId}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
qlik reload-task rm <taskId>