Skip to content

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.

Endpoints

Skip to section
GET/reloads
POST/reloads
GET/reloads/{reloadId}

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

Header Parameters GET /reloads

Authorization
string

JWT containing tenant credentials.

Query Parameters GET /reloads

next
optional
string

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

prev
optional
string

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

limit
optional, 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).

appId
string

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.

partial
optional
boolean

The boolean value used to search for a reload is partial or not.

Responses GET /reloads

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

500
application/json

Internal server error.

GET/reloads

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

Response GET /reloads

{
  "data": [
    {
      "id": "5be59decca62aa00097268a4",
      "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
      "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
      "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
      "partial": true,
      "type": "hub",
      "status": "CREATED",
      "log": "Connected\\nRestConnectorMasterTable <<  12 Lines fetched\\nCSV_source << RestConnectorMasterTable 12 Lines fetched\\n",
      "creationTime": "2020-11-03T17:00:00.164Z",
      "startTime": "2020-11-03T17:00:06.351Z",
      "endTime": "2020-11-03T17:00:11.865Z",
      "engineTime": "2020-11-03T17:00:07.048Z",
      "links": {
        "self": {
          "href": "http://example.com"
        }
      }
    }
  ],
  "links": {
    "self": {
      "href": "http://example.com"
    }
  }
}

Reloads an app specified by an app ID.

Header Parameters POST /reloads

Authorization
string

JWT containing tenant credentials.

Request Body POST /reloads

application/json

Request body specifying ID of app to be reloaded.

Responses POST /reloads

201
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 execution of this reload.

429
application/json

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

500
application/json

Internal server error.

POST/reloads

curl "https://your-tenant.us.qlikcloud.com/api/v1/reloads" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"appId":"116dbfae-7fb9-4983-8e23-5ccd8c508722","partial":true}'

Request POST /reloads

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

Response POST /reloads

{
  "id": "5be59decca62aa00097268a4",
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "partial": true,
  "type": "hub",
  "status": "CREATED",
  "log": "Connected\\nRestConnectorMasterTable <<  12 Lines fetched\\nCSV_source << RestConnectorMasterTable 12 Lines fetched\\n",
  "creationTime": "2020-11-03T17:00:00.164Z",
  "startTime": "2020-11-03T17:00:06.351Z",
  "endTime": "2020-11-03T17:00:11.865Z",
  "engineTime": "2020-11-03T17:00:07.048Z",
  "links": {
    "self": {
      "href": "http://example.com"
    }
  }
}

Get reload record

Finds and returns a reload record

Header Parameters GET /reloads/{reloadId}

Authorization
string

JWT containing tenant credentials.

Path Parameters GET /reloads/{reloadId}

reloadId
string

The unique identifier of the reload.

Responses GET /reloads/{reloadId}

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 creation or retrieval of this engine session.

404
application/json

Not found.

500
application/json

Internal server error.

GET/reloads/{reloadId}

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

Response GET /reloads/{reloadId}

{
  "id": "5be59decca62aa00097268a4",
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "partial": true,
  "type": "hub",
  "status": "CREATED",
  "log": "Connected\\nRestConnectorMasterTable <<  12 Lines fetched\\nCSV_source << RestConnectorMasterTable 12 Lines fetched\\n",
  "creationTime": "2020-11-03T17:00:00.164Z",
  "startTime": "2020-11-03T17:00:06.351Z",
  "endTime": "2020-11-03T17:00:11.865Z",
  "engineTime": "2020-11-03T17:00:07.048Z",
  "links": {
    "self": {
      "href": "http://example.com"
    }
  }
}

Reload

object

Properties

id
string

The ID of the reload.

appId
string

The ID of the app.

tenantId
string

The ID of the tenant who owns the reload.

userId
string

The ID of the user who created the reload.

partial
optional
boolean

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

type
string

The type of reload event (hub, chronos or external).

status
string

The status of the reload (CREATED, QUEUED, RELOADING, FAILED, SUCCEEDED).

log
optional
string

The log describing the result of the reload request.

creationTime
string

The time the reload job was created.

startTime
optional
string

The time the reload job was consumed from the queue.

endTime
optional
string

The time the reload job finished.

engineTime
optional
string

The timestamp returned from the Sense engine upon successful reload.

links
optional

No description

Reloads

object

Properties

data

No description

links

No description

Properties

self

No description

object

Properties

self

No description

Href

object

Properties

href
string<uri>

No description

ReloadRequest

Properties

appId
string

The ID of the app to be reloaded.

partial
optional
boolean

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

ScheduledReloadRequest

Properties

taskId
string

The ID of the task whose app is to be reloaded.

Errors

object

Properties

errors

No description

Error

object

Properties

code
string

No description

title
string

No description

detail
optional
string

No description

v3.0.0
Was this page helpful?