Apps

App created (com.qlik.v1.app.created)

An app was created

PayloadApp created (com.qlik.v1.app.created)

cloudEventsVersion string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source default='com.qlik/engine' string	The source of the event.
contentType default='application/json' string	The content type of the event payload.
eventId string	Unique identifier for the event.
eventTime string<date-time>	Timestamp of when the event happened.
eventTypeVersion string	Version of the event
eventType default='com.qlik.v1.app.created' string	Unique identifier for the event type.
extensions object	No description
data NxApp	Application attributes and user privileges.

ExampleApp created (com.qlik.v1.app.created)

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

App deleted (com.qlik.v1.app.deleted)

An app was deleted

PayloadApp deleted (com.qlik.v1.app.deleted)

cloudEventsVersion string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source default='com.qlik/engine' string	The source of the event.
contentType default='application/json' string	The content type of the event payload.
eventId string	Unique identifier for the event.
eventTime string<date-time>	Timestamp of when the event happened.
eventTypeVersion string	Version of the event
eventType default='com.qlik.v1.app.deleted' string	Unique identifier for the event type.
extensions object	No description
data NxAppDeleted	Application attributes and user privileges.

ExampleApp deleted (com.qlik.v1.app.deleted)

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

App data updated (com.qlik.v1.app.data.updated)

An apps data was updated

PayloadApp data updated (com.qlik.v1.app.data.updated)

cloudEventsVersion string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source default='com.qlik/engine' string	The source of the event.
contentType default='application/json' string	The content type of the event payload.
eventId string	Unique identifier for the event.
eventTime string<date-time>	Timestamp of when the event happened.
eventTypeVersion string	Version of the event
eventType default='com.qlik.v1.app.data.updated' string	Unique identifier for the event type.
extensions object	No description
data DataUpdated	No description

ExampleApp data updated (com.qlik.v1.app.data.updated)

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

App exported (com.qlik.v1.app.exported)

An apps data was exported

PayloadApp exported (com.qlik.v1.app.exported)

cloudEventsVersion string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source default='com.qlik/engine' string	The source of the event.
contentType default='application/json' string	The content type of the event payload.
eventId string	Unique identifier for the event.
eventTime string<date-time>	Timestamp of when the event happened.
eventTypeVersion string	Version of the event
eventType default='com.qlik.v1.app.exported' string	Unique identifier for the event type.
extensions object	No description
data NxAppExported	Application attributes and user privileges.

ExampleApp exported (com.qlik.v1.app.exported)

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

App published (com.qlik.v1.app.published)

An app has been published

PayloadApp published (com.qlik.v1.app.published)

cloudEventsVersion string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source default='com.qlik/engine' string	The source of the event.
contentType default='application/json' string	The content type of the event payload.
eventId string	Unique identifier for the event.
eventTime string<date-time>	Timestamp of when the event happened.
eventTypeVersion string	Version of the event
eventType default='com.qlik.v1.app.published' string	Unique identifier for the event type.
extensions object	No description
data NxAppPublished	Application attributes and user privileges.

ExampleApp published (com.qlik.v1.app.published)

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

App reload finished (com.qlik.v1.app.reload.finished)

An app reload has finished

PayloadApp reload finished (com.qlik.v1.app.reload.finished)

cloudEventsVersion string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source default='com.qlik/engine' string	The source of the event.
contentType default='application/json' string	The content type of the event payload.
eventId string	Unique identifier for the event.
eventTime string<date-time>	Timestamp of when the event happened.
eventTypeVersion string	Version of the event
eventType default='com.qlik.v1.app.reload.finished' string	Unique identifier for the event type.
extensions object	No description
data ReloadFinished	No description

ExampleApp reload finished (com.qlik.v1.app.reload.finished)

{
  "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": 0,
    "reloadId": "id1234",
    "size": {
      "memory": 3000
    },
    "statements": [
      {
        "connection": "string",
        "connectionId": "id1234",
        "dataSize": 0,
        "discriminator": "AUTOGENERATE",
        "duration": 1,
        "nbrOfFields": 3,
        "nbrOfRows": 26,
        "statement": "string",
        "storageProvider": "Engine",
        "type": "Load"
      }
    ],
    "status": "ok",
    "warnings": []
  }
}

AppCreated

An app was created

PayloadAppCreated

eventType default='com.qlik.v1.app.created' string	Unique identifier for the event type.
extensions object	No description
data object	Event data

AppDeleted

An app was deleted

PayloadAppDeleted

eventType default='com.qlik.v1.app.deleted' string	Unique identifier for the event type.
extensions object	No description
data object	Event data

AppDataUpdated

An apps data was updated

PayloadAppDataUpdated

eventType default='com.qlik.v1.app.data.updated' string	Unique identifier for the event type.
extensions object	No description
data object	Event data

AppExported

An apps data was exported

PayloadAppExported

eventType default='com.qlik.v1.app.exported' string	Unique identifier for the event type.
extensions object	No description
data object	Event data

AppPublished

An app has been published

PayloadAppPublished

eventType default='com.qlik.v1.app.published' string	Unique identifier for the event type.
extensions object	No description
data object	Event data

AppReloadFinished

An app reload has finished

PayloadAppReloadFinished

eventType default='com.qlik.v1.app.reload.finished' string	Unique identifier for the event type.
extensions object	No description
data object	Event data

cloudEvents

object

PropertiescloudEvents

cloudEventsVersion optional string	The event is compatible with the CloudEvents specification v0.1. Enum: 0.1
source optional, default='com.qlik/engine' string	The source of the event.
contentType optional, default='application/json' string	The content type of the event payload.
eventId optional string	Unique identifier for the event.
eventTime optional string<date-time>	Timestamp of when the event happened.
eventTypeVersion optional string	Version of the event

extensionObject

object

PropertiesextensionObject

ownerId optional string	Id of the owner of the affected resource.
spaceId optional string	Id of the space related to the action performed on the eventContext.
tenantId optional string	Unique identifier for the tenant related to the event.
userId optional string	Unique identifer for the user related to the event.

updatesObject

object

PropertiesupdatesObject

updates

optional

Array<object>

Collection of updates performed on the resource.

NxApp

object

Application attributes and user privileges.

PropertiesNxApp

attributes

optional

object

Application attributes.

NxAttributes

object

App attributes. This structure can also contain extra user-defined attributes.

PropertiesNxAttributes

id optional string	The App ID.
name optional string	App name.
description optional string	App description.
lastReloadTime optional string<date-time>	Date and time of the last reload of the app.
createdDate optional string<date-time>	The date and time when the app was created.
modifiedDate optional string<date-time>	The date and time when the app was modified.
owner optional string	The owner of the app.
ownerId optional string	Id of the owner
dynamicColor optional string	The dynamic color of the app.
published optional boolean	True if the app is published, false if not.
publishTime optional string<date-time>	The date and time when the app was published, empty if unpublished.
hasSectionAccess optional boolean	If set to true, the app has section access configured,
originAppId optional string	The Origin App ID for published apps.

NxAppExported

object

Application attributes and user privileges.

PropertiesNxAppExported

attributes

optional

object

Application attributes.

NxAttributesExported

object

App attributes. This structure can also contain extra user-defined attributes.

PropertiesNxAttributesExported

id optional string	The App ID.
name optional string	App name.
owner optional string	The owner of the app.
ownerId optional string	Id of the owner

NxAppPublished

object

Application attributes and user privileges.

PropertiesNxAppPublished

attributes

optional

object

Application attributes.

NxAttributesPublished

object

App attributes. This structure can also contain extra user-defined attributes.

PropertiesNxAttributesPublished

id optional string	The App ID.
name optional string	App name.
owner optional string	The owner of the app.
originAppId optional string	The Origin App ID for published apps.

NxAppDeleted

object

Application attributes and user privileges.

PropertiesNxAppDeleted

attributes

optional

object

Application attributes.

NxAttributesDeleted

object

App attributes. This structure can also contain extra user-defined attributes.

PropertiesNxAttributesDeleted

id optional string	The App ID.
name optional string	App name.

JsonObject

object

Contains dynamic JSON data specified by the client.

NxAppCreatePrivileges

object

PropertiesNxAppCreatePrivileges

resource optional string	Type of resources. For example, sheet, story, bookmark, etc.
canCreate optional boolean	Is set to true if the user has privileges to create the resource.

ReloadFinished

object

PropertiesReloadFinished

duration optional integer	Duration of the reload in seconds.
endTime optional	TimeStamp of when the reload ended.
errors optional Array<>	Array of errors that occured during the reload.
name optional string	Name of the app that was reloaded.
peakMemoryBytes optional integer	Number of bytes used at most for the reload.
reloadId optional string	Id of the reload.
size optional object	No description
statements optional Array<>	No description
status optional string	Status of the finished reload.
warnings optional Array<>	Array of warnings that occured during the reload.

Statement

object

PropertiesStatement

connection optional string	FIXME
connectionId optional string	Id of connection used.
dataSize optional integer	FIXME
discriminator optional string	FIXME
duration optional integer	FIXME
nbrOfFields optional integer	FIXME
nbrOfRows optional integer	FIXME
statement optional string	FIXME
storageProvider optional string	FIXME
type optional string	FIXME

DataUpdated

object

PropertiesDataUpdated

lastReloadTime optional	TimeStamp of when last reload ended.
name optional string	Name of the app that was reloaded.
size optional object	No description

v1.0.0

PayloadApp created (com.qlik.v1.app.created)

ExampleApp created (com.qlik.v1.app.created)

PayloadApp deleted (com.qlik.v1.app.deleted)

ExampleApp deleted (com.qlik.v1.app.deleted)

PayloadApp data updated (com.qlik.v1.app.data.updated)

ExampleApp data updated (com.qlik.v1.app.data.updated)

PayloadApp exported (com.qlik.v1.app.exported)

ExampleApp exported (com.qlik.v1.app.exported)

PayloadApp published (com.qlik.v1.app.published)

ExampleApp published (com.qlik.v1.app.published)

PayloadApp reload finished (com.qlik.v1.app.reload.finished)

ExampleApp reload finished (com.qlik.v1.app.reload.finished)

PayloadAppCreated

PayloadAppDeleted

PayloadAppDataUpdated

PayloadAppExported

PayloadAppPublished

PayloadAppReloadFinished

PropertiescloudEvents

PropertiesextensionObject

PropertiesupdatesObject

PropertiesNxApp

PropertiesNxAttributes

PropertiesNxAppExported

PropertiesNxAttributesExported

PropertiesNxAppPublished

PropertiesNxAttributesPublished

PropertiesNxAppDeleted

PropertiesNxAttributesDeleted

PropertiesNxAppCreatePrivileges

PropertiesReloadFinished

PropertiesStatement

PropertiesDataUpdated

Company

Legal

Forums