Skip to content

Reload tasks

reload-tasks allows for publishing a reload schedule job request to the job queue, and for handling CRUD operations of scheduled reload tasks.

Endpoints

Skip to section
GET/v1/reload-tasks
POST/v1/reload-tasks
GET/v1/reload-tasks/{taskId}
PUT/v1/reload-tasks/{taskId}
DELETE/v1/reload-tasks/{taskId}

Find and return the tasks that the user can access.

manage

Facts GET /v1/reload-tasks

Rate limit
required
Tier 1 (1000 requests per minute)

Header Parameters GET /v1/reload-tasks

Authorization
required
string

JWT containing tenant credentials.

Query Parameters GET /v1/reload-tasks

appId
string

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

limit
default=10, minimum=1, maximum=100
integer<int32>

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

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 GET /v1/reload-tasks

200
application/json

Expected response to a valid request.

400
application/json

Bad Request.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

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

404
application/json

Not Found.

500
application/json

Internal server error.

503
application/json

Service Unavailable.

GET/v1/reload-tasks

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/reload-tasks

{
  "data": [
    {
      "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
      "partial": true,
      "timeZone": "America/Toronto",
      "autoReload": true,
      "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": true,
      "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",
      "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
      "fortressId": "5c5b097116d25a0001a48b06",
      "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"
    }
  }
}

Create a task for a specified app.

manage

Facts POST /v1/reload-tasks

Rate limit
required
Tier 2 (100 requests per minute)

Header Parameters POST /v1/reload-tasks

Authorization
required
string

JWT containing tenant credentials.

Request Body POST /v1/reload-tasks

application/json

Request body specifying the task parameters.

Responses POST /v1/reload-tasks

201
application/json
Task

Expected response to a valid request.

400
application/json

Bad Request.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

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

404
application/json

Not Found.

500
application/json

Internal server error.

503
application/json

Service Unavailable.

POST/v1/reload-tasks

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":true,"timeZone":"America/Toronto","autoReload":true,"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":true,"type":"scheduled_reload"}'

Request POST /v1/reload-tasks

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "partial": true,
  "timeZone": "America/Toronto",
  "autoReload": true,
  "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": true,
  "type": "scheduled_reload"
}

Response POST /v1/reload-tasks

{
  "undefined": {
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "partial": true,
    "timeZone": "America/Toronto",
    "autoReload": true,
    "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": true,
    "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",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "fortressId": "5c5b097116d25a0001a48b06",
    "lastExecutionTime": "2022-09-20T17:17:00Z",
    "nextExecutionTime": "2022-09-20T17:17:00Z"
  }
}

Find and return a task.

manage

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

Rate limit
required
Tier 1 (1000 requests per minute)

Header Parameters GET /v1/reload-tasks/{taskId}

Authorization
required
string

JWT containing tenant credentials.

Path Parameters GET /v1/reload-tasks/{taskId}

taskId
required
string

The unique identifier of the task.

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

200
application/json
Task

Expected response to a valid request.

400
application/json

Bad Request.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

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

404
application/json

Not Found.

500
application/json

Internal server error.

503
application/json

Service Unavailable.

GET/v1/reload-tasks/{taskId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
 -H "Authorization: Bearer <API-key>"

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

{
  "undefined": {
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "partial": true,
    "timeZone": "America/Toronto",
    "autoReload": true,
    "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": true,
    "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",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "fortressId": "5c5b097116d25a0001a48b06",
    "lastExecutionTime": "2022-09-20T17:17:00Z",
    "nextExecutionTime": "2022-09-20T17:17:00Z"
  }
}

Update an existing task.

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Header Parameters PUT /v1/reload-tasks/{taskId}

Authorization
required
string

JWT containing tenant credentials.

Path Parameters PUT /v1/reload-tasks/{taskId}

taskId
required
string

The unique identifier of the task.

Request Body PUT /v1/reload-tasks/{taskId}

application/json

Request body specifying the task parameters.

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

200
application/json
Task

Expected response to a valid request.

400
application/json

Bad Request.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

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

404
application/json

Not Found.

500
application/json

Internal server error.

503
application/json

Service Unavailable.

PUT/v1/reload-tasks/{taskId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/reload-tasks/{taskId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":true,"timeZone":"America/Toronto","autoReload":true,"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":true,"state":"Disabled"}'

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

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "partial": true,
  "timeZone": "America/Toronto",
  "autoReload": true,
  "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": true,
  "state": "Disabled"
}

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

{
  "undefined": {
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "partial": true,
    "timeZone": "America/Toronto",
    "autoReload": true,
    "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": true,
    "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",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "fortressId": "5c5b097116d25a0001a48b06",
    "lastExecutionTime": "2022-09-20T17:17:00Z",
    "nextExecutionTime": "2022-09-20T17:17:00Z"
  }
}

Delete a task.

manage

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

Rate limit
required
Tier 2 (100 requests per minute)

Header Parameters DELETE /v1/reload-tasks/{taskId}

Authorization
required
string

JWT containing tenant credentials.

Path Parameters DELETE /v1/reload-tasks/{taskId}

taskId
required
string

The unique identifier of the task.

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

204
object

Task deleted successfully.

400
application/json

Bad Request.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

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

404
application/json

Not Found.

500
application/json

Internal server error.

DELETE/v1/reload-tasks/{taskId}

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

Error

object

Properties

code
required
string

No description

title
required
string

No description

detail
string

No description

Errors

object

Properties

errors

No description

traceId
string

No description

Href

object

Properties

href
required
string<uri>

No description

Properties

self

No description

next

No description

prev

No description

PostTaskBody

Properties

appId
string

The ID of the app.

partial
default=false
boolean

The task is partial reload or not

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.

autoReload
default=false
boolean

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

recurrence
Array<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

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
default=false
boolean

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

type
deprecated
string

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.

Enum:

scheduled_reload

PutTaskBody

Properties

appId
string

The ID of the app.

partial
default=false
boolean

The task is partial reload or not

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.

autoReload
default=false
boolean

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

recurrence
Array<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

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
default=false
boolean

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

state
string

Toggle for enabling and disabling the reload task

Enum:

Enabled

Disabled

Completed

object

Properties

self
required

No description

Task

Properties

appId
string

The ID of the app.

partial
default=false
boolean

The task is partial reload or not

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.

autoReload
default=false
boolean

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

recurrence
Array<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

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
default=false
boolean

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

id
string

The ID of the task.

log
string

The reason why the task was disabled.

links

No description

state
string

Toggle for enabling and disabling the reload task

Enum:

Enabled

Disabled

Completed

userId
string

The ID of the user who owns the task.

spaceId
string

The space ID of the application

tenantId
string

The ID of the tenant who owns the task.

fortressId
string

The fortress ID of the application

lastExecutionTime
string

The last time the task executed.

nextExecutionTime
string

The next time the task will execute.

TaskBase

object

Properties

appId
string

The ID of the app.

partial
default=false
boolean

The task is partial reload or not

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.

autoReload
default=false
boolean

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

recurrence
Array<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

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
default=false
boolean

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

Tasks

object

Properties

data
required

No description

links

No description

v0.690.0
Was this page helpful?