Creates a new app.

Request Body

application/json

Attributes that the user wants to set in new app.

Responses

200
application/json

OK

POST
/apps
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"attributes":{"name":"string","description":"string","spaceId":"string"}}'

Request

{
  "attributes": {
    "name": "string",
    "description": "string",
    "spaceId": "string"
  }
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.800Z",
    "createdDate": "2020-11-24T21:41:47.800Z",
    "modifiedDate": "2020-11-24T21:41:47.800Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.800Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Imports an app into the system.

<div class=note>This operation in autoreplace mode is supported only in EFE mode.</div>

Query Parameters

name
string

The name of the target app.

spaceId
string

The space ID of the target app.

mode
string

The import mode. In new mode (default), the source app will be imported as a new app with generated attributes. In autoreplace mode, the attributes from the source app will be retained and imported with the app. The app-id is extracted from the source app and used as the target app-id. If the app exists, it will be replaced. Approved objects in the target app that are not available in the source app will be removed. Non-approved objects in the target app will not be removed.

One of:

  • NEW
  • AUTOREPLACE

Enum:

NEW

AUTOREPLACE

appId
string

The app ID of the target app when source is qvw file.

fileId
string

The file ID to be downloaded from TCS and used during import.

fallbackName
string

The name of the target app when source does not have a specified name, applicable if source is qvw file.

Request Body

application/octet-stream

Path of the source app.

Responses

200
application/json

OK

404
object

Not Found

POST
/apps/import
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/import" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/octet-stream" \
 --data-binary "@/path/to/file"

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.800Z",
    "createdDate": "2020-11-24T21:41:47.800Z",
    "modifiedDate": "2020-11-24T21:41:47.800Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.800Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Gets the app privileges for the current user, such as create app and import app. Empty means that the current user has no app privileges.

Responses

200
application/json
Array<string>

OK

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

Response

{
  "items": "string"
}

Retrieves information for a specific app.

Path Parameters

appId
string

Identifier of the app.

Responses

200
application/json

OK

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

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.800Z",
    "createdDate": "2020-11-24T21:41:47.800Z",
    "modifiedDate": "2020-11-24T21:41:47.800Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.800Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Deletes a specific app.

Path Parameters

appId
string

Identifier of the app.

Responses

200
object

OK

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

Updates the information for a specific app.

Path Parameters

appId
string

Identifier of the app.

Request Body

application/json

Attributes that user wants to set.

Responses

200
application/json

OK

PUT
/apps/{appId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"attributes":{"name":"string","description":"string","spaceId":"string"}}'

Request

{
  "attributes": {
    "name": "string",
    "description": "string",
    "spaceId": "string"
  }
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.800Z",
    "createdDate": "2020-11-24T21:41:47.800Z",
    "modifiedDate": "2020-11-24T21:41:47.800Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.800Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Copies a specific app.

Path Parameters

appId
string

Identifier of the app.

Request Body

application/json

Attributes that should be set in the copy.

Responses

200
application/json

OK

POST
/apps/{appId}/copy
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/copy" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"attributes":{"name":"string","description":"string","spaceId":"string"}}'

Request

{
  "attributes": {
    "name": "string",
    "description": "string",
    "spaceId": "string"
  }
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.800Z",
    "createdDate": "2020-11-24T21:41:47.800Z",
    "modifiedDate": "2020-11-24T21:41:47.800Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.800Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.

Path Parameters

appId
string

Identifier of the app.

Responses

200
application/json

OK

GET
/apps/{appId}/data/lineage
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/data/lineage" \
 -H "Authorization: Bearer <API-key>"

Response

[
  {
    "discriminator": "string",
    "statement": "string"
  }
]

Retrieves the data model and reload statistics metadata of an app.

<div class=note>An empty metadata structure is returned if the metadata is not available in the app.</div>

Path Parameters

appId
string

Identifier of the app.

Responses

200
application/json

OK

GET
/apps/{appId}/data/metadata
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/data/metadata" \
 -H "Authorization: Bearer <API-key>"

Response

{
  "reload_meta": {
    "cpu_time_spent_ms": 0,
    "hardware": {
      "logical_cores": 0,
      "total_memory": 0
    },
    "peak_memory_bytes": 0
  },
  "static_byte_size": 0,
  "fields": [
    {
      "name": "string",
      "src_tables": [],
      "is_system": true,
      "is_hidden": true,
      "is_semantic": true,
      "distinct_only": true,
      "cardinal": 0,
      "total_count": 0,
      "is_locked": true,
      "always_one_selected": true,
      "is_numeric": true,
      "comment": "string",
      "tags": [],
      "byte_size": 0,
      "hash": "string"
    }
  ],
  "tables": [
    {
      "name": "string",
      "is_system": true,
      "is_semantic": true,
      "is_loose": true,
      "no_of_rows": 0,
      "no_of_fields": 0,
      "no_of_key_fields": 0,
      "comment": "string",
      "byte_size": 0
    }
  ],
  "has_section_access": true
}

Exports a specific app.

Path Parameters

appId
string

Identifier of the app.

Query Parameters

NoData
boolean

The flag indicating if only object contents should be exported.

Responses

201
object

Created

400
object

Bad request

403
object

Forbidden

404
object

Not Found

POST
/apps/{appId}/export
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/export" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Gets media content from file. Returns a stream of bytes containing the media file content on success, or error if file is not found.

Path Parameters

appId
string

Unique application identifier.

path
string

Path to file content.

Responses

200
application/octet-stream
string<binary>

OK

403
object

Forbidden

404
object

Not Found

GET
/apps/{appId}/media/files/{path}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
 -H "Authorization: Bearer <API-key>"

Stores the media content file. Returns OK if the bytes containing the media file content were successfully stored, or error in case of failure, lack of permission or file already exists on the supplied path.

Path Parameters

appId
string

Unique application identifier.

path
string

Path to file content.

Request Body

application/octet-stream

No description

Responses

200
object

OK

403
object

Forbidden

404
object

Not Found

PUT
/apps/{appId}/media/files/{path}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/octet-stream" \
 --data-binary "@/path/to/file"

Deletes a media content file or complete directory. Returns OK if the bytes containing the media file (or the complete content of a directory) were successfully deleted, or error in case of failure or lack of permission.

Path Parameters

appId
string

Unique application identifier.

path
string

Path to file content.

Responses

200
object

OK

403
object

Forbidden

404
object

Not Found

DELETE
/apps/{appId}/media/files/{path}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/files/{path}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Lists media content. Returns a JSON formatted array of strings describing the available media content or error if the optional path supplied is not found.

Path Parameters

appId
string

Unique application identifier.

path
string

The path to sub folder with static content relative to the root folder. Use empty path to access the root folder.

Query Parameters

show
string

Optional. List output can include files and folders in different ways:

  • Not recursive, default if show option is not supplied or incorrectly specified, results in output with files and empty directories for the path specified only.
  • Recursive(r), use ?show=r or ?show=recursive, results in a recursive output with files, all empty folders are excluded.
  • All(a), use ?show=a or ?show=all, results in a recursive output with files and empty directories.

Responses

200
application/json

OK

403
object

Forbidden

404
object

Not Found

GET
/apps/{appId}/media/list/{path}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/list/{path}" \
 -H "Authorization: Bearer <API-key>"

Response

{
  "library": "string",
  "subpath": "string",
  "data": [
    {
      "type": "string",
      "id": "string",
      "link": "string",
      "name": "string"
    }
  ]
}

Gets media content from file currently used as application thumbnail. Returns a stream of bytes containing the media file content on success, or error if file is not found.

<div class=note>The image selected as thumbnail is only updated when application is saved.</div>

Path Parameters

appId
string

Unique application identifier.

Responses

200
application/octet-stream
string<binary>

OK

403
object

Forbidden

404
object

Not Found

GET
/apps/{appId}/media/thumbnail
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/media/thumbnail" \
 -H "Authorization: Bearer <API-key>"

Changes owner of the app.

Path Parameters

appId
string

Identifier of the app.

Request Body

application/json

New owner.

Responses

200
application/json

OK

403
object

Forbidden

404
object

Not Found

PUT
/apps/{appId}/owner
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/owner" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"ownerId":"string"}'

Request

{
  "ownerId": "string"
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.801Z",
    "createdDate": "2020-11-24T21:41:47.801Z",
    "modifiedDate": "2020-11-24T21:41:47.801Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.801Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Publishes a specific app to a managed space.

Path Parameters

appId
string

Identifier of the app.

Request Body

application/json

Publish information for the app.

Responses

200
application/json

OK

POST
/apps/{appId}/publish
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/publish" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"spaceId":"string","data":"source"}'

Request

{
  "spaceId": "string",
  "data": "source"
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.801Z",
    "createdDate": "2020-11-24T21:41:47.801Z",
    "modifiedDate": "2020-11-24T21:41:47.801Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.801Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Republishes a published app to a managed space.

Path Parameters

appId
string

Identifier of the app.

Request Body

application/json

Republish information for the app.

Responses

200
application/json

OK

PUT
/apps/{appId}/publish
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/publish" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"targetId":"string","data":"source"}'

Request

{
  "targetId": "string",
  "data": "source"
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.801Z",
    "createdDate": "2020-11-24T21:41:47.801Z",
    "modifiedDate": "2020-11-24T21:41:47.801Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.801Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Sets space on a specific app.

Path Parameters

appId
string

Identifier of the app.

Request Body

application/json

New space.

Responses

200
application/json

OK

PUT
/apps/{appId}/space
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/space" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"spaceId":"string"}'

Request

{
  "spaceId": "string"
}

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.801Z",
    "createdDate": "2020-11-24T21:41:47.801Z",
    "modifiedDate": "2020-11-24T21:41:47.801Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.801Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

Removes space from a specific app.

Path Parameters

appId
string

Identifier of the app.

Responses

200
application/json

OK

DELETE
/apps/{appId}/space
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/space" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Response

{
  "attributes": {
    "id": "string",
    "name": "string",
    "description": "string",
    "thumbnail": "string",
    "lastReloadTime": "2020-11-24T21:41:47.801Z",
    "createdDate": "2020-11-24T21:41:47.801Z",
    "modifiedDate": "2020-11-24T21:41:47.801Z",
    "owner": "string",
    "ownerId": "string",
    "dynamicColor": "string",
    "published": true,
    "publishTime": "2020-11-24T21:41:47.801Z",
    "custom": {},
    "hasSectionAccess": true,
    "encrypted": true,
    "originAppId": "string"
  },
  "privileges": [],
  "create": [
    {
      "resource": "string",
      "canCreate": true
    }
  ]
}

CreateApp

object

Properties

attributes

No description

Properties

name
string

The name (title) of the application

description
string

The description of the application

spaceId
string

The space ID of the application

NxApp

object

Application attributes and user privileges.

Properties

attributes

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

privileges
Array<string>

Application privileges. Hints to the client what actions the user is allowed to perform. Could be any of:

  • read
  • create
  • update
  • delete
  • reload
  • import
  • publish
  • duplicate
  • export
  • exportdata
  • change_owner
  • change_space
create

Object create privileges. Hints to the client what type of objects the user is allowed to create.

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

Properties

id
string

The App ID.

name
string

App name.

description
string

App description.

thumbnail
string

App thumbnail.

lastReloadTime
string<date-time>

Date and time of the last reload of the app.

createdDate
string<date-time>

The date and time when the app was created.

modifiedDate
string<date-time>

The date and time when the app was modified.

owner
string

The owner of the app.

ownerId
string

No description

dynamicColor
string

The dynamic color of the app.

published
boolean

True if the app is published, false if not.

publishTime
string<date-time>

The date and time when the app was published, empty if unpublished.

custom

Contains dynamic JSON data specified by the client.

hasSectionAccess
boolean

If set to true, the app has section access configured,

encrypted
boolean

If set to true, the app is encrypted.

originAppId
string

The Origin App ID for published apps.

Contains dynamic JSON data specified by the client.

Properties

resource
string

Type of resources. For example, sheet, story, bookmark, etc.

canCreate
boolean

Is set to true if the user has privileges to create the resource.

FileData

string<binary>

UpdateApp

object

Properties

attributes

No description

Properties

discriminator
string

A string indicating the origin of the data:

  • [filename]: the data comes from a local file.
  • INLINE: the data is entered inline in the load script.
  • RESIDENT: the data comes from a resident table. The table name is listed.
  • AUTOGENERATE: the data is generated from the load script (no external table of data source).
  • Provider: the data comes from a data connection. The connector source name is listed.
  • [webfile]: the data comes from a web-based file.
  • STORE: path to QVD or TXT file where data is stored.
  • EXTENSION: the data comes from a Server Side Extension (SSE).
statement
string

The LOAD and SELECT script statements from the data load script.

Properties

reload_meta

No description

static_byte_size
integer<int64>

Static memory usage for the app.

fields

List of field descriptions.

tables

List of table descriptions.

has_section_access
boolean

If set to true, the app has section access configured,

Properties

cpu_time_spent_ms
integer<int64>

Number of CPU milliseconds it took to reload the app.

hardware

No description

peak_memory_bytes
integer<int64>

Max number of bytes used during reload of the app.

Properties

logical_cores
integer<int32>

Number of logical cores available.

total_memory
integer<int64>

RAM available.

Properties

name
string

Name of the field.

src_tables
Array<string>

List of table names.

is_system
boolean

If set to true, the field is a system field. The default value is false.

is_hidden
boolean

If set to true, the field is hidden. The default value is false.

is_semantic
boolean

If set to true, the field is semantic. The default value is false.

distinct_only
boolean

If set to true, only distinct field values are shown. The default value is false.

cardinal
integer<int32>

Number of distinct field values.

total_count
integer<int64>

Total number of field values.

is_locked
boolean

If set to true, the field is locked. The default value is false.

always_one_selected
boolean

If set to true, the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field. The default value is false.

is_numeric
boolean

Is set to true if the value is a numeric. The default value is false.

comment
string

Field comment.

tags
Array<string>

Gives information on a field. For example, it can return the type of the field. Examples: key, text, ASCII.

byte_size
integer<int64>

Static RAM memory used in bytes.

hash
string

Hash of the data in the field. If the data in a reload is the same, the hash will be consistent.

Properties

name
string

Name of the table.

is_system
boolean

If set to true, the table is a system table. The default value is false.

is_semantic
boolean

If set to true, the table is semantic. The default value is false.

is_loose
boolean

If set to true, the table is loose due to circular connection. The default value is false.

no_of_rows
integer<int64>

Number of rows.

no_of_fields
integer<int32>

Number of fields.

no_of_key_fields
integer<int32>

Number of key fields.

comment
string

Table comment.

byte_size
integer<int64>

Static RAM memory used in bytes.

Properties

library
string

Content library name.

subpath
string

Content library relative listing path. Empty in case of root listed or representing actual subpath listed.

data

Content list items.

Properties

type
string

Content type.

id
string

Unique content identifier.

link
string

Unique content link.

name
string

Content name.

Properties

ownerId
string

No description

Properties

spaceId
string

The managed space ID where the app will be published.

data
string

The published app will have data from source or target app. The default is source

  • source: Publish with source data
  • target: Publish with target data

Enum:

source

target

Properties

targetId
string

The target ID to be republished.

data
string

The republished app will have data from source or target app. The default is source

  • source: Publish with source data
  • target: Publish with target data

Enum:

source

target

Properties

spaceId
string

No description

v1.36.1