Reloads

Download AsyncAPI spec

Reload Finished Event

The reload finished event will be published when a reload has finished. While a reload might be executed multiple times, there will be only one reload finished event.

Payload

object
  • idstring

    Unique identifier for the event.

  • hoststring

    The host of the event.

  • timestring

    Timestamp of when the event happened.

    format = "date-time"

  • typestring

    Unique identifier for the event type.

    default = "com.qlik.v1.reload.finished"

  • sourcestring

    The source of the event.

    default = "com.qlik/reloads"

  • owneridstring

    The owner ID of the event.

  • originipstring

    The origin IP of the event.

  • specversionstring

    The event is compatible with the CloudEvents specification v1.0.

    Can be one of: "1.0"

    default = "1.0"

  • datacontenttypestring

    The content type of the event payload.

    default = "application/json"

  • reasonstring

    reason for why the event is triggered.

  • useridstring

    Unique identifier for the user related to the event.

  • spaceidstring

    Unique identifier for the space related to the event.

  • authtypestring

    Representing the type of principal that triggered the occurrence.

  • clientidstring

    Unique identifier for the client related to the event.

  • tenantidstring
    Required

    Unique identifier for the tenant related to the event.

  • sessionidstring

    The session ID of the event.

  • authclaimsstring

    A JSON string representing claims of the principal that triggered the event

  • tracestatestring

    A comma-delimited list of key-value pairs.

  • traceparentstring

    Contains a version, trace ID, span ID, and trace options.

  • toplevelresourceidstring

    Unique identifier for top level resource related to the event.

  • dataobject

    Data specific to the reload finished event.

    Show data properties
    • idstring
      Required

      Reload ID.

    • typestring

      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""chronos""external""automations""data-refresh""choreographer"

    • appIdstring
      Required

      ID of the reloaded app.

    • statusstring

      The end status of reload.

      Can be one of: "SUCCEEDED""FAILED""CANCELED""EXCEEDED_LIMIT"

    • taskIdstring

      ID of the app's scheduled reload task.

    • userIdstring
      Required

      ID of the requesting user.

    • weightinteger

      The weight of the reload. 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 partial status of reload.

    • appUsagestring

      The app's usage type

    • tenantIdstring

      ID of the tenant.

    • errorCodestring

      Error code, if failed.

    • startTimestring

      reload starting time from engine.

    • succeededboolean
      Required

      Success status of reload.

    • creationTimestring

      reload creation time.

    • errorMessagestring

      Error message, if failed.

    • lastReloadTimestring

      Last reload time from engine, if succeeded.

    • durationSecondsnumber

      Duration from engine session acquisition to reload attempt completion (seconds).

    • crashedOnMaxSizeEngineboolean

      Whether the session request failed due to the app previously crashing on a max size engine

com.qlik.v1.reload.finished

Example payload of the "Reload Finished Event" event

{
  "id": "id123",
  "host": "qlik.example.com",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.reload.finished",
  "source": "com.qlik/reloads",
  "ownerid": "id123",
  "originip": "192.168.1.1",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "reason": "User initiated reload",
  "userid": "id123",
  "spaceid": "id123",
  "authtype": "token",
  "clientid": "id123",
  "tenantid": "id123",
  "sessionid": "id123",
  "authclaims": "{\"sub\":\"id123\",\"name\":\"John Doe\",\"email\":\"john.doe@example.com\"}",
  "tracestate": "key1=value1,key2=value2",
  "traceparent": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01",
  "toplevelresourceid": "id123",
  "data": {
    "id": "id123",
    "appId": "app1",
    "userId": "user1",
    "succeeded": true
  }
}