Apps

Attributes that the user wants to set in new app.

OK

The name of the target app.

The space ID of the target app.

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

NEW

AUTOREPLACE

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

The file ID to be downloaded from Temporary Content Service (TCS) and used during import.

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

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.

Path of the source app.

OK

Not Found

OK

Identifier of the app.

OK

Identifier of the app.

OK

Identifier of the app.

Attributes that user wants to set.

OK

Identifier of the app.

Attributes that should be set in the copy.

OK

Identifier of the app.

OK

Identifier of the app.

OK

Identifier of the app.

The flag indicating if only object contents should be exported.

Created

Bad request

Forbidden

Not Found

Unique application identifier.

Path to file content.

OK

Forbidden

Not Found

Unique application identifier.

Path to file content.

OK

Forbidden

Not Found

Unique application identifier.

Path to file content.

OK

Forbidden

Not Found

Unique application identifier.

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

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.

OK

Forbidden

Not Found

Unique application identifier.

OK

Forbidden

Not Found

Identifier of the app.

New owner.

OK

Forbidden

Not Found

Identifier of the app.

Publish information for the app.

OK

Identifier of the app.

Republish information for the app.

OK

Identifier of the app.

OK

Identifier of the app.

Identifier of the reload.

OK

Identifier of the app.

New space.

OK

Identifier of the app.

OK

The name (title) of the application

The description of the application

The space ID of the application

Set custom locale instead of the system default

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

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

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

The App ID.

App name.

App description.

App thumbnail.

Date and time of the last reload of the app.

The date and time when the app was created.

The date and time when the app was modified.

The owner of the app.

The dynamic color of the app.

True if the app is published on-prem, distributed in QCS, false if not.

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

Contains dynamic JSON data specified by the client.

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

If set to true, the app is encrypted.

The Origin App ID for published apps.

True if the app is a Direct Query app, false if not

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

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

The name (title) of the application.

The description of the application.

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).

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

Static memory usage for the app.

List of field descriptions.

List of table descriptions.

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

Profiling data of the tables in the app.

Number of CPU milliseconds it took to reload the app.

Maximum number of bytes used during reload of the app.

Number of logical cores available.

RAM available.

Name of the field.

List of table names.

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

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

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

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

Number of distinct field values.

Total number of field values.

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

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 set to true if the value is a numeric. The default value is false.

Field comment.

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

Static RAM memory used in bytes.

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

Name of the table.

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

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

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

Number of rows.

Number of fields.

Number of key fields.

Table comment.

Static RAM memory used in bytes.

Number of rows in the table.

Field values profiling info

Name of the field.

List of tags related to the field.

Sets 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:

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.

Number of distinct values

Number of distinct numeric values

Number of distinct text values

Number of numeric values

Number of null values

Number of textual values

Number of negative values

Number of positive values

Number of zero values for numerical values

Sum of all numerical values. NaN otherwise.

Squared sum of all numerical values. NaN otherwise.

Average of all numerical values. NaN otherwise.

Median of all numerical values. NaN otherwise.

Standard deviation of numerical values. NaN otherwise.

Minimum value of numerical values. NaN otherwise.

Maximum value of numerical values. NaN otherwise.

Skewness of the numerical values. NaN otherwise.

Kurtosis of the numerical values. NaN otherwise.

The .01, .05, .1, .25, .5, .75, .9, .95, .99 fractiles. Array of NaN otherwise.

Number of empty strings

Maximum string length of textual values. 0 otherwise.

Minimum string length of textual values. 0 otherwise.

Sum of all characters in strings in the field

Average string length of textual values. 0 otherwise.

For textual values the first sorted string.

For textual values the last sorted string.

Three most frequent values and their frequencies

Type of the field. Default is U.

One of:

• U or UNKNOWN
• A or ASCII
• I or INTEGER
• R or REAL
• F or FIX
• M or MONEY
• D or DATE
• T or TIME
• TS or TIMESTAMP
• IV or INTERVAL

UNKNOWN

ASCII

INTEGER

REAL

FIX

MONEY

DATE

TIME

TIMESTAMP

INTERVAL

Number of decimals. Default is 10.

Defines whether or not a thousands separator must be used. Default is 0.

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.

Defines the decimal separator. Example: .

Defines the thousand separator (if any). Is used if qUseThou is set to 1. Example: ,

Frequency of the above symbol in the field

String value of the symbol. This parameter is optional and present only if Symbol is a string.

Numeric value of the symbol. NaN otherwise.

Number of bins.

Bins edges.

Bins frequencies.

Content library name.

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

Content list items.

Content type.

Unique content identifier.

Unique content link.

Content name.

The managed space ID where the app will be published.

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

source

target

The target ID to be republished.

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

source

target

Validate that source app is same as originally published.

Array of scriptLogMeta.

Reload identifier.

True if the reload was successful.

Duration of reload (ms).

Time when reload ended.

Provides a link to download the log file.