ancoreMate Content (Preview)

Work with files and data in Qlik Cloud®: find items, upload, copy, move and delete data files and folders, manage data connections and read the changes of write tables (change stores). Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name ancoreSoft
URL https://ancorecloud.com/
Email support@ancoresoft.com
Connector Metadata
Publisher ancoreSoft
Website https://ancorecloud.com/
Privacy policy https://ancoresoft.com/legal/ancoremate/privacy/
Categories Data;Content and Files

ancoreMate Content

Work with files and data in Qlik Cloud®: find items, upload, copy, move and delete data files and folders, manage data connections and read the changes of write tables (change stores).

Qlik®, Qlik Cloud® and Qlik Sense® are trademarks of QlikTech International AB. ancoreMate is not affiliated with or endorsed by Qlik.

Publisher

ancoreSoft

Prerequisites

  • An ancoreCloud account with an ancoreMate subscription. See https://ancorecloud.com/ for details and https://docs.ancoresoft.com/ for the documentation.
  • A Qlik Cloud user with access to the content you want to automate. No OAuth client, client ID or API key needs to be created in Qlik Cloud.

Supported operations

Copy data connection

Creates a copy of a data connection, optionally in another space.

Copy data file

Copies a data file under a new name, optionally into another space.

Create data connection

Creates a data connection in a space.

Create data folder

Creates a folder for data files in a space or the personal space.

Delete data connection

Deletes a data connection.

Delete data file

Deletes a data file.

Delete data files

Deletes several data files at once.

Get Qlik connection

Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.

Get change store

Returns a change store.

Get data connection

Returns a data connection.

Get data file

Returns the details of a data file.

Get item

Returns an item of the tenant.

List change store columns

Lists the editable columns of a change store.

List change store table

Lists the edits of a change store as table rows.

List change stores

Lists the change stores that keep the edits of write tables.

List current changes

Lists the current edits in a change store.

List data connections

Lists the data connections the connected user can use.

List data file connections

Lists the data file connections, one per space with data files.

List data files

Lists the data files in a space or in the personal space.

List items

Lists the items of the tenant such as apps, data files, notes and automations. Filter by type, name or space.

Send Qlik Cloud request

Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.

Update data connection

Replaces the settings of a data connection.

Upload data file

Uploads a data file, for example CSV or Excel, into a space or the personal space. A file with the same name is replaced unless If the file exists is set to Fail. Files up to 30 MB can be sent and files up to 50 MB returned.

Obtaining credentials

  1. Create a connection and select Sign in.
  2. Sign in with your ancoreCloud account.
  3. The first time, enter your Qlik Cloud tenant, for example company.eu.qlikcloud.com, sign in at Qlik Cloud and approve the access for ancoreMate. Later sign-ins list the Qlik Cloud connections of your ancoreCloud account: continue with one of them, or add another tenant or Qlik user. Each connection works with the Qlik Cloud connection chosen in its sign-in; the others stay as they are.
  4. If your Qlik Cloud administrators require it, an administrator approves ancoreMate once in the Qlik Cloud administration (Integrations > OAuth).

Getting started

Use Upload data file to put a CSV or Excel file, for example from SharePoint, into a space, and reload the app that reads it with the ancoreMate Reloads connector.

Known issues and limitations

  • Data files larger than 30 MB cannot be uploaded through the connector.
  • Change stores have no trigger, because Qlik Cloud sends no event for them.
  • Qlik Cloud offers no interface to download the content of a data file; data files can be uploaded, replaced, copied, listed and deleted, and loaded by apps.
  • Only Qlik Cloud tenants are supported; Qlik Sense client-managed (on-premises) deployments are not supported.
  • Qlik Cloud rate limits apply. When Qlik Cloud limits requests, the action fails with status 429; the flow's retry policy retries it automatically.
  • Each connection works with one Qlik Cloud tenant and Qlik user, chosen in its sign-in. To work with several tenants or Qlik users, for example development and production, create one connection per tenant or user; a flow can use several of them.

Deployment instructions

Use the instructions to deploy a custom connector with the files apiDefinition.swagger.json and apiProperties.json of this folder.

Actions

Copy data connection

Creates a copy of a data connection, optionally in another space.

Copy data file

Copies a data file under a new name, optionally into another space.

Create data connection

Creates a data connection in a space.

Create data folder

Creates a folder for data files in a space or the personal space.

Delete data connection

Deletes a data connection.

Delete data file

Deletes a data file.

Delete data files

Deletes several data files at once.

Get change store

Returns a change store.

Get data connection

Returns a data connection.

Get data file

Returns the details of a data file.

Get item

Returns an item of the tenant.

Get Qlik connection

Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.

List change store columns

Lists the editable columns of a change store.

List change store table

Lists the edits of a change store as table rows.

List change stores

Lists the change stores that keep the edits of write tables.

List current changes

Lists the current edits in a change store.

List data connections

Lists the data connections the connected user can use.

List data file connections

Lists the data file connections, one per space with data files.

List data files

Lists the data files in a space or in the personal space.

List items

Lists the items of the tenant such as apps, data files, notes and automations. Filter by type, name or space.

Send Qlik Cloud request

Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.

Update data connection

Replaces the settings of a data connection.

Upload data file

Uploads a data file, for example CSV or Excel, into a space or the personal space. A file with the same name is replaced unless If the file exists is set to Fail. Files up to 30 MB can be sent and files up to 50 MB returned.

Copy data connection

Creates a copy of a data connection, optionally in another space.

Parameters

Name Key Required Type Description
ID
id True string

ID of the source connection being duplicated.

Name
name string

Optional name for the duplicated connection, must be unique in the target scope.

Space ID
spaceId string

Optional target space ID for the duplicated connection.

Q Password
qPassword string

Optional credential password, specify to override credential embedded (or associated) with the source connection.

Q Username
qUsername string

Optional credential username, specify to override credential embedded (or associated) with the source connection.

Returns

Essential fields of a connection.

Copy data file

Copies a data file under a new name, optionally into another space.

Parameters

Name Key Required Type Description
Data file
dataFileId True string

The data file.

Name
name True string

The name of the copy, for example sales-2025.csv.

Space
dataFileConnectionId string

The data file connection of the space. Leave empty for the personal space.

Folder ID
folderId string

The ID of the folder, for example from Create data folder.

Returns

A data file.

Body
DataFile

Create data connection

Creates a data connection in a space.

Parameters

Name Key Required Type Description
Q ID
qID string

Unique identifier (UUID) for the data connection.

Tags
tags array of string

List of tags attached to the connection (allow max 31 tags).

Owner
owner string

App ID.

Q Name
qName string

Descriptive name of the data connection.

Q Type
qType string

Type of connection - indicates connection provider type.

Space
space string

ID of the space in which the connection shall be created.

Q Log On
qLogOn integer

The type of user of the data connection: 0 for the service user, 1 for the current user.

Q Password
qPassword string

Any logon password associated with the data connection (connector encoded).

Q Username
qUsername string

Any logon username associated with the data connection.

Datasource ID
datasourceID string

ID of the datasource of the connection.

QRI In Request
qriInRequest string

QRI string of the connection.

Q Architecture
qArchitecture integer

The q architecture.

Q Credentials ID
qCredentialsID string

ID of the credential associated with the connection.

Q Engine Object ID
qEngineObjectID string

Unique identifier (UUID) for the data connection as specified by the Sense engine.

Q Credentials Name
qCredentialsName string

Name of the credential associated with the connection.

Q Connect Statement
qConnectStatement string

Connection string for the data connection.

Q Connection Secret
qConnectionSecret string

String that contains connection specific secret (or password) that requires encryption before persist to database.

Q Separate Credentials
qSeparateCredentials boolean

Indicates whether or not to create a credential-less connection.

Auth URL Only
authUrlOnly boolean

When set to true, only authentication URL will be returned (i.e.

Connection Properties
connectionProperties object

Connection properties required to create dataconnection for the given datasource, which is defined by the response of 'GET /v1/data-sources/:{datasourceId}/api-specs'.

Returns

Essential fields of a connection.

Create data folder

Creates a folder for data files in a space or the personal space.

Parameters

Name Key Required Type Description
Name
name True string

The name of the folder.

Space
dataFileConnectionId string

The data file connection of the space. Leave empty for the personal space.

Folder ID
folderId string

The ID of the folder, for example from Create data folder.

Returns

A data file.

Body
DataFile

Delete data connection

Deletes a data connection.

Parameters

Name Key Required Type Description
Data Connection ID
dataConnectionId True string

Connection ID.

Delete data file

Deletes a data file.

Parameters

Name Key Required Type Description
Data File ID
dataFileId True string

The ID of the data file or folder to delete.

Delete data files

Deletes several data files at once.

Parameters

Name Key Required Type Description
Data file IDs
ids True array of string

The IDs of the data files to delete.

Returns

The result of delete data files.

Get change store

Returns a change store.

Parameters

Name Key Required Type Description
Space
spaceId string

The space of the change store. Only narrows the list of change stores; leave empty when you enter the store ID.

Store ID
storeId True string

The id of the change store.

Returns

A change store.

Get data connection

Returns a data connection.

Parameters

Name Key Required Type Description
Data Connection ID
dataConnectionId True string

Connection ID.

Returns

Essential fields of a connection.

Get data file

Returns the details of a data file.

Parameters

Name Key Required Type Description
Data File ID
dataFileId True string

The ID of the data file.

Returns

A data file.

Body
DataFile

Get item

Returns an item of the tenant.

Parameters

Name Key Required Type Description
Item ID
itemId True string

The item's unique identifier.

Returns

An item.

Body
Item

Get Qlik connection

Returns whether ancoreMate is connected to a Qlik Cloud tenant, and to which tenant and Qlik user.

Returns

The connection between ancoreMate and Qlik Cloud.

Body
Connection

List change store columns

Lists the editable columns of a change store.

Parameters

Name Key Required Type Description
Space
spaceId string

The space of the change store. Only narrows the list of change stores; leave empty when you enter the store ID.

Store ID
storeId True string

The id of the change store.

Filter
filter string

A SCIM filter expression used to filter the result.

Sort
sort string

Sort results by a field, with optional + (asc) or - (desc) prefix.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of change store items.

List change store table

Lists the edits of a change store as table rows.

Parameters

Name Key Required Type Description
Space
spaceId string

The space of the change store. Only narrows the list of change stores; leave empty when you enter the store ID.

Store ID
storeId True string

The id of the change store.

Filter
filter string

A SCIM filter expression used to filter the result.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of change store items.

List change stores

Lists the change stores that keep the edits of write tables.

Parameters

Name Key Required Type Description
Filter
filter string

A SCIM filter expression used to filter the result.

Sort
sort string

Sort results by a field, with optional + (asc) or - (desc) prefix.

Space ID
spaceId True string

The space ID to filter change stores by.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of change store items.

List current changes

Lists the current edits in a change store.

Parameters

Name Key Required Type Description
Space
spaceId string

The space of the change store. Only narrows the list of change stores; leave empty when you enter the store ID.

Store ID
storeId True string

The id of the change store.

Filter
filter string

A SCIM filter expression used to filter the result.

Sort
sort string

Sort results by a field, with optional + (asc) or - (desc) prefix.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of change store items.

List data connections

Lists the data connections the connected user can use.

Parameters

Name Key Required Type Description
Data Name
dataName string

Provides an alternate name to be used for data[] element in GET response.

Personal
personal boolean

Filtering on personal connections, ignored if spaceId is defined in same request.

Owner
owner string

Filtering on datafile connections by owner (i.e.

Sort
sort string

Name of field sort on for pagination, with prefix with + or - indicating ascending or descending order.

Filter
filter string

Filtering resources by properties (filterable properties only) using SCIM filter string.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of data connection items.

List data file connections

Lists the data file connections, one per space with data files.

Parameters

Name Key Required Type Description
App ID
appId string

If present, get connections with connection strings that are scoped to the given app ID.

Name
name string

If present, only return connections with the given name.

Personal
personal boolean

If true, only return the connections that access data in a personal space.

Sort
sort string

The name of the field used to sort the result.

Space ID
spaceId string

If present, only return the connection that accesses data files in the specified space.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of data file items.

List data files

Lists the data files in a space or in the personal space.

Parameters

Name Key Required Type Description
App ID
appId string

Only return files scoped to the specified app.

Base Name Wildcard
baseNameWildcard string

Returns only files whose name matches this pattern; * stands for any text and ? for one character, for example sales* or *.csv.

Data File Connection ID
dataFileConnectionId string

Return files and folders that reside in the space referenced by the specified DataFiles connection.

Folder Path
folderPath string

If present, return only items which reside under the specified folder path.

Include Folders
includeFolders boolean

If set to true, include folders in the returned list.

Name
name string

Returns only the data file with exactly this name, for example sales.csv. To find files by a part of the name, use Base name wildcard.

Owner ID
ownerId string

If present, fetch the data files for the specified owner.

Sort
sort string

The name of the field used to sort the result.

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of data file items.

List items

Lists the items of the tenant such as apps, data files, notes and automations. Filter by type, name or space.

Parameters

Name Key Required Type Description
Collection ID
collectionId string

The collection's unique identifier.

Name
name string

The case-insensitive string used to search for a resource by name.

Owner ID
ownerId string

Owner identifier.

Query
query string

The case-insensitive string used to search for a resource by name or description.

Resource Type
resourceType string

The case-sensitive string used to filter items by resourceType(s).

Sort
sort string

The property of a resource to sort on (default sort is +createdAt).

Space ID
spaceId string

The space's unique identifier (supports 'personal' as spaceId).

Space Type
spaceType string

The case-sensitive string used to filter items on space type(s).

Limit
limit integer

The maximum number of items to return, between 1 and 5000.

Returns

A list of item items.

Body
ItemList

Send Qlik Cloud request

Calls any REST API of your Qlik Cloud tenant below /api/v1/ with the connected user's rights, for operations that have no action of their own.

Parameters

Name Key Required Type Description
Method
method True string

The HTTP method.

Path
path True string

The path below /api/v1/, for example spaces or apps/1234/reloads/logs.

Query
query string

Query parameters as in a URL, for example limit=10&name=Sales.

Body
body object

The JSON body for POST, PUT, PATCH and DELETE, for example the IDs of the items to delete.

Returns

The JSON response of Qlik Cloud, unchanged.

response
object

Update data connection

Replaces the settings of a data connection.

Parameters

Name Key Required Type Description
Data Connection ID
dataConnectionId True string

Connection ID.

Q ID
qID True string

Unique identifier for the data connection.

Q Name
qName True string

Descriptive name of the data connection.

Q Type
qType True string

Type of connection - indicates connection provider type.

Space
space string

ID of the space to which the connection belongs.

Q Log On
qLogOn integer

The type of user of the data connection: 0 for the service user, 1 for the current user.

Q Password
qPassword string

Any logon password associated with the data connection.

Q Username
qUsername string

Any logon username associated with the data connection.

Datasource ID
datasourceID string

ID of the datasource associated with this connection.

Q Architecture
qArchitecture integer

The q architecture.

Q Credentials ID
qCredentialsID string

ID of the credential associated with the connection.

Q Engine Object ID
qEngineObjectID True string

Unique identifier for the data connection as specified by the Sense engine.

Q Credentials Name
qCredentialsName string

Name of the credential associated with the connection.

Q Connect Statement
qConnectStatement True string

Connection string for the data connection.

Q Connection Secret
qConnectionSecret string

String that contains connection level secret (or password).

Q Separate Credentials
qSeparateCredentials boolean

Indicates whether or not this is a credential-less connection.

Upload data file

Uploads a data file, for example CSV or Excel, into a space or the personal space. A file with the same name is replaced unless If the file exists is set to Fail. Files up to 30 MB can be sent and files up to 50 MB returned.

Parameters

Name Key Required Type Description
Name
name True string

The file name, for example sales.csv.

Space
dataFileConnectionId string

The data file connection of the space. Leave empty for the personal space.

Folder ID
folderId string

The ID of the folder, for example from Create data folder.

If the file exists
ifExists string

What happens when a data file with this name already exists in the space or folder: replace (the default) replaces its content, fail stops with an error.

Data file to replace
dataFileId string

The data file to replace, also under another name. Leave empty to upload by name.

File content
file True binary

The content of the data file.

Returns

A data file.

Body
DataFile

Definitions

ChangeStore

A change store.

Name Path Type Description
Used By
usedBy array of object

List of chart/app references.

App ID
usedBy.appId string

The id of the app.

Chart ID
usedBy.chartId string

The id of the chart.

Space ID
spaceId string

The space id where the change store is located.

Store ID
storeId string

The id of the change store.

Tenant ID
tenantId string

The tenant id the change store belongs to.

Created At
createdAt date-time

The time when the change store was created.

Created By
createdBy string

The id of the user who created the change store.

Store Name
storeName string

The name of the change store.

Updated At
updatedAt date-time

The time when the change store was last updated.

Primary Key
primaryKey array of string

The list of primary key columns for the change store.

Reference ID
referenceId string

The reference id used to identify related editable-columns or change stores.

Publish Ref ID
publishRefId string

The publish reference id used to map stores across published apps/spaces.

ChangeStoreChange

A change store.

Name Path Type Description
Row Key
cellKey.rowKey object

A map of row keys.

Column ID
cellKey.columnId string

The id of the column.

Changes
changes array of object

The changes.

Tenant ID
changes.tenantId string

The tenant id.

Cell Value
changes.cellValue string

The value of the cell.

Committed
changes.committed boolean

Whether the change has been committed.

Created At
changes.createdAt date-time

The time when a user starts typing in a cell and the row becomes locked.

Created By
changes.createdBy string

The id of the user who created the change.

Updated At
changes.updatedAt date-time

The time when an update to the change has been done.

Column Name
columnName string

The name of the column.

ChangeStoreChangeList

A list of change store items.

Name Path Type Description
Items
value array of ChangeStoreChange

The items.

ChangeStoreColumn

A change store.

Name Path Type Description
ID
id string

The unique id of the editable column.

Type
type string

Type of the editable column.

Max Date
config.maxDate date

Maximum selectable date for editable-date columns (ISO 8601 date).

Min Date
config.minDate date

Minimum selectable date for editable-date columns (ISO 8601 date).

Selector Type
config.selectorType string

Type of selector.

Selector Values
config.selectorValues array of object

List of value/label key/value pairs.

Label
config.selectorValues.label string

The Label of the selector.

Value
config.selectorValues.value string

The Value of the selector.

Selector Expression
config.selectorExpression string

Expression used to create dynamic selector values.

Used By
usedBy array of object

List of chart/app references.

App ID
usedBy.appId string

The id of the app.

Chart ID
usedBy.chartId string

The id of the chart.

Space ID
spaceId string

The space id that the editable columns are associated with.

Store ID
storeId string

Store id.

Tenant ID
tenantId string

Tenant id.

Created At
createdAt date-time

Timestamp of creation.

Created By
createdBy string

The user who created the column.

Updated At
updatedAt date-time

Timestamp of last update.

Column Name
columnName string

Name of the editable column.

Reference ID
referenceId string

The unique id used to keep a reference of editable columns in multiple spaces.

Publish Ref ID
publishRefId string

The publish reference id used to relate editable columns between published apps/spaces.

Selector Values
selectorValues array of object

List of value/label key/value pairs.

Label
selectorValues.label string

The Label of the selector.

Value
selectorValues.value string

The Value of the selector.

ChangeStoreColumnList

A list of change store items.

Name Path Type Description
Items
value array of ChangeStoreColumn

The items.

ChangeStoreList

A list of change store items.

Name Path Type Description
Items
value array of ChangeStore

The items.

ChangeStoreRow

A change store.

Name Path Type Description
Updated At
updatedAt date-time

The timestamp when the row was last updated.

Updated By
updatedBy string

The user id that performed the latest update in the row (corresponds to updatedAt).

ChangeStoreRowList

A list of change store items.

Name Path Type Description
Items
value array of ChangeStoreRow

The items.

Connection

The connection between ancoreMate and Qlik Cloud.

Name Path Type Description
Connected
connected boolean

Whether ancoreMate is connected to Qlik Cloud.

Qlik Cloud tenant
tenantHost string

The host name of the connected Qlik Cloud tenant.

Qlik user
qlikUserName string

The name of the connected Qlik Cloud user.

Connected at
connectedAt date-time

The time the connection was established.

CopyDataConnectionResponse

Essential fields of a connection.

Name Path Type Description
Q ID
qID string

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID.

User
user string

User ID of the connection's creator.

Href
links.self.href string

URL pointing to the resource.

Q Name
qName string

Descriptive name of the data connection.

Q Type
qType string

Type of connection - indicates connection provider type.

Space
space string

ID of the space to which the connection belongs.

Q Log On
qLogOn integer

The type of user of the data connection: 0 for the service user, 1 for the current user.

Created
created string

Datetime when the connection was created.

Updated
updated string

Datetime when the connection was last updated.

Privileges
privileges array of string

Array of string (i.e.

Q Architecture
qArchitecture integer

The q architecture.

Q Reference Key
qReferenceKey string

Reference key of credential in redis.

Q Credentials ID
qCredentialsID string

ID of the credential associated with the connection.

Q Engine Object ID
qEngineObjectID string

Unique identifier (UUID) for the data connection, must be same as qID.

Q Credentials Name
qCredentialsName string

Name of the credential associated with the connection.

Q Connect Statement
qConnectStatement string

Connection string for the data connection.

Q Separate Credentials
qSeparateCredentials boolean

Indicates whether or not this is a credential-less connection.

CreateDataConnectionResponse

Essential fields of a connection.

Name Path Type Description
Q ID
qID string

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID.

User
user string

User ID of the connection's creator.

Href
links.self.href string

URL pointing to the resource.

Q Name
qName string

Descriptive name of the data connection.

Q Type
qType string

Type of connection - indicates connection provider type.

Space
space string

ID of the space to which the connection belongs.

Q Log On
qLogOn integer

The type of user of the data connection: 0 for the service user, 1 for the current user.

Created
created string

Datetime when the connection was created.

Updated
updated string

Datetime when the connection was last updated.

Privileges
privileges array of string

Array of string (i.e.

Q Architecture
qArchitecture integer

The q architecture.

Q Reference Key
qReferenceKey string

Reference key of credential in redis.

Q Credentials ID
qCredentialsID string

ID of the credential associated with the connection.

Q Engine Object ID
qEngineObjectID string

Unique identifier (UUID) for the data connection, must be same as qID.

Q Credentials Name
qCredentialsName string

Name of the credential associated with the connection.

Q Connect Statement
qConnectStatement string

Connection string for the data connection.

Q Separate Credentials
qSeparateCredentials boolean

Indicates whether or not this is a credential-less connection.

Auth URL
authUrl string

Authentication URL used to generate authentication code for datasources supporting OAuth.

DataConnection

Essential fields of a connection.

Name Path Type Description
Q ID
qID string

Unique identifier (UUID) for the data connection, must be same as qEngineObjectID.

QRI
qri string

Encrypted base Qri string (filterable using SCIM filter, e.g.

Tags
tags array of string

List of tags attached to the connection.

User
user string

User ID of the connection's creator.

Href
links.self.href string

URL pointing to the resource.

Q Name
qName string

Descriptive name of the data connection.

Q Type
qType string

Type of connection, i.e.

Space
space string

ID of the space to which the connection belongs.

Q Log On
qLogOn integer

The type of user of the data connection: 0 for the service user, 1 for the current user.

Tenant
tenant string

Tenant ID of the connection's creator.

Created
created string

Datetime when the connection was created.

Updated
updated string

Datetime when the connection was last updated.

Privileges
privileges array of string

Array of string (i.e.

Datasource ID
datasourceID string

Data source ID.

Q Architecture
qArchitecture integer

The q architecture.

Q Credentials ID
qCredentialsID string

ID of the credential associated with the connection.

Q Engine Object ID
qEngineObjectID string

Unique identifier (UUID) for the data connection, must be same as qID.

Q Connect Statement
qConnectStatement string

Connection string for the data connection.

Q Connection Secret
qConnectionSecret string

String that contains connection specific secret (or password).

Connection Properties
connectionProperties object

List of connection parsed from connection string (only available when query parseConnection=true is set).

Q Separate Credentials
qSeparateCredentials boolean

Indicates whether or not this is a credential-less connection.

DataConnectionList

A list of data connection items.

Name Path Type Description
Items
value array of DataConnection

The items.

DataFile

A data file.

Name Path Type Description
ID
id string

The ID for the file or folder.

QRI
qri string

The QRI generated from the datafile or folder's metadata.

Name
name string

The full name of the file or folder, including any folder path prefix.

Size
size integer

The size of the uploaded file, in bytes.

App ID
appId string

If this file or folder is bound to the lifecycle of a specific app, this is the ID of this app.

Folder
folder boolean

Whether or not this given item represents a folder or a file.

Actions
actions array of string

The CRUD actions that are allowed on the given data file.

Owner ID
ownerId string

The 'owner' of a file or folder is the user who last uploaded the item's content.

Space ID
spaceId string

If the file or folder was created in a team space, this is the ID of that space.

Base Name
baseName string

The name of the file or folder, not including any folder path prefix.

Folder ID
folderId string

If the file or folder resides in a parent folder, this is the parent folder ID.

Folder Path
folderPath string

If the file or folder resides in a parent folder, this is the parent folder path.

Created Date
createdDate date-time

The date that the file or folder was created.

Total File Count
folderStats.totalFileCount integer

The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct File Count
folderStats.directFileCount integer

The number of data files that reside as direct children of the given folder.

Total Folder Count
folderStats.totalFolderCount integer

The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Aggregate File Size
folderStats.aggregateFileSize integer

The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct Folder Count
folderStats.directFolderCount integer

The number of sub-folders that reside as direct children of the given folder.

Total Internal File Count
folderStats.totalInternalFileCount integer

The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct Internal File Count
folderStats.directInternalFileCount integer

The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.

Total App Scoped File Count
folderStats.totalAppScopedFileCount integer

The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct App Scoped File Count
folderStats.directAppScopedFileCount integer

The number of app-scoped data files that reside as direct children of the given folder.

Aggregate Internal File Size
folderStats.aggregateInternalFileSize integer

The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Aggregate App Scoped File Size
folderStats.aggregateAppScopedFileSize integer

The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Modified Date
modifiedDate date-time

The date that the updated file or folder was last modified.

Content Updated Date
contentUpdatedDate date-time

If the data file's content was updated, this is the DateTime of the last content update.

DataFileConnection

A data file.

Name Path Type Description
ID
id string

The unique identifier of the connection.

Name
name string

The name of the connection.

Type
type string

The type of the connection.

Space ID
spaceId string

The team space that the given connection is associated with.

Total File Count
spaceStats.totalFileCount integer

The number of data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct File Count
spaceStats.directFileCount integer

The number of data files that reside as direct children of the given folder.

Total Folder Count
spaceStats.totalFolderCount integer

The number of folders that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Aggregate File Size
spaceStats.aggregateFileSize integer

The sum of the file sizes, in bytes, of all data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct Folder Count
spaceStats.directFolderCount integer

The number of sub-folders that reside as direct children of the given folder.

Total Internal File Count
spaceStats.totalInternalFileCount integer

The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct Internal File Count
spaceStats.directInternalFileCount integer

The number of 'internal' data files (IE, those that are not visible to end users by default) that reside as direct children of the given folder.

Total App Scoped File Count
spaceStats.totalAppScopedFileCount integer

The number of app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Direct App Scoped File Count
spaceStats.directAppScopedFileCount integer

The number of app-scoped data files that reside as direct children of the given folder.

Aggregate Internal File Size
spaceStats.aggregateInternalFileSize integer

The sum of the file sizes, in bytes, of all internal data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Aggregate App Scoped File Size
spaceStats.aggregateAppScopedFileSize integer

The sum of the file sizes, in bytes, of all app-scoped data files that reside as direct and indirect children of the given folder and it's sub-folder hierarchy.

Connect Statement
connectStatement string

The connect statement that will be passed to the connector when invoked.

DataFileConnectionList

A list of data file items.

Name Path Type Description
Items
value array of DataFileConnection

The items.

DataFileList

A list of data file items.

Name Path Type Description
Items
value array of DataFile

The items.

DeleteDataFilesResponse

The result of delete data files.

Name Path Type Description
Data
data array of object

List of individual results for the items in the specified batch.

ID
data.id string

The unique identifier of the file.

Code
data.code string

Fine-grained error codes for data-files REST operations.

Title
data.title string

Summary of the problem.

Detail
data.detail string

A human-readable explanation specific to this occurrence of the problem.

Status
data.status integer

The HTTP status code.

GetChangeStoreResponse

A change store.

Name Path Type Description
Used By
data.usedBy array of object

List of chart/app references.

App ID
data.usedBy.appId string

The id of the app.

Chart ID
data.usedBy.chartId string

The id of the chart.

Space ID
data.spaceId string

The space id where the change store is located.

Store ID
data.storeId string

The id of the change store.

Tenant ID
data.tenantId string

The tenant id the change store belongs to.

Created At
data.createdAt date-time

The time when the change store was created.

Created By
data.createdBy string

The id of the user who created the change store.

Store Name
data.storeName string

The name of the change store.

Updated At
data.updatedAt date-time

The time when the change store was last updated.

Primary Key
data.primaryKey array of string

The list of primary key columns for the change store.

Reference ID
data.referenceId string

The reference id used to identify related editable-columns or change stores.

Publish Ref ID
data.publishRefId string

The publish reference id used to map stores across published apps/spaces.

Item

An item.

Name Path Type Description
ID
id string

The item's unique identifier.

Tags
meta.tags array of object

An array of tags that the item is part of.

ID
meta.tags.id string

The ID of the tag/collection.

Name
meta.tags.name string

The name of the tag/collection.

Actions
meta.actions array of string

The actions that the user can perform on the item.

Collections
meta.collections array of object

An array of collections that the item is part of.

ID
meta.collections.id string

The ID of the tag/collection.

Name
meta.collections.name string

The name of the tag/collection.

Is Favorited
meta.isFavorited boolean

The flag that indicates if item is in the user's favorites collection.

Name
name string

The name.

Href
links.open.href uri

The href.

Href
links.self.href uri

The href.

Href
links.qvPlugin.href uri

The href.

Href
links.thumbnail.href uri

The href.

Href
links.collections.href uri

The href.

Actions
actions array of string

The actions that the user can perform on the item.

Owner ID
ownerId string

The ID of the user who owns the item.

Space ID
spaceId string

The space's unique identifier.

Tenant ID
tenantId string

The ID of the tenant that owns the item.

Created At
createdAt date-time

The RFC3339 datetime when the item was created.

Creator ID
creatorId string

The ID of the user who created the item.

Week
itemViews.week array of object

The week.

Start
itemViews.week.start date-time

The RFC3339 datetime representing the start of the referenced week.

Total
itemViews.week.total integer

Total number of views the resource got during the referenced week.

Unique
itemViews.week.unique integer

Number of unique users who viewed the resource during the referenced week.

Total
itemViews.total integer

Total number of views the resource got during the last 28 days.

Trend
itemViews.trend number

Trend in views over the last 4 weeks.

Unique
itemViews.unique integer

Number of unique users who viewed the resource during the last 28 days.

Used By
itemViews.usedBy integer

Number of apps this dataset is used in (datasets only).

Updated At
updatedAt date-time

The RFC3339 datetime when the item was last updated.

Updater ID
updaterId string

ID of the user who last updated the item.

Resource ID
resourceId string

The case-sensitive string used to search for an item by resourceId.

Description
description string

The description.

Is Favorited
isFavorited boolean

The flag that indicates if item is in the user's favorites collection.

Thumbnail ID
thumbnailId string

The item thumbnail's unique identifier.

Resource Link
resourceLink uri

The case-sensitive string used to search for an item by resourceLink.

App File
resourceSize.appFile number

Size of the app on disk in bytes.

App Memory
resourceSize.appMemory number

Size of the app in memory in bytes.

Resource Type
resourceType string

The case-sensitive string defining the item's type.

Collection IDs
collectionIds array of string

The ID of the collections that the item has been added to.

Resource Sub Type
resourceSubType string

Optional field defining the item's subtype, if any.

Resource Created At
resourceCreatedAt date-time

The RFC3339 datetime when the resource that the item references was created.

Resource Updated At
resourceUpdatedAt date-time

The RFC3339 datetime when the resource that the item references was last updated.

Resource Attributes
resourceAttributes object

The resource attributes.

Resource Reload Status
resourceReloadStatus string

If the resource last reload was successful or not.

Resource Reload End Time
resourceReloadEndTime date-time

The RFC3339 datetime when the resource last reload ended.

Resource Custom Attributes
resourceCustomAttributes object

The resource custom attributes.

ItemList

A list of item items.

Name Path Type Description
Items
value array of Item

The items.

object

This is the type 'object'.