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

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

manage

Facts GET /v1/reloads

Rate limit
required
Tier 1 (1000 requests per minute)

Header Parameters GET /v1/reloads

Authorization
required
string

JWT containing tenant credentials.

Query Parameters GET /v1/reloads

appId
required
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.

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

log
default=true
boolean

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

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.

Responses GET /v1/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(error code: RELOADS-003).

500
application/json

Internal server error.

GET/v1/reloads

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

Response GET /v1/reloads

{
  "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": "SUCCEEDED",
      "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
      "endTime": "2020-11-03T17:00:11.865Z",
      "partial": true,
      "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
      "startTime": "2020-11-03T17:00:06.351Z",
      "engineTime": "2020-11-03T17:00:07.048Z",
      "creationTime": "2020-11-03T17:00:00.164Z"
    }
  ],
  "links": {
    "self": {
      "href": "http://example.com"
    },
    "next": {
      "href": "http://example.com"
    },
    "prev": {
      "href": "http://example.com"
    }
  }
}

Reloads an app specified by an app ID.

manage

Facts POST /v1/reloads

Rate limit
required
Special (10 requests per minute)

Header Parameters POST /v1/reloads

Authorization
required
string

JWT containing tenant credentials.

Request Body POST /v1/reloads

application/json

Request body specifying ID of app to be reloaded.

Responses POST /v1/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(error code: RELOADS-003) or the reload frequency quota has been met.(error code: RELOADS-013).

429
application/json

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

500
application/json

Internal server error.

POST/v1/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 /v1/reloads

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

Response POST /v1/reloads

{
  "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": "SUCCEEDED",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "endTime": "2020-11-03T17:00:11.865Z",
  "partial": true,
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "startTime": "2020-11-03T17:00:06.351Z",
  "engineTime": "2020-11-03T17:00:07.048Z",
  "creationTime": "2020-11-03T17:00:00.164Z"
}

Get reload record

manage

Finds and returns a reload record

Facts GET /v1/reloads/{reloadId}

Rate limit
required
Tier 1 (1000 requests per minute)

Header Parameters GET /v1/reloads/{reloadId}

Authorization
required
string

JWT containing tenant credentials.

Path Parameters GET /v1/reloads/{reloadId}

reloadId
required
string

The unique identifier of the reload.

Responses GET /v1/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 to find or get a reload(error code: RELOADS-003).

404
application/json

Not found.

500
application/json

Internal server error.

GET/v1/reloads/{reloadId}

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

Response GET /v1/reloads/{reloadId}

{
  "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": "SUCCEEDED",
  "userId": "FyPG6xWp6prDU6BXQ3g7LY9gWR_YRkkx",
  "endTime": "2020-11-03T17:00:11.865Z",
  "partial": true,
  "tenantId": "efSCcpNYuayTysONkUcE3F80zYQ_LV9w",
  "startTime": "2020-11-03T17:00:06.351Z",
  "engineTime": "2020-11-03T17:00:07.048Z",
  "creationTime": "2020-11-03T17:00:00.164Z"
}

Cancels a reload

manage

Cancels a reload that is in progress or has been queued

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

Rate limit
required
Special (10 requests per minute)

Header Parameters POST /v1/reloads/{reloadId}/actions/cancel

Authorization
required
string

JWT containing tenant credentials.

Path Parameters POST /v1/reloads/{reloadId}/actions/cancel

reloadId
required
string

The unique identifier of the reload.

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

202
object

Reload is being cancelled.

204
object

Reload has been cancelled.

400
application/json

Bad request.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

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

404
application/json

The specified reload record could not be found.

409
application/json

Reload is not in a cancellable state.

500
application/json

Internal server error.

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

Error

object

Properties

code
required
string

The error code is in form of 'RELOADS-xxx'. ranges from 'RELOADS-001' to 'RELOADS-013'.

title
required
string

No description

detail
string

No description

Errors

object

Properties

errors

No description

Href

object

Properties

href
string<uri>

No description

Partial

boolean

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

Reload

object

Properties

id
required
string

The ID of the reload.

log
string

The log describing the result of the latest reload execution from the request.

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

Enum:

hub

external

chronos

automations

data-refresh

appId
required
string

The ID of the app.

links

No description

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

Enum:

QUEUED

RELOADING

CANCELING

SUCCEEDED

FAILED

CANCELED

EXCEEDED_LIMIT

userId
required
string

The ID of the user who created the reload.

endTime
string

The time the reload job finished.

partial

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

tenantId
required
string

The ID of the tenant who owns the reload.

startTime
string

The time the reload job was consumed from the queue.

engineTime
string

The timestamp returned from the Sense engine upon successful reload.

creationTime
required
string

The time the reload job was created.

object

Properties

self

No description

ReloadRequest

Properties

appId
required
string

The ID of the app to be reloaded.

partial
boolean

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

Reloads

object

Properties

data
required

No description

links
required

No description

Properties

self

No description

next

No description

prev

No description

Status

string

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.

Enum:

QUEUED

RELOADING

CANCELING

SUCCEEDED

FAILED

CANCELED

EXCEEDED_LIMIT

Type

string

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.

Enum:

hub

external

chronos

automations

data-refresh

v0.879.8
Was this page helpful?