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 specification

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)
Categories	manage

Header Parameters

Authorizationstring
Required

JWT containing tenant credentials.

Query Parameters

appIdstring
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.
filterstring
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
limitinteger

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
logboolean

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

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

Expected response to a valid request.

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  Required
  
  The ID of the reload.
  
  logstring
  
  The log describing the result of the latest reload execution from the request.
  
  typestring
  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"
  
  appIdstring
  Required
  
  The ID of the app.
  
  linksobject
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
  
  statusstring
  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"
  
  userIdstring
  Required
  
  The ID of the user who created the reload.
  
  weightinteger
  
  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
  
  endTimestring
  
  The time the reload job finished.
  
  partialboolean
  
  The boolean value used to present the reload is partial or not.
  
  tenantIdstring
  Required
  
  The ID of the tenant who owns the reload.
  
  errorCodestring
  
  The error code when the status is FAILED.
  
  startTimestring
  
  The time the reload job was consumed from the queue.
  
  engineTimestring
  
  The timestamp returned from the Sense engine upon successful reload.
  
  creationTimestring
  Required
  
  The time the reload job was created.
  
  errorMessagestring
  
  The error message when the status is FAILED.
- linksobject
  Required
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  format = "uri"
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  format = "uri"

400

Bad request.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

401

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

403

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

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

500

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

GET /api/v1/reloads

curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads" \
-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/reloads',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

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",
      "creationTime": "2020-11-03T17:00:00.164Z",
      "errorMessage": "failed to complete reload: unexpected EOF"
    }
  ],
  "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)
Categories	manage

Header Parameters

Authorizationstring
Required

JWT containing tenant credentials.

Request Body

Required

Request body specifying ID of app to be reloaded.

application/jsonobject
Show application/json properties
- appIdstring
  Required
  
  The ID of the app to be reloaded.
- weightinteger
  
  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
- partialboolean
  
  The boolean value used to present the reload is partial or not
- variablesobject
  
  The variables to be used in the load script.
  
  additional properties

Responses

201

Expected response to a valid request.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The ID of the reload.
- logstring
  
  The log describing the result of the latest reload execution from the request.
- typestring
  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"
- appIdstring
  Required
  
  The ID of the app.
- linksobject
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
- statusstring
  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"
- userIdstring
  Required
  
  The ID of the user who created the reload.
- weightinteger
  
  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
- endTimestring
  
  The time the reload job finished.
- partialboolean
  
  The boolean value used to present the reload is partial or not.
- tenantIdstring
  Required
  
  The ID of the tenant who owns the reload.
- errorCodestring
  
  The error code when the status is FAILED.
- startTimestring
  
  The time the reload job was consumed from the queue.
- engineTimestring
  
  The timestamp returned from the Sense engine upon successful reload.
- creationTimestring
  Required
  
  The time the reload job was created.
- errorMessagestring
  
  The error message when the status is FAILED.

400

Bad request.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

401

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

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/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

429

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

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

500

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

POST /api/v1/reloads

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

const https = require('https')
  const data = JSON.stringify({"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","weight":1,"partial":false,"variables":{"var1":"value1","var2":"value2"}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/reloads',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>',
      'Content-type': 'application/json'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "weight": 1,
  "partial": false,
  "variables": {
    "var1": "value1",
    "var2": "value2"
  }
}

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",
  "creationTime": "2020-11-03T17:00:00.164Z",
  "errorMessage": "failed to complete reload: unexpected EOF"
}

Finds and returns a reload record.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Header Parameters

Authorizationstring
Required

JWT containing tenant credentials.

Path Parameters

reloadIdstring
Required

The unique identifier of the reload.

Responses

200

Expected response to a valid request.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  The ID of the reload.
- logstring
  
  The log describing the result of the latest reload execution from the request.
- typestring
  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"
- appIdstring
  Required
  
  The ID of the app.
- linksobject
  
  Show links properties
  
  selfobject
  
  Show self properties
  
  hrefstring
  
  format = "uri"
- statusstring
  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"
- userIdstring
  Required
  
  The ID of the user who created the reload.
- weightinteger
  
  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
- endTimestring
  
  The time the reload job finished.
- partialboolean
  
  The boolean value used to present the reload is partial or not.
- tenantIdstring
  Required
  
  The ID of the tenant who owns the reload.
- errorCodestring
  
  The error code when the status is FAILED.
- startTimestring
  
  The time the reload job was consumed from the queue.
- engineTimestring
  
  The timestamp returned from the Sense engine upon successful reload.
- creationTimestring
  Required
  
  The time the reload job was created.
- errorMessagestring
  
  The error message when the status is FAILED.

400

Bad request.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

401

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

403

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

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

404

Not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

500

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

GET /api/v1/reloads/{reloadId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads/{reloadId}" \
-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/reloads/{reloadId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

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",
  "creationTime": "2020-11-03T17:00:00.164Z",
  "errorMessage": "failed to complete reload: unexpected EOF"
}

Cancels a reload that is in progress or has been queued

Facts

Rate limit	Special (50 requests per minute)
Categories	manage

Header Parameters

Authorizationstring
Required

JWT containing tenant credentials.

Path Parameters

reloadIdstring
Required

The unique identifier of the reload.

Responses

202

Reload is being cancelled.

204

Reload has been cancelled.

400

Bad request.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

401

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

403

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

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

404

The specified reload record could not be found.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

409

Reload is not in a cancellable state.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

500

Internal server error.

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  Required
  
  The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.
  
  titlestring
  Required
  
  detailstring

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

curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads/{reloadId}/actions/cancel" \
-X POST \
-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/reloads/{reloadId}/actions/cancel',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Reloads

Endpoints

Find and return reloads

Facts

Header Parameters

Query Parameters

Responses

200

400

401

403

500

Response

Reload an app

Facts

Header Parameters

Request Body

Responses

201

400

401

403

429

500

Request

Response

Get reload record

Facts

Header Parameters

Path Parameters

Responses

200

400

401

403

404

500

Response

Cancel a reload

Facts

Header Parameters

Path Parameters

Responses

202

204

400

401

403

404

409

500