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

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

Facts

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

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).

  • logboolean

    The boolean value used to include the log field or not, default is included, set log=false to exclude the log field.

  • 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

application/json

Expected response to a valid request.

  • 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.

      Can be one of: "hub""external""chronos""automations""data-refresh"

    • appIdstring
      Required

      The ID of the app.

    • linksobject
      Show links properties
      • selfobject
        Show self properties
        • hrefstring
    • 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.

    • 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
    • nextobject
      Show next properties
      • hrefstring
    • prevobject
      Show prev properties
      • hrefstring

400

application/json

Bad request.

  • errorsarray of objects

401

application/json

Unauthorized, JWT invalid or not provided.

  • errorsarray of objects

403

application/json

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

  • errorsarray of objects

500

application/json

Internal server error.

  • errorsarray of objects
GET /v1/reloads
curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads" \
-H "Authorization: Bearer <API-key>"
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 <API-key>'
    }
  }
  const req = https.request(options)
  
qlik reload ls

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",
      "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 (10 requests per minute)
Categories externalmanage

Header Parameters

  • Authorizationstring
    Required

    JWT containing tenant credentials.

Request Body

Required

application/json

Request body specifying ID of app to be reloaded.

  • appIdstring
    Required

    The ID of the app to be reloaded.

  • partialboolean

    The boolean value used to present the reload is partial or not

Responses

201

application/json

Expected response to a valid request.

  • 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.

    Can be one of: "hub""external""chronos""automations""data-refresh"

  • appIdstring
    Required

    The ID of the app.

  • linksobject
    Show links properties
    • selfobject
      Show self properties
      • hrefstring
  • 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.

  • 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

application/json

Bad request.

  • errorsarray of objects

401

application/json

Unauthorized, JWT invalid or not provided.

  • errorsarray of objects

403

application/json

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).

  • errorsarray of objects

429

application/json

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

  • errorsarray of objects

500

application/json

Internal server error.

  • errorsarray of objects
POST /v1/reloads
curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":false}'
const https = require('https')
  const data = JSON.stringify({"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":false})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/reloads',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)
  
qlik reload create \
--appId="116dbfae-7fb9-4983-8e23-5ccd8c508722"

Request

{
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "partial": false
}

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",
  "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"
}

Get reload record

Finds and returns a reload record

Facts

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

Header Parameters

  • Authorizationstring
    Required

    JWT containing tenant credentials.

Path Parameters

  • reloadIdstring
    Required

    The unique identifier of the reload.

Responses

200

application/json

Expected response to a valid request.

  • 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.

    Can be one of: "hub""external""chronos""automations""data-refresh"

  • appIdstring
    Required

    The ID of the app.

  • linksobject
    Show links properties
    • selfobject
      Show self properties
      • hrefstring
  • 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.

  • 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

application/json

Bad request.

  • errorsarray of objects

401

application/json

Unauthorized, JWT invalid or not provided.

  • errorsarray of objects

403

application/json

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

  • errorsarray of objects

404

application/json

Not found.

  • errorsarray of objects

500

application/json

Internal server error.

  • errorsarray of objects
GET /v1/reloads/{reloadId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads/{reloadId}" \
-H "Authorization: Bearer <API-key>"
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 <API-key>'
    }
  }
  const req = https.request(options)
  
qlik reload get <reloadId>

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",
  "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

Cancels a reload that is in progress or has been queued

Facts

Rate limit Special (10 requests per minute)
Categories externalmanage

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

application/json

Bad request.

  • errorsarray of objects

401

application/json

Unauthorized, JWT invalid or not provided.

  • errorsarray of objects

403

application/json

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

  • errorsarray of objects

404

application/json

The specified reload record could not be found.

  • errorsarray of objects

409

application/json

Reload is not in a cancellable state.

  • errorsarray of objects

500

application/json

Internal server error.

  • errorsarray of objects
POST /v1/reloads/{reloadId}/actions/cancel
curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads/{reloadId}/actions/cancel" \
-X POST \
-H "Authorization: Bearer <API-key>"
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 <API-key>'
    }
  }
  const req = https.request(options)
  
qlik reload cancel <reloadId>