Apps
Apps are central to the Qlik platform and is the resource you use when interacting with Qlik Sense and QlikView apps.
Endpoints
Skip to sectionPOST | /apps |
POST | /apps/import |
GET | /apps/privileges |
GET | /apps/{appId} |
DELETE | /apps/{appId} |
PUT | /apps/{appId} |
POST | /apps/{appId}/copy |
GET | /apps/{appId}/data/lineage |
GET | /apps/{appId}/data/metadata |
POST | /apps/{appId}/export |
GET | /apps/{appId}/media/files/{path} |
PUT | /apps/{appId}/media/files/{path} |
DELETE | /apps/{appId}/media/files/{path} |
GET | /apps/{appId}/media/list/{path} |
GET | /apps/{appId}/media/thumbnail |
PUT | /apps/{appId}/owner |
POST | /apps/{appId}/publish |
PUT | /apps/{appId}/publish |
GET | /apps/{appId}/reloads/logs |
GET | /apps/{appId}/reloads/logs/{reloadId} |
PUT | /apps/{appId}/space |
DELETE | /apps/{appId}/space |
Creates a new app.
Creates a new app.
Request Body POST /apps
application/json | Attributes that the user wants to set in new app. |
Responses POST /apps
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","locale":"string"}}'
Request POST /apps
{
"attributes": {
"name": "string",
"description": "string",
"spaceId": "string",
"locale": "string"
}
}
Response POST /apps
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.848Z",
"createdDate": "2022-05-18T10:58:20.848Z",
"modifiedDate": "2022-05-18T10:58:20.848Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.848Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Imports an app into the system.
Imports an app into the system.
Query Parameters POST /apps/import
name string | The name of the target app. |
spaceId string | The space ID of the target app. |
mode | The import mode. In One of:
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 Temporary Content Service (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. |
NoData boolean | If NoData is true, the data of the existing app will be kept as is, otherwise it will be replaced by the new incoming data. |
Request Body POST /apps/import
application/octet-stream | Path of the source app. |
Responses POST /apps/import
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 POST /apps/import
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.849Z",
"createdDate": "2022-05-18T10:58:20.849Z",
"modifiedDate": "2022-05-18T10:58:20.849Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.849Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"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.
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 GET /apps/privileges
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 GET /apps/privileges
{
"items": "string"
}
Retrieves information for a specific app.
Retrieves information for a specific app.
Path Parameters GET /apps/{appId}
appId string | Identifier of the app. |
Responses GET /apps/{appId}
200 application/json | OK |
GET/apps/{appId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}" \
-H "Authorization: Bearer <API-key>"
Response GET /apps/{appId}
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.849Z",
"createdDate": "2022-05-18T10:58:20.849Z",
"modifiedDate": "2022-05-18T10:58:20.849Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.849Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Deletes a specific app.
Deletes a specific app.
Path Parameters DELETE /apps/{appId}
appId string | Identifier of the app. |
Responses DELETE /apps/{appId}
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.
Updates the information for a specific app.
Path Parameters PUT /apps/{appId}
appId string | Identifier of the app. |
Request Body PUT /apps/{appId}
application/json | Attributes that user wants to set. |
Responses PUT /apps/{appId}
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"}}'
Request PUT /apps/{appId}
{
"attributes": {
"name": "string",
"description": "string"
}
}
Response PUT /apps/{appId}
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.849Z",
"createdDate": "2022-05-18T10:58:20.849Z",
"modifiedDate": "2022-05-18T10:58:20.849Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.849Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Copies a specific app.
Copies a specific app.
Path Parameters POST /apps/{appId}/copy
appId string | Identifier of the app. |
Request Body POST /apps/{appId}/copy
application/json | Attributes that should be set in the copy. |
Responses POST /apps/{appId}/copy
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","locale":"string"}}'
Request POST /apps/{appId}/copy
{
"attributes": {
"name": "string",
"description": "string",
"spaceId": "string",
"locale": "string"
}
}
Response POST /apps/{appId}/copy
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.849Z",
"createdDate": "2022-05-18T10:58:20.849Z",
"modifiedDate": "2022-05-18T10:58:20.849Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.849Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"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.
Retrieves the lineage for an app. Returns a JSON-formatted array of strings describing the lineage of the app.
Path Parameters GET /apps/{appId}/data/lineage
appId string | Identifier of the app. |
Responses GET /apps/{appId}/data/lineage
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 GET /apps/{appId}/data/lineage
[
{
"discriminator": "string",
"statement": "string"
}
]
Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app.
Retrieves the data model and reload statistics metadata of an app. An empty metadata structure is returned if the metadata is not available in the app.
Path Parameters GET /apps/{appId}/data/metadata
appId string | Identifier of the app. |
Responses GET /apps/{appId}/data/metadata
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 GET /apps/{appId}/data/metadata
{
"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,
"tables_profiling_data": [
{
"NoOfRows": 0,
"FieldProfiling": [
{
"Name": "string",
"FieldTags": [],
"NumberFormat": {
"Type": "UNKNOWN",
"nDec": 10,
"UseThou": 0,
"Fmt": "string",
"Dec": "string",
"Thou": "string"
},
"DistinctValues": 0,
"DistinctNumericValues": 0,
"DistinctTextValues": 0,
"NumericValues": 0,
"NullValues": 0,
"TextValues": 0,
"NegValues": 0,
"PosValues": 0,
"ZeroValues": 0,
"Sum": 0,
"Sum2": 0,
"Average": 0,
"Median": 0,
"Std": 0,
"Min": 0,
"Max": 0,
"Skewness": 0,
"Kurtosis": 0,
"Fractiles": [],
"EmptyStrings": 0,
"MaxStringLen": 0,
"MinStringLen": 0,
"SumStringLen": 0,
"AvgStringLen": 0,
"FirstSorted": "string",
"LastSorted": "string",
"MostFrequent": [
{
"Symbol": {
"Text": "string",
"Number": 0
},
"Frequency": 0
}
],
"FrequencyDistribution": {
"NumberOfBins": 0,
"BinsEdges": [],
"Frequencies": []
}
}
]
}
],
"is_direct_query_mode": true
}
Exports a specific app.
Exports a specific app.
Path Parameters POST /apps/{appId}/export
appId string | Identifier of the app. |
Query Parameters POST /apps/{appId}/export
NoData boolean | The flag indicating if only object contents should be exported. |
Responses POST /apps/{appId}/export
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.
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 GET /apps/{appId}/media/files/{path}
appId string | Unique application identifier. |
path string | Path to file content. |
Responses GET /apps/{appId}/media/files/{path}
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>"
Response GET /apps/{appId}/media/files/{path}
{
"undefined": "string"
}
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.
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 PUT /apps/{appId}/media/files/{path}
appId string | Unique application identifier. |
path string | Path to file content. |
Request Body PUT /apps/{appId}/media/files/{path}
application/octet-stream | No description |
Responses PUT /apps/{appId}/media/files/{path}
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.
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 DELETE /apps/{appId}/media/files/{path}
appId string | Unique application identifier. |
path string | Path to file content. |
Responses DELETE /apps/{appId}/media/files/{path}
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.
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 GET /apps/{appId}/media/list/{path}
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 GET /apps/{appId}/media/list/{path}
show string | Optional. List output can include files and folders in different ways:
|
Responses GET /apps/{appId}/media/list/{path}
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 GET /apps/{appId}/media/list/{path}
{
"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. The image selected as thumbnail is only updated when application is saved.
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. The image selected as thumbnail is only updated when application is saved.
Path Parameters GET /apps/{appId}/media/thumbnail
appId string | Unique application identifier. |
Responses GET /apps/{appId}/media/thumbnail
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>"
Response GET /apps/{appId}/media/thumbnail
{
"undefined": "string"
}
Changes owner of the app.
Changes owner of the app.
Path Parameters PUT /apps/{appId}/owner
appId string | Identifier of the app. |
Request Body PUT /apps/{appId}/owner
application/json | New owner. |
Responses PUT /apps/{appId}/owner
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 PUT /apps/{appId}/owner
{
"ownerId": "string"
}
Response PUT /apps/{appId}/owner
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.850Z",
"createdDate": "2022-05-18T10:58:20.850Z",
"modifiedDate": "2022-05-18T10:58:20.850Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.850Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Publishes a specific app to a managed space.
Publishes a specific app to a managed space.
Path Parameters POST /apps/{appId}/publish
appId string | Identifier of the app. |
Request Body POST /apps/{appId}/publish
application/json | Publish information for the app. |
Responses POST /apps/{appId}/publish
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","attributes":{"name":"string","description":"string"},"data":"source"}'
Request POST /apps/{appId}/publish
{
"spaceId": "string",
"attributes": {
"name": "string",
"description": "string"
},
"data": "source"
}
Response POST /apps/{appId}/publish
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.850Z",
"createdDate": "2022-05-18T10:58:20.850Z",
"modifiedDate": "2022-05-18T10:58:20.850Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.850Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Republishes a published app to a managed space.
Republishes a published app to a managed space.
Path Parameters PUT /apps/{appId}/publish
appId string | Identifier of the app. |
Request Body PUT /apps/{appId}/publish
application/json | Republish information for the app. |
Responses PUT /apps/{appId}/publish
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","attributes":{"name":"string","description":"string"},"checkOriginAppId":true}'
Request PUT /apps/{appId}/publish
{
"targetId": "string",
"data": "source",
"attributes": {
"name": "string",
"description": "string"
},
"checkOriginAppId": true
}
Response PUT /apps/{appId}/publish
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.850Z",
"createdDate": "2022-05-18T10:58:20.850Z",
"modifiedDate": "2022-05-18T10:58:20.850Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.850Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.
Retrieves the metadata about all script logs stored for an app. Returns an array of ScriptLogMeta objects.
Path Parameters GET /apps/{appId}/reloads/logs
appId string | Identifier of the app. |
Responses GET /apps/{appId}/reloads/logs
200 application/json | OK |
GET/apps/{appId}/reloads/logs
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/logs" \
-H "Authorization: Bearer <API-key>"
Response GET /apps/{appId}/reloads/logs
{
"data": [
{
"reloadId": "string",
"success": true,
"duration": 0,
"endTime": "2022-05-18T10:58:20.850Z",
"links": {
"log": "string"
}
}
]
}
Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".
Retrieves the log of a specific reload. Returns the log as "text/plain; charset=UTF-8".
Path Parameters GET /apps/{appId}/reloads/logs/{reloadId}
appId string | Identifier of the app. |
reloadId string | Identifier of the reload. |
Responses GET /apps/{appId}/reloads/logs/{reloadId}
200 application/octet-stream string<binary> | OK |
GET/apps/{appId}/reloads/logs/{reloadId}
curl "https://your-tenant.us.qlikcloud.com/api/v1/apps/{appId}/reloads/logs/{reloadId}" \
-H "Authorization: Bearer <API-key>"
Response GET /apps/{appId}/reloads/logs/{reloadId}
{
"undefined": "string"
}
Sets space on a specific app.
Sets space on a specific app.
Path Parameters PUT /apps/{appId}/space
appId string | Identifier of the app. |
Request Body PUT /apps/{appId}/space
application/json | New space. |
Responses PUT /apps/{appId}/space
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 PUT /apps/{appId}/space
{
"spaceId": "string"
}
Response PUT /apps/{appId}/space
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.850Z",
"createdDate": "2022-05-18T10:58:20.850Z",
"modifiedDate": "2022-05-18T10:58:20.850Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.850Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
Removes space from a specific app.
Removes space from a specific app.
Path Parameters DELETE /apps/{appId}/space
appId string | Identifier of the app. |
Responses DELETE /apps/{appId}/space
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 DELETE /apps/{appId}/space
{
"attributes": {
"id": "string",
"name": "string",
"description": "string",
"thumbnail": "string",
"lastReloadTime": "2022-05-18T10:58:20.850Z",
"createdDate": "2022-05-18T10:58:20.850Z",
"modifiedDate": "2022-05-18T10:58:20.850Z",
"owner": "string",
"ownerId": "string",
"dynamicColor": "string",
"published": true,
"publishTime": "2022-05-18T10:58:20.850Z",
"custom": {},
"hasSectionAccess": true,
"encrypted": true,
"originAppId": "string",
"isDirectQueryMode": true
},
"privileges": [],
"create": [
{
"resource": "string",
"canCreate": true
}
]
}
CreateApp
objectProperties
attributes | No description |
AppAttributes
objectProperties
name string | The name (title) of the application |
description string | The description of the application |
spaceId string | The space ID of the application |
locale string | Set custom locale instead of the system default |
NxApp
objectApplication 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:
|
create | Object create privileges. Hints to the client what type of objects the user is allowed to create. |
NxAttributes
objectApp 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 on-prem, distributed in QCS, 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. |
isDirectQueryMode boolean | True if the app is a Direct Query app, false if not |
JsonObject
objectContains dynamic JSON data specified by the client.
NxAppCreatePrivileges
objectProperties
resource string | Type of resource. 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
objectProperties
attributes | No description |
AppUpdateAttributes
objectProperties
name string | The name (title) of the application. |
description string | The description of the application. |
LineageInfoRest
objectProperties
discriminator string | A string indicating the origin of the data:
|
statement string | The LOAD and SELECT script statements from the data load script. |
DataModelMetadata
objectProperties
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. |
tables_profiling_data | Profiling data of the tables in the app. |
is_direct_query_mode boolean | No description |
LastReloadMetadata
objectProperties
cpu_time_spent_ms integer<int64> | Number of CPU milliseconds it took to reload the app. |
hardware | No description |
peak_memory_bytes integer<int64> | Maximum number of bytes used during reload of the app. |
HardwareMeta
objectProperties
logical_cores integer<int32> | Number of logical cores available. |
total_memory integer<int64> | RAM available. |
FieldMetadata
objectProperties
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. |
TableMetadata
objectProperties
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. |
TableProfilingData
objectProperties
NoOfRows integer<int64> | Number of rows in the table. |
FieldProfiling | Field values profiling info |
FieldInTableProfilingData
objectProperties
Name string | Name of the field. |
FieldTags Array<string> | List of tags related to the field. |
NumberFormat | Sets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below. Formatting mechanismThe formatting mechanism depends on the type set in qType, as shown below: <div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>Type is DATE, TIME, TIMESTAMP or INTERVALThe following applies:
Type is INTEGERThe following applies:
Type is REALThe following applies:
Type is FIXThe following applies:
Type is MONEYThe following applies:
Type is ASCIINo formatting, qFmt is ignored. |
DistinctValues integer<int64> | Number of distinct values |
DistinctNumericValues integer<int64> | Number of distinct numeric values |
DistinctTextValues integer<int64> | Number of distinct text values |
NumericValues integer<int64> | Number of numeric values |
NullValues integer<int64> | Number of null values |
TextValues integer<int64> | Number of textual values |
NegValues integer<int64> | Number of negative values |
PosValues integer<int64> | Number of positive values |
ZeroValues integer<int64> | Number of zero values for numerical values |
Sum number<double> | Sum of all numerical values. NaN otherwise. |
Sum2 number<double> | Squared sum of all numerical values. NaN otherwise. |
Average number<double> | Average of all numerical values. NaN otherwise. |
Median number<double> | Median of all numerical values. NaN otherwise. |
Std number<double> | Standard deviation of numerical values. NaN otherwise. |
Min number<double> | Minimum value of numerical values. NaN otherwise. |
Max number<double> | Maximum value of numerical values. NaN otherwise. |
Skewness number<double> | Skewness of the numerical values. NaN otherwise. |
Kurtosis number<double> | Kurtosis of the numerical values. NaN otherwise. |
Fractiles Array<number<double>> | The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise. |
EmptyStrings integer<int64> | Number of empty strings |
MaxStringLen integer<int64> | Maximum string length of textual values. 0 otherwise. |
MinStringLen integer<int64> | Minimum string length of textual values. 0 otherwise. |
SumStringLen integer<int64> | Sum of all characters in strings in the field |
AvgStringLen number<double> | Average string length of textual values. 0 otherwise. |
FirstSorted string | For textual values the first sorted string. |
LastSorted string | For textual values the last sorted string. |
MostFrequent | Three most frequent values and their frequencies |
FrequencyDistribution | No description |
FieldAttributes
objectSets the formatting of a field. The properties of qFieldAttributes and the formatting mechanism are described below.
Formatting mechanism
The formatting mechanism depends on the type set in qType, as shown below:
<div class=note>In case of inconsistencies between the type and the format pattern, the format pattern takes precedence over the type.</div>Type is DATE, TIME, TIMESTAMP or INTERVAL
The following applies:
- If a format pattern is defined in qFmt , the formatting is as defined in qFmt .
- If qFmt is empty, the formatting is defined by the number interpretation variables included at the top of the script ( TimeFormat , DateFormat , TimeStampFormat ).
- The properties qDec , qThou , qnDec , qUseThou are not used.
Type is INTEGER
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the formatting mechanism uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , no formatting is applied. The properties qDec , qThou , qnDec , qUseThou and the number interpretation variables defined in the script are not used .
Type is REAL
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , and if the value is almost an integer value (for example, 14,000012), the value is formatted as an integer. The properties qDec , qThou , qnDec , qUseThou are not used.
- If no format pattern is defined in qFmt , and if qnDec is defined and not 0, the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
- If no format pattern is defined in qFmt , and if qnDec is 0, the number of decimals is 14 and the property qDec is used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is FIX
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of the script ( DecimalSep and ThousandSep ).
- If no format pattern is defined in qFmt , the properties qDec and qnDec are used. If qDec is not defined, the variable DecimalSep defined at the top of the script is used.
Type is MONEY
The following applies:
- If a format pattern is defined in qFmt , the engine looks at the values set in qDec and qThou . If these properties are not defined, the engine uses the number interpretation variables included at the top of any script ( MoneyDecimalSep and MoneyThousandSep ).
- If no format pattern is defined in qFmt , the engine uses the number interpretation variables included at the top of the script ( MoneyDecimalSep and MoneyThousandSep ).
Type is ASCII
No formatting, qFmt is ignored.
Properties
Type default='UNKNOWN' string | Type of the field. Default is U. One of:
Enum: UNKNOWN ASCII INTEGER REAL FIX MONEY DATE TIME TIMESTAMP INTERVAL |
nDec default=10 integer<int32> | Number of decimals. Default is 10. |
UseThou default=0 integer<int32> | Defines whether or not a thousands separator must be used. Default is 0. |
Fmt string | Defines the format pattern that applies to qText . Is used in connection to the type of the field (parameter qType ). For more information, see Formatting mechanism. Example: YYYY-MM-DD for a date. |
Dec string | Defines the decimal separator. Example: . |
Thou string | Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: , |
SymbolFrequency
objectProperties
Symbol | No description |
Frequency integer<int64> | Frequency of the above symbol in the field |
SymbolValue
objectProperties
Text string | String value of the symbol. This parameter is optional and present only if Symbol is a string. |
Number number<double> | Numeric value of the symbol. NaN otherwise. |
FrequencyDistributionData
objectProperties
NumberOfBins integer<int32> | Number of bins. |
BinsEdges Array<number<double>> | Bins edges. |
Frequencies Array<integer<int32>> | Bins frequencies. |
AppContentList
objectProperties
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. |
AppContentListItem
objectProperties
type string | Content type. |
id string | Unique content identifier. |
link string | Unique content link. |
name string | Content name. |
UpdateOwner
objectProperties
ownerId string | No description |
PublishApp
objectProperties
spaceId string | The managed space ID where the app will be published. |
attributes | No description |
data string | The published app will have data from source or target app. The default is source.
Enum: source target |
RepublishApp
objectProperties
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.
Enum: source target |
attributes | No description |
checkOriginAppId default=true boolean | Validate that source app is same as originally published. |
ScriptLogList
objectProperties
data | Array of scriptLogMeta. |
ScriptLogMeta
objectProperties
reloadId string | Reload identifier. |
success boolean | True if the reload was successful. |
duration integer<int64> | Duration of reload (ms). |
endTime string<date-time> | Time when reload ended. |
links | No description |
Log
objectProperties
log string | Provides a link to download the log file. |
UpdateSpace
objectProperties
spaceId string | No description |