Reloads

Reloads allows for triggering reloads of apps to refresh its data. Traditionally this has only been possible through the JSON-RPC WebSocket API, but can now also be done by using this REST API.

Download OpenAPI spec

Endpoints

GET

/api/v1/reloads
POST

/api/v1/reloads
GET

/api/v1/reloads/{reloadId}
POST

/api/v1/reloads/{reloadId}/actions/cancel

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

Facts

Rate limit

Tier 1 (1000 requests per minute)

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Query Parameters

appId string

Required

The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant.
filter string
SCIM filter expression used to search for reloads. The filter syntax is defined in RFC 7644 section 3.4.2.2

Supported attributes:
- status: see #schemas/Status
- partial: see #schemas/Partial
- type: see #schemas/Type
Supported operators:
- eq
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
log boolean

The boolean value used to include the log field or not, set log=true to include the log field.

default = false
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 reload is partial or not.
prev string

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

The field to sort by, with +/- prefix indicating sort order

Can be one of: "creationTime""+creationTime""-creationTime""status""+status""-status""startTime""+startTime""-startTime""endTime""+endTime""-endTime"
default = "-creationTime"

Responses

200

Expected response to a valid request.

application/json object
Show application/json properties
- data array of objects
  
  Required
  
  Show data properties
  
  id string
  
  Required
  
  The ID of the reload.
  
  log string
  
  The log describing the result of the latest reload execution from the request.
  
  type string
  
  Required
  
  What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.
  
  Can be one of: "hub""external""chronos""automations""data-refresh""choreographer"
  
  appId string
  
  Required
  
  The ID of the app.
  
  links object
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  status string
  
  Required
  
  The status of the reload. There are seven statuses. QUEUED, RELOADING, CANCELING are the active statuses. SUCCEEDED, FAILED, CANCELED, EXCEEDED_LIMIT are the end statuses.
  
  Can be one of: "QUEUED""RELOADING""CANCELING""SUCCEEDED""FAILED""CANCELED""EXCEEDED_LIMIT"
  
  userId string
  
  Required
  
  The ID of the user who created the reload.
  
  weight integer
  
  The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.
  
  minimum = 1, maximum = 10, default = 1, default = 1
  
  endTime string
  
  The time the reload job finished.
  
  partial boolean
  
  The boolean value used to present the reload is partial or not.
  
  tenantId string
  
  Required
  
  The ID of the tenant who owns the reload.
  
  errorCode string
  
  The error code when the status is FAILED.
  
  startTime string
  
  The time the reload job was consumed from the queue.
  
  engineTime string
  
  The timestamp returned from the Sense engine upon successful reload.
  
  resourceId string
  
  The String field identifying the specific resource ID within that service
  
  creationTime string
  
  Required
  
  The time the reload job was created.
  
  errorMessage string
  
  The error message when the status is FAILED.
  
  resourceType string
  
  The String field identifying the service type that triggered the reload, e.g. "api"
  
  Can be one of: "api""reload-tasks""tasks""automate"
- links object
  
  Required
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
  
  next object
  
  Show next properties
  
  href string
  
  format = "uri"
  
  prev object
  
  Show prev properties
  
  href string
  
  format = "uri"

400

Bad request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail 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
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

403

Forbidden, the requesting JWT does not allow for retrieval of this reload(error code: RELOADS-003).

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

GET /api/v1/reloads

import { createQlikApi } from '@qlik/api'

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

await qlik.reloads.getReloads({ appId: 'string' })

qlik reload ls \
  --appId 'string'

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

Example Response

{
  "data": [
    {
      "id": "5be59decca62aa00097268a4",
      "log": "ReloadID: 5be59decca62aa00097268a4\\nStarted loading\\n(A detailed script progress log can be downloaded when the reload is finished)\\nApp saved\\nFinished successfully\\n",
      "type": "chronos",
      "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
      "links": {
        "self": {
          "href": "http://example.com"
        }
      },
      "status": "FAILED",
      "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
      "weight": 1,
      "endTime": "2020-11-03T17:00:11.865Z",
      "partial": false,
      "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
      "errorCode": "EngineConnectionError",
      "startTime": "2020-11-03T17:00:06.351Z",
      "engineTime": "2020-11-03T17:00:07.048Z",
      "resourceId": "5be59decca62aa00097268a4",
      "creationTime": "2020-11-03T17:00:00.164Z",
      "errorMessage": "failed to complete reload: unexpected EOF",
      "resourceType": "api"
    }
  ],
  "links": {
    "self": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    }
  }
}

Reloads an app specified by an app ID.

Facts

Rate limit

Special (50 requests per minute)

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Request Body

Required

Request body specifying ID of app to be reloaded.

application/json object
Show application/json properties
- appId string
  
  Required
  
  The ID of the app to be reloaded.
- weight integer
  
  The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.
  
  minimum = 1, maximum = 10, default = 1, default = 1
- partial boolean
  
  The boolean value used to present the reload is partial or not
- variables object
  
  The variables to be used in the load script. Maximum of 20 variables allowed with a maximum length of 256 characters for each name/value.
  
  maxProperties = 20
  
  Show additional optional properties
  
  string string
  
  maxLength = 256
- resourceId string
  
  The String field identifying the specific resource ID within that service
- resourceType string
  
  The String field identifying the service type that triggered the reload, e.g. "api"
  
  Can be one of: "api""reload-tasks""tasks""automate"

Responses

201

Expected response to a valid request.

application/json object
Show application/json properties
- id string
  
  Required
  
  The ID of the reload.
- log string
  
  The log describing the result of the latest reload execution from the request.
- type string
  
  Required
  
  What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.
  
  Can be one of: "hub""external""chronos""automations""data-refresh""choreographer"
- appId string
  
  Required
  
  The ID of the app.
- links object
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
- status string
  
  Required
  
  The status of the reload. There are seven statuses. QUEUED, RELOADING, CANCELING are the active statuses. SUCCEEDED, FAILED, CANCELED, EXCEEDED_LIMIT are the end statuses.
  
  Can be one of: "QUEUED""RELOADING""CANCELING""SUCCEEDED""FAILED""CANCELED""EXCEEDED_LIMIT"
- userId string
  
  Required
  
  The ID of the user who created the reload.
- weight integer
  
  The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.
  
  minimum = 1, maximum = 10, default = 1, default = 1
- endTime string
  
  The time the reload job finished.
- partial boolean
  
  The boolean value used to present the reload is partial or not.
- tenantId string
  
  Required
  
  The ID of the tenant who owns the reload.
- errorCode string
  
  The error code when the status is FAILED.
- startTime string
  
  The time the reload job was consumed from the queue.
- engineTime string
  
  The timestamp returned from the Sense engine upon successful reload.
- resourceId string
  
  The String field identifying the specific resource ID within that service
- creationTime string
  
  Required
  
  The time the reload job was created.
- errorMessage string
  
  The error message when the status is FAILED.
- resourceType string
  
  The String field identifying the service type that triggered the reload, e.g. "api"
  
  Can be one of: "api""reload-tasks""tasks""automate"

400

Bad request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail 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
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

403

Forbidden, the requesting JWT does not allow for execution of this reload(error code: RELOADS-003) or the reload frequency quota has been met.(error code: RELOADS-013).

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

429

Too many requests, a pending reload request already exists for this app.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

POST /api/v1/reloads

import { createQlikApi } from '@qlik/api'

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

await qlik.reloads.queueReload({
  appId: '116dbfae-7fb9-4983-8e23-5ccd8c508722',
  resourceId: '5be59decca62aa00097268a4',
  resourceType: 'api',
  variables: { var1: 'value1', var2: 'value2' },
  weight: 1,
})

qlik reload create \
  --appId '116dbfae-7fb9-4983-8e23-5ccd8c508722'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reloads" \
-X POST \
-H "Authorization: Bearer <access_token>" \
-H "Content-type: application/json" \
-d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","weight":1,"partial":false,"variables":{"var1":"value1","var2":"value2"},"resourceId":"5be59decca62aa00097268a4","resourceType":"api"}'

Example Response

{
  "id": "5be59decca62aa00097268a4",
  "log": "ReloadID: 5be59decca62aa00097268a4\\nStarted loading\\n(A detailed script progress log can be downloaded when the reload is finished)\\nApp saved\\nFinished successfully\\n",
  "type": "chronos",
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "links": {
    "self": {
      "href": "http://example.com"
    }
  },
  "status": "FAILED",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "weight": 1,
  "endTime": "2020-11-03T17:00:11.865Z",
  "partial": false,
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "errorCode": "EngineConnectionError",
  "startTime": "2020-11-03T17:00:06.351Z",
  "engineTime": "2020-11-03T17:00:07.048Z",
  "resourceId": "5be59decca62aa00097268a4",
  "creationTime": "2020-11-03T17:00:00.164Z",
  "errorMessage": "failed to complete reload: unexpected EOF",
  "resourceType": "api"
}

Finds and returns a reload record.

Facts

Rate limit

Tier 1 (1000 requests per minute)

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Path Parameters

reloadId string

Required

The unique identifier of the reload.

Responses

200

Expected response to a valid request.

application/json object
Show application/json properties
- id string
  
  Required
  
  The ID of the reload.
- log string
  
  The log describing the result of the latest reload execution from the request.
- type string
  
  Required
  
  What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.
  
  Can be one of: "hub""external""chronos""automations""data-refresh""choreographer"
- appId string
  
  Required
  
  The ID of the app.
- links object
  
  Show links properties
  
  self object
  
  Show self properties
  
  href string
  
  format = "uri"
- status string
  
  Required
  
  The status of the reload. There are seven statuses. QUEUED, RELOADING, CANCELING are the active statuses. SUCCEEDED, FAILED, CANCELED, EXCEEDED_LIMIT are the end statuses.
  
  Can be one of: "QUEUED""RELOADING""CANCELING""SUCCEEDED""FAILED""CANCELED""EXCEEDED_LIMIT"
- userId string
  
  Required
  
  The ID of the user who created the reload.
- weight integer
  
  The weight of the reload for the same tenant. The higher the weight, the sooner the reload will be scheduled relative to other reloads for the same tenant. The personal app will be always set as 1.
  
  minimum = 1, maximum = 10, default = 1, default = 1
- endTime string
  
  The time the reload job finished.
- partial boolean
  
  The boolean value used to present the reload is partial or not.
- tenantId string
  
  Required
  
  The ID of the tenant who owns the reload.
- errorCode string
  
  The error code when the status is FAILED.
- startTime string
  
  The time the reload job was consumed from the queue.
- engineTime string
  
  The timestamp returned from the Sense engine upon successful reload.
- resourceId string
  
  The String field identifying the specific resource ID within that service
- creationTime string
  
  Required
  
  The time the reload job was created.
- errorMessage string
  
  The error message when the status is FAILED.
- resourceType string
  
  The String field identifying the service type that triggered the reload, e.g. "api"
  
  Can be one of: "api""reload-tasks""tasks""automate"

400

Bad request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail 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
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

403

Forbidden, the requesting JWT does not allow to find or get a reload(error code: RELOADS-003).

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

404

Not found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

GET /api/v1/reloads/{reloadId}

import { createQlikApi } from '@qlik/api'

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

await qlik.reloads.getReload('string')

qlik reload get 'string'

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

Example Response

{
  "id": "5be59decca62aa00097268a4",
  "log": "ReloadID: 5be59decca62aa00097268a4\\nStarted loading\\n(A detailed script progress log can be downloaded when the reload is finished)\\nApp saved\\nFinished successfully\\n",
  "type": "chronos",
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "links": {
    "self": {
      "href": "http://example.com"
    }
  },
  "status": "FAILED",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "weight": 1,
  "endTime": "2020-11-03T17:00:11.865Z",
  "partial": false,
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "errorCode": "EngineConnectionError",
  "startTime": "2020-11-03T17:00:06.351Z",
  "engineTime": "2020-11-03T17:00:07.048Z",
  "resourceId": "5be59decca62aa00097268a4",
  "creationTime": "2020-11-03T17:00:00.164Z",
  "errorMessage": "failed to complete reload: unexpected EOF",
  "resourceType": "api"
}

Cancels a reload that is in progress or has been queued

Facts

Rate limit

Special (50 requests per minute)

Header Parameters

Authorization string

Required

JWT containing tenant credentials.

Path Parameters

reloadId string

Required

The unique identifier of the reload.

Responses

202

Reload is being cancelled.

application/json object
Show application/json properties
- status string
  
  The status of the reload.
  
  Can be one of: "QUEUED""RELOADING""CANCELING""SUCCEEDED""FAILED""CANCELED""EXCEEDED_LIMIT"

204

Reload has been cancelled.

400

Bad request.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail 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
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

403

Forbidden, the requesting JWT does not allow to cancel a reload(error code: RELOADS-003).

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

404

The specified reload record could not be found.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

409

Reload is not in a cancellable state.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

500

Internal server error.

application/json object
Show application/json properties
- errors array of objects
  
  Show errors properties
  
  code string
  
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  title string
  
  Required
  
  detail string

POST /api/v1/reloads/{reloadId}/actions/cancel

import { createQlikApi } from '@qlik/api'

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

await qlik.reloads.cancelReload('string')

qlik reload cancel 'string'

curl "https://{tenant}.{region}.qlikcloud.com/api/v1/reloads/{reloadId}/actions/cancel" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "status": "RELOADING"
}

Reloads

Endpoints

Find and return reloads

Facts

Header Parameters

Query Parameters

Responses

200

400

401

403

500

Example Response

Reload an app

Facts

Header Parameters

Request Body

Responses

201

400

401

403

429

500

Example Response

Get reload record

Facts

Header Parameters

Path Parameters

Responses

200

400

401

403

404

500

Example Response

Cancel a reload

Facts

Header Parameters

Path Parameters

Responses

202

204

400

401

403

404

409

500

Example Response