Data sets

Download AsyncAPI spec

Data set load finished

Published when a data set load operation finishes, whether it succeeded or failed.

Payload

object
  • id string
    Required

    Identifies the event.

    minLength = 1

  • time string

    Timestamp of when the occurrence happened. Must adhere to RFC 3339.

    minLength = 1, format = "date-time"

  • type string
    Required

    Data set load operation finished.

    default = "com.qlik.v1.data-set.data.load.finished"

  • source string
    Required

    Identifies the context in which an event happened.

    minLength = 1, format = "uri-reference"

  • specversion string
    Required

    The version of the CloudEvents specification which the event uses.

    minLength = 1

  • datacontenttype string

    Content type of the data value. Must adhere to RFC 2046 format.

    minLength = 1, default = "application/json"

  • userid string

    Unique identifier for the user related to the event.

  • updates array of objects

    Updates of qemServer object

    Show updates properties
    • path string

      updated item path

    • newvalue string

      new value at given path

    • oldvalue string

      original value at given path
  • authtype string

    Representing the type of principal that triggered the occurrence.

  • tenantid string
    Required

    Unique identifier for the tenant related to the event.

  • authclaims string

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

  • tracestate string

    A comma-delimited list of key-value pairs.

  • traceparent string

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

  • toplevelresourceid string

    Unique identifier referring to integration application related to the event.

  • data object
    Show data properties
    • appId string

      Unique identifier for the app related to the event.

      format = "uid"

    • dataSetId string

      Unique identifier for the data set related to the event.

    • firstLoad boolean

      Indicates whether the load reported is the first time the data set is loaded (can be used by backend systems to aggregate/bill differently based on first time indication).

    • consumption object
      Show consumption properties
      • totalBytes number

        Harmonized total bytes property, same value as totalBytesLoaded.

      • totalBytesLoaded number

        Total bytes loaded in a specific load operation.
    • dataAssetId string

      Unique identifier for the data asset related to the event.

    • loadEndedAt string

      Timestamp of when the data set load ended. Must adhere to RFC 3339.

      format = "date-time"

    • loadSuccess boolean

      Indicates whether the load was successful (can be used by backend systems to aggregate/bill differently based on success criteria).

    • errorMessage string

      Error message describing why the load failed (only populated when loadSuccess is false)

    • dataAssetType string

      Type of the data asset the load belongs to (e.g. LANDING, STORAGE).

    • loadStartedAt string

      Timestamp of when the data set load started. Must adhere to RFC 3339.

      format = "date-time"

    • notChargeable boolean

      When this field is set to true the event should be discarded from consumption metrics.

    • recordsLoaded integer

      Number of records loaded into the data set (only applicable on finished event).

    • dataSetSecureQRI string

      Secure QRI (Qlik resource identifier) of the data set related to the event. It identifies the data set's underlying resource without exposing connection details.

    • notChargeableReason string

      Description for why the event is set to notChargeable.

com.qlik.v1.data-set.data.load.finished

Example payload of the "Data set load finished" event

{
  "id": "A234-1234-1234",
  "time": "2018-10-30T07:06:22Z",
  "type": "com.qlik.v1.data-set.data.load.finished",
  "source": "com.qlik/my-service",
  "specversion": "1.0",
  "datacontenttype": "application/json",
  "userid": "id123",
  "updates": [
    {}
  ],
  "authtype": "string",
  "tenantid": "id123",
  "authclaims": "string",
  "tracestate": "string",
  "traceparent": "string",
  "toplevelresourceid": "id123",
  "data": {
    "appId": "id123",
    "dataSetId": "id123",
    "firstLoad": true,
    "consumption": {
      "totalBytes": 20000,
      "totalBytesLoaded": 20000
    },
    "dataAssetId": "id123",
    "loadEndedAt": "2018-10-30T07:06:22Z",
    "loadSuccess": true,
    "errorMessage": "Failed to connect to source",
    "dataAssetType": "LANDING",
    "loadStartedAt": "2018-10-30T07:06:22Z",
    "notChargeable": false,
    "recordsLoaded": 20,
    "dataSetSecureQRI": "qri:db:snowflake://Bh__CEOO2-D2Ty2f5egzjobOWnrxe6Cl8hHjJ6G08KE#w7OWgEHpy-iUi4EVNEGGQ6bJwU3FT6RdX38hbbrpJlM",
    "notChargeableReason": "Transform to QCS"
  }
}