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
GET
/reloads
POST
/reloads
GET
/reloads/{reloadId}

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

experimental

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

Header Parameters

Authorization
string

JWT containing tenant credentials.

Query Parameters

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
integer

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

appId
optional
string

The case-sensitive string used to search for a reload by ID.

Responses

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

[
  {
    "id": "5be59decca62aa00097268a4",
    "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
    "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
    "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
    "type": "hub",
    "status": "SUCCEEDED",
    "log": "Connected\\nRestConnectorMasterTable <<  12 Lines fetched\\nCSV_source << RestConnectorMasterTable 12 Lines fetched\\n",
    "duration": "413ms",
    "creationTime": "2018-11-09 14:46:07.697 +0000 UTC",
    "startTime": "2018-11-09 14:47:08.698 +0000 UTC",
    "endTime": "2018-11-09 14:47:09.112 +0000 UTC",
    "engineTime": "2018-11-09 14:47:08.94 +0000 UTC"
  }
]

Reloads an app specified by an app ID.

experimental

Reloads an app specified by an app ID.

Header Parameters

Authorization
string

JWT containing tenant credentials.

Request Body

application/json

Request body specifying ID of app to be reloaded.

Responses

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

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

Request

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

Response

{
  "id": "5be59decca62aa00097268a4",
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "type": "hub",
  "status": "SUCCEEDED",
  "log": "Connected\\nRestConnectorMasterTable <<  12 Lines fetched\\nCSV_source << RestConnectorMasterTable 12 Lines fetched\\n",
  "duration": "413ms",
  "creationTime": "2018-11-09 14:46:07.697 +0000 UTC",
  "startTime": "2018-11-09 14:47:08.698 +0000 UTC",
  "endTime": "2018-11-09 14:47:09.112 +0000 UTC",
  "engineTime": "2018-11-09 14:47:08.94 +0000 UTC"
}

Finds and returns a reload

experimental

Finds and returns a reload

Header Parameters

Authorization
string

JWT containing tenant credentials.

Path Parameters

reloadId
string

The unique identifier of the reload.

Responses

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.

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

{
  "id": "5be59decca62aa00097268a4",
  "appId": "116dbfae-7fb9-4983-8e23-5ccd8c508722",
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "type": "hub",
  "status": "SUCCEEDED",
  "log": "Connected\\nRestConnectorMasterTable <<  12 Lines fetched\\nCSV_source << RestConnectorMasterTable 12 Lines fetched\\n",
  "duration": "413ms",
  "creationTime": "2018-11-09 14:46:07.697 +0000 UTC",
  "startTime": "2018-11-09 14:47:08.698 +0000 UTC",
  "endTime": "2018-11-09 14:47:09.112 +0000 UTC",
  "engineTime": "2018-11-09 14:47:08.94 +0000 UTC"
}

Reload

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.

type
string

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

status
string

The status of the reload.

log
optional
string

The log describing the result of the reload request.

duration
optional
string

The duration of the reload attempt.

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.

Reloads

Array<Reload>

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.

type
string

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

status
string

The status of the reload.

log
optional
string

The log describing the result of the reload request.

duration
optional
string

The duration of the reload attempt.

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.

ReloadRequest

Properties

appId
string

The ID of the app to be reloaded.

Error

Properties

code
integer<int32>

No description

message
string

No description

v1.3.3