Reload tasks

Reloads tasks allow you to schedule reloads of analytics applications in your tenant.

Endpoints

GET

/api/v1/reload-tasks
POST

/api/v1/reload-tasks
GET

/api/v1/reload-tasks/{taskId}
PUT

/api/v1/reload-tasks/{taskId}
DELETE

/api/v1/reload-tasks/{taskId}

Finds and returns the tasks that the user has access to.

Facts

	Rate limit	Tier 1 (1000 requests per minute)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-11
	Deprecated description	This endpoint is deprecated and will be removed after 2026-11. Use the `/scheduling/tasks` endpoint instead.

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Query Parameters

appId string

The case sensitive string used to search for a task by app ID.
limit integer

The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

minimum = 1, maximum = 100, default = 10, format = int32, default = 10
next string

The cursor to the next page of resources. Provide either the next or prev cursor, but not both.
partial boolean

The boolean value used to search for a task is partial or not
prev string

The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

Responses

200

Expected response to a valid request.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  appId string
  
  Required
  
  The ID of the app.
  
  partial boolean
  
  The task is partial reload or not
  
  default = false
  
  timeZone string
  
  Required
  
  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.
  
  autoReload boolean
  
  A flag that indicates whether a reload is triggered when data of the app is changed
  
  default = false
  
  recurrence array 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
  
  endDateTime string
  
  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.
  
  startDateTime string
  
  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.
  
  autoReloadPartial boolean
  
  A flag that indicates whether it is a partial reload or not for the auto reload
  
  default = false
  
  id string
  
  Required
  
  The ID of the task.
  
  log string Deprecated
  
  The reason why the task was disabled.
  
  jobId string
  
  Required
  
  The ID of the scheduler job associated with the task.
  
  links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"
  
  state string
  
  Required
  
  Toggle for enabling and disabling the reload task
  
  Can be one of: "Enabled""Disabled""Completed"
  
  userId string
  
  Required
  
  The ID of the user who owns the task.
  
  spaceId string
  
  The space ID of the application
  
  migrated boolean
  
  A flag indicating whether the task has been migrated to the new scheduling service.
  
  default = false
  
  tenantId string
  
  Required
  
  The ID of the tenant who owns the task.
  
  fortressId string Deprecated
  
  The fortress ID of the application
  
  disabledCode string
  
  The reason why the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
  
  lastExecutionTime string
  
  The last time the task executed.
  
  nextExecutionTime string
  
  The next time the task will execute.
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"
  
  next object
  
  Show next properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"

400

Bad Request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

403

Forbidden, the requesting JWT does not allow for retrieval of this task.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

429

Too Many Requests.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

503

Service Unavailable.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

GET /api/v1/reload-tasks

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.reloadTasks.getReloadTasks({})

# qlik-cli has not implemented support for GET /api/v1/reload-tasks yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reload-tasks" \
-H "Authorization: Bearer <access_token>"

Example 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.",
      "jobId": "5be59decca62aa00097268a5",
      "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)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-11
	Deprecated description	This endpoint is deprecated and will be removed after 2026-11. Use the `/scheduling/tasks` endpoint instead.

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Request Body

Required

Request body specifying the task parameters.

application/json object
Show application/json properties
- appId string
  
  Required
  
  The ID of the app.
- partial boolean
  
  The task is partial reload or not
  
  default = false
- timeZone string
  
  Required
  
  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.
- autoReload boolean
  
  A flag that indicates whether a reload is triggered when data of the app is changed
  
  default = false
- recurrence array 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
- endDateTime string
  
  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.
- startDateTime string
  
  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.
- autoReloadPartial boolean
  
  A flag that indicates whether it is a partial reload or not for the auto reload
  
  default = false
- type string Deprecated
  
  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

Expected response to a valid request.

application/json object
Show application/json properties
- appId string
  
  Required
  
  The ID of the app.
- partial boolean
  
  The task is partial reload or not
  
  default = false
- timeZone string
  
  Required
  
  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.
- autoReload boolean
  
  A flag that indicates whether a reload is triggered when data of the app is changed
  
  default = false
- recurrence array 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
- endDateTime string
  
  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.
- startDateTime string
  
  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.
- autoReloadPartial boolean
  
  A flag that indicates whether it is a partial reload or not for the auto reload
  
  default = false
- id string
  
  Required
  
  The ID of the task.
- log string Deprecated
  
  The reason why the task was disabled.
- jobId string
  
  Required
  
  The ID of the scheduler job associated with the task.
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"
- state string
  
  Required
  
  Toggle for enabling and disabling the reload task
  
  Can be one of: "Enabled""Disabled""Completed"
- userId string
  
  Required
  
  The ID of the user who owns the task.
- spaceId string
  
  The space ID of the application
- migrated boolean
  
  A flag indicating whether the task has been migrated to the new scheduling service.
  
  default = false
- tenantId string
  
  Required
  
  The ID of the tenant who owns the task.
- fortressId string Deprecated
  
  The fortress ID of the application
- disabledCode string
  
  The reason why the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTime string
  
  The last time the task executed.
- nextExecutionTime string
  
  The next time the task will execute.

400

Bad Request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

403

Forbidden, the requesting JWT does not allow for retrieval of this task.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

410

The reload-tasks API is deprecated and will be removed in a future release. Please refer to the documentation for alternative approaches.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

503

Service Unavailable.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

POST /api/v1/reload-tasks

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.reloadTasks.createReloadTask({
  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',
})

# qlik-cli has not implemented support for POST /api/v1/reload-tasks yet.

curl "https://{tenant}.{region}.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"}'

Example 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.",
  "jobId": "5be59decca62aa00097268a5",
  "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)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-11
	Deprecated description	This endpoint is deprecated and will be removed after 2026-11. Use the `/scheduling/tasks/{id}` endpoint instead.

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Path Parameters

taskId string

Required

The unique identifier of the task.

Responses

200

Expected response to a valid request.

application/json object
Show application/json properties
- appId string
  
  Required
  
  The ID of the app.
- partial boolean
  
  The task is partial reload or not
  
  default = false
- timeZone string
  
  Required
  
  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.
- autoReload boolean
  
  A flag that indicates whether a reload is triggered when data of the app is changed
  
  default = false
- recurrence array 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
- endDateTime string
  
  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.
- startDateTime string
  
  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.
- autoReloadPartial boolean
  
  A flag that indicates whether it is a partial reload or not for the auto reload
  
  default = false
- id string
  
  Required
  
  The ID of the task.
- log string Deprecated
  
  The reason why the task was disabled.
- jobId string
  
  Required
  
  The ID of the scheduler job associated with the task.
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"
- state string
  
  Required
  
  Toggle for enabling and disabling the reload task
  
  Can be one of: "Enabled""Disabled""Completed"
- userId string
  
  Required
  
  The ID of the user who owns the task.
- spaceId string
  
  The space ID of the application
- migrated boolean
  
  A flag indicating whether the task has been migrated to the new scheduling service.
  
  default = false
- tenantId string
  
  Required
  
  The ID of the tenant who owns the task.
- fortressId string Deprecated
  
  The fortress ID of the application
- disabledCode string
  
  The reason why the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTime string
  
  The last time the task executed.
- nextExecutionTime string
  
  The next time the task will execute.

400

Bad Request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

403

Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

429

Too Many Requests.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

503

Service Unavailable.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

GET /api/v1/reload-tasks/{taskId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.reloadTasks.getReloadTask('string')

# qlik-cli has not implemented support for GET /api/v1/reload-tasks/{taskId} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
-H "Authorization: Bearer <access_token>"

Example 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.",
  "jobId": "5be59decca62aa00097268a5",
  "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)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-11
	Deprecated description	This endpoint is deprecated and will be removed after 2026-11. Use the `/scheduling/tasks/{id}` endpoint instead.

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Path Parameters

taskId string

Required

The unique identifier of the task.

Request Body

Required

Request body specifying the task parameters.

application/json object
Show application/json properties
- partial boolean
  
  The task is partial reload or not
  
  default = false
- timeZone string
  
  Required
  
  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.
- autoReload boolean
  
  A flag that indicates whether a reload is triggered when data of the app is changed
  
  default = false
- recurrence array 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
- endDateTime string
  
  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.
- startDateTime string
  
  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.
- autoReloadPartial boolean
  
  A flag that indicates whether it is a partial reload or not for the auto reload
  
  default = false
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
- state string
  
  Required
  
  Toggle for enabling and disabling the reload task
  
  Can be one of: "Enabled""Disabled""Completed"

Responses

200

Expected response to a valid request.

application/json object
Show application/json properties
- appId string
  
  Required
  
  The ID of the app.
- partial boolean
  
  The task is partial reload or not
  
  default = false
- timeZone string
  
  Required
  
  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.
- autoReload boolean
  
  A flag that indicates whether a reload is triggered when data of the app is changed
  
  default = false
- recurrence array 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
- endDateTime string
  
  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.
- startDateTime string
  
  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.
- autoReloadPartial boolean
  
  A flag that indicates whether it is a partial reload or not for the auto reload
  
  default = false
- id string
  
  Required
  
  The ID of the task.
- log string Deprecated
  
  The reason why the task was disabled.
- jobId string
  
  Required
  
  The ID of the scheduler job associated with the task.
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Required
  
  Show self properties
  
  href string
  
  Required
  
  href link to the resource.
  
  format = "uri"
- state string
  
  Required
  
  Toggle for enabling and disabling the reload task
  
  Can be one of: "Enabled""Disabled""Completed"
- userId string
  
  Required
  
  The ID of the user who owns the task.
- spaceId string
  
  The space ID of the application
- migrated boolean
  
  A flag indicating whether the task has been migrated to the new scheduling service.
  
  default = false
- tenantId string
  
  Required
  
  The ID of the tenant who owns the task.
- fortressId string Deprecated
  
  The fortress ID of the application
- disabledCode string
  
  The reason why the task was disabled.
  
  Can be one of: "MANUALLY""CONSECUTIVE-FAILURES""OWNER-DELETED""OWNER-DISABLED"
- lastExecutionTime string
  
  The last time the task executed.
- nextExecutionTime string
  
  The next time the task will execute.

400

Bad Request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

403

Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

410

the task cannot be updated as it has already been migrated to Enterprise-Scheduling.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

503

Service Unavailable.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

PUT /api/v1/reload-tasks/{taskId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.reloadTasks.updateReloadTask(
  'string',
  {},
)

# qlik-cli has not implemented support for PUT /api/v1/reload-tasks/{taskId} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
-X PUT \
-H "Authorization: Bearer <access_token>" \
-H "Content-type: application/json"

Example 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.",
  "jobId": "5be59decca62aa00097268a5",
  "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)
	Deprecated	This endpoint is deprecated and will eventually be removed. Read our API policy here.
	Deprecated sunset	2026-11
	Deprecated description	This endpoint is deprecated and will be removed after 2026-11. Use the `/scheduling/tasks/{id}` endpoint instead.

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Path Parameters

taskId string

Required

The unique identifier of the task.

Responses

204

Task deleted successfully.

400

Bad Request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

401

Unauthorized, JWT invalid or not provided.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

403

Forbidden, the requesting JWT does not allow for creation or retrieval of this engine session.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

404

Not Found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

410

the task cannot be updated as it has already been migrated to Enterprise-Scheduling.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  title string
  
  Required
  
  detail string
- traceId string

DELETE /api/v1/reload-tasks/{taskId}

import { createQlikApi } from '@qlik/api'

const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})

await qlik.reloadTasks.deleteReloadTask('string')

# qlik-cli has not implemented support for DELETE /api/v1/reload-tasks/{taskId} yet.

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Reload tasks

Endpoints

Find and return tasks

Facts

Header Parameters

Query Parameters

Responses

200

400

401

403

404

429

500

503

Example Response

Create a task

Facts

Header Parameters

Request Body

Responses

201

400

401

403

404

410

500

503

Example Response

Find a task

Facts

Header Parameters

Path Parameters

Responses

200

400

401

403

404

429

500

503

Example Response

Update an existing task

Facts

Header Parameters

Path Parameters

Request Body

Responses

200

400

401

403

404

410

500

503

Example Response

Delete a task

Facts

Header Parameters

Path Parameters

Responses

204

400

401

403

404

410

500