Apps

Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.

An app was created

Payload

object

cloudEventsVersionstring

The event is compatible with the CloudEvents specification v0.1.

Can be one of: "0.1"
sourcestring

The source of the event.

default = "com.qlik/engine"
contentTypestring

The content type of the event payload.

default = "application/json"
eventIdstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
eventTypeVersionstring

Version of the event
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.app.created"
extensionsobject
Show extensions properties
- ownerIdstring
  
  Id of the owner of the affected resource.
- spaceIdstring
  
  Id of the space related to the action performed on the eventContext.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
- userIdstring
  Required
  
  Unique identifer for the user related to the event.
dataobject

Application attributes and user privileges.
Show data properties
- attributesobject
  
  App attributes. This structure can also contain extra user-defined attributes.
  
  Show attributes properties
  
  idstring
  
  The App ID.
  
  namestring
  
  App name.
  
  descriptionstring
  
  App description.
  
  lastReloadTimestring
  
  Date and time of the last reload of the app.
  
  format = "date-time"
  
  createdDatestring
  
  The date and time when the app was created.
  
  format = "date-time"
  
  modifiedDatestring
  
  The date and time when the app was modified.
  
  format = "date-time"
  
  ownerstring
  
  The owner of the app.
  
  ownerIdstring
  
  Id of the owner
  
  dynamicColorstring
  
  The dynamic color of the app.
  
  publishedboolean
  
  True if the app is published, false if not.
  
  publishTimestring
  
  The date and time when the app was published, empty if unpublished.
  
  format = "date-time"
  
  hasSectionAccessboolean
  
  If set to true, the app has section access configured,
  
  originAppIdstring
  
  The Origin App ID for published apps.

com.qlik.v1.app.created

Example payload of the "App created" event

{
  "cloudEventsVersion": "0.1",
  "source": "com.qlik/engine",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventTypeVersion": "1.0.0",
  "eventType": "com.qlik.v1.app.created",
  "extensions": {
    "ownerId": "id123",
    "spaceId": "id123",
    "tenantId": "id123",
    "userId": "id123"
  },
  "data": {
    "attributes": {
      "id": "id123",
      "name": "My app",
      "description": "My app with data",
      "lastReloadTime": "2018-10-30T07:06:22.123Z",
      "createdDate": "2018-10-30T07:06:22.123Z",
      "modifiedDate": "2018-10-30T07:06:22.123Z",
      "owner": "Owner",
      "ownerId": "id123",
      "dynamicColor": "Color",
      "published": "true",
      "publishTime": "2018-10-30T07:06:22.123Z",
      "hasSectionAccess": "false",
      "originAppId": "id123"
    }
  }
}

An app was deleted

Payload

object

cloudEventsVersionstring

The event is compatible with the CloudEvents specification v0.1.

Can be one of: "0.1"
sourcestring

The source of the event.

default = "com.qlik/engine"
contentTypestring

The content type of the event payload.

default = "application/json"
eventIdstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
eventTypeVersionstring

Version of the event
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.app.deleted"
extensionsobject
Show extensions properties
- spaceIdstring
  
  Id of the space related to the action performed on the eventContext.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
- userIdstring
  Required
  
  Unique identifer for the user related to the event.
dataobject

Application attributes and user privileges.
Show data properties
- attributesobject
  
  App attributes. This structure can also contain extra user-defined attributes.
  
  Show attributes properties
  
  idstring
  
  The App ID.
  
  namestring
  
  App name.

com.qlik.v1.app.deleted

Example payload of the "App deleted" event

{
  "cloudEventsVersion": "0.1",
  "source": "com.qlik/engine",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventTypeVersion": "1.0.0",
  "eventType": "com.qlik.v1.app.deleted",
  "extensions": {
    "spaceId": "id123",
    "tenantId": "id123",
    "userId": "id123"
  },
  "data": {
    "attributes": {
      "id": "id123",
      "name": "My app"
    }
  }
}

An apps data was updated

Payload

object

cloudEventsVersionstring

The event is compatible with the CloudEvents specification v0.1.

Can be one of: "0.1"
sourcestring

The source of the event.

default = "com.qlik/engine"
contentTypestring

The content type of the event payload.

default = "application/json"
eventIdstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
eventTypeVersionstring

Version of the event
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.app.data.updated"
extensionsobject
Show extensions properties
- spaceIdstring
  
  Id of the space related to the action performed on the eventContext.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
- userIdstring
  Required
  
  Unique identifer for the user related to the event.
- topLevelResourceIdstring
  
  Id of the app this data update relates to
dataobject

Event data
Show data properties
- lastReloadTimestring
  
  TimeStamp of when last reload ended.
  
  format = "date-time"
- namestring
  
  Name of the app that was reloaded.
- sizeobject
  
  Show size properties
  
  fileinteger
  
  Size on disk.
  
  memorystring
  
  Size in memory.

com.qlik.v1.app.data.updated

Example payload of the "App data updated" event

{
  "cloudEventsVersion": "0.1",
  "source": "com.qlik/engine",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventTypeVersion": "1.0.0",
  "eventType": "com.qlik.v1.app.data.updated",
  "extensions": {
    "spaceId": "id123",
    "tenantId": "id123",
    "userId": "id123",
    "topLevelResourceId": "id123"
  },
  "data": {
    "lastReloadTime": "2018-10-30T07:06:22Z",
    "name": "My app",
    "size": {
      "file": 0,
      "memory": 3000
    }
  }
}

An apps data was exported

Payload

object

cloudEventsVersionstring

The event is compatible with the CloudEvents specification v0.1.

Can be one of: "0.1"
sourcestring

The source of the event.

default = "com.qlik/engine"
contentTypestring

The content type of the event payload.

default = "application/json"
eventIdstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
eventTypeVersionstring

Version of the event
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.app.exported"
extensionsobject
Show extensions properties
- ownerIdstring
  
  Id of the owner of the affected resource.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
- userIdstring
  Required
  
  Unique identifer for the user related to the event.
dataobject

Application attributes and user privileges.
Show data properties
- attributesobject
  
  App attributes. This structure can also contain extra user-defined attributes.
  
  Show attributes properties
  
  idstring
  
  The App ID.
  
  namestring
  
  App name.
  
  ownerstring
  
  The owner of the app.
  
  ownerIdstring
  
  Id of the owner

com.qlik.v1.app.exported

Example payload of the "App exported" event

{
  "cloudEventsVersion": "0.1",
  "source": "com.qlik/engine",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventTypeVersion": "1.0.0",
  "eventType": "com.qlik.v1.app.exported",
  "extensions": {
    "ownerId": "id123",
    "tenantId": "id123",
    "userId": "id123"
  },
  "data": {
    "attributes": {
      "id": "id123",
      "name": "My app",
      "owner": "Owner",
      "ownerId": "id123"
    }
  }
}

An app has been published

Payload

object

cloudEventsVersionstring

The event is compatible with the CloudEvents specification v0.1.

Can be one of: "0.1"
sourcestring

The source of the event.

default = "com.qlik/engine"
contentTypestring

The content type of the event payload.

default = "application/json"
eventIdstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
eventTypeVersionstring

Version of the event
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.app.published"
extensionsobject
Show extensions properties
- spaceIdstring
  
  Id of the space related to the action performed on the eventContext.
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
- userIdstring
  Required
  
  Unique identifer for the user related to the event.
dataobject

Application attributes and user privileges.
Show data properties
- attributesobject
  
  App attributes. This structure can also contain extra user-defined attributes.
  
  Show attributes properties
  
  idstring
  
  The App ID.
  
  namestring
  
  App name.
  
  ownerstring
  
  The owner of the app.
  
  originAppIdstring
  
  The Origin App ID for published apps.

com.qlik.v1.app.published

Example payload of the "App published" event

{
  "cloudEventsVersion": "0.1",
  "source": "com.qlik/engine",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventTypeVersion": "1.0.0",
  "eventType": "com.qlik.v1.app.published",
  "extensions": {
    "spaceId": "id123",
    "tenantId": "id123",
    "userId": "id123"
  },
  "data": {
    "attributes": {
      "id": "id123",
      "name": "My app",
      "owner": "Owner",
      "originAppId": "id123"
    }
  }
}

An app reload has finished

Payload

object

cloudEventsVersionstring

The event is compatible with the CloudEvents specification v0.1.

Can be one of: "0.1"
sourcestring

The source of the event.

default = "com.qlik/engine"
contentTypestring

The content type of the event payload.

default = "application/json"
eventIdstring

Unique identifier for the event.
eventTimestring

Timestamp of when the event happened.

format = "date-time"
eventTypeVersionstring

Version of the event
eventTypestring

Unique identifier for the event type.

default = "com.qlik.v1.app.reload.finished"
extensionsobject
Show extensions properties
- tenantIdstring
  Required
  
  Unique identifier for the tenant related to the event.
- userIdstring
  Required
  
  Unique identifer for the user related to the event.
- topLevelResourceIdstring
  
  Id of the app this data update relates to
dataobject

Event data
Show data properties
- durationinteger
  
  Duration of the reload in seconds.
- endTimestring
  
  TimeStamp of when the reload ended.
  
  format = "date-time"
- errorsarray
  
  Array of errors that occured during the reload.
- namestring
  
  Name of the app that was reloaded.
- peakMemoryBytesinteger
  
  Number of bytes used at most for the reload.
- reloadIdstring
  
  Id of the reload.
- sizeobject
  
  Show size properties
  
  memorystring
  
  Size in memory.
- statementsarray of objects
  
  Show statements properties
  
  connectionstring
  
  FIXME
  
  connectionIdstring
  
  Id of connection used.
  
  dataSizeinteger
  
  FIXME
  
  discriminatorstring
  
  FIXME
  
  durationinteger
  
  FIXME
  
  nbrOfFieldsinteger
  
  FIXME
  
  nbrOfRowsinteger
  
  FIXME
  
  statementstring
  
  FIXME
  
  storageProviderstring
  
  FIXME
  
  typestring
  
  FIXME
- statusstring
  
  Status of the finished reload.
- warningsarray
  
  Array of warnings that occured during the reload.

com.qlik.v1.app.reload.finished

Example payload of the "App reload finished" event

{
  "cloudEventsVersion": "0.1",
  "source": "com.qlik/engine",
  "contentType": "application/json",
  "eventId": "id123",
  "eventTime": "2018-10-30T07:06:22Z",
  "eventTypeVersion": "1.0.0",
  "eventType": "com.qlik.v1.app.reload.finished",
  "extensions": {
    "tenantId": "id123",
    "userId": "id123",
    "topLevelResourceId": "id123"
  },
  "data": {
    "duration": 425,
    "endTime": "2018-10-30T07:06:22Z",
    "errors": [],
    "name": "My app",
    "peakMemoryBytes": 42,
    "reloadId": "id1234",
    "size": {
      "memory": 3000
    },
    "statements": [
      {
        "connection": "",
        "connectionId": "id1234",
        "dataSize": 0,
        "discriminator": "AUTOGENERATE",
        "duration": 1,
        "nbrOfFields": 3,
        "nbrOfRows": 26,
        "statement": "",
        "storageProvider": "Engine",
        "type": "Load"
      }
    ],
    "status": "ok",
    "warnings": []
  }
}