@qlik/api 1.28.0 → 1.30.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.d.ts +20 -0
- package/api-keys.js +2 -2
- package/apps.d.ts +123 -4
- package/apps.js +2 -2
- package/audits.d.ts +1 -1
- package/audits.js +2 -2
- package/auth.js +2 -2
- package/automations.d.ts +49 -37
- package/automations.js +2 -2
- package/brands.js +2 -2
- package/chunks/{5MRIMVKS.js → F5UDCCRD.js} +17 -20
- package/chunks/{QOOCP2TS.js → FKCZFVJL.js} +1 -1
- package/chunks/{NBW6PHZU.js → G6QUM5WQ.js} +27 -6
- package/chunks/{5XNSGPGZ.js → IQBP2PKS.js} +1 -1
- package/chunks/{2BRBIRM2.js → JIX6RMFP.js} +1 -1
- package/chunks/{4D5NADHK.js → OTTC4QSX.js} +1 -1
- package/chunks/{WQYEWU54.js → PTDXR7AY.js} +2 -2
- package/chunks/{KYCIMQ4L.js → QK4TMJ64.js} +1 -1
- package/chunks/{MGXEGSJC.js → QWQLGDMI.js} +2 -2
- package/chunks/{2B7YWDQC.js → TXC5XORK.js} +3 -3
- package/collections.d.ts +1 -1
- package/collections.js +2 -2
- package/csp-origins.js +2 -2
- package/data-assets.d.ts +1 -1
- package/data-assets.js +2 -2
- package/data-connections.d.ts +83 -1
- package/data-connections.js +2 -2
- package/data-credentials.d.ts +28 -0
- package/data-credentials.js +2 -2
- package/data-files.d.ts +90 -0
- package/data-files.js +2 -2
- package/extensions.js +2 -2
- package/glossaries.d.ts +34 -14
- package/glossaries.js +2 -2
- package/groups.d.ts +70 -0
- package/groups.js +2 -2
- package/identity-providers.js +2 -2
- package/index.d.ts +6 -2
- package/index.js +33 -4
- package/items.d.ts +1 -1
- package/items.js +2 -2
- package/licenses.d.ts +191 -0
- package/licenses.js +2 -2
- package/oauth-clients.d.ts +516 -0
- package/oauth-clients.js +112 -0
- package/package.json +5 -4
- package/qix.d.ts +19 -3
- package/qix.js +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.d.ts +20 -0
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +41 -10
- package/reloads.js +2 -2
- package/reports.d.ts +159 -17
- package/reports.js +2 -2
- package/roles.d.ts +42 -2
- package/roles.js +2 -2
- package/spaces.d.ts +225 -38
- package/spaces.js +47 -2
- package/temp-contents.js +2 -2
- package/tenants.d.ts +47 -1
- package/tenants.js +2 -2
- package/themes.js +2 -2
- package/transports.d.ts +9 -0
- package/transports.js +2 -2
- package/users.d.ts +88 -0
- package/users.js +2 -2
- package/web-integrations.d.ts +20 -0
- package/web-integrations.js +2 -2
- package/web-notifications.d.ts +19 -0
- package/web-notifications.js +2 -2
- package/webhooks.d.ts +3 -3
- package/webhooks.js +2 -2
package/qix.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { H as HostConfig } from './auth-types-PkN9CAF_.js';
|
|
2
2
|
import './invoke-fetch-types-BXn-uSF5.js';
|
|
3
3
|
|
|
4
|
-
declare const QIX_SCHEMA_VERSION = "12.
|
|
4
|
+
declare const QIX_SCHEMA_VERSION = "12.2385.0";
|
|
5
5
|
type AlfaNumString = {
|
|
6
6
|
/**
|
|
7
7
|
* Calculated value.
|
|
@@ -3752,6 +3752,12 @@ type NxDimensionInfo = {
|
|
|
3752
3752
|
* Refers to a dimension stored in the library.
|
|
3753
3753
|
*/
|
|
3754
3754
|
qLibraryId?: string;
|
|
3755
|
+
/**
|
|
3756
|
+
* The expanded and stripped dimension name used internally in engine.
|
|
3757
|
+
*
|
|
3758
|
+
* Stability: *experimental*
|
|
3759
|
+
*/
|
|
3760
|
+
qEffectiveDimensionName?: string;
|
|
3755
3761
|
};
|
|
3756
3762
|
type NxDimensionType = "D" | "NX_DIMENSION_TYPE_DISCRETE" | "N" | "NX_DIMENSION_TYPE_NUMERIC" | "T" | "NX_DIMENSION_TYPE_TIME";
|
|
3757
3763
|
type NxDownloadInfo = {
|
|
@@ -4156,6 +4162,7 @@ type NxLibraryDimension = {
|
|
|
4156
4162
|
* Alias of the dimension.
|
|
4157
4163
|
*/
|
|
4158
4164
|
qAlias?: string;
|
|
4165
|
+
qScriptGenerated?: boolean;
|
|
4159
4166
|
};
|
|
4160
4167
|
type NxLibraryDimensionDef = {
|
|
4161
4168
|
/**
|
|
@@ -4180,6 +4187,7 @@ type NxLibraryDimensionDef = {
|
|
|
4180
4187
|
* Alias of the dimension.
|
|
4181
4188
|
*/
|
|
4182
4189
|
qAlias?: string;
|
|
4190
|
+
qScriptGenerated?: boolean;
|
|
4183
4191
|
};
|
|
4184
4192
|
/**
|
|
4185
4193
|
* Information about the library measure. Is the layout for _NxLibraryMeasureDef_.
|
|
@@ -4203,6 +4211,7 @@ type NxLibraryMeasure = {
|
|
|
4203
4211
|
* This parameter is optional.
|
|
4204
4212
|
*/
|
|
4205
4213
|
qNumFormat?: FieldAttributes;
|
|
4214
|
+
qScriptGenerated?: boolean;
|
|
4206
4215
|
};
|
|
4207
4216
|
type NxLibraryMeasureDef = {
|
|
4208
4217
|
/**
|
|
@@ -4241,6 +4250,7 @@ type NxLibraryMeasureDef = {
|
|
|
4241
4250
|
* This parameter is optional.
|
|
4242
4251
|
*/
|
|
4243
4252
|
qNumFormat?: FieldAttributes;
|
|
4253
|
+
qScriptGenerated?: boolean;
|
|
4244
4254
|
};
|
|
4245
4255
|
type NxLinkedObjectInfo = {
|
|
4246
4256
|
/**
|
|
@@ -4275,7 +4285,7 @@ type NxListObjectExpressionDef = {
|
|
|
4275
4285
|
*/
|
|
4276
4286
|
qLibraryId?: string;
|
|
4277
4287
|
};
|
|
4278
|
-
type NxLocalizedErrorCode = "LOCERR_INTERNAL_ERROR" | "LOCERR_GENERIC_UNKNOWN" | "LOCERR_GENERIC_OK" | "LOCERR_GENERIC_NOT_SET" | "LOCERR_GENERIC_NOT_FOUND" | "LOCERR_GENERIC_ALREADY_EXISTS" | "LOCERR_GENERIC_INVALID_PATH" | "LOCERR_GENERIC_ACCESS_DENIED" | "LOCERR_GENERIC_OUT_OF_MEMORY" | "LOCERR_GENERIC_NOT_INITIALIZED" | "LOCERR_GENERIC_INVALID_PARAMETERS" | "LOCERR_GENERIC_EMPTY_PARAMETERS" | "LOCERR_GENERIC_INTERNAL_ERROR" | "LOCERR_GENERIC_CORRUPT_DATA" | "LOCERR_GENERIC_MEMORY_INCONSISTENCY" | "LOCERR_GENERIC_INVISIBLE_OWNER_ABORT" | "LOCERR_GENERIC_PROHIBIT_VALIDATE" | "LOCERR_GENERIC_ABORTED" | "LOCERR_GENERIC_CONNECTION_LOST" | "LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION" | "LOCERR_GENERIC_REST_CONNECTION_FAILURE" | "LOCERR_GENERIC_MEMORY_LIMIT_REACHED" | "LOCERR_GENERIC_NOT_IMPLEMENTED" | "LOCERR_HTTP_400" | "LOCERR_HTTP_401" | "LOCERR_HTTP_402" | "LOCERR_HTTP_403" | "LOCERR_HTTP_404" | "LOCERR_HTTP_405" | "LOCERR_HTTP_406" | "LOCERR_HTTP_407" | "LOCERR_HTTP_408" | "LOCERR_HTTP_409" | "LOCERR_HTTP_410" | "LOCERR_HTTP_411" | "LOCERR_HTTP_412" | "LOCERR_HTTP_413" | "LOCERR_HTTP_414" | "LOCERR_HTTP_415" | "LOCERR_HTTP_416" | "LOCERR_HTTP_417" | "LOCERR_HTTP_422" | "LOCERR_HTTP_423" | "LOCERR_HTTP_429" | "LOCERR_HTTP_500" | "LOCERR_HTTP_501" | "LOCERR_HTTP_502" | "LOCERR_HTTP_503" | "LOCERR_HTTP_504" | "LOCERR_HTTP_505" | "LOCERR_HTTP_509" | "LOCERR_HTTP_COULD_NOT_RESOLVE_HOST" | "LOCERR_APP_ALREADY_EXISTS" | "LOCERR_APP_INVALID_NAME" | "LOCERR_APP_ALREADY_OPEN" | "LOCERR_APP_NOT_FOUND" | "LOCERR_APP_IMPORT_FAILED" | "LOCERR_APP_SAVE_FAILED" | "LOCERR_APP_CREATE_FAILED" | "LOCERR_APP_INVALID" | "LOCERR_APP_CONNECT_FAILED" | "LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE" | "LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE" | "LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION" | "LOCERR_APP_MIGRATION_FAILURE" | "LOCERR_APP_SCRIPT_MISSING" | "LOCERR_APP_EXPORT_FAILED" | "LOCERR_APP_SIZE_EXCEEDED" | "LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED" | "LOCERR_APP_NOT_OPEN" | "LOCERR_APP_EVENT_SOURCE_TIMEOUT" | "LOCERR_CONNECTION_ALREADY_EXISTS" | "LOCERR_CONNECTION_NOT_FOUND" | "LOCERR_CONNECTION_FAILED_TO_LOAD" | "LOCERR_CONNECTION_FAILED_TO_IMPORT" | "LOCERR_CONNECTION_NAME_IS_INVALID" | "LOCERR_CONNECTION_MISSING_CREDENTIALS" | "LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT" | "LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE" | "LOCERR_FILE_ACCESS_DENIED" | "LOCERR_FILE_NAME_INVALID" | "LOCERR_FILE_CORRUPT" | "LOCERR_FILE_NOT_FOUND" | "LOCERR_FILE_FORMAT_UNSUPPORTED" | "LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE" | "LOCERR_FILE_TABLE_NOT_FOUND" | "LOCERR_USER_ACCESS_DENIED" | "LOCERR_USER_IMPERSONATION_FAILED" | "LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS" | "LOCERR_SERVER_OUT_OF_SESSION_CALS" | "LOCERR_SERVER_OUT_OF_USAGE_CALS" | "LOCERR_SERVER_OUT_OF_CALS" | "LOCERR_SERVER_OUT_OF_NAMED_CALS" | "LOCERR_SERVER_OFF_DUTY" | "LOCERR_SERVER_BUSY" | "LOCERR_SERVER_LICENSE_EXPIRED" | "LOCERR_SERVER_AJAX_DISABLED" | "LOCERR_SERVER_NO_TOKEN" | "LOCERR_HC_INVALID_OBJECT" | "LOCERR_HC_RESULT_TOO_LARGE" | "LOCERR_HC_INVALID_OBJECT_STATE" | "LOCERR_HC_MODAL_OBJECT_ERROR" | "LOCERR_CALC_INVALID_DEF" | "LOCERR_CALC_NOT_IN_LIB" | "LOCERR_CALC_HEAP_ERROR" | "LOCERR_CALC_TOO_LARGE" | "LOCERR_CALC_TIMEOUT" | "LOCERR_CALC_EVAL_CONDITION_FAILED" | "LOCERR_CALC_MIXED_LINKED_AGGREGATION" | "LOCERR_CALC_MISSING_LINKED" | "LOCERR_CALC_INVALID_COL_SORT" | "LOCERR_CALC_PAGES_TOO_LARGE" | "LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED" | "LOCERR_CALC_VALIDATION_STATE_INVALID" | "LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS" | "LOCERR_CALC_MISSING_LINKED_FIELD" | "LOCERR_CALC_NOT_CALCULATED" | "LOCERR_LAYOUT_EXTENDS_INVALID_ID" | "LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND" | "LOCERR_LAYOUT_LINKED_OBJECT_INVALID" | "LOCERR_PERSISTENCE_WRITE_FAILED" | "LOCERR_PERSISTENCE_READ_FAILED" | "LOCERR_PERSISTENCE_DELETE_FAILED" | "LOCERR_PERSISTENCE_NOT_FOUND" | "LOCERR_PERSISTENCE_UNSUPPORTED_VERSION" | "LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY" | "LOCERR_PERSISTENCE_MIGRATION_CANCELLED" | "LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED" | "LOCERR_PERSISTENCE_DISK_FULL" | "LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP" | "LOCERR_PERSISTENCE_MOVE_FAILED" | "LOCERR_PERSISTENCE_OBJECT_LOCKED" | "LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING" | "LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS" | "LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS" | "LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED" | "LOCERR_RELOAD_IN_PROGRESS" | "LOCERR_RELOAD_TABLE_X_NOT_FOUND" | "LOCERR_RELOAD_UNKNOWN_STATEMENT" | "LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_FIELD_X_NOT_FOUND" | "LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND" | "LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND" | "LOCERR_RELOAD_NAME_ALREADY_TAKEN" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED" | "LOCERR_RELOAD_OPEN_FILE_ERROR" | "LOCERR_RELOAD_AUTO_GENERATE_COUNT" | "LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB" | "LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE" | "LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE" | "LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS" | "LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS" | "LOCERR_RELOAD_NO_OPEN_DATABASE" | "LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY" | "LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE" | "LOCERR_RELOAD_ODBC_CONNECT_FAILED" | "LOCERR_RELOAD_OLEDB_CONNECT_FAILED" | "LOCERR_RELOAD_CUSTOM_CONNECT_FAILED" | "LOCERR_RELOAD_ODBC_READ_FAILED" | "LOCERR_RELOAD_OLEDB_READ_FAILED" | "LOCERR_RELOAD_CUSTOM_READ_FAILED" | "LOCERR_RELOAD_BINARY_LOAD_PROHIBITED" | "LOCERR_RELOAD_CONNECTOR_START_FAILED" | "LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING" | "LOCERR_RELOAD_CONNECTOR_REPLY_ERROR" | "LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR" | "LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR" | "LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS" | "LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD" | "LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT" | "LOCERR_PERSONAL_NEW_VERSION_AVAILABLE" | "LOCERR_PERSONAL_VERSION_EXPIRED" | "LOCERR_PERSONAL_SECTION_ACCESS_DETECTED" | "LOCERR_PERSONAL_APP_DELETION_FAILED" | "LOCERR_USER_AUTHENTICATION_FAILURE" | "LOCERR_EXPORT_OUT_OF_MEMORY" | "LOCERR_EXPORT_NO_DATA" | "LOCERR_SYNC_INVALID_OFFSET" | "LOCERR_SEARCH_TIMEOUT" | "LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL" | "LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW" | "LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT" | "LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED" | "LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED" | "LOCERR_SMART_LOAD_TABLE_NOT_FOUND" | "LOCERR_SMART_LOAD_TABLE_DUPLICATED" | "LOCERR_VARIABLE_NO_NAME" | "LOCERR_VARIABLE_DUPLICATE_NAME" | "LOCERR_VARIABLE_INCONSISTENCY" | "LOCERR_MEDIA_LIBRARY_LIST_FAILED" | "LOCERR_MEDIA_LIBRARY_CONTENT_FAILED" | "LOCERR_MEDIA_BUNDLING_FAILED" | "LOCERR_MEDIA_UNBUNDLING_FAILED" | "LOCERR_MEDIA_LIBRARY_NOT_FOUND" | "LOCERR_FEATURE_DISABLED" | "LOCERR_LOAD_TOO_MANY_FIELDS" | "LOCERR_LOAD_TOO_MANY_TABLES" | "LOCERR_JSON_RPC_INVALID_REQUEST" | "LOCERR_JSON_RPC_METHOD_NOT_FOUND" | "LOCERR_JSON_RPC_INVALID_PARAMETERS" | "LOCERR_JSON_RPC_INTERNAL_ERROR" | "LOCERR_JSON_RPC_PARSE_ERROR" | "LOCERR_MQ_SOCKET_CONNECT_FAILURE" | "LOCERR_MQ_SOCKET_OPEN_FAILURE" | "LOCERR_MQ_PROTOCOL_NO_RESPONE" | "LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION" | "LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED" | "LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED" | "LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR" | "LOCERR_MQ_PROTOCOL_INVALID_STATUS" | "LOCERR_EXTENGINE_GRPC_STATUS_OK" | "LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED" | "LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN" | "LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT" | "LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED" | "LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND" | "LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS" | "LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED" | "LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED" | "LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION" | "LOCERR_EXTENGINE_GRPC_STATUS_ABORTED" | "LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE" | "LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED" | "LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL" | "LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE" | "LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS" | "LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED" | "LOCERR_LXW_INVALID_OBJ" | "LOCERR_LXW_INVALID_FILE" | "LOCERR_LXW_INVALID_SHEET" | "LOCERR_LXW_INVALID_EXPORT_RANGE" | "LOCERR_LXW_ERROR" | "LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED" | "LOCERR_LXW_ERROR_CREATING_XLSX_FILE" | "LOCERR_LXW_ERROR_CREATING_TMPFILE" | "LOCERR_LXW_ERROR_ZIP_FILE_OPERATION" | "LOCERR_LXW_ERROR_ZIP_FILE_ADD" | "LOCERR_LXW_ERROR_ZIP_CLOSE" | "LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED" | "LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED" | "LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED" | "LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND" | "LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE" | "LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED" | "LOCERR_BDI_STATUS_OK" | "LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED" | "LOCERR_TRENDLINE_INVALID_DEF" | "LOCERR_TRENDLINE_INVALID_MATH_ERROR" | "LOCERR_CURL_UNSUPPORTED_PROTOCOL" | "LOCERR_CURL_COULDNT_RESOLVE_PROXY" | "LOCERR_CURL_COULDNT_CONNECT" | "LOCERR_CURL_REMOTE_ACCESS_DENIED" | "LOCERR_CURL_FTP_ACCEPT_FAILED" | "LOCERR_CURL_FTP_ACCEPT_TIMEOUT" | "LOCERR_CURL_FTP_CANT_GET_HOST" | "LOCERR_CURL_PARTIAL_FILE" | "LOCERR_CURL_QUOTE_ERROR" | "LOCERR_CURL_WRITE_ERROR" | "LOCERR_CURL_UPLOAD_FAILED" | "LOCERR_CURL_OUT_OF_MEMORY" | "LOCERR_CURL_OPERATION_TIMEDOUT" | "LOCERR_CURL_FTP_COULDNT_USE_REST" | "LOCERR_CURL_HTTP_POST_ERROR" | "LOCERR_CURL_SSL_CONNECT_ERROR" | "LOCERR_CURL_FILE_COULDNT_READ_FILE" | "LOCERR_CURL_LDAP_CANNOT_BIND" | "LOCERR_CURL_LDAP_SEARCH_FAILED" | "LOCERR_CURL_TOO_MANY_REDIRECTS" | "LOCERR_CURL_PEER_FAILED_VERIFICATION" | "LOCERR_CURL_GOT_NOTHING" | "LOCERR_CURL_SSL_ENGINE_NOTFOUND" | "LOCERR_CURL_SSL_ENGINE_SETFAILED" | "LOCERR_CURL_SSL_CERTPROBLEM" | "LOCERR_CURL_SSL_CIPHER" | "LOCERR_CURL_SSL_CACERT" | "LOCERR_CURL_BAD_CONTENT_ENCODING" | "LOCERR_CURL_LDAP_INVALID_URL" | "LOCERR_CURL_USE_SSL_FAILED" | "LOCERR_CURL_SSL_ENGINE_INITFAILED" | "LOCERR_CURL_LOGIN_DENIED" | "LOCERR_CURL_TFTP_NOTFOUND" | "LOCERR_CURL_TFTP_ILLEGAL" | "LOCERR_CURL_SSH" | "LOCERR_SETEXPRESSION_TOO_LARGE" | "LOCERR_RELOAD_MERGE_LOAD_ERROR" | "LOCERR_WIN_FTP_DROPPED" | "LOCERR_WIN_FTP_NO_PASSIVE_MODE" | "LOCERR_WIN_HTTP_DOWNLEVEL_SERVER" | "LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE" | "LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION" | "LOCERR_WIN_INTERNET_FORCE_RETRY" | "LOCERR_WIN_INTERNET_CANNOT_CONNECT" | "LOCERR_WIN_INTERNET_CONNECTION_ABORTED" | "LOCERR_WIN_INTERNET_CONNECTION_RESET" | "LOCERR_WIN_INTERNET_DISCONNECTED" | "LOCERR_WIN_INTERNET_INCORRECT_FORMAT" | "LOCERR_WIN_INTERNET_INVALID_CA" | "LOCERR_WIN_INTERNET_INVALID_OPERATION" | "LOCERR_WIN_INTERNET_INVALID_URL" | "LOCERR_WIN_INTERNET_ITEM_NOT_FOUND" | "LOCERR_WIN_INTERNET_LOGIN_FAILURE" | "LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED" | "LOCERR_WIN_INTERNET_NEED_UI" | "LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID" | "LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID" | "LOCERR_WIN_INTERNET_SEC_CERT_ERRORS" | "LOCERR_WIN_INTERNET_SEC_INVALID_CERT" | "LOCERR_WIN_INTERNET_SERVER_UNREACHABLE" | "LOCERR_BM_RESULT_TOO_LARGE";
|
|
4288
|
+
type NxLocalizedErrorCode = "LOCERR_INTERNAL_ERROR" | "LOCERR_GENERIC_UNKNOWN" | "LOCERR_GENERIC_OK" | "LOCERR_GENERIC_NOT_SET" | "LOCERR_GENERIC_NOT_FOUND" | "LOCERR_GENERIC_ALREADY_EXISTS" | "LOCERR_GENERIC_INVALID_PATH" | "LOCERR_GENERIC_ACCESS_DENIED" | "LOCERR_GENERIC_OUT_OF_MEMORY" | "LOCERR_GENERIC_NOT_INITIALIZED" | "LOCERR_GENERIC_INVALID_PARAMETERS" | "LOCERR_GENERIC_EMPTY_PARAMETERS" | "LOCERR_GENERIC_INTERNAL_ERROR" | "LOCERR_GENERIC_CORRUPT_DATA" | "LOCERR_GENERIC_MEMORY_INCONSISTENCY" | "LOCERR_GENERIC_INVISIBLE_OWNER_ABORT" | "LOCERR_GENERIC_PROHIBIT_VALIDATE" | "LOCERR_GENERIC_ABORTED" | "LOCERR_GENERIC_CONNECTION_LOST" | "LOCERR_GENERIC_UNSUPPORTED_IN_PRODUCT_VERSION" | "LOCERR_GENERIC_REST_CONNECTION_FAILURE" | "LOCERR_GENERIC_MEMORY_LIMIT_REACHED" | "LOCERR_GENERIC_NOT_IMPLEMENTED" | "LOCERR_HTTP_400" | "LOCERR_HTTP_401" | "LOCERR_HTTP_402" | "LOCERR_HTTP_403" | "LOCERR_HTTP_404" | "LOCERR_HTTP_405" | "LOCERR_HTTP_406" | "LOCERR_HTTP_407" | "LOCERR_HTTP_408" | "LOCERR_HTTP_409" | "LOCERR_HTTP_410" | "LOCERR_HTTP_411" | "LOCERR_HTTP_412" | "LOCERR_HTTP_413" | "LOCERR_HTTP_414" | "LOCERR_HTTP_415" | "LOCERR_HTTP_416" | "LOCERR_HTTP_417" | "LOCERR_HTTP_422" | "LOCERR_HTTP_423" | "LOCERR_HTTP_429" | "LOCERR_HTTP_500" | "LOCERR_HTTP_501" | "LOCERR_HTTP_502" | "LOCERR_HTTP_503" | "LOCERR_HTTP_504" | "LOCERR_HTTP_505" | "LOCERR_HTTP_509" | "LOCERR_HTTP_COULD_NOT_RESOLVE_HOST" | "LOCERR_APP_ALREADY_EXISTS" | "LOCERR_APP_INVALID_NAME" | "LOCERR_APP_ALREADY_OPEN" | "LOCERR_APP_NOT_FOUND" | "LOCERR_APP_IMPORT_FAILED" | "LOCERR_APP_SAVE_FAILED" | "LOCERR_APP_CREATE_FAILED" | "LOCERR_APP_INVALID" | "LOCERR_APP_CONNECT_FAILED" | "LOCERR_APP_ALREADY_OPEN_IN_DIFFERENT_MODE" | "LOCERR_APP_MIGRATION_COULD_NOT_CONTACT_MIGRATION_SERVICE" | "LOCERR_APP_MIGRATION_COULD_NOT_START_MIGRATION" | "LOCERR_APP_MIGRATION_FAILURE" | "LOCERR_APP_SCRIPT_MISSING" | "LOCERR_APP_EXPORT_FAILED" | "LOCERR_APP_SIZE_EXCEEDED" | "LOCERR_APP_DIRECT_QUERY_WORKLOAD_NOT_SUPPORTED" | "LOCERR_APP_NOT_OPEN" | "LOCERR_APP_EVENT_SOURCE_TIMEOUT" | "LOCERR_CONNECTION_ALREADY_EXISTS" | "LOCERR_CONNECTION_NOT_FOUND" | "LOCERR_CONNECTION_FAILED_TO_LOAD" | "LOCERR_CONNECTION_FAILED_TO_IMPORT" | "LOCERR_CONNECTION_NAME_IS_INVALID" | "LOCERR_CONNECTION_MISSING_CREDENTIALS" | "LOCERR_CONNECTOR_NO_FILE_STREAMING_SUPPORT" | "LOCERR_CONNECTOR_FILESIZE_EXCEEDED_BUFFER_SIZE" | "LOCERR_FILE_ACCESS_DENIED" | "LOCERR_FILE_NAME_INVALID" | "LOCERR_FILE_CORRUPT" | "LOCERR_FILE_NOT_FOUND" | "LOCERR_FILE_FORMAT_UNSUPPORTED" | "LOCERR_FILE_OPENED_IN_UNSUPPORTED_MODE" | "LOCERR_FILE_TABLE_NOT_FOUND" | "LOCERR_USER_ACCESS_DENIED" | "LOCERR_USER_IMPERSONATION_FAILED" | "LOCERR_SERVER_OUT_OF_SESSION_AND_USER_CALS" | "LOCERR_SERVER_OUT_OF_SESSION_CALS" | "LOCERR_SERVER_OUT_OF_USAGE_CALS" | "LOCERR_SERVER_OUT_OF_CALS" | "LOCERR_SERVER_OUT_OF_NAMED_CALS" | "LOCERR_SERVER_OFF_DUTY" | "LOCERR_SERVER_BUSY" | "LOCERR_SERVER_LICENSE_EXPIRED" | "LOCERR_SERVER_AJAX_DISABLED" | "LOCERR_SERVER_NO_TOKEN" | "LOCERR_HC_INVALID_OBJECT" | "LOCERR_HC_RESULT_TOO_LARGE" | "LOCERR_HC_INVALID_OBJECT_STATE" | "LOCERR_HC_MODAL_OBJECT_ERROR" | "LOCERR_CALC_INVALID_DEF" | "LOCERR_CALC_NOT_IN_LIB" | "LOCERR_CALC_HEAP_ERROR" | "LOCERR_CALC_TOO_LARGE" | "LOCERR_CALC_TIMEOUT" | "LOCERR_CALC_EVAL_CONDITION_FAILED" | "LOCERR_CALC_MIXED_LINKED_AGGREGATION" | "LOCERR_CALC_MISSING_LINKED" | "LOCERR_CALC_INVALID_COL_SORT" | "LOCERR_CALC_PAGES_TOO_LARGE" | "LOCERR_CALC_SEMANTIC_FIELD_NOT_ALLOWED" | "LOCERR_CALC_VALIDATION_STATE_INVALID" | "LOCERR_CALC_PIVOT_DIMENSIONS_ALREADY_EXISTS" | "LOCERR_CALC_MISSING_LINKED_FIELD" | "LOCERR_CALC_NOT_CALCULATED" | "LOCERR_LAYOUT_EXTENDS_INVALID_ID" | "LOCERR_LAYOUT_LINKED_OBJECT_NOT_FOUND" | "LOCERR_LAYOUT_LINKED_OBJECT_INVALID" | "LOCERR_PERSISTENCE_WRITE_FAILED" | "LOCERR_PERSISTENCE_READ_FAILED" | "LOCERR_PERSISTENCE_DELETE_FAILED" | "LOCERR_PERSISTENCE_NOT_FOUND" | "LOCERR_PERSISTENCE_UNSUPPORTED_VERSION" | "LOCERR_PERSISTENCE_MIGRATION_FAILED_READ_ONLY" | "LOCERR_PERSISTENCE_MIGRATION_CANCELLED" | "LOCERR_PERSISTENCE_MIGRATION_BACKUP_FAILED" | "LOCERR_PERSISTENCE_DISK_FULL" | "LOCERR_PERSISTENCE_NOT_SUPPORTED_FOR_SESSION_APP" | "LOCERR_PERSISTENCE_MOVE_FAILED" | "LOCERR_PERSISTENCE_OBJECT_LOCKED" | "LOCERR_PERSISTENCE_ENCRYPTION_KEY_MIGRATION_ONGOING" | "LOCERR_PERSISTENCE_SYNC_SET_CHUNK_INVALID_PARAMETERS" | "LOCERR_PERSISTENCE_SYNC_GET_CHUNK_INVALID_PARAMETERS" | "LOCERR_SCRIPT_DATASOURCE_ACCESS_DENIED" | "LOCERR_RELOAD_IN_PROGRESS" | "LOCERR_RELOAD_TABLE_X_NOT_FOUND" | "LOCERR_RELOAD_UNKNOWN_STATEMENT" | "LOCERR_RELOAD_EXPECTED_SOMETHING_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_NOTHING_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_1_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_2_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_3_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_4_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_5_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_6_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_7_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_EXPECTED_ONE_OF_8_OR_MORE_TOKENS_FOUND_UNKNOWN" | "LOCERR_RELOAD_FIELD_X_NOT_FOUND" | "LOCERR_RELOAD_MAPPING_TABLE_X_NOT_FOUND" | "LOCERR_RELOAD_LIB_CONNECTION_X_NOT_FOUND" | "LOCERR_RELOAD_NAME_ALREADY_TAKEN" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_DIF" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_BIFF" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_ENCRYPTED" | "LOCERR_RELOAD_OPEN_FILE_ERROR" | "LOCERR_RELOAD_AUTO_GENERATE_COUNT" | "LOCERR_RELOAD_PE_ILLEGAL_PREFIX_COMB" | "LOCERR_RELOAD_MATCHING_CONTROL_STATEMENT_ERROR" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_NOT_FOUND" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_INVALID" | "LOCERR_RELOAD_MATCHING_LIBPATH_X_OUTSIDE" | "LOCERR_RELOAD_NO_QUALIFIED_PATH_FOR_FILE" | "LOCERR_RELOAD_MODE_STATEMENT_ONLY_FOR_LIB_PATHS" | "LOCERR_RELOAD_INCONSISTENT_USE_OF_SEMANTIC_FIELDS" | "LOCERR_RELOAD_NO_OPEN_DATABASE" | "LOCERR_RELOAD_AGGREGATION_REQUIRED_BY_GROUP_BY" | "LOCERR_RELOAD_CONNECT_MUST_USE_LIB_PREFIX_IN_THIS_MODE" | "LOCERR_RELOAD_ODBC_CONNECT_FAILED" | "LOCERR_RELOAD_OLEDB_CONNECT_FAILED" | "LOCERR_RELOAD_CUSTOM_CONNECT_FAILED" | "LOCERR_RELOAD_ODBC_READ_FAILED" | "LOCERR_RELOAD_OLEDB_READ_FAILED" | "LOCERR_RELOAD_CUSTOM_READ_FAILED" | "LOCERR_RELOAD_BINARY_LOAD_PROHIBITED" | "LOCERR_RELOAD_CONNECTOR_START_FAILED" | "LOCERR_RELOAD_CONNECTOR_NOT_RESPONDING" | "LOCERR_RELOAD_CONNECTOR_REPLY_ERROR" | "LOCERR_RELOAD_CONNECTOR_CONNECT_ERROR" | "LOCERR_RELOAD_CONNECTOR_NOT_FOUND_ERROR" | "LOCERR_RELOAD_INPUT_FIELD_WITH_DUPLICATE_KEYS" | "LOCERR_RELOAD_CONCATENATE_LOAD_NO_PREVIOUS_TABLE" | "LOCERR_RELOAD_WRONG_FILE_FORMAT_QVD" | "LOCERR_RELOAD_ACTION_BLOCKED_ENTITLEMENT" | "LOCERR_PERSONAL_NEW_VERSION_AVAILABLE" | "LOCERR_PERSONAL_VERSION_EXPIRED" | "LOCERR_PERSONAL_SECTION_ACCESS_DETECTED" | "LOCERR_PERSONAL_APP_DELETION_FAILED" | "LOCERR_USER_AUTHENTICATION_FAILURE" | "LOCERR_EXPORT_OUT_OF_MEMORY" | "LOCERR_EXPORT_NO_DATA" | "LOCERR_SYNC_INVALID_OFFSET" | "LOCERR_SEARCH_TIMEOUT" | "LOCERR_DIRECT_DISCOVERY_LINKED_EXPRESSION_FAIL" | "LOCERR_DIRECT_DISCOVERY_ROWCOUNT_OVERFLOW" | "LOCERR_DIRECT_DISCOVERY_EMPTY_RESULT" | "LOCERR_DIRECT_DISCOVERY_DB_CONNECTION_FAILED" | "LOCERR_DIRECT_DISCOVERY_MEASURE_NOT_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_DETAIL_NOT_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_NOT_SYNTH_CIRCULAR_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_ONLY_ONE_DD_TABLE_ALLOWED" | "LOCERR_DIRECT_DISCOVERY_DB_AUTHORIZATION_FAILED" | "LOCERR_SMART_LOAD_TABLE_NOT_FOUND" | "LOCERR_SMART_LOAD_TABLE_DUPLICATED" | "LOCERR_VARIABLE_NO_NAME" | "LOCERR_VARIABLE_DUPLICATE_NAME" | "LOCERR_VARIABLE_INCONSISTENCY" | "LOCERR_MEDIA_LIBRARY_LIST_FAILED" | "LOCERR_MEDIA_LIBRARY_CONTENT_FAILED" | "LOCERR_MEDIA_BUNDLING_FAILED" | "LOCERR_MEDIA_UNBUNDLING_FAILED" | "LOCERR_MEDIA_LIBRARY_NOT_FOUND" | "LOCERR_FEATURE_DISABLED" | "LOCERR_LOAD_TOO_MANY_FIELDS" | "LOCERR_LOAD_TOO_MANY_TABLES" | "LOCERR_JSON_RPC_INVALID_REQUEST" | "LOCERR_JSON_RPC_METHOD_NOT_FOUND" | "LOCERR_JSON_RPC_INVALID_PARAMETERS" | "LOCERR_JSON_RPC_INTERNAL_ERROR" | "LOCERR_JSON_RPC_RESPONSE_TOO_LARGE" | "LOCERR_JSON_RPC_PARSE_ERROR" | "LOCERR_MQ_SOCKET_CONNECT_FAILURE" | "LOCERR_MQ_SOCKET_OPEN_FAILURE" | "LOCERR_MQ_PROTOCOL_NO_RESPONE" | "LOCERR_MQ_PROTOCOL_LIBRARY_EXCEPTION" | "LOCERR_MQ_PROTOCOL_CONNECTION_CLOSED" | "LOCERR_MQ_PROTOCOL_CHANNEL_CLOSED" | "LOCERR_MQ_PROTOCOL_UNKNOWN_ERROR" | "LOCERR_MQ_PROTOCOL_INVALID_STATUS" | "LOCERR_EXTENGINE_GRPC_STATUS_OK" | "LOCERR_EXTENGINE_GRPC_STATUS_CANCELLED" | "LOCERR_EXTENGINE_GRPC_STATUS_UNKNOWN" | "LOCERR_EXTENGINE_GRPC_STATUS_INVALID_ARGUMENT" | "LOCERR_EXTENGINE_GRPC_STATUS_DEADLINE_EXCEEDED" | "LOCERR_EXTENGINE_GRPC_STATUS_NOT_FOUND" | "LOCERR_EXTENGINE_GRPC_STATUS_ALREADY_EXISTS" | "LOCERR_EXTENGINE_GRPC_STATUS_PERMISSION_DENIED" | "LOCERR_EXTENGINE_GRPC_STATUS_RESOURCE_EXHAUSTED" | "LOCERR_EXTENGINE_GRPC_STATUS_FAILED_PRECONDITION" | "LOCERR_EXTENGINE_GRPC_STATUS_ABORTED" | "LOCERR_EXTENGINE_GRPC_STATUS_OUT_OF_RANGE" | "LOCERR_EXTENGINE_GRPC_STATUS_UNIMPLEMENTED" | "LOCERR_EXTENGINE_GRPC_STATUS_INTERNAL" | "LOCERR_EXTENGINE_GRPC_STATUS_UNAVAILABLE" | "LOCERR_EXTENGINE_GRPC_STATUS_DATA_LOSS" | "LOCERR_EXTENGINE_GRPC_STATUS_UNAUTHENTICATED" | "LOCERR_LXW_INVALID_OBJ" | "LOCERR_LXW_INVALID_FILE" | "LOCERR_LXW_INVALID_SHEET" | "LOCERR_LXW_INVALID_EXPORT_RANGE" | "LOCERR_LXW_ERROR" | "LOCERR_LXW_ERROR_MEMORY_MALLOC_FAILED" | "LOCERR_LXW_ERROR_CREATING_XLSX_FILE" | "LOCERR_LXW_ERROR_CREATING_TMPFILE" | "LOCERR_LXW_ERROR_ZIP_FILE_OPERATION" | "LOCERR_LXW_ERROR_ZIP_FILE_ADD" | "LOCERR_LXW_ERROR_ZIP_CLOSE" | "LOCERR_LXW_ERROR_NULL_PARAMETER_IGNORED" | "LOCERR_LXW_ERROR_MAX_STRING_LENGTH_EXCEEDED" | "LOCERR_LXW_ERROR_255_STRING_LENGTH_EXCEEDED" | "LOCERR_LXW_ERROR_SHARED_STRING_INDEX_NOT_FOUND" | "LOCERR_LXW_ERROR_WORKSHEET_INDEX_OUT_OF_RANGE" | "LOCERR_LXW_ERROR_WORKSHEET_MAX_NUMBER_URLS_EXCEEDED" | "LOCERR_BDI_STATUS_OK" | "LOCERR_BDI_GENERIC_ERROR_NOT_TRANSLATED" | "LOCERR_TRENDLINE_INVALID_DEF" | "LOCERR_TRENDLINE_INVALID_MATH_ERROR" | "LOCERR_CURL_UNSUPPORTED_PROTOCOL" | "LOCERR_CURL_COULDNT_RESOLVE_PROXY" | "LOCERR_CURL_COULDNT_CONNECT" | "LOCERR_CURL_REMOTE_ACCESS_DENIED" | "LOCERR_CURL_FTP_ACCEPT_FAILED" | "LOCERR_CURL_FTP_ACCEPT_TIMEOUT" | "LOCERR_CURL_FTP_CANT_GET_HOST" | "LOCERR_CURL_PARTIAL_FILE" | "LOCERR_CURL_QUOTE_ERROR" | "LOCERR_CURL_WRITE_ERROR" | "LOCERR_CURL_UPLOAD_FAILED" | "LOCERR_CURL_OUT_OF_MEMORY" | "LOCERR_CURL_OPERATION_TIMEDOUT" | "LOCERR_CURL_FTP_COULDNT_USE_REST" | "LOCERR_CURL_HTTP_POST_ERROR" | "LOCERR_CURL_SSL_CONNECT_ERROR" | "LOCERR_CURL_FILE_COULDNT_READ_FILE" | "LOCERR_CURL_LDAP_CANNOT_BIND" | "LOCERR_CURL_LDAP_SEARCH_FAILED" | "LOCERR_CURL_TOO_MANY_REDIRECTS" | "LOCERR_CURL_PEER_FAILED_VERIFICATION" | "LOCERR_CURL_GOT_NOTHING" | "LOCERR_CURL_SSL_ENGINE_NOTFOUND" | "LOCERR_CURL_SSL_ENGINE_SETFAILED" | "LOCERR_CURL_SSL_CERTPROBLEM" | "LOCERR_CURL_SSL_CIPHER" | "LOCERR_CURL_SSL_CACERT" | "LOCERR_CURL_BAD_CONTENT_ENCODING" | "LOCERR_CURL_LDAP_INVALID_URL" | "LOCERR_CURL_USE_SSL_FAILED" | "LOCERR_CURL_SSL_ENGINE_INITFAILED" | "LOCERR_CURL_LOGIN_DENIED" | "LOCERR_CURL_TFTP_NOTFOUND" | "LOCERR_CURL_TFTP_ILLEGAL" | "LOCERR_CURL_SSH" | "LOCERR_SETEXPRESSION_TOO_LARGE" | "LOCERR_RELOAD_MERGE_LOAD_ERROR" | "LOCERR_WIN_FTP_DROPPED" | "LOCERR_WIN_FTP_NO_PASSIVE_MODE" | "LOCERR_WIN_HTTP_DOWNLEVEL_SERVER" | "LOCERR_WIN_HTTP_INVALID_SERVER_RESPONSE" | "LOCERR_WIN_HTTP_REDIRECT_NEEDS_CONFIRMATION" | "LOCERR_WIN_INTERNET_FORCE_RETRY" | "LOCERR_WIN_INTERNET_CANNOT_CONNECT" | "LOCERR_WIN_INTERNET_CONNECTION_ABORTED" | "LOCERR_WIN_INTERNET_CONNECTION_RESET" | "LOCERR_WIN_INTERNET_DISCONNECTED" | "LOCERR_WIN_INTERNET_INCORRECT_FORMAT" | "LOCERR_WIN_INTERNET_INVALID_CA" | "LOCERR_WIN_INTERNET_INVALID_OPERATION" | "LOCERR_WIN_INTERNET_INVALID_URL" | "LOCERR_WIN_INTERNET_ITEM_NOT_FOUND" | "LOCERR_WIN_INTERNET_LOGIN_FAILURE" | "LOCERR_WIN_INTERNET_NAME_NOT_RESOLVED" | "LOCERR_WIN_INTERNET_NEED_UI" | "LOCERR_WIN_INTERNET_SEC_CERT_CN_INVALID" | "LOCERR_WIN_INTERNET_SEC_CERT_DATE_INVALID" | "LOCERR_WIN_INTERNET_SEC_CERT_ERRORS" | "LOCERR_WIN_INTERNET_SEC_INVALID_CERT" | "LOCERR_WIN_INTERNET_SERVER_UNREACHABLE" | "LOCERR_BM_RESULT_TOO_LARGE";
|
|
4279
4289
|
type NxLocalizedWarningCode = "LOCWARN_PERSONAL_RELOAD_REQUIRED" | "LOCWARN_PERSONAL_VERSION_EXPIRES_SOON" | "LOCWARN_EXPORT_DATA_TRUNCATED" | "LOCWARN_COULD_NOT_OPEN_ALL_OBJECTS" | "LOCWARN_SEARCH_INVALID_SEARCHFIELD_DETECTED";
|
|
4280
4290
|
type NxMatchingFieldInfo = {
|
|
4281
4291
|
/**
|
|
@@ -5187,6 +5197,12 @@ type NxTreeDimensionInfo = {
|
|
|
5187
5197
|
* Refers to a dimension stored in the library.
|
|
5188
5198
|
*/
|
|
5189
5199
|
qLibraryId?: string;
|
|
5200
|
+
/**
|
|
5201
|
+
* The expanded and stripped dimension name used internally in engine.
|
|
5202
|
+
*
|
|
5203
|
+
* Stability: *experimental*
|
|
5204
|
+
*/
|
|
5205
|
+
qEffectiveDimensionName?: string;
|
|
5190
5206
|
};
|
|
5191
5207
|
type NxTreeMultiRangeSelectInfo = {
|
|
5192
5208
|
/**
|
|
@@ -8550,7 +8566,7 @@ type NativeDocFunctions<FieldRpcObject, GenericBookmarkRpcObject, GenericDimensi
|
|
|
8550
8566
|
* - `ignorePatches` - Set to true to exclude patches from the bookmark. Default is false.
|
|
8551
8567
|
* - `objectIdsToPatch` - Add softpatches for this objects if available. If empty all softpatches are added to the bookmark. Ignored if IgnorePatches is set to true.
|
|
8552
8568
|
*
|
|
8553
|
-
* Stability: *
|
|
8569
|
+
* Stability: *locked*
|
|
8554
8570
|
*/
|
|
8555
8571
|
replaceBookmark: (id: string, ignorePatches?: boolean, objectIdsToPatch?: string[]) => Promise<unknown>;
|
|
8556
8572
|
/**
|
package/qix.js
CHANGED
package/quotas.js
CHANGED
package/reload-tasks.d.ts
CHANGED
|
@@ -6,10 +6,28 @@ type Error = {
|
|
|
6
6
|
detail?: string;
|
|
7
7
|
title: string;
|
|
8
8
|
};
|
|
9
|
+
/**
|
|
10
|
+
* @example
|
|
11
|
+
* {
|
|
12
|
+
* errors: [
|
|
13
|
+
* {
|
|
14
|
+
* code: "TASKS-123",
|
|
15
|
+
* title: "short error message"
|
|
16
|
+
* }
|
|
17
|
+
* ],
|
|
18
|
+
* traceId: "7975401f3954aa47"
|
|
19
|
+
* }
|
|
20
|
+
*/
|
|
9
21
|
type Errors = {
|
|
10
22
|
errors?: Error[];
|
|
11
23
|
traceId?: string;
|
|
12
24
|
};
|
|
25
|
+
/**
|
|
26
|
+
* @example
|
|
27
|
+
* {
|
|
28
|
+
* href: "http://example.com"
|
|
29
|
+
* }
|
|
30
|
+
*/
|
|
13
31
|
type Href = {
|
|
14
32
|
href: string;
|
|
15
33
|
};
|
|
@@ -43,6 +61,8 @@ type Task = TaskBase & {
|
|
|
43
61
|
/** @deprecated
|
|
44
62
|
* The reason why the task was disabled. */
|
|
45
63
|
log?: string;
|
|
64
|
+
/** A flag indicating whether the task has been migrated to the new scheduling service. */
|
|
65
|
+
migrated?: boolean;
|
|
46
66
|
/** The next time the task will execute. */
|
|
47
67
|
nextExecutionTime?: string;
|
|
48
68
|
/** The space ID of the application */
|
package/reload-tasks.js
CHANGED
package/reloads.d.ts
CHANGED
|
@@ -7,20 +7,35 @@ type Error = {
|
|
|
7
7
|
detail?: string;
|
|
8
8
|
title: string;
|
|
9
9
|
};
|
|
10
|
+
/**
|
|
11
|
+
* @example
|
|
12
|
+
* {
|
|
13
|
+
* errors: [
|
|
14
|
+
* {
|
|
15
|
+
* code: "HTTP-123",
|
|
16
|
+
* title: "short error message"
|
|
17
|
+
* }
|
|
18
|
+
* ]
|
|
19
|
+
* }
|
|
20
|
+
*/
|
|
10
21
|
type Errors = {
|
|
11
22
|
errors?: Error[];
|
|
12
23
|
};
|
|
24
|
+
/**
|
|
25
|
+
* @example
|
|
26
|
+
* {
|
|
27
|
+
* href: "http://example.com"
|
|
28
|
+
* }
|
|
29
|
+
*/
|
|
13
30
|
type Href = {
|
|
14
31
|
href?: string;
|
|
15
32
|
};
|
|
16
33
|
/**
|
|
17
34
|
* The boolean value used to present the reload is partial or not.
|
|
35
|
+
* @example
|
|
36
|
+
* false
|
|
18
37
|
*/
|
|
19
38
|
type Partial = boolean;
|
|
20
|
-
/**
|
|
21
|
-
* The priority of the reload. The higher the priority, the sooner the reload will be scheduled relative to other reloads for the same tenant.
|
|
22
|
-
*/
|
|
23
|
-
type Priority = number;
|
|
24
39
|
type Reload = {
|
|
25
40
|
/** The ID of the app. */
|
|
26
41
|
appId: string;
|
|
@@ -41,8 +56,6 @@ type Reload = {
|
|
|
41
56
|
log?: string;
|
|
42
57
|
/** The boolean value used to present the reload is partial or not. */
|
|
43
58
|
partial?: Partial;
|
|
44
|
-
/** The priority of the reload. The higher the priority, the sooner the reload will be scheduled relative to other reloads for the same tenant. */
|
|
45
|
-
priority?: Priority;
|
|
46
59
|
/** The time the reload job was consumed from the queue. */
|
|
47
60
|
startTime?: string;
|
|
48
61
|
/** The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses. */
|
|
@@ -62,8 +75,8 @@ type ReloadRequest = {
|
|
|
62
75
|
appId: string;
|
|
63
76
|
/** The boolean value used to present the reload is partial or not */
|
|
64
77
|
partial?: boolean;
|
|
65
|
-
/** The
|
|
66
|
-
|
|
78
|
+
/** The variables to be used in the load script. */
|
|
79
|
+
variables?: Record<string, string>;
|
|
67
80
|
};
|
|
68
81
|
type Reloads = {
|
|
69
82
|
data: Reload[];
|
|
@@ -75,21 +88,32 @@ type ReloadsLinks = ReloadLinks & {
|
|
|
75
88
|
};
|
|
76
89
|
/**
|
|
77
90
|
* The status of the reload. There are seven statuses. `QUEUED`, `RELOADING`, `CANCELING` are the active statuses. `SUCCEEDED`, `FAILED`, `CANCELED`, `EXCEEDED_LIMIT` are the end statuses.
|
|
91
|
+
* @example
|
|
92
|
+
* "FAILED"
|
|
78
93
|
*/
|
|
79
94
|
type Status = "QUEUED" | "RELOADING" | "CANCELING" | "SUCCEEDED" | "FAILED" | "CANCELED" | "EXCEEDED_LIMIT";
|
|
80
95
|
/**
|
|
81
96
|
* What initiated the reload: hub = one-time reload manually triggered in hub, chronos = time based scheduled reload triggered by chronos, external = reload triggered via external API request, automations = reload triggered in automation, data-refresh = reload triggered by refresh of data, choreographer = reload triggered by choreographer.
|
|
97
|
+
* @example
|
|
98
|
+
* "chronos"
|
|
82
99
|
*/
|
|
83
100
|
type Type = "hub" | "external" | "chronos" | "automations" | "data-refresh" | "choreographer";
|
|
84
101
|
/**
|
|
85
102
|
* Finds and returns the reloads that the user has access to.
|
|
103
|
+
* @example
|
|
104
|
+
* getReloads(
|
|
105
|
+
* {
|
|
106
|
+
* filter: "(status eq \"FAILED\" or status eq \"EXCEEDED_LIMIT\") and partial eq \"false\" and type eq \"chronos\"
|
|
107
|
+
* "
|
|
108
|
+
* }
|
|
109
|
+
* )
|
|
86
110
|
*
|
|
87
111
|
* @param query an object with query parameters
|
|
88
112
|
* @throws GetReloadsHttpError
|
|
89
113
|
*/
|
|
90
114
|
declare const getReloads: (query: {
|
|
91
115
|
/** The UUID formatted string used to search for an app's reload history entries. TenantAdmin users may omit this parameter to list all reload history in the tenant. */
|
|
92
|
-
appId
|
|
116
|
+
appId: string;
|
|
93
117
|
/** SCIM filter expression used to search for reloads.
|
|
94
118
|
* The filter syntax is defined in RFC 7644 section 3.4.2.2
|
|
95
119
|
*
|
|
@@ -180,6 +204,13 @@ declare function clearCache(): void;
|
|
|
180
204
|
interface ReloadsAPI {
|
|
181
205
|
/**
|
|
182
206
|
* Finds and returns the reloads that the user has access to.
|
|
207
|
+
* @example
|
|
208
|
+
* getReloads(
|
|
209
|
+
* {
|
|
210
|
+
* filter: "(status eq \"FAILED\" or status eq \"EXCEEDED_LIMIT\") and partial eq \"false\" and type eq \"chronos\"
|
|
211
|
+
* "
|
|
212
|
+
* }
|
|
213
|
+
* )
|
|
183
214
|
*
|
|
184
215
|
* @param query an object with query parameters
|
|
185
216
|
* @throws GetReloadsHttpError
|
|
@@ -216,4 +247,4 @@ interface ReloadsAPI {
|
|
|
216
247
|
*/
|
|
217
248
|
declare const reloadsExport: ReloadsAPI;
|
|
218
249
|
|
|
219
|
-
export { type CancelReloadHttpError, type CancelReloadHttpResponse, type Error, type Errors, type GetReloadHttpError, type GetReloadHttpResponse, type GetReloadsHttpError, type GetReloadsHttpResponse, type Href, type Partial, type
|
|
250
|
+
export { type CancelReloadHttpError, type CancelReloadHttpResponse, type Error, type Errors, type GetReloadHttpError, type GetReloadHttpResponse, type GetReloadsHttpError, type GetReloadsHttpResponse, type Href, type Partial, type QueueReloadHttpError, type QueueReloadHttpResponse, type Reload, type ReloadLinks, type ReloadRequest, type Reloads, type ReloadsAPI, type ReloadsLinks, type Status, type Type, cancelReload, clearCache, reloadsExport as default, getReload, getReloads, queueReload };
|
package/reloads.js
CHANGED
package/reports.d.ts
CHANGED
|
@@ -10,7 +10,7 @@ type AppError = {
|
|
|
10
10
|
/** The method that is failing. */
|
|
11
11
|
method?: string;
|
|
12
12
|
/** Parameters of method that fails. */
|
|
13
|
-
parameters?:
|
|
13
|
+
parameters?: Record<string, string>;
|
|
14
14
|
};
|
|
15
15
|
/**
|
|
16
16
|
* Errors occurring when dealing with the app.
|
|
@@ -39,12 +39,21 @@ type ComposableTemplate = {
|
|
|
39
39
|
/** Template type and version using semantic versioning. It must have the following name convention, dashed-separated-template-name-MAJOR.MINOR */
|
|
40
40
|
type: "sense-image-1.0" | "sense-sheet-1.0";
|
|
41
41
|
};
|
|
42
|
+
type CycleOutput = {
|
|
43
|
+
/** Output to be used to export an excel template. */
|
|
44
|
+
excelOutput?: ExcelOutput;
|
|
45
|
+
/** not needed at initial phase */
|
|
46
|
+
namingPattern?: "fieldValueWithUnderscore";
|
|
47
|
+
/** Output to be used to export a single visualization, a sheet, Sense Excel template as pdf. For Sense Excel template (sense-excel-template-1.0) no properties are needed, any property specified has no effect. */
|
|
48
|
+
pdfOutput?: PdfOutput;
|
|
49
|
+
type: "excel" | "pdf" | "html";
|
|
50
|
+
};
|
|
42
51
|
/**
|
|
43
52
|
* Definitions of common properties that are shared between templates, e.g. selectionsByState can be the same for all templates within a composition of templates.
|
|
44
53
|
*/
|
|
45
54
|
type Definitions = {
|
|
46
55
|
/** It maps an ID to a selectionsByState object. */
|
|
47
|
-
selectionsByState?:
|
|
56
|
+
selectionsByState?: Record<string, Record<string, QSelection[]>>;
|
|
48
57
|
};
|
|
49
58
|
/**
|
|
50
59
|
* Properties of the document. In case of multiple composition, only properties specified in the composition output are taken and the ones specified in each output item are ignored.
|
|
@@ -65,6 +74,14 @@ type ExcelOutput = {
|
|
|
65
74
|
/** The output format of the report to be produced. */
|
|
66
75
|
outFormat?: "xlsx";
|
|
67
76
|
};
|
|
77
|
+
type ExportDataOptions = {
|
|
78
|
+
/** Show the Selections Applied to the Visualization in the artifact produced */
|
|
79
|
+
showSelections?: boolean;
|
|
80
|
+
/** Show Visualization Title, SubTitle, Footnote in the artifact produced */
|
|
81
|
+
showTitles?: boolean;
|
|
82
|
+
/** Show Visualization Totals in the artifact produced */
|
|
83
|
+
showTotals?: boolean;
|
|
84
|
+
};
|
|
68
85
|
/**
|
|
69
86
|
* Error occured during report generation.
|
|
70
87
|
*/
|
|
@@ -144,7 +161,8 @@ type ExportError = {
|
|
|
144
161
|
* - "REP-400050" Error retrieving outputs.
|
|
145
162
|
* - "REP-400052" Report Request Aborted from internal error.
|
|
146
163
|
* - "REP-500053" Unexpected number of generated cycle reports.
|
|
147
|
-
* - "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
|
|
164
|
+
* - "REP-400054" The number of generated cycle reports exceeds the maximum allowed.
|
|
165
|
+
* - "REP-400055" Export options not allowed for this object. */
|
|
148
166
|
code: string;
|
|
149
167
|
/** Optional. MAY be used to provide more concrete details. */
|
|
150
168
|
detail?: string;
|
|
@@ -204,9 +222,30 @@ type NxPatch = {
|
|
|
204
222
|
/** Corresponds to the value of the property to add or to the new value of the property to update. */
|
|
205
223
|
qValue?: string;
|
|
206
224
|
};
|
|
225
|
+
/**
|
|
226
|
+
* @example
|
|
227
|
+
* {
|
|
228
|
+
* outputId: "output1",
|
|
229
|
+
* pdfOutput: {
|
|
230
|
+
* align: {
|
|
231
|
+
* horizontal: "center",
|
|
232
|
+
* vertical: "middle"
|
|
233
|
+
* },
|
|
234
|
+
* imageRenderingDpi: 300,
|
|
235
|
+
* orientation: "P",
|
|
236
|
+
* resizeData: {
|
|
237
|
+
* fit: "210mmx287mm"
|
|
238
|
+
* },
|
|
239
|
+
* resizeType: "fit",
|
|
240
|
+
* size: "A4"
|
|
241
|
+
* },
|
|
242
|
+
* type: "pdf"
|
|
243
|
+
* }
|
|
244
|
+
*/
|
|
207
245
|
type OutputItem = {
|
|
208
246
|
/** The callback to be performed once the report is done. */
|
|
209
247
|
callBackAction?: CallBackAction;
|
|
248
|
+
cycleOutput?: CycleOutput;
|
|
210
249
|
/** Output to be used to export an excel template. */
|
|
211
250
|
excelOutput?: ExcelOutput;
|
|
212
251
|
/** Output to be used to export a single visualization as image. */
|
|
@@ -234,8 +273,8 @@ type OutputItem = {
|
|
|
234
273
|
* - excel requires excelOutput to be set
|
|
235
274
|
* - pdfcomposition requires pdfCompositionOutput to be set
|
|
236
275
|
* - pptxcomposition requires pptxCompositionOutput to be set
|
|
237
|
-
* - pdf requires
|
|
238
|
-
* - pptx requires
|
|
276
|
+
* - pdf requires pdfOutput to be set
|
|
277
|
+
* - pptx requires pptxOutput to be set
|
|
239
278
|
* - image requires imageOutput to be set
|
|
240
279
|
* - csv doesn't have csv output
|
|
241
280
|
* - xlsx requires xlsxOutput to be set */
|
|
@@ -329,6 +368,78 @@ type Reason = {
|
|
|
329
368
|
outputId?: string;
|
|
330
369
|
traceId?: string;
|
|
331
370
|
};
|
|
371
|
+
/**
|
|
372
|
+
* @example
|
|
373
|
+
* {
|
|
374
|
+
* compositionTemplates: [
|
|
375
|
+
* {
|
|
376
|
+
* senseSheetTemplate: {
|
|
377
|
+
* appId: "2451e58e-a1b9-4047-abf6-315e91d8a610",
|
|
378
|
+
* selectionsByStateDef: "sel1",
|
|
379
|
+
* sheet: {
|
|
380
|
+
* id: "5ffe3801-1b6d-439d-a849-84d0748358f1"
|
|
381
|
+
* }
|
|
382
|
+
* },
|
|
383
|
+
* type: "sense-sheet-1.0"
|
|
384
|
+
* },
|
|
385
|
+
* {
|
|
386
|
+
* senseSheetTemplate: {
|
|
387
|
+
* appId: "2451e58e-a1b9-4047-abf6-315e91d8a610",
|
|
388
|
+
* selectionsByStateDef: "sel1",
|
|
389
|
+
* sheet: {
|
|
390
|
+
* id: "ffrxJyA"
|
|
391
|
+
* }
|
|
392
|
+
* },
|
|
393
|
+
* type: "sense-sheet-1.0"
|
|
394
|
+
* }
|
|
395
|
+
* ],
|
|
396
|
+
* definitions: {
|
|
397
|
+
* selectionsByState: {
|
|
398
|
+
* "sel1": {
|
|
399
|
+
* "$": [
|
|
400
|
+
* {
|
|
401
|
+
* defaultIsNumeric: false,
|
|
402
|
+
* fieldName: "Region",
|
|
403
|
+
* values: [
|
|
404
|
+
* {
|
|
405
|
+
* isNumeric: false,
|
|
406
|
+
* text: "Arizona"
|
|
407
|
+
* }
|
|
408
|
+
* ]
|
|
409
|
+
* }
|
|
410
|
+
* ]
|
|
411
|
+
* }
|
|
412
|
+
* }
|
|
413
|
+
* },
|
|
414
|
+
* output: {
|
|
415
|
+
* outputId: "composition1",
|
|
416
|
+
* pdfCompositionOutput: {
|
|
417
|
+
* pdfOutputs: [
|
|
418
|
+
* {
|
|
419
|
+
* align: {
|
|
420
|
+
* horizontal: "center",
|
|
421
|
+
* vertical: "middle"
|
|
422
|
+
* },
|
|
423
|
+
* orientation: "A",
|
|
424
|
+
* resizeType: "autofit",
|
|
425
|
+
* size: "A4"
|
|
426
|
+
* },
|
|
427
|
+
* {
|
|
428
|
+
* align: {
|
|
429
|
+
* horizontal: "center",
|
|
430
|
+
* vertical: "middle"
|
|
431
|
+
* },
|
|
432
|
+
* orientation: "A",
|
|
433
|
+
* resizeType: "autofit",
|
|
434
|
+
* size: "A4"
|
|
435
|
+
* }
|
|
436
|
+
* ]
|
|
437
|
+
* },
|
|
438
|
+
* type: "pdfcomposition"
|
|
439
|
+
* },
|
|
440
|
+
* type: "composition-1.0"
|
|
441
|
+
* }
|
|
442
|
+
*/
|
|
332
443
|
type ReportRequest = {
|
|
333
444
|
/** Composition of senseSheetTemplate and/or senseImageTemplate templates. */
|
|
334
445
|
compositionTemplates?: ComposableTemplate[];
|
|
@@ -351,7 +462,7 @@ type ReportRequest = {
|
|
|
351
462
|
/** Used to export a sheet as pdf or pptx. */
|
|
352
463
|
senseSheetTemplate?: SenseSheetTemplate;
|
|
353
464
|
/** Template type and version using semantic versioning. It must have the following name convention: dashed-separated-template-name-MAJOR.MINOR.
|
|
354
|
-
* Please note that sense-
|
|
465
|
+
* Please note that sense-html-template-1.0, sense-story-x.0 and qv-data-x.0 are only for internal use.
|
|
355
466
|
*
|
|
356
467
|
* Each type requires a specific template to be provided:
|
|
357
468
|
* - composition-1.0 requires compositionTemplates to be set
|
|
@@ -359,15 +470,41 @@ type ReportRequest = {
|
|
|
359
470
|
* - sense-image-1.0 requires senseImageTemplate to be set
|
|
360
471
|
* - sense-sheet-1.0 requires senseSheetTemplate to be set
|
|
361
472
|
* - sense-data-1.0 requires senseDataTemplate to be set
|
|
473
|
+
* - sense-pixel-perfect-template-1.0 requires sensePixelPerfectTemplate to be set
|
|
474
|
+
* - sense-html-template-1.0 requires senseHtmlTemplate to be set
|
|
362
475
|
*
|
|
363
476
|
* Each template type supports specific output types:
|
|
364
|
-
* - composition-1.0 supports pdfcomposition and
|
|
477
|
+
* - composition-1.0 supports pdfcomposition and pptxcomposition output type
|
|
365
478
|
* - sense-excel-template-1.0 supports excel and pdf output type
|
|
366
479
|
* - sense-image-1.0 supports pdf, pptx and png output types
|
|
367
480
|
* - sense-sheet-1.0 supports pdf, pptx output type
|
|
368
|
-
* - sense-data-1.0 supports xlsx output type
|
|
481
|
+
* - sense-data-1.0 supports xlsx output type
|
|
482
|
+
* - sense-pixel-perfect-template-1.0 supports pdf output types
|
|
483
|
+
* - sense-html-template-1.0 supports html output types
|
|
484
|
+
*
|
|
485
|
+
* Each output type requires a specific output to be provided:
|
|
486
|
+
* - pdfcomposition requires pdfCompositionOutput to be set
|
|
487
|
+
* - pptxcomposition requires pptxCompositionOutput to be set
|
|
488
|
+
* - pdf requires pdfOutput to be set
|
|
489
|
+
* - pptx requires pptxOutput to be set
|
|
490
|
+
* - image requires imageOutput to be set
|
|
491
|
+
* - xlsx requires xlsxOutput to be set */
|
|
369
492
|
type: "composition-1.0" | "sense-image-1.0" | "sense-data-1.0" | "sense-sheet-1.0" | "sense-story-1.0" | "qv-data-1.0" | "qv-data-2.0" | "sense-excel-template-1.0" | "sense-pixel-perfect-template-1.0" | "sense-html-template-1.0";
|
|
370
493
|
};
|
|
494
|
+
/**
|
|
495
|
+
* @example
|
|
496
|
+
* {
|
|
497
|
+
* resolutionAttempts: 1,
|
|
498
|
+
* results: [
|
|
499
|
+
* {
|
|
500
|
+
* location: "https://qlikcloud.com:443/api/v1/temp-contents/619baab68023910001efcb86?inline=1",
|
|
501
|
+
* outputId: "output1"
|
|
502
|
+
* }
|
|
503
|
+
* ],
|
|
504
|
+
* status: "done",
|
|
505
|
+
* statusLocation: "/reports/01562a37-23e3-4b43-865d-84c26122276c/status"
|
|
506
|
+
* }
|
|
507
|
+
*/
|
|
371
508
|
type ReportStatus = {
|
|
372
509
|
/** @deprecated
|
|
373
510
|
* Present when status is failed. Deprecated. Use /reports/{id}/outputs instead. */
|
|
@@ -421,14 +558,15 @@ type SelectionError = {
|
|
|
421
558
|
type SelectionErrors = SelectionError[];
|
|
422
559
|
type SelectionFilter = {
|
|
423
560
|
/** A map for applying soft properties, aka patches, to specific visualization IDs within the sheet. */
|
|
424
|
-
patchesById?:
|
|
561
|
+
patchesById?: Record<string, NxPatch[]>;
|
|
425
562
|
/** Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and Maximum number of overall field values allowed is 150000. */
|
|
426
|
-
selectionsByState?:
|
|
563
|
+
selectionsByState?: Record<string, QSelection[]>;
|
|
427
564
|
variables?: unknown[];
|
|
428
565
|
};
|
|
429
566
|
type SelectionStrategy = "failOnErrors" | "ignoreErrorsReturnDetails" | "ignoreErrorsNoDetails";
|
|
430
567
|
type SenseDataTemplate = {
|
|
431
568
|
appId: string;
|
|
569
|
+
exportOptions?: ExportDataOptions;
|
|
432
570
|
/** Sense visualization id. Visualizations created "on the fly" are not supported. */
|
|
433
571
|
id: string;
|
|
434
572
|
patches?: NxPatch[];
|
|
@@ -438,7 +576,7 @@ type SenseDataTemplate = {
|
|
|
438
576
|
selectionStrategy?: SelectionStrategy;
|
|
439
577
|
selectionType?: SenseSelectionType;
|
|
440
578
|
/** Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
|
|
441
|
-
selectionsByState?:
|
|
579
|
+
selectionsByState?: Record<string, QSelection[]>;
|
|
442
580
|
/** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
|
|
443
581
|
temporaryBookmarkV2?: SenseTemporaryBookmarkV2;
|
|
444
582
|
variables?: unknown[];
|
|
@@ -447,7 +585,9 @@ type SenseDataTemplate = {
|
|
|
447
585
|
* Used to produce reports from a template file.
|
|
448
586
|
*/
|
|
449
587
|
type SenseFileTemplate = {
|
|
450
|
-
/**
|
|
588
|
+
/** The values of the field to be selected. */
|
|
589
|
+
cycleFields?: string[];
|
|
590
|
+
/** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. Currently only the "theme" and "language" properties are supported. */
|
|
451
591
|
jsOpts?: unknown;
|
|
452
592
|
/** Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck. */
|
|
453
593
|
reloadTimestampMatchType?: ReloadTimestampMatchType;
|
|
@@ -467,7 +607,7 @@ type SenseImageTemplate = {
|
|
|
467
607
|
selectionStrategy?: SelectionStrategy;
|
|
468
608
|
selectionType?: SenseSelectionType;
|
|
469
609
|
/** Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
|
|
470
|
-
selectionsByState?:
|
|
610
|
+
selectionsByState?: Record<string, QSelection[]>;
|
|
471
611
|
/** The definition ID referring to a selectionsByState definition declared in definitions. */
|
|
472
612
|
selectionsByStateDef?: string;
|
|
473
613
|
/** The temporary bookmark to apply. Patches and Variables are ignored if passed to the API, because they already are applied in the backend. */
|
|
@@ -490,7 +630,7 @@ type SenseSheetTemplate = {
|
|
|
490
630
|
selectionStrategy?: SelectionStrategy;
|
|
491
631
|
selectionType?: SenseSelectionType;
|
|
492
632
|
/** Map of selections to apply by state. Maximum number of states allowed is 125. Maximum number of fields allowed is 125 and maximum number of overall field values allowed is 150000. */
|
|
493
|
-
selectionsByState?:
|
|
633
|
+
selectionsByState?: Record<string, QSelection[]>;
|
|
494
634
|
/** The definition ID referring to a selectionsByState definition declared in definitions. */
|
|
495
635
|
selectionsByStateDef?: string;
|
|
496
636
|
/** It refers to the Sense Sheet to be exported. Note that if widthPx and heightPx are not specified, default values will be applied depending on the actual size and layout properties of the Sense Sheet object. */
|
|
@@ -516,9 +656,9 @@ type Sheet = {
|
|
|
516
656
|
/** A JSON object that is passed as-is to the mashup page while rendering, this will be applied to all charts within the sheet. It includes properties of the whole sheet such as theme, gradient etc. */
|
|
517
657
|
jsOpts?: unknown;
|
|
518
658
|
/** A map for applying jsOpts to specific visualization IDs within the sheet. */
|
|
519
|
-
jsOptsById?: unknown
|
|
659
|
+
jsOptsById?: Record<string, unknown>;
|
|
520
660
|
/** A map for applying soft properties, aka patches, to specific visualization IDs within the sheet. */
|
|
521
|
-
patchesById?:
|
|
661
|
+
patchesById?: Record<string, NxPatch[]>;
|
|
522
662
|
/** The width of the sheet in pixels. Default value is: - 1680 pixels for responsive sheet - 1120 pixels for extended sheet - same width set in sheet properties for custom sheet */
|
|
523
663
|
widthPx?: number;
|
|
524
664
|
};
|
|
@@ -546,6 +686,8 @@ type Visualization = {
|
|
|
546
686
|
};
|
|
547
687
|
/**
|
|
548
688
|
* Choose the reloadTimestamp constraint to apply. An empty value leads to the default noCheck.
|
|
689
|
+
* @example
|
|
690
|
+
* "noCheck"
|
|
549
691
|
*/
|
|
550
692
|
type ReloadTimestampMatchType = "noCheck" | "requestTimeExact";
|
|
551
693
|
/**
|
|
@@ -611,4 +753,4 @@ interface ReportsAPI {
|
|
|
611
753
|
*/
|
|
612
754
|
declare const reportsExport: ReportsAPI;
|
|
613
755
|
|
|
614
|
-
export { type AppError, type AppErrors, type CallBackAction, type ChainableSelection, type ChainableSelectionType, type ComposableTemplate, type CreateReportHttpError, type CreateReportHttpResponse, type Definitions, type DocProperties, type Error, type ExcelOutput, type ExportError, type ExportErrors, type Float64, type GetReportStatusHttpError, type GetReportStatusHttpResponse, type HttpRequest, type ImageOutput, type Meta, type MetaExportError, type NxPatch, type OutputItem, type PdfCompositionOutput, type PdfOutput, type PptxCompositionOutput, type PptxOutput, type QFieldValue, type QSelection, type Reason, type ReloadTimestampMatchType, type ReportRequest, type ReportStatus, type ReportsAPI, type Result, type SelectionChain, type SelectionError, type SelectionErrors, type SelectionFilter, type SelectionStrategy, type SenseDataTemplate, type SenseFileTemplate, type SenseImageTemplate, type SensePersistentBookmark, type SenseSelectionType, type SenseSheetTemplate, type SenseTemporaryBookmarkV2, type Sheet, type TemplateLocation, type Visualization, clearCache, createReport, reportsExport as default, getReportStatus };
|
|
756
|
+
export { type AppError, type AppErrors, type CallBackAction, type ChainableSelection, type ChainableSelectionType, type ComposableTemplate, type CreateReportHttpError, type CreateReportHttpResponse, type CycleOutput, type Definitions, type DocProperties, type Error, type ExcelOutput, type ExportDataOptions, type ExportError, type ExportErrors, type Float64, type GetReportStatusHttpError, type GetReportStatusHttpResponse, type HttpRequest, type ImageOutput, type Meta, type MetaExportError, type NxPatch, type OutputItem, type PdfCompositionOutput, type PdfOutput, type PptxCompositionOutput, type PptxOutput, type QFieldValue, type QSelection, type Reason, type ReloadTimestampMatchType, type ReportRequest, type ReportStatus, type ReportsAPI, type Result, type SelectionChain, type SelectionError, type SelectionErrors, type SelectionFilter, type SelectionStrategy, type SenseDataTemplate, type SenseFileTemplate, type SenseImageTemplate, type SensePersistentBookmark, type SenseSelectionType, type SenseSheetTemplate, type SenseTemporaryBookmarkV2, type Sheet, type TemplateLocation, type Visualization, clearCache, createReport, reportsExport as default, getReportStatus };
|