@gooddata/api-client-tiger 11.35.0-alpha.6 → 11.35.0-alpha.7
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/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +1204 -495
- package/esm/endpoints/genAI/index.d.ts +2 -2
- package/esm/endpoints/genAI/index.js +4 -2
- package/esm/gd-tiger-model/TigerTypes.d.ts +2 -1
- package/esm/generated/afm-rest-api/api.d.ts +674 -16
- package/esm/generated/afm-rest-api/api.js +672 -2
- package/esm/generated/ai-json-api/api.d.ts +94 -0
- package/esm/generated/ai-json-api/api.js +84 -0
- package/esm/generated/automation-json-api/api.d.ts +31 -1
- package/esm/generated/export-json-api/api.d.ts +31 -1
- package/esm/generated/metadata-json-api/api.d.ts +1786 -447
- package/esm/generated/metadata-json-api/api.js +1433 -280
- package/esm/generated/scan-json-api/api.d.ts +1 -1
- package/esm/index.d.ts +2 -3
- package/esm/index.js +1 -1
- package/package.json +4 -4
|
@@ -289,6 +289,15 @@ export declare class ActionsApi extends MetadataBaseApi implements ActionsApiInt
|
|
|
289
289
|
* @memberof ActionsApi
|
|
290
290
|
*/
|
|
291
291
|
registerUploadNotification(requestParameters: ActionsApiRegisterUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
292
|
+
/**
|
|
293
|
+
* Notification sets up all reports to be computed again with new data.
|
|
294
|
+
* @summary Register an upload notification
|
|
295
|
+
* @param {ActionsApiRegisterWorkspaceUploadNotificationRequest} requestParameters Request parameters.
|
|
296
|
+
* @param {*} [options] Override http request option.
|
|
297
|
+
* @throws {RequiredError}
|
|
298
|
+
* @memberof ActionsApi
|
|
299
|
+
*/
|
|
300
|
+
registerWorkspaceUploadNotification(requestParameters: ActionsApiRegisterWorkspaceUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
292
301
|
/**
|
|
293
302
|
* Resolves values of available entitlements for the organization.
|
|
294
303
|
* @summary Values for all public entitlements.
|
|
@@ -2095,11 +2104,11 @@ export declare interface ActionsApiExplainAFMRequest {
|
|
|
2095
2104
|
*/
|
|
2096
2105
|
readonly afmExecution: AfmExecution;
|
|
2097
2106
|
/**
|
|
2098
|
-
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request
|
|
2099
|
-
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'}
|
|
2107
|
+
* Requested explain type. If not specified all types are bundled in a ZIP archive. `MAQL` - MAQL Abstract Syntax Tree, execution dimensions and related info `GRPC_MODEL` - Datasets used in execution `GRPC_MODEL_SVG` - Generated SVG image of the datasets `COMPRESSED_GRPC_MODEL_SVG` - Generated SVG image of the model fragment used in the query `WDF` - Workspace data filters in execution workspace context `QT` - Query Tree, created from MAQL AST using Logical Data Model, contains all information needed to generate SQL `QT_SVG` - Generated SVG image of the Query Tree `OPT_QT` - Optimized Query Tree `OPT_QT_SVG` - Generated SVG image of the Optimized Query Tree `SQL` - Final SQL to be executed `COMPRESSED_SQL` - Final SQL to be executed with rolled SQL datasets `SETTINGS` - Settings used to execute explain request `GIT` - Git properties of current build
|
|
2108
|
+
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT'}
|
|
2100
2109
|
* @memberof ActionsApiExplainAFM
|
|
2101
2110
|
*/
|
|
2102
|
-
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL';
|
|
2111
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL' | 'COMPRESSED_GRPC_MODEL_SVG' | 'GIT';
|
|
2103
2112
|
}
|
|
2104
2113
|
|
|
2105
2114
|
/**
|
|
@@ -2648,6 +2657,15 @@ export declare interface ActionsApiInterface {
|
|
|
2648
2657
|
* @memberof ActionsApiInterface
|
|
2649
2658
|
*/
|
|
2650
2659
|
registerUploadNotification(requestParameters: ActionsApiRegisterUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2660
|
+
/**
|
|
2661
|
+
* Notification sets up all reports to be computed again with new data.
|
|
2662
|
+
* @summary Register an upload notification
|
|
2663
|
+
* @param {ActionsApiRegisterWorkspaceUploadNotificationRequest} requestParameters Request parameters.
|
|
2664
|
+
* @param {*} [options] Override http request option.
|
|
2665
|
+
* @throws {RequiredError}
|
|
2666
|
+
* @memberof ActionsApiInterface
|
|
2667
|
+
*/
|
|
2668
|
+
registerWorkspaceUploadNotification(requestParameters: ActionsApiRegisterWorkspaceUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2651
2669
|
/**
|
|
2652
2670
|
* Resolves values of available entitlements for the organization.
|
|
2653
2671
|
* @summary Values for all public entitlements.
|
|
@@ -3227,6 +3245,20 @@ export declare interface ActionsApiRegisterUploadNotificationRequest {
|
|
|
3227
3245
|
readonly dataSourceId: string;
|
|
3228
3246
|
}
|
|
3229
3247
|
|
|
3248
|
+
/**
|
|
3249
|
+
* Request parameters for registerWorkspaceUploadNotification operation in ActionsApi.
|
|
3250
|
+
* @export
|
|
3251
|
+
* @interface ActionsApiRegisterWorkspaceUploadNotificationRequest
|
|
3252
|
+
*/
|
|
3253
|
+
export declare interface ActionsApiRegisterWorkspaceUploadNotificationRequest {
|
|
3254
|
+
/**
|
|
3255
|
+
*
|
|
3256
|
+
* @type {string}
|
|
3257
|
+
* @memberof ActionsApiRegisterWorkspaceUploadNotification
|
|
3258
|
+
*/
|
|
3259
|
+
readonly workspaceId: string;
|
|
3260
|
+
}
|
|
3261
|
+
|
|
3230
3262
|
/**
|
|
3231
3263
|
* Request parameters for resolveAllSettingsWithoutWorkspace operation in ActionsApi.
|
|
3232
3264
|
* @export
|
|
@@ -5113,6 +5145,7 @@ export declare class AfmActionsApi extends LabelElementsBaseApi implements AfmAc
|
|
|
5113
5145
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
5114
5146
|
* @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
5115
5147
|
* @param {*} [options] Override http request option.
|
|
5148
|
+
* @deprecated
|
|
5116
5149
|
* @throws {RequiredError}
|
|
5117
5150
|
* @memberof ActionsApi
|
|
5118
5151
|
*/
|
|
@@ -5122,6 +5155,7 @@ export declare class AfmActionsApi extends LabelElementsBaseApi implements AfmAc
|
|
|
5122
5155
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
5123
5156
|
* @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
5124
5157
|
* @param {*} [options] Override http request option.
|
|
5158
|
+
* @deprecated
|
|
5125
5159
|
* @throws {RequiredError}
|
|
5126
5160
|
* @memberof ActionsApi
|
|
5127
5161
|
*/
|
|
@@ -5566,6 +5600,7 @@ export declare interface AfmActionsApiInterface {
|
|
|
5566
5600
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection
|
|
5567
5601
|
* @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters.
|
|
5568
5602
|
* @param {*} [options] Override http request option.
|
|
5603
|
+
* @deprecated
|
|
5569
5604
|
* @throws {RequiredError}
|
|
5570
5605
|
* @memberof ActionsApiInterface
|
|
5571
5606
|
*/
|
|
@@ -5575,6 +5610,7 @@ export declare interface AfmActionsApiInterface {
|
|
|
5575
5610
|
* @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result
|
|
5576
5611
|
* @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters.
|
|
5577
5612
|
* @param {*} [options] Override http request option.
|
|
5613
|
+
* @deprecated
|
|
5578
5614
|
* @throws {RequiredError}
|
|
5579
5615
|
* @memberof ActionsApiInterface
|
|
5580
5616
|
*/
|
|
@@ -10413,6 +10449,24 @@ export declare interface AiSkillResponse {
|
|
|
10413
10449
|
'examples': Array<string>;
|
|
10414
10450
|
}
|
|
10415
10451
|
|
|
10452
|
+
declare interface AiSummarizeRequest {
|
|
10453
|
+
'visualizations': Array<string>;
|
|
10454
|
+
'filterContext': Array<object>;
|
|
10455
|
+
'dashboardId': string;
|
|
10456
|
+
}
|
|
10457
|
+
export { AiSummarizeRequest }
|
|
10458
|
+
export { AiSummarizeRequest as GenAiApiSummarizeRequest }
|
|
10459
|
+
|
|
10460
|
+
declare interface AiSummarizeResponse {
|
|
10461
|
+
'summary': string;
|
|
10462
|
+
'filterContext': Array<object>;
|
|
10463
|
+
'visualizationsIncluded': Array<AiVisualizationIncludedResponse>;
|
|
10464
|
+
'visualizationsExcluded': Array<AiVisualizationExcludedResponse>;
|
|
10465
|
+
'generatedAt': string;
|
|
10466
|
+
}
|
|
10467
|
+
export { AiSummarizeResponse }
|
|
10468
|
+
export { AiSummarizeResponse as GenAiApiSummarizeResponse }
|
|
10469
|
+
|
|
10416
10470
|
export declare interface AiTextFilterValue {
|
|
10417
10471
|
'type': AiTextFilterValueTypeEnum;
|
|
10418
10472
|
'using': string;
|
|
@@ -10643,6 +10697,12 @@ export declare type AiVisualizationConfigAnomalyDetectionSensitivityEnum = 'low'
|
|
|
10643
10697
|
|
|
10644
10698
|
export declare type AiVisualizationConfigAnomalyDetectionSizeEnum = 'small' | 'medium' | 'large';
|
|
10645
10699
|
|
|
10700
|
+
export declare interface AiVisualizationExcludedResponse {
|
|
10701
|
+
'visualizationId': string;
|
|
10702
|
+
'reason': string;
|
|
10703
|
+
'title'?: string | null;
|
|
10704
|
+
}
|
|
10705
|
+
|
|
10646
10706
|
/**
|
|
10647
10707
|
* @type AiVisualizationFilter
|
|
10648
10708
|
*/
|
|
@@ -10655,6 +10715,11 @@ export declare interface AiVisualizationIdUpdateRequest {
|
|
|
10655
10715
|
'id': string;
|
|
10656
10716
|
}
|
|
10657
10717
|
|
|
10718
|
+
export declare interface AiVisualizationIncludedResponse {
|
|
10719
|
+
'visualizationId': string;
|
|
10720
|
+
'title'?: string | null;
|
|
10721
|
+
}
|
|
10722
|
+
|
|
10658
10723
|
export declare interface AiVisualizationMetricsInner {
|
|
10659
10724
|
'field': string;
|
|
10660
10725
|
}
|
|
@@ -11001,13 +11066,13 @@ export declare function AnalyticalDashboardControllerApi_UpdateEntityAnalyticalD
|
|
|
11001
11066
|
* @summary Post Dashboards
|
|
11002
11067
|
* @param {string} workspaceId
|
|
11003
11068
|
* @param {JsonApiAnalyticalDashboardPostOptionalIdDocument} jsonApiAnalyticalDashboardPostOptionalIdDocument
|
|
11004
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11069
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11005
11070
|
* @param {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
11006
11071
|
* @param {*} [options] Override http request option.
|
|
11007
11072
|
* @param {Configuration} [configuration] Optional configuration.
|
|
11008
11073
|
* @throws {RequiredError}
|
|
11009
11074
|
*/
|
|
11010
|
-
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_CreateEntityAnalyticalDashboards(workspaceId: string, jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11075
|
+
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_CreateEntityAnalyticalDashboards(workspaceId: string, jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11011
11076
|
|
|
11012
11077
|
/**
|
|
11013
11078
|
*
|
|
@@ -11026,7 +11091,7 @@ export declare function AnalyticalDashboardControllerApiAxiosParamCreator_Delete
|
|
|
11026
11091
|
* @param {string} workspaceId
|
|
11027
11092
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
11028
11093
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
11029
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11094
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11030
11095
|
* @param {number} [page] Zero-based page index (0..N)
|
|
11031
11096
|
* @param {number} [size] The size of the page to be returned
|
|
11032
11097
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -11036,7 +11101,7 @@ export declare function AnalyticalDashboardControllerApiAxiosParamCreator_Delete
|
|
|
11036
11101
|
* @param {Configuration} [configuration] Optional configuration.
|
|
11037
11102
|
* @throws {RequiredError}
|
|
11038
11103
|
*/
|
|
11039
|
-
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_GetAllEntitiesAnalyticalDashboards(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11104
|
+
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_GetAllEntitiesAnalyticalDashboards(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11040
11105
|
|
|
11041
11106
|
/**
|
|
11042
11107
|
*
|
|
@@ -11044,14 +11109,14 @@ export declare function AnalyticalDashboardControllerApiAxiosParamCreator_GetAll
|
|
|
11044
11109
|
* @param {string} workspaceId
|
|
11045
11110
|
* @param {string} objectId
|
|
11046
11111
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
11047
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11112
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11048
11113
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
11049
11114
|
* @param {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
11050
11115
|
* @param {*} [options] Override http request option.
|
|
11051
11116
|
* @param {Configuration} [configuration] Optional configuration.
|
|
11052
11117
|
* @throws {RequiredError}
|
|
11053
11118
|
*/
|
|
11054
|
-
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_GetEntityAnalyticalDashboards(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11119
|
+
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_GetEntityAnalyticalDashboards(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11055
11120
|
|
|
11056
11121
|
/**
|
|
11057
11122
|
*
|
|
@@ -11060,12 +11125,12 @@ export declare function AnalyticalDashboardControllerApiAxiosParamCreator_GetEnt
|
|
|
11060
11125
|
* @param {string} objectId
|
|
11061
11126
|
* @param {JsonApiAnalyticalDashboardPatchDocument} jsonApiAnalyticalDashboardPatchDocument
|
|
11062
11127
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
11063
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11128
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11064
11129
|
* @param {*} [options] Override http request option.
|
|
11065
11130
|
* @param {Configuration} [configuration] Optional configuration.
|
|
11066
11131
|
* @throws {RequiredError}
|
|
11067
11132
|
*/
|
|
11068
|
-
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_PatchEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardPatchDocument: JsonApiAnalyticalDashboardPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11133
|
+
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_PatchEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardPatchDocument: JsonApiAnalyticalDashboardPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11069
11134
|
|
|
11070
11135
|
/**
|
|
11071
11136
|
*
|
|
@@ -11087,12 +11152,12 @@ export declare function AnalyticalDashboardControllerApiAxiosParamCreator_Search
|
|
|
11087
11152
|
* @param {string} objectId
|
|
11088
11153
|
* @param {JsonApiAnalyticalDashboardInDocument} jsonApiAnalyticalDashboardInDocument
|
|
11089
11154
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
11090
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11155
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11091
11156
|
* @param {*} [options] Override http request option.
|
|
11092
11157
|
* @param {Configuration} [configuration] Optional configuration.
|
|
11093
11158
|
* @throws {RequiredError}
|
|
11094
11159
|
*/
|
|
11095
|
-
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_UpdateEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardInDocument: JsonApiAnalyticalDashboardInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11160
|
+
export declare function AnalyticalDashboardControllerApiAxiosParamCreator_UpdateEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardInDocument: JsonApiAnalyticalDashboardInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
11096
11161
|
|
|
11097
11162
|
/**
|
|
11098
11163
|
* Request parameters for createEntityAnalyticalDashboards operation in AnalyticalDashboardControllerApi.
|
|
@@ -11114,10 +11179,10 @@ export declare interface AnalyticalDashboardControllerApiCreateEntityAnalyticalD
|
|
|
11114
11179
|
readonly jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument;
|
|
11115
11180
|
/**
|
|
11116
11181
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11117
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11182
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11118
11183
|
* @memberof AnalyticalDashboardControllerApiCreateEntityAnalyticalDashboards
|
|
11119
11184
|
*/
|
|
11120
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11185
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11121
11186
|
/**
|
|
11122
11187
|
* Include Meta objects.
|
|
11123
11188
|
* @type {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>}
|
|
@@ -11172,10 +11237,10 @@ export declare interface AnalyticalDashboardControllerApiGetAllEntitiesAnalytica
|
|
|
11172
11237
|
readonly filter?: string;
|
|
11173
11238
|
/**
|
|
11174
11239
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11175
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11240
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11176
11241
|
* @memberof AnalyticalDashboardControllerApiGetAllEntitiesAnalyticalDashboards
|
|
11177
11242
|
*/
|
|
11178
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11243
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11179
11244
|
/**
|
|
11180
11245
|
* Zero-based page index (0..N)
|
|
11181
11246
|
* @type {number}
|
|
@@ -11234,10 +11299,10 @@ export declare interface AnalyticalDashboardControllerApiGetEntityAnalyticalDash
|
|
|
11234
11299
|
readonly filter?: string;
|
|
11235
11300
|
/**
|
|
11236
11301
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11237
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11302
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11238
11303
|
* @memberof AnalyticalDashboardControllerApiGetEntityAnalyticalDashboards
|
|
11239
11304
|
*/
|
|
11240
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11305
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11241
11306
|
/**
|
|
11242
11307
|
*
|
|
11243
11308
|
* @type {boolean}
|
|
@@ -11355,10 +11420,10 @@ export declare interface AnalyticalDashboardControllerApiPatchEntityAnalyticalDa
|
|
|
11355
11420
|
readonly filter?: string;
|
|
11356
11421
|
/**
|
|
11357
11422
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11358
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11423
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11359
11424
|
* @memberof AnalyticalDashboardControllerApiPatchEntityAnalyticalDashboards
|
|
11360
11425
|
*/
|
|
11361
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11426
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11362
11427
|
}
|
|
11363
11428
|
|
|
11364
11429
|
/**
|
|
@@ -11425,10 +11490,10 @@ export declare interface AnalyticalDashboardControllerApiUpdateEntityAnalyticalD
|
|
|
11425
11490
|
readonly filter?: string;
|
|
11426
11491
|
/**
|
|
11427
11492
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
11428
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11493
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
11429
11494
|
* @memberof AnalyticalDashboardControllerApiUpdateEntityAnalyticalDashboards
|
|
11430
11495
|
*/
|
|
11431
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11496
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
11432
11497
|
}
|
|
11433
11498
|
|
|
11434
11499
|
declare namespace AnalyticalDashboardModelV1 {
|
|
@@ -16561,6 +16626,34 @@ export declare interface AutomationDashboardAttributeFilterAttributeFilter {
|
|
|
16561
16626
|
|
|
16562
16627
|
export declare type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
16563
16628
|
|
|
16629
|
+
export declare interface AutomationDashboardCompoundComparisonCondition {
|
|
16630
|
+
'comparison': AutomationDashboardCompoundComparisonConditionComparison;
|
|
16631
|
+
}
|
|
16632
|
+
|
|
16633
|
+
export declare interface AutomationDashboardCompoundComparisonConditionComparison {
|
|
16634
|
+
'operator': AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum;
|
|
16635
|
+
'value': number;
|
|
16636
|
+
}
|
|
16637
|
+
|
|
16638
|
+
export declare type AutomationDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
16639
|
+
|
|
16640
|
+
/**
|
|
16641
|
+
* @type AutomationDashboardCompoundConditionItem
|
|
16642
|
+
*/
|
|
16643
|
+
export declare type AutomationDashboardCompoundConditionItem = AutomationDashboardCompoundComparisonCondition | AutomationDashboardCompoundRangeCondition;
|
|
16644
|
+
|
|
16645
|
+
export declare interface AutomationDashboardCompoundRangeCondition {
|
|
16646
|
+
'range': AutomationDashboardCompoundRangeConditionRange;
|
|
16647
|
+
}
|
|
16648
|
+
|
|
16649
|
+
export declare interface AutomationDashboardCompoundRangeConditionRange {
|
|
16650
|
+
'operator': AutomationDashboardCompoundRangeConditionRangeOperatorEnum;
|
|
16651
|
+
'from': number;
|
|
16652
|
+
'to': number;
|
|
16653
|
+
}
|
|
16654
|
+
|
|
16655
|
+
export declare type AutomationDashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
16656
|
+
|
|
16564
16657
|
export declare interface AutomationDashboardDateFilter {
|
|
16565
16658
|
'dateFilter': AutomationDashboardDateFilterDateFilter;
|
|
16566
16659
|
}
|
|
@@ -16617,7 +16710,7 @@ export declare type AutomationDashboardExportSettingsPageSizeEnum = 'A3' | 'A4'
|
|
|
16617
16710
|
/**
|
|
16618
16711
|
* @type AutomationDashboardFilter
|
|
16619
16712
|
*/
|
|
16620
|
-
export declare type AutomationDashboardFilter = AutomationDashboardArbitraryAttributeFilter | AutomationDashboardAttributeFilter | AutomationDashboardDateFilter | AutomationDashboardMatchAttributeFilter;
|
|
16713
|
+
export declare type AutomationDashboardFilter = AutomationDashboardArbitraryAttributeFilter | AutomationDashboardAttributeFilter | AutomationDashboardDateFilter | AutomationDashboardMatchAttributeFilter | AutomationDashboardMeasureValueFilter;
|
|
16621
16714
|
|
|
16622
16715
|
export declare interface AutomationDashboardMatchAttributeFilter {
|
|
16623
16716
|
'matchAttributeFilter': AutomationDashboardMatchAttributeFilterMatchAttributeFilter;
|
|
@@ -16635,6 +16728,17 @@ export declare interface AutomationDashboardMatchAttributeFilterMatchAttributeFi
|
|
|
16635
16728
|
|
|
16636
16729
|
export declare type AutomationDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
16637
16730
|
|
|
16731
|
+
export declare interface AutomationDashboardMeasureValueFilter {
|
|
16732
|
+
'dashboardMeasureValueFilter': AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter;
|
|
16733
|
+
}
|
|
16734
|
+
|
|
16735
|
+
export declare interface AutomationDashboardMeasureValueFilterDashboardMeasureValueFilter {
|
|
16736
|
+
'measure': AutomationIdentifierRef;
|
|
16737
|
+
'conditions': Array<AutomationDashboardCompoundConditionItem>;
|
|
16738
|
+
'title'?: string;
|
|
16739
|
+
'localIdentifier'?: string;
|
|
16740
|
+
}
|
|
16741
|
+
|
|
16638
16742
|
export declare interface AutomationDashboardTabularExport {
|
|
16639
16743
|
'requestPayload': DashboardTabularExportRequestV2;
|
|
16640
16744
|
}
|
|
@@ -23699,6 +23803,34 @@ export declare interface DashboardAttributeFilterAttributeFilter {
|
|
|
23699
23803
|
|
|
23700
23804
|
export declare type DashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
23701
23805
|
|
|
23806
|
+
export declare interface DashboardCompoundComparisonCondition {
|
|
23807
|
+
'comparison': DashboardCompoundComparisonConditionComparison;
|
|
23808
|
+
}
|
|
23809
|
+
|
|
23810
|
+
export declare interface DashboardCompoundComparisonConditionComparison {
|
|
23811
|
+
'operator': DashboardCompoundComparisonConditionComparisonOperatorEnum;
|
|
23812
|
+
'value': number;
|
|
23813
|
+
}
|
|
23814
|
+
|
|
23815
|
+
export declare type DashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
23816
|
+
|
|
23817
|
+
/**
|
|
23818
|
+
* @type DashboardCompoundConditionItem
|
|
23819
|
+
*/
|
|
23820
|
+
export declare type DashboardCompoundConditionItem = DashboardCompoundComparisonCondition | DashboardCompoundRangeCondition;
|
|
23821
|
+
|
|
23822
|
+
export declare interface DashboardCompoundRangeCondition {
|
|
23823
|
+
'range': DashboardCompoundRangeConditionRange;
|
|
23824
|
+
}
|
|
23825
|
+
|
|
23826
|
+
export declare interface DashboardCompoundRangeConditionRange {
|
|
23827
|
+
'operator': DashboardCompoundRangeConditionRangeOperatorEnum;
|
|
23828
|
+
'from': number;
|
|
23829
|
+
'to': number;
|
|
23830
|
+
}
|
|
23831
|
+
|
|
23832
|
+
export declare type DashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
23833
|
+
|
|
23702
23834
|
/**
|
|
23703
23835
|
* Dashboard the user is currently viewing.
|
|
23704
23836
|
*/
|
|
@@ -23769,7 +23901,7 @@ export declare type DashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'LETTER'
|
|
|
23769
23901
|
/**
|
|
23770
23902
|
* @type DashboardFilter
|
|
23771
23903
|
*/
|
|
23772
|
-
export declare type DashboardFilter = DashboardArbitraryAttributeFilter | DashboardAttributeFilter | DashboardDateFilter | DashboardMatchAttributeFilter;
|
|
23904
|
+
export declare type DashboardFilter = DashboardArbitraryAttributeFilter | DashboardAttributeFilter | DashboardDateFilter | DashboardMatchAttributeFilter | DashboardMeasureValueFilter;
|
|
23773
23905
|
|
|
23774
23906
|
export declare interface DashboardMatchAttributeFilter {
|
|
23775
23907
|
'matchAttributeFilter': DashboardMatchAttributeFilterMatchAttributeFilter;
|
|
@@ -23787,6 +23919,17 @@ export declare interface DashboardMatchAttributeFilterMatchAttributeFilter {
|
|
|
23787
23919
|
|
|
23788
23920
|
export declare type DashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
23789
23921
|
|
|
23922
|
+
export declare interface DashboardMeasureValueFilter {
|
|
23923
|
+
'dashboardMeasureValueFilter': DashboardMeasureValueFilterDashboardMeasureValueFilter;
|
|
23924
|
+
}
|
|
23925
|
+
|
|
23926
|
+
export declare interface DashboardMeasureValueFilterDashboardMeasureValueFilter {
|
|
23927
|
+
'measure': IdentifierRef;
|
|
23928
|
+
'conditions': Array<DashboardCompoundConditionItem>;
|
|
23929
|
+
'title'?: string;
|
|
23930
|
+
'localIdentifier'?: string;
|
|
23931
|
+
}
|
|
23932
|
+
|
|
23790
23933
|
export declare interface DashboardPermissions {
|
|
23791
23934
|
/**
|
|
23792
23935
|
* List of rules
|
|
@@ -24563,13 +24706,13 @@ export declare function DashboardsApi_UpdateEntityAnalyticalDashboards(axios: Ax
|
|
|
24563
24706
|
* @summary Post Dashboards
|
|
24564
24707
|
* @param {string} workspaceId
|
|
24565
24708
|
* @param {JsonApiAnalyticalDashboardPostOptionalIdDocument} jsonApiAnalyticalDashboardPostOptionalIdDocument
|
|
24566
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24709
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24567
24710
|
* @param {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24568
24711
|
* @param {*} [options] Override http request option.
|
|
24569
24712
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24570
24713
|
* @throws {RequiredError}
|
|
24571
24714
|
*/
|
|
24572
|
-
export declare function DashboardsApiAxiosParamCreator_CreateEntityAnalyticalDashboards(workspaceId: string, jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24715
|
+
export declare function DashboardsApiAxiosParamCreator_CreateEntityAnalyticalDashboards(workspaceId: string, jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24573
24716
|
|
|
24574
24717
|
/**
|
|
24575
24718
|
*
|
|
@@ -24588,7 +24731,7 @@ export declare function DashboardsApiAxiosParamCreator_DeleteEntityAnalyticalDas
|
|
|
24588
24731
|
* @param {string} workspaceId
|
|
24589
24732
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
24590
24733
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24591
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24734
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24592
24735
|
* @param {number} [page] Zero-based page index (0..N)
|
|
24593
24736
|
* @param {number} [size] The size of the page to be returned
|
|
24594
24737
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -24598,7 +24741,7 @@ export declare function DashboardsApiAxiosParamCreator_DeleteEntityAnalyticalDas
|
|
|
24598
24741
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24599
24742
|
* @throws {RequiredError}
|
|
24600
24743
|
*/
|
|
24601
|
-
export declare function DashboardsApiAxiosParamCreator_GetAllEntitiesAnalyticalDashboards(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24744
|
+
export declare function DashboardsApiAxiosParamCreator_GetAllEntitiesAnalyticalDashboards(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24602
24745
|
|
|
24603
24746
|
/**
|
|
24604
24747
|
*
|
|
@@ -24606,14 +24749,14 @@ export declare function DashboardsApiAxiosParamCreator_GetAllEntitiesAnalyticalD
|
|
|
24606
24749
|
* @param {string} workspaceId
|
|
24607
24750
|
* @param {string} objectId
|
|
24608
24751
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24609
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24752
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24610
24753
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
24611
24754
|
* @param {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
24612
24755
|
* @param {*} [options] Override http request option.
|
|
24613
24756
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24614
24757
|
* @throws {RequiredError}
|
|
24615
24758
|
*/
|
|
24616
|
-
export declare function DashboardsApiAxiosParamCreator_GetEntityAnalyticalDashboards(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24759
|
+
export declare function DashboardsApiAxiosParamCreator_GetEntityAnalyticalDashboards(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24617
24760
|
|
|
24618
24761
|
/**
|
|
24619
24762
|
*
|
|
@@ -24622,12 +24765,12 @@ export declare function DashboardsApiAxiosParamCreator_GetEntityAnalyticalDashbo
|
|
|
24622
24765
|
* @param {string} objectId
|
|
24623
24766
|
* @param {JsonApiAnalyticalDashboardPatchDocument} jsonApiAnalyticalDashboardPatchDocument
|
|
24624
24767
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24625
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24768
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24626
24769
|
* @param {*} [options] Override http request option.
|
|
24627
24770
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24628
24771
|
* @throws {RequiredError}
|
|
24629
24772
|
*/
|
|
24630
|
-
export declare function DashboardsApiAxiosParamCreator_PatchEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardPatchDocument: JsonApiAnalyticalDashboardPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24773
|
+
export declare function DashboardsApiAxiosParamCreator_PatchEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardPatchDocument: JsonApiAnalyticalDashboardPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24631
24774
|
|
|
24632
24775
|
/**
|
|
24633
24776
|
*
|
|
@@ -24649,12 +24792,12 @@ export declare function DashboardsApiAxiosParamCreator_SearchEntitiesAnalyticalD
|
|
|
24649
24792
|
* @param {string} objectId
|
|
24650
24793
|
* @param {JsonApiAnalyticalDashboardInDocument} jsonApiAnalyticalDashboardInDocument
|
|
24651
24794
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
24652
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24795
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24653
24796
|
* @param {*} [options] Override http request option.
|
|
24654
24797
|
* @param {Configuration} [configuration] Optional configuration.
|
|
24655
24798
|
* @throws {RequiredError}
|
|
24656
24799
|
*/
|
|
24657
|
-
export declare function DashboardsApiAxiosParamCreator_UpdateEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardInDocument: JsonApiAnalyticalDashboardInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24800
|
+
export declare function DashboardsApiAxiosParamCreator_UpdateEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardInDocument: JsonApiAnalyticalDashboardInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
24658
24801
|
|
|
24659
24802
|
/**
|
|
24660
24803
|
* Request parameters for createEntityAnalyticalDashboards operation in DashboardsApi.
|
|
@@ -24676,10 +24819,10 @@ export declare interface DashboardsApiCreateEntityAnalyticalDashboardsRequest {
|
|
|
24676
24819
|
readonly jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument;
|
|
24677
24820
|
/**
|
|
24678
24821
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24679
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24822
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24680
24823
|
* @memberof DashboardsApiCreateEntityAnalyticalDashboards
|
|
24681
24824
|
*/
|
|
24682
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24825
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24683
24826
|
/**
|
|
24684
24827
|
* Include Meta objects.
|
|
24685
24828
|
* @type {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>}
|
|
@@ -24734,10 +24877,10 @@ export declare interface DashboardsApiGetAllEntitiesAnalyticalDashboardsRequest
|
|
|
24734
24877
|
readonly filter?: string;
|
|
24735
24878
|
/**
|
|
24736
24879
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24737
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24880
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24738
24881
|
* @memberof DashboardsApiGetAllEntitiesAnalyticalDashboards
|
|
24739
24882
|
*/
|
|
24740
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24883
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24741
24884
|
/**
|
|
24742
24885
|
* Zero-based page index (0..N)
|
|
24743
24886
|
* @type {number}
|
|
@@ -24796,10 +24939,10 @@ export declare interface DashboardsApiGetEntityAnalyticalDashboardsRequest {
|
|
|
24796
24939
|
readonly filter?: string;
|
|
24797
24940
|
/**
|
|
24798
24941
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24799
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24942
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24800
24943
|
* @memberof DashboardsApiGetEntityAnalyticalDashboards
|
|
24801
24944
|
*/
|
|
24802
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24945
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24803
24946
|
/**
|
|
24804
24947
|
*
|
|
24805
24948
|
* @type {boolean}
|
|
@@ -24917,10 +25060,10 @@ export declare interface DashboardsApiPatchEntityAnalyticalDashboardsRequest {
|
|
|
24917
25060
|
readonly filter?: string;
|
|
24918
25061
|
/**
|
|
24919
25062
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24920
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
25063
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24921
25064
|
* @memberof DashboardsApiPatchEntityAnalyticalDashboards
|
|
24922
25065
|
*/
|
|
24923
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
25066
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24924
25067
|
}
|
|
24925
25068
|
|
|
24926
25069
|
/**
|
|
@@ -24987,10 +25130,10 @@ export declare interface DashboardsApiUpdateEntityAnalyticalDashboardsRequest {
|
|
|
24987
25130
|
readonly filter?: string;
|
|
24988
25131
|
/**
|
|
24989
25132
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
24990
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
25133
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
24991
25134
|
* @memberof DashboardsApiUpdateEntityAnalyticalDashboards
|
|
24992
25135
|
*/
|
|
24993
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
25136
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
24994
25137
|
}
|
|
24995
25138
|
|
|
24996
25139
|
/**
|
|
@@ -29173,7 +29316,7 @@ export declare interface DataSourceStatisticsResponse {
|
|
|
29173
29316
|
}
|
|
29174
29317
|
|
|
29175
29318
|
/**
|
|
29176
|
-
* An id of the table. Including ID of data source.
|
|
29319
|
+
* An id of the table. Including ID of data source. Must NOT be set on AUXILIARY datasets.
|
|
29177
29320
|
*/
|
|
29178
29321
|
export declare interface DataSourceTableIdentifier {
|
|
29179
29322
|
/**
|
|
@@ -29252,7 +29395,7 @@ export declare interface DeclarativeAgent {
|
|
|
29252
29395
|
/**
|
|
29253
29396
|
* List of custom skills when skillsMode is CUSTOM.
|
|
29254
29397
|
*/
|
|
29255
|
-
'customSkills'?: Array<DeclarativeAgentCustomSkillsEnum
|
|
29398
|
+
'customSkills'?: Array<DeclarativeAgentCustomSkillsEnum>;
|
|
29256
29399
|
/**
|
|
29257
29400
|
* Whether AI knowledge is enabled.
|
|
29258
29401
|
*/
|
|
@@ -29277,7 +29420,7 @@ export declare interface DeclarativeAgent {
|
|
|
29277
29420
|
'modifiedBy'?: DeclarativeUserIdentifier;
|
|
29278
29421
|
}
|
|
29279
29422
|
|
|
29280
|
-
export declare type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'what_if_analysis' | 'knowledge';
|
|
29423
|
+
export declare type DeclarativeAgentCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
29281
29424
|
|
|
29282
29425
|
/**
|
|
29283
29426
|
* AI agent configurations.
|
|
@@ -29666,7 +29809,7 @@ export declare interface DeclarativeColorPalette {
|
|
|
29666
29809
|
*/
|
|
29667
29810
|
export declare interface DeclarativeColumn {
|
|
29668
29811
|
/**
|
|
29669
|
-
* Column name
|
|
29812
|
+
* Column name. Must not contain NUL (0x00) characters.
|
|
29670
29813
|
*/
|
|
29671
29814
|
'name': string;
|
|
29672
29815
|
/**
|
|
@@ -29807,11 +29950,11 @@ export declare interface DeclarativeDataset {
|
|
|
29807
29950
|
*/
|
|
29808
29951
|
'facts'?: Array<DeclarativeFact>;
|
|
29809
29952
|
/**
|
|
29810
|
-
* An array of aggregated facts.
|
|
29953
|
+
* An array of aggregated facts. Presence makes the dataset a pre-aggregation dataset, which requires `precedence > 0` and must NOT be set on AUXILIARY datasets.
|
|
29811
29954
|
*/
|
|
29812
29955
|
'aggregatedFacts'?: Array<DeclarativeAggregatedFact>;
|
|
29813
29956
|
/**
|
|
29814
|
-
* An array of references.
|
|
29957
|
+
* An array of references. The semantics of `sources` depends on the dataset shape: for NORMAL→NORMAL references, `sources` is a compound foreign key to the target dataset\'s grain (one source per grain component, dataType-matched). For pre-aggregation datasets (NORMAL with `aggregatedFacts`), `sources` is reinterpreted as independent column→attribute mappings — one entry per source — and targets are NOT required to be grain components.
|
|
29815
29958
|
*/
|
|
29816
29959
|
'references': Array<DeclarativeReference>;
|
|
29817
29960
|
'dataSourceTableId'?: DataSourceTableIdentifier;
|
|
@@ -29825,15 +29968,15 @@ export declare interface DeclarativeDataset {
|
|
|
29825
29968
|
*/
|
|
29826
29969
|
'workspaceDataFilterColumns'?: Array<DeclarativeWorkspaceDataFilterColumn>;
|
|
29827
29970
|
/**
|
|
29828
|
-
* An array of explicit workspace data filters.
|
|
29971
|
+
* An array of explicit workspace data filters. Must NOT be set on AUXILIARY datasets.
|
|
29829
29972
|
*/
|
|
29830
29973
|
'workspaceDataFilterReferences'?: Array<DeclarativeWorkspaceDataFilterReferences>;
|
|
29831
29974
|
/**
|
|
29832
|
-
* Precedence used in aggregate awareness.
|
|
29975
|
+
* Precedence used in aggregate awareness. Pre-aggregation datasets (NORMAL with `aggregatedFacts`) MUST set `precedence > 0`; non-pre-aggregation datasets MUST leave it null. Must NOT be set on AUXILIARY datasets.
|
|
29833
29976
|
*/
|
|
29834
29977
|
'precedence'?: number;
|
|
29835
29978
|
/**
|
|
29836
|
-
* Dataset type
|
|
29979
|
+
* Dataset type. NORMAL is the standard fact/dim dataset. AUXILIARY denotes a synthetic dataset used as a reference target by pre-aggregation datasets (keystone of the aggregate-awareness design); AUX datasets must not carry `aggregatedFacts`, `sql`, `dataSourceTableId`, `workspaceDataFilterReferences` or `precedence`. Date datasets use a separate schema and are not represented by this enum.
|
|
29837
29980
|
*/
|
|
29838
29981
|
'type'?: DeclarativeDatasetTypeEnum;
|
|
29839
29982
|
}
|
|
@@ -29853,7 +29996,7 @@ export declare interface DeclarativeDatasetExtension {
|
|
|
29853
29996
|
}
|
|
29854
29997
|
|
|
29855
29998
|
/**
|
|
29856
|
-
* SQL defining this dataset.
|
|
29999
|
+
* SQL defining this dataset. Must NOT be set on AUXILIARY datasets.
|
|
29857
30000
|
*/
|
|
29858
30001
|
export declare interface DeclarativeDatasetSql {
|
|
29859
30002
|
/**
|
|
@@ -30239,6 +30382,28 @@ export declare type DeclarativeIdentityProviderIdentifierTypeEnum = 'identityPro
|
|
|
30239
30382
|
|
|
30240
30383
|
export declare type DeclarativeIdentityProviderIdpTypeEnum = 'MANAGED_IDP' | 'FIM_IDP' | 'DEX_IDP' | 'CUSTOM_IDP';
|
|
30241
30384
|
|
|
30385
|
+
/**
|
|
30386
|
+
* A declarative form of an IP allowlist policy.
|
|
30387
|
+
*/
|
|
30388
|
+
export declare interface DeclarativeIpAllowlistPolicy {
|
|
30389
|
+
/**
|
|
30390
|
+
* Identifier of an IP allowlist policy.
|
|
30391
|
+
*/
|
|
30392
|
+
'id': string;
|
|
30393
|
+
/**
|
|
30394
|
+
* Allowed source IP addresses or CIDR ranges.
|
|
30395
|
+
*/
|
|
30396
|
+
'allowedSources': Array<string>;
|
|
30397
|
+
/**
|
|
30398
|
+
* Target users this policy applies to.
|
|
30399
|
+
*/
|
|
30400
|
+
'users'?: Array<DeclarativeUserIdentifier>;
|
|
30401
|
+
/**
|
|
30402
|
+
* Target user groups this policy applies to.
|
|
30403
|
+
*/
|
|
30404
|
+
'userGroups'?: Array<DeclarativeUserGroupIdentifier>;
|
|
30405
|
+
}
|
|
30406
|
+
|
|
30242
30407
|
/**
|
|
30243
30408
|
* A declarative form of the JWK.
|
|
30244
30409
|
*/
|
|
@@ -30534,6 +30699,7 @@ export declare interface DeclarativeOrganization {
|
|
|
30534
30699
|
'organization': DeclarativeOrganizationInfo;
|
|
30535
30700
|
'users'?: Array<DeclarativeUser>;
|
|
30536
30701
|
'userGroups'?: Array<DeclarativeUserGroup>;
|
|
30702
|
+
'ipAllowlistPolicies'?: Array<DeclarativeIpAllowlistPolicy>;
|
|
30537
30703
|
'dataSources'?: Array<DeclarativeDataSource>;
|
|
30538
30704
|
'workspaces'?: Array<DeclarativeWorkspace>;
|
|
30539
30705
|
'workspaceDataFilters'?: Array<DeclarativeWorkspaceDataFilter>;
|
|
@@ -30617,7 +30783,7 @@ export declare interface DeclarativeParameter {
|
|
|
30617
30783
|
* Parameter description.
|
|
30618
30784
|
*/
|
|
30619
30785
|
'description'?: string;
|
|
30620
|
-
'content':
|
|
30786
|
+
'content': DeclarativeParameterContent;
|
|
30621
30787
|
/**
|
|
30622
30788
|
* A list of tags.
|
|
30623
30789
|
*/
|
|
@@ -30634,6 +30800,11 @@ export declare interface DeclarativeParameter {
|
|
|
30634
30800
|
'createdAt'?: string | null;
|
|
30635
30801
|
}
|
|
30636
30802
|
|
|
30803
|
+
/**
|
|
30804
|
+
* @type DeclarativeParameterContent
|
|
30805
|
+
*/
|
|
30806
|
+
export declare type DeclarativeParameterContent = NumberParameterDefinition | StringParameterDefinition;
|
|
30807
|
+
|
|
30637
30808
|
/**
|
|
30638
30809
|
* A dataset reference.
|
|
30639
30810
|
*/
|
|
@@ -30748,7 +30919,7 @@ export declare interface DeclarativeSetting {
|
|
|
30748
30919
|
'type'?: DeclarativeSettingTypeEnum;
|
|
30749
30920
|
}
|
|
30750
30921
|
|
|
30751
|
-
export declare type DeclarativeSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
30922
|
+
export declare type DeclarativeSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
30752
30923
|
|
|
30753
30924
|
export declare interface DeclarativeSingleWorkspacePermission {
|
|
30754
30925
|
/**
|
|
@@ -31385,6 +31556,9 @@ export declare interface DependentEntitiesGraph {
|
|
|
31385
31556
|
|
|
31386
31557
|
export declare interface DependentEntitiesNode {
|
|
31387
31558
|
'id': string;
|
|
31559
|
+
/**
|
|
31560
|
+
* Object type in the graph.
|
|
31561
|
+
*/
|
|
31388
31562
|
'type': DependentEntitiesNodeTypeEnum;
|
|
31389
31563
|
'title'?: string;
|
|
31390
31564
|
}
|
|
@@ -31663,6 +31837,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
31663
31837
|
* @memberof EntitiesApi
|
|
31664
31838
|
*/
|
|
31665
31839
|
createEntityCustomGeoCollections(requestParameters: EntitiesApiCreateEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutDocument>;
|
|
31840
|
+
/**
|
|
31841
|
+
*
|
|
31842
|
+
* @summary Post a new custom application setting for the user
|
|
31843
|
+
* @param {EntitiesApiCreateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
31844
|
+
* @param {*} [options] Override http request option.
|
|
31845
|
+
* @throws {RequiredError}
|
|
31846
|
+
* @memberof EntitiesApi
|
|
31847
|
+
*/
|
|
31848
|
+
createEntityCustomUserApplicationSettings(requestParameters: EntitiesApiCreateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
31666
31849
|
/**
|
|
31667
31850
|
*
|
|
31668
31851
|
* @summary Post Plugins
|
|
@@ -31979,6 +32162,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
31979
32162
|
* @memberof EntitiesApi
|
|
31980
32163
|
*/
|
|
31981
32164
|
deleteEntityCustomGeoCollections(requestParameters: EntitiesApiDeleteEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
32165
|
+
/**
|
|
32166
|
+
*
|
|
32167
|
+
* @summary Delete a custom application setting for a user
|
|
32168
|
+
* @param {EntitiesApiDeleteEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
32169
|
+
* @param {*} [options] Override http request option.
|
|
32170
|
+
* @throws {RequiredError}
|
|
32171
|
+
* @memberof EntitiesApi
|
|
32172
|
+
*/
|
|
32173
|
+
deleteEntityCustomUserApplicationSettings(requestParameters: EntitiesApiDeleteEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
31982
32174
|
/**
|
|
31983
32175
|
*
|
|
31984
32176
|
* @summary Delete a Plugin
|
|
@@ -32322,6 +32514,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
32322
32514
|
* @memberof EntitiesApi
|
|
32323
32515
|
*/
|
|
32324
32516
|
getAllEntitiesCustomGeoCollections(requestParameters?: EntitiesApiGetAllEntitiesCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutList>;
|
|
32517
|
+
/**
|
|
32518
|
+
*
|
|
32519
|
+
* @summary List all custom application settings for a user
|
|
32520
|
+
* @param {EntitiesApiGetAllEntitiesCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
32521
|
+
* @param {*} [options] Override http request option.
|
|
32522
|
+
* @throws {RequiredError}
|
|
32523
|
+
* @memberof EntitiesApi
|
|
32524
|
+
*/
|
|
32525
|
+
getAllEntitiesCustomUserApplicationSettings(requestParameters: EntitiesApiGetAllEntitiesCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutList>;
|
|
32325
32526
|
/**
|
|
32326
32527
|
*
|
|
32327
32528
|
* @summary Get all Plugins
|
|
@@ -32746,6 +32947,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
32746
32947
|
* @memberof EntitiesApi
|
|
32747
32948
|
*/
|
|
32748
32949
|
getEntityCustomGeoCollections(requestParameters: EntitiesApiGetEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutDocument>;
|
|
32950
|
+
/**
|
|
32951
|
+
*
|
|
32952
|
+
* @summary Get a custom application setting for a user
|
|
32953
|
+
* @param {EntitiesApiGetEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
32954
|
+
* @param {*} [options] Override http request option.
|
|
32955
|
+
* @throws {RequiredError}
|
|
32956
|
+
* @memberof EntitiesApi
|
|
32957
|
+
*/
|
|
32958
|
+
getEntityCustomUserApplicationSettings(requestParameters: EntitiesApiGetEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
32749
32959
|
/**
|
|
32750
32960
|
*
|
|
32751
32961
|
* @summary Get a Plugin
|
|
@@ -33414,15 +33624,6 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
33414
33624
|
* @memberof EntitiesApi
|
|
33415
33625
|
*/
|
|
33416
33626
|
patchEntityWorkspaces(requestParameters: EntitiesApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
33417
|
-
/**
|
|
33418
|
-
* Notification sets up all reports to be computed again with new data.
|
|
33419
|
-
* @summary Register an upload notification
|
|
33420
|
-
* @param {EntitiesApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
33421
|
-
* @param {*} [options] Override http request option.
|
|
33422
|
-
* @throws {RequiredError}
|
|
33423
|
-
* @memberof EntitiesApi
|
|
33424
|
-
*/
|
|
33425
|
-
registerUploadNotificationWorkspaces(requestParameters: EntitiesApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
33426
33627
|
/**
|
|
33427
33628
|
*
|
|
33428
33629
|
* @summary The search endpoint (beta)
|
|
@@ -33711,6 +33912,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
33711
33912
|
* @memberof EntitiesApi
|
|
33712
33913
|
*/
|
|
33713
33914
|
updateEntityCustomGeoCollections(requestParameters: EntitiesApiUpdateEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutDocument>;
|
|
33915
|
+
/**
|
|
33916
|
+
*
|
|
33917
|
+
* @summary Put a custom application setting for the user
|
|
33918
|
+
* @param {EntitiesApiUpdateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
33919
|
+
* @param {*} [options] Override http request option.
|
|
33920
|
+
* @throws {RequiredError}
|
|
33921
|
+
* @memberof EntitiesApi
|
|
33922
|
+
*/
|
|
33923
|
+
updateEntityCustomUserApplicationSettings(requestParameters: EntitiesApiUpdateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
33714
33924
|
/**
|
|
33715
33925
|
*
|
|
33716
33926
|
* @summary Put a Plugin
|
|
@@ -36393,18 +36603,6 @@ export declare function EntitiesApi_PatchEntityWorkspaces(axios: AxiosInstance,
|
|
|
36393
36603
|
*/
|
|
36394
36604
|
export declare function EntitiesApi_PatchEntityWorkspaceSettings(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiWorkspaceSettingOutDocument>;
|
|
36395
36605
|
|
|
36396
|
-
/**
|
|
36397
|
-
* Notification sets up all reports to be computed again with new data.
|
|
36398
|
-
* @summary Register an upload notification
|
|
36399
|
-
* @param {AxiosInstance} axios Axios instance.
|
|
36400
|
-
* @param {string} basePath Base path.
|
|
36401
|
-
* @param {EntitiesApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
36402
|
-
* @param {*} [options] Override http request option.
|
|
36403
|
-
* @param {Configuration} [configuration] Optional configuration.
|
|
36404
|
-
* @throws {RequiredError}
|
|
36405
|
-
*/
|
|
36406
|
-
export declare function EntitiesApi_RegisterUploadNotificationWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
36407
|
-
|
|
36408
36606
|
/**
|
|
36409
36607
|
*
|
|
36410
36608
|
* @summary The search endpoint (beta)
|
|
@@ -37129,13 +37327,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityAgents(jsonApiA
|
|
|
37129
37327
|
* @summary Post Dashboards
|
|
37130
37328
|
* @param {string} workspaceId
|
|
37131
37329
|
* @param {JsonApiAnalyticalDashboardPostOptionalIdDocument} jsonApiAnalyticalDashboardPostOptionalIdDocument
|
|
37132
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37330
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37133
37331
|
* @param {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
37134
37332
|
* @param {*} [options] Override http request option.
|
|
37135
37333
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37136
37334
|
* @throws {RequiredError}
|
|
37137
37335
|
*/
|
|
37138
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityAnalyticalDashboards(workspaceId: string, jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
37336
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityAnalyticalDashboards(workspaceId: string, jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
37139
37337
|
|
|
37140
37338
|
/**
|
|
37141
37339
|
*
|
|
@@ -37461,13 +37659,13 @@ export declare function EntitiesApiAxiosParamCreator_CreateEntityUserSettings(us
|
|
|
37461
37659
|
* @summary Post Visualization Objects
|
|
37462
37660
|
* @param {string} workspaceId
|
|
37463
37661
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
37464
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37662
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37465
37663
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
37466
37664
|
* @param {*} [options] Override http request option.
|
|
37467
37665
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37468
37666
|
* @throws {RequiredError}
|
|
37469
37667
|
*/
|
|
37470
|
-
export declare function EntitiesApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
37668
|
+
export declare function EntitiesApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
37471
37669
|
|
|
37472
37670
|
/**
|
|
37473
37671
|
*
|
|
@@ -37942,7 +38140,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAggregatedFac
|
|
|
37942
38140
|
* @param {string} workspaceId
|
|
37943
38141
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
37944
38142
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
37945
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
38143
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
37946
38144
|
* @param {number} [page] Zero-based page index (0..N)
|
|
37947
38145
|
* @param {number} [size] The size of the page to be returned
|
|
37948
38146
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -37952,7 +38150,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAggregatedFac
|
|
|
37952
38150
|
* @param {Configuration} [configuration] Optional configuration.
|
|
37953
38151
|
* @throws {RequiredError}
|
|
37954
38152
|
*/
|
|
37955
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAnalyticalDashboards(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
38153
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesAnalyticalDashboards(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
37956
38154
|
|
|
37957
38155
|
/**
|
|
37958
38156
|
*
|
|
@@ -38531,7 +38729,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserSettings(
|
|
|
38531
38729
|
* @param {string} workspaceId
|
|
38532
38730
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
38533
38731
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
38534
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
38732
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
38535
38733
|
* @param {number} [page] Zero-based page index (0..N)
|
|
38536
38734
|
* @param {number} [size] The size of the page to be returned
|
|
38537
38735
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -38541,7 +38739,7 @@ export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesUserSettings(
|
|
|
38541
38739
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38542
38740
|
* @throws {RequiredError}
|
|
38543
38741
|
*/
|
|
38544
|
-
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
38742
|
+
export declare function EntitiesApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
38545
38743
|
|
|
38546
38744
|
/**
|
|
38547
38745
|
*
|
|
@@ -38662,14 +38860,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityAggregatedFacts(wo
|
|
|
38662
38860
|
* @param {string} workspaceId
|
|
38663
38861
|
* @param {string} objectId
|
|
38664
38862
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
38665
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
38863
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
38666
38864
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
38667
38865
|
* @param {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
38668
38866
|
* @param {*} [options] Override http request option.
|
|
38669
38867
|
* @param {Configuration} [configuration] Optional configuration.
|
|
38670
38868
|
* @throws {RequiredError}
|
|
38671
38869
|
*/
|
|
38672
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityAnalyticalDashboards(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
38870
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityAnalyticalDashboards(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
38673
38871
|
|
|
38674
38872
|
/**
|
|
38675
38873
|
*
|
|
@@ -39165,14 +39363,14 @@ export declare function EntitiesApiAxiosParamCreator_GetEntityUserSettings(userI
|
|
|
39165
39363
|
* @param {string} workspaceId
|
|
39166
39364
|
* @param {string} objectId
|
|
39167
39365
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
39168
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39366
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39169
39367
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
39170
39368
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39171
39369
|
* @param {*} [options] Override http request option.
|
|
39172
39370
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39173
39371
|
* @throws {RequiredError}
|
|
39174
39372
|
*/
|
|
39175
|
-
export declare function EntitiesApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39373
|
+
export declare function EntitiesApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39176
39374
|
|
|
39177
39375
|
/**
|
|
39178
39376
|
*
|
|
@@ -39261,12 +39459,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityAgents(id: strin
|
|
|
39261
39459
|
* @param {string} objectId
|
|
39262
39460
|
* @param {JsonApiAnalyticalDashboardPatchDocument} jsonApiAnalyticalDashboardPatchDocument
|
|
39263
39461
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
39264
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39462
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39265
39463
|
* @param {*} [options] Override http request option.
|
|
39266
39464
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39267
39465
|
* @throws {RequiredError}
|
|
39268
39466
|
*/
|
|
39269
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardPatchDocument: JsonApiAnalyticalDashboardPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39467
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardPatchDocument: JsonApiAnalyticalDashboardPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39270
39468
|
|
|
39271
39469
|
/**
|
|
39272
39470
|
*
|
|
@@ -39693,12 +39891,12 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityUsers(id: string
|
|
|
39693
39891
|
* @param {string} objectId
|
|
39694
39892
|
* @param {JsonApiVisualizationObjectPatchDocument} jsonApiVisualizationObjectPatchDocument
|
|
39695
39893
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
39696
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39894
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
39697
39895
|
* @param {*} [options] Override http request option.
|
|
39698
39896
|
* @param {Configuration} [configuration] Optional configuration.
|
|
39699
39897
|
* @throws {RequiredError}
|
|
39700
39898
|
*/
|
|
39701
|
-
export declare function EntitiesApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39899
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39702
39900
|
|
|
39703
39901
|
/**
|
|
39704
39902
|
*
|
|
@@ -39754,18 +39952,6 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityWorkspaces(id: s
|
|
|
39754
39952
|
*/
|
|
39755
39953
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityWorkspaceSettings(workspaceId: string, objectId: string, jsonApiWorkspaceSettingPatchDocument: JsonApiWorkspaceSettingPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39756
39954
|
|
|
39757
|
-
/**
|
|
39758
|
-
* Notification sets up all reports to be computed again with new data.
|
|
39759
|
-
* @summary Register an upload notification
|
|
39760
|
-
* @param {string} workspaceId
|
|
39761
|
-
* @param {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
39762
|
-
* @param {object} [body] Request body
|
|
39763
|
-
* @param {*} [options] Override http request option.
|
|
39764
|
-
* @param {Configuration} [configuration] Optional configuration.
|
|
39765
|
-
* @throws {RequiredError}
|
|
39766
|
-
*/
|
|
39767
|
-
export declare function EntitiesApiAxiosParamCreator_RegisterUploadNotificationWorkspaces(workspaceId: string, metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>, body?: object, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39768
|
-
|
|
39769
39955
|
/**
|
|
39770
39956
|
*
|
|
39771
39957
|
* @summary The search endpoint (beta)
|
|
@@ -40085,12 +40271,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityAgents(id: stri
|
|
|
40085
40271
|
* @param {string} objectId
|
|
40086
40272
|
* @param {JsonApiAnalyticalDashboardInDocument} jsonApiAnalyticalDashboardInDocument
|
|
40087
40273
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
40088
|
-
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40274
|
+
* @param {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40089
40275
|
* @param {*} [options] Override http request option.
|
|
40090
40276
|
* @param {Configuration} [configuration] Optional configuration.
|
|
40091
40277
|
* @throws {RequiredError}
|
|
40092
40278
|
*/
|
|
40093
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardInDocument: JsonApiAnalyticalDashboardInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
40279
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityAnalyticalDashboards(workspaceId: string, objectId: string, jsonApiAnalyticalDashboardInDocument: JsonApiAnalyticalDashboardInDocument, filter?: string, include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
40094
40280
|
|
|
40095
40281
|
/**
|
|
40096
40282
|
*
|
|
@@ -40474,12 +40660,12 @@ export declare function EntitiesApiAxiosParamCreator_UpdateEntityUserSettings(us
|
|
|
40474
40660
|
* @param {string} objectId
|
|
40475
40661
|
* @param {JsonApiVisualizationObjectInDocument} jsonApiVisualizationObjectInDocument
|
|
40476
40662
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
40477
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40663
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40478
40664
|
* @param {*} [options] Override http request option.
|
|
40479
40665
|
* @param {Configuration} [configuration] Optional configuration.
|
|
40480
40666
|
* @throws {RequiredError}
|
|
40481
40667
|
*/
|
|
40482
|
-
export declare function EntitiesApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
40668
|
+
export declare function EntitiesApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
40483
40669
|
|
|
40484
40670
|
/**
|
|
40485
40671
|
*
|
|
@@ -40575,10 +40761,10 @@ export declare interface EntitiesApiCreateEntityAnalyticalDashboardsRequest {
|
|
|
40575
40761
|
readonly jsonApiAnalyticalDashboardPostOptionalIdDocument: JsonApiAnalyticalDashboardPostOptionalIdDocument;
|
|
40576
40762
|
/**
|
|
40577
40763
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
40578
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
40764
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
40579
40765
|
* @memberof EntitiesApiCreateEntityAnalyticalDashboards
|
|
40580
40766
|
*/
|
|
40581
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
40767
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
40582
40768
|
/**
|
|
40583
40769
|
* Include Meta objects.
|
|
40584
40770
|
* @type {Array<'permissions' | 'origin' | 'accessInfo' | 'all' | 'ALL'>}
|
|
@@ -40739,6 +40925,26 @@ export declare interface EntitiesApiCreateEntityCustomGeoCollectionsRequest {
|
|
|
40739
40925
|
readonly jsonApiCustomGeoCollectionInDocument: JsonApiCustomGeoCollectionInDocument;
|
|
40740
40926
|
}
|
|
40741
40927
|
|
|
40928
|
+
/**
|
|
40929
|
+
* Request parameters for createEntityCustomUserApplicationSettings operation in EntitiesApi.
|
|
40930
|
+
* @export
|
|
40931
|
+
* @interface EntitiesApiCreateEntityCustomUserApplicationSettingsRequest
|
|
40932
|
+
*/
|
|
40933
|
+
export declare interface EntitiesApiCreateEntityCustomUserApplicationSettingsRequest {
|
|
40934
|
+
/**
|
|
40935
|
+
*
|
|
40936
|
+
* @type {string}
|
|
40937
|
+
* @memberof EntitiesApiCreateEntityCustomUserApplicationSettings
|
|
40938
|
+
*/
|
|
40939
|
+
readonly userId: string;
|
|
40940
|
+
/**
|
|
40941
|
+
*
|
|
40942
|
+
* @type {JsonApiCustomUserApplicationSettingPostOptionalIdDocument}
|
|
40943
|
+
* @memberof EntitiesApiCreateEntityCustomUserApplicationSettings
|
|
40944
|
+
*/
|
|
40945
|
+
readonly jsonApiCustomUserApplicationSettingPostOptionalIdDocument: JsonApiCustomUserApplicationSettingPostOptionalIdDocument;
|
|
40946
|
+
}
|
|
40947
|
+
|
|
40742
40948
|
/**
|
|
40743
40949
|
* Request parameters for createEntityDashboardPlugins operation in EntitiesApi.
|
|
40744
40950
|
* @export
|
|
@@ -41233,10 +41439,10 @@ export declare interface EntitiesApiCreateEntityVisualizationObjectsRequest {
|
|
|
41233
41439
|
readonly jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument;
|
|
41234
41440
|
/**
|
|
41235
41441
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
41236
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
41442
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
41237
41443
|
* @memberof EntitiesApiCreateEntityVisualizationObjects
|
|
41238
41444
|
*/
|
|
41239
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
41445
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
41240
41446
|
/**
|
|
41241
41447
|
* Include Meta objects.
|
|
41242
41448
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -41517,6 +41723,26 @@ export declare interface EntitiesApiDeleteEntityCustomGeoCollectionsRequest {
|
|
|
41517
41723
|
readonly id: string;
|
|
41518
41724
|
}
|
|
41519
41725
|
|
|
41726
|
+
/**
|
|
41727
|
+
* Request parameters for deleteEntityCustomUserApplicationSettings operation in EntitiesApi.
|
|
41728
|
+
* @export
|
|
41729
|
+
* @interface EntitiesApiDeleteEntityCustomUserApplicationSettingsRequest
|
|
41730
|
+
*/
|
|
41731
|
+
export declare interface EntitiesApiDeleteEntityCustomUserApplicationSettingsRequest {
|
|
41732
|
+
/**
|
|
41733
|
+
*
|
|
41734
|
+
* @type {string}
|
|
41735
|
+
* @memberof EntitiesApiDeleteEntityCustomUserApplicationSettings
|
|
41736
|
+
*/
|
|
41737
|
+
readonly userId: string;
|
|
41738
|
+
/**
|
|
41739
|
+
*
|
|
41740
|
+
* @type {string}
|
|
41741
|
+
* @memberof EntitiesApiDeleteEntityCustomUserApplicationSettings
|
|
41742
|
+
*/
|
|
41743
|
+
readonly id: string;
|
|
41744
|
+
}
|
|
41745
|
+
|
|
41520
41746
|
/**
|
|
41521
41747
|
* Request parameters for deleteEntityDashboardPlugins operation in EntitiesApi.
|
|
41522
41748
|
* @export
|
|
@@ -42141,10 +42367,10 @@ export declare interface EntitiesApiGetAllEntitiesAnalyticalDashboardsRequest {
|
|
|
42141
42367
|
readonly filter?: string;
|
|
42142
42368
|
/**
|
|
42143
42369
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
42144
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
42370
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
42145
42371
|
* @memberof EntitiesApiGetAllEntitiesAnalyticalDashboards
|
|
42146
42372
|
*/
|
|
42147
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
42373
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
42148
42374
|
/**
|
|
42149
42375
|
* Zero-based page index (0..N)
|
|
42150
42376
|
* @type {number}
|
|
@@ -42577,6 +42803,50 @@ export declare interface EntitiesApiGetAllEntitiesCustomGeoCollectionsRequest {
|
|
|
42577
42803
|
readonly metaInclude?: Array<'page' | 'all' | 'ALL'>;
|
|
42578
42804
|
}
|
|
42579
42805
|
|
|
42806
|
+
/**
|
|
42807
|
+
* Request parameters for getAllEntitiesCustomUserApplicationSettings operation in EntitiesApi.
|
|
42808
|
+
* @export
|
|
42809
|
+
* @interface EntitiesApiGetAllEntitiesCustomUserApplicationSettingsRequest
|
|
42810
|
+
*/
|
|
42811
|
+
export declare interface EntitiesApiGetAllEntitiesCustomUserApplicationSettingsRequest {
|
|
42812
|
+
/**
|
|
42813
|
+
*
|
|
42814
|
+
* @type {string}
|
|
42815
|
+
* @memberof EntitiesApiGetAllEntitiesCustomUserApplicationSettings
|
|
42816
|
+
*/
|
|
42817
|
+
readonly userId: string;
|
|
42818
|
+
/**
|
|
42819
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
42820
|
+
* @type {string}
|
|
42821
|
+
* @memberof EntitiesApiGetAllEntitiesCustomUserApplicationSettings
|
|
42822
|
+
*/
|
|
42823
|
+
readonly filter?: string;
|
|
42824
|
+
/**
|
|
42825
|
+
* Zero-based page index (0..N)
|
|
42826
|
+
* @type {number}
|
|
42827
|
+
* @memberof EntitiesApiGetAllEntitiesCustomUserApplicationSettings
|
|
42828
|
+
*/
|
|
42829
|
+
readonly page?: number;
|
|
42830
|
+
/**
|
|
42831
|
+
* The size of the page to be returned
|
|
42832
|
+
* @type {number}
|
|
42833
|
+
* @memberof EntitiesApiGetAllEntitiesCustomUserApplicationSettings
|
|
42834
|
+
*/
|
|
42835
|
+
readonly size?: number;
|
|
42836
|
+
/**
|
|
42837
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
42838
|
+
* @type {Array<string>}
|
|
42839
|
+
* @memberof EntitiesApiGetAllEntitiesCustomUserApplicationSettings
|
|
42840
|
+
*/
|
|
42841
|
+
readonly sort?: Array<string>;
|
|
42842
|
+
/**
|
|
42843
|
+
* Include Meta objects.
|
|
42844
|
+
* @type {Array<'page' | 'all' | 'ALL'>}
|
|
42845
|
+
* @memberof EntitiesApiGetAllEntitiesCustomUserApplicationSettings
|
|
42846
|
+
*/
|
|
42847
|
+
readonly metaInclude?: Array<'page' | 'all' | 'ALL'>;
|
|
42848
|
+
}
|
|
42849
|
+
|
|
42580
42850
|
/**
|
|
42581
42851
|
* Request parameters for getAllEntitiesDashboardPlugins operation in EntitiesApi.
|
|
42582
42852
|
* @export
|
|
@@ -43973,10 +44243,10 @@ export declare interface EntitiesApiGetAllEntitiesVisualizationObjectsRequest {
|
|
|
43973
44243
|
readonly filter?: string;
|
|
43974
44244
|
/**
|
|
43975
44245
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
43976
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
44246
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
43977
44247
|
* @memberof EntitiesApiGetAllEntitiesVisualizationObjects
|
|
43978
44248
|
*/
|
|
43979
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
44249
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
43980
44250
|
/**
|
|
43981
44251
|
* Zero-based page index (0..N)
|
|
43982
44252
|
* @type {number}
|
|
@@ -44329,10 +44599,10 @@ export declare interface EntitiesApiGetEntityAnalyticalDashboardsRequest {
|
|
|
44329
44599
|
readonly filter?: string;
|
|
44330
44600
|
/**
|
|
44331
44601
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
44332
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
44602
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
44333
44603
|
* @memberof EntitiesApiGetEntityAnalyticalDashboards
|
|
44334
44604
|
*/
|
|
44335
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
44605
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
44336
44606
|
/**
|
|
44337
44607
|
*
|
|
44338
44608
|
* @type {boolean}
|
|
@@ -44623,6 +44893,32 @@ export declare interface EntitiesApiGetEntityCustomGeoCollectionsRequest {
|
|
|
44623
44893
|
readonly filter?: string;
|
|
44624
44894
|
}
|
|
44625
44895
|
|
|
44896
|
+
/**
|
|
44897
|
+
* Request parameters for getEntityCustomUserApplicationSettings operation in EntitiesApi.
|
|
44898
|
+
* @export
|
|
44899
|
+
* @interface EntitiesApiGetEntityCustomUserApplicationSettingsRequest
|
|
44900
|
+
*/
|
|
44901
|
+
export declare interface EntitiesApiGetEntityCustomUserApplicationSettingsRequest {
|
|
44902
|
+
/**
|
|
44903
|
+
*
|
|
44904
|
+
* @type {string}
|
|
44905
|
+
* @memberof EntitiesApiGetEntityCustomUserApplicationSettings
|
|
44906
|
+
*/
|
|
44907
|
+
readonly userId: string;
|
|
44908
|
+
/**
|
|
44909
|
+
*
|
|
44910
|
+
* @type {string}
|
|
44911
|
+
* @memberof EntitiesApiGetEntityCustomUserApplicationSettings
|
|
44912
|
+
*/
|
|
44913
|
+
readonly id: string;
|
|
44914
|
+
/**
|
|
44915
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
44916
|
+
* @type {string}
|
|
44917
|
+
* @memberof EntitiesApiGetEntityCustomUserApplicationSettings
|
|
44918
|
+
*/
|
|
44919
|
+
readonly filter?: string;
|
|
44920
|
+
}
|
|
44921
|
+
|
|
44626
44922
|
/**
|
|
44627
44923
|
* Request parameters for getEntityDashboardPlugins operation in EntitiesApi.
|
|
44628
44924
|
* @export
|
|
@@ -45553,10 +45849,10 @@ export declare interface EntitiesApiGetEntityVisualizationObjectsRequest {
|
|
|
45553
45849
|
readonly filter?: string;
|
|
45554
45850
|
/**
|
|
45555
45851
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
45556
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
45852
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
45557
45853
|
* @memberof EntitiesApiGetEntityVisualizationObjects
|
|
45558
45854
|
*/
|
|
45559
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
45855
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
45560
45856
|
/**
|
|
45561
45857
|
*
|
|
45562
45858
|
* @type {boolean}
|
|
@@ -45830,6 +46126,15 @@ export declare interface EntitiesApiInterface {
|
|
|
45830
46126
|
* @memberof EntitiesApiInterface
|
|
45831
46127
|
*/
|
|
45832
46128
|
createEntityCustomGeoCollections(requestParameters: EntitiesApiCreateEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutDocument>;
|
|
46129
|
+
/**
|
|
46130
|
+
*
|
|
46131
|
+
* @summary Post a new custom application setting for the user
|
|
46132
|
+
* @param {EntitiesApiCreateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
46133
|
+
* @param {*} [options] Override http request option.
|
|
46134
|
+
* @throws {RequiredError}
|
|
46135
|
+
* @memberof EntitiesApiInterface
|
|
46136
|
+
*/
|
|
46137
|
+
createEntityCustomUserApplicationSettings(requestParameters: EntitiesApiCreateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
45833
46138
|
/**
|
|
45834
46139
|
*
|
|
45835
46140
|
* @summary Post Plugins
|
|
@@ -46146,6 +46451,15 @@ export declare interface EntitiesApiInterface {
|
|
|
46146
46451
|
* @memberof EntitiesApiInterface
|
|
46147
46452
|
*/
|
|
46148
46453
|
deleteEntityCustomGeoCollections(requestParameters: EntitiesApiDeleteEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
46454
|
+
/**
|
|
46455
|
+
*
|
|
46456
|
+
* @summary Delete a custom application setting for a user
|
|
46457
|
+
* @param {EntitiesApiDeleteEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
46458
|
+
* @param {*} [options] Override http request option.
|
|
46459
|
+
* @throws {RequiredError}
|
|
46460
|
+
* @memberof EntitiesApiInterface
|
|
46461
|
+
*/
|
|
46462
|
+
deleteEntityCustomUserApplicationSettings(requestParameters: EntitiesApiDeleteEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
46149
46463
|
/**
|
|
46150
46464
|
*
|
|
46151
46465
|
* @summary Delete a Plugin
|
|
@@ -46489,6 +46803,15 @@ export declare interface EntitiesApiInterface {
|
|
|
46489
46803
|
* @memberof EntitiesApiInterface
|
|
46490
46804
|
*/
|
|
46491
46805
|
getAllEntitiesCustomGeoCollections(requestParameters: EntitiesApiGetAllEntitiesCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutList>;
|
|
46806
|
+
/**
|
|
46807
|
+
*
|
|
46808
|
+
* @summary List all custom application settings for a user
|
|
46809
|
+
* @param {EntitiesApiGetAllEntitiesCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
46810
|
+
* @param {*} [options] Override http request option.
|
|
46811
|
+
* @throws {RequiredError}
|
|
46812
|
+
* @memberof EntitiesApiInterface
|
|
46813
|
+
*/
|
|
46814
|
+
getAllEntitiesCustomUserApplicationSettings(requestParameters: EntitiesApiGetAllEntitiesCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutList>;
|
|
46492
46815
|
/**
|
|
46493
46816
|
*
|
|
46494
46817
|
* @summary Get all Plugins
|
|
@@ -46913,6 +47236,15 @@ export declare interface EntitiesApiInterface {
|
|
|
46913
47236
|
* @memberof EntitiesApiInterface
|
|
46914
47237
|
*/
|
|
46915
47238
|
getEntityCustomGeoCollections(requestParameters: EntitiesApiGetEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutDocument>;
|
|
47239
|
+
/**
|
|
47240
|
+
*
|
|
47241
|
+
* @summary Get a custom application setting for a user
|
|
47242
|
+
* @param {EntitiesApiGetEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
47243
|
+
* @param {*} [options] Override http request option.
|
|
47244
|
+
* @throws {RequiredError}
|
|
47245
|
+
* @memberof EntitiesApiInterface
|
|
47246
|
+
*/
|
|
47247
|
+
getEntityCustomUserApplicationSettings(requestParameters: EntitiesApiGetEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
46916
47248
|
/**
|
|
46917
47249
|
*
|
|
46918
47250
|
* @summary Get a Plugin
|
|
@@ -47581,15 +47913,6 @@ export declare interface EntitiesApiInterface {
|
|
|
47581
47913
|
* @memberof EntitiesApiInterface
|
|
47582
47914
|
*/
|
|
47583
47915
|
patchEntityWorkspaces(requestParameters: EntitiesApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
47584
|
-
/**
|
|
47585
|
-
* Notification sets up all reports to be computed again with new data.
|
|
47586
|
-
* @summary Register an upload notification
|
|
47587
|
-
* @param {EntitiesApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
47588
|
-
* @param {*} [options] Override http request option.
|
|
47589
|
-
* @throws {RequiredError}
|
|
47590
|
-
* @memberof EntitiesApiInterface
|
|
47591
|
-
*/
|
|
47592
|
-
registerUploadNotificationWorkspaces(requestParameters: EntitiesApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
47593
47916
|
/**
|
|
47594
47917
|
*
|
|
47595
47918
|
* @summary The search endpoint (beta)
|
|
@@ -47878,6 +48201,15 @@ export declare interface EntitiesApiInterface {
|
|
|
47878
48201
|
* @memberof EntitiesApiInterface
|
|
47879
48202
|
*/
|
|
47880
48203
|
updateEntityCustomGeoCollections(requestParameters: EntitiesApiUpdateEntityCustomGeoCollectionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomGeoCollectionOutDocument>;
|
|
48204
|
+
/**
|
|
48205
|
+
*
|
|
48206
|
+
* @summary Put a custom application setting for the user
|
|
48207
|
+
* @param {EntitiesApiUpdateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
48208
|
+
* @param {*} [options] Override http request option.
|
|
48209
|
+
* @throws {RequiredError}
|
|
48210
|
+
* @memberof EntitiesApiInterface
|
|
48211
|
+
*/
|
|
48212
|
+
updateEntityCustomUserApplicationSettings(requestParameters: EntitiesApiUpdateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
47881
48213
|
/**
|
|
47882
48214
|
*
|
|
47883
48215
|
* @summary Put a Plugin
|
|
@@ -48188,10 +48520,10 @@ export declare interface EntitiesApiPatchEntityAnalyticalDashboardsRequest {
|
|
|
48188
48520
|
readonly filter?: string;
|
|
48189
48521
|
/**
|
|
48190
48522
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
48191
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
48523
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
48192
48524
|
* @memberof EntitiesApiPatchEntityAnalyticalDashboards
|
|
48193
48525
|
*/
|
|
48194
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48526
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
48195
48527
|
}
|
|
48196
48528
|
|
|
48197
48529
|
/**
|
|
@@ -49262,10 +49594,10 @@ export declare interface EntitiesApiPatchEntityVisualizationObjectsRequest {
|
|
|
49262
49594
|
readonly filter?: string;
|
|
49263
49595
|
/**
|
|
49264
49596
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
49265
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
49597
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
49266
49598
|
* @memberof EntitiesApiPatchEntityVisualizationObjects
|
|
49267
49599
|
*/
|
|
49268
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
49600
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
49269
49601
|
}
|
|
49270
49602
|
|
|
49271
49603
|
/**
|
|
@@ -49408,32 +49740,6 @@ export declare interface EntitiesApiPatchEntityWorkspacesRequest {
|
|
|
49408
49740
|
readonly include?: Array<'workspaces' | 'parent' | 'ALL'>;
|
|
49409
49741
|
}
|
|
49410
49742
|
|
|
49411
|
-
/**
|
|
49412
|
-
* Request parameters for registerUploadNotificationWorkspaces operation in EntitiesApi.
|
|
49413
|
-
* @export
|
|
49414
|
-
* @interface EntitiesApiRegisterUploadNotificationWorkspacesRequest
|
|
49415
|
-
*/
|
|
49416
|
-
export declare interface EntitiesApiRegisterUploadNotificationWorkspacesRequest {
|
|
49417
|
-
/**
|
|
49418
|
-
*
|
|
49419
|
-
* @type {string}
|
|
49420
|
-
* @memberof EntitiesApiRegisterUploadNotificationWorkspaces
|
|
49421
|
-
*/
|
|
49422
|
-
readonly workspaceId: string;
|
|
49423
|
-
/**
|
|
49424
|
-
* Include Meta objects.
|
|
49425
|
-
* @type {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>}
|
|
49426
|
-
* @memberof EntitiesApiRegisterUploadNotificationWorkspaces
|
|
49427
|
-
*/
|
|
49428
|
-
readonly metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>;
|
|
49429
|
-
/**
|
|
49430
|
-
* Request body
|
|
49431
|
-
* @type {object}
|
|
49432
|
-
* @memberof EntitiesApiRegisterUploadNotificationWorkspaces
|
|
49433
|
-
*/
|
|
49434
|
-
readonly body?: object;
|
|
49435
|
-
}
|
|
49436
|
-
|
|
49437
49743
|
/**
|
|
49438
49744
|
* Request parameters for searchEntitiesAggregatedFacts operation in EntitiesApi.
|
|
49439
49745
|
* @export
|
|
@@ -50234,10 +50540,10 @@ export declare interface EntitiesApiUpdateEntityAnalyticalDashboardsRequest {
|
|
|
50234
50540
|
readonly filter?: string;
|
|
50235
50541
|
/**
|
|
50236
50542
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
50237
|
-
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
50543
|
+
* @type {Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
50238
50544
|
* @memberof EntitiesApiUpdateEntityAnalyticalDashboards
|
|
50239
50545
|
*/
|
|
50240
|
-
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
50546
|
+
readonly include?: Array<'userIdentifiers' | 'visualizationObjects' | 'analyticalDashboards' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'filterContexts' | 'dashboardPlugins' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
50241
50547
|
}
|
|
50242
50548
|
|
|
50243
50549
|
/**
|
|
@@ -50452,6 +50758,38 @@ export declare interface EntitiesApiUpdateEntityCustomGeoCollectionsRequest {
|
|
|
50452
50758
|
readonly filter?: string;
|
|
50453
50759
|
}
|
|
50454
50760
|
|
|
50761
|
+
/**
|
|
50762
|
+
* Request parameters for updateEntityCustomUserApplicationSettings operation in EntitiesApi.
|
|
50763
|
+
* @export
|
|
50764
|
+
* @interface EntitiesApiUpdateEntityCustomUserApplicationSettingsRequest
|
|
50765
|
+
*/
|
|
50766
|
+
export declare interface EntitiesApiUpdateEntityCustomUserApplicationSettingsRequest {
|
|
50767
|
+
/**
|
|
50768
|
+
*
|
|
50769
|
+
* @type {string}
|
|
50770
|
+
* @memberof EntitiesApiUpdateEntityCustomUserApplicationSettings
|
|
50771
|
+
*/
|
|
50772
|
+
readonly userId: string;
|
|
50773
|
+
/**
|
|
50774
|
+
*
|
|
50775
|
+
* @type {string}
|
|
50776
|
+
* @memberof EntitiesApiUpdateEntityCustomUserApplicationSettings
|
|
50777
|
+
*/
|
|
50778
|
+
readonly id: string;
|
|
50779
|
+
/**
|
|
50780
|
+
*
|
|
50781
|
+
* @type {JsonApiCustomUserApplicationSettingInDocument}
|
|
50782
|
+
* @memberof EntitiesApiUpdateEntityCustomUserApplicationSettings
|
|
50783
|
+
*/
|
|
50784
|
+
readonly jsonApiCustomUserApplicationSettingInDocument: JsonApiCustomUserApplicationSettingInDocument;
|
|
50785
|
+
/**
|
|
50786
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
50787
|
+
* @type {string}
|
|
50788
|
+
* @memberof EntitiesApiUpdateEntityCustomUserApplicationSettings
|
|
50789
|
+
*/
|
|
50790
|
+
readonly filter?: string;
|
|
50791
|
+
}
|
|
50792
|
+
|
|
50455
50793
|
/**
|
|
50456
50794
|
* Request parameters for updateEntityDashboardPlugins operation in EntitiesApi.
|
|
50457
50795
|
* @export
|
|
@@ -51188,10 +51526,10 @@ export declare interface EntitiesApiUpdateEntityVisualizationObjectsRequest {
|
|
|
51188
51526
|
readonly filter?: string;
|
|
51189
51527
|
/**
|
|
51190
51528
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
51191
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51529
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
51192
51530
|
* @memberof EntitiesApiUpdateEntityVisualizationObjects
|
|
51193
51531
|
*/
|
|
51194
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51532
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
51195
51533
|
}
|
|
51196
51534
|
|
|
51197
51535
|
/**
|
|
@@ -51755,10 +52093,13 @@ export declare interface EntityIdentifier {
|
|
|
51755
52093
|
* Object identifier.
|
|
51756
52094
|
*/
|
|
51757
52095
|
'id': string;
|
|
52096
|
+
/**
|
|
52097
|
+
* Object type in the graph.
|
|
52098
|
+
*/
|
|
51758
52099
|
'type': EntityIdentifierTypeEnum;
|
|
51759
52100
|
}
|
|
51760
52101
|
|
|
51761
|
-
export declare type EntityIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'automation' | 'knowledgeRecommendation' | 'visualizationObject' | 'filterContext' | 'filterView';
|
|
52102
|
+
export declare type EntityIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'parameter' | 'automation' | 'memoryItem' | 'knowledgeRecommendation' | 'visualizationObject' | 'filterContext' | 'filterView';
|
|
51762
52103
|
|
|
51763
52104
|
/**
|
|
51764
52105
|
* Request body for entity search operations
|
|
@@ -52430,6 +52771,34 @@ export declare interface ExportDashboardAttributeFilterAttributeFilter {
|
|
|
52430
52771
|
|
|
52431
52772
|
export declare type ExportDashboardAttributeFilterAttributeFilterSelectionModeEnum = 'single' | 'multi';
|
|
52432
52773
|
|
|
52774
|
+
export declare interface ExportDashboardCompoundComparisonCondition {
|
|
52775
|
+
'comparison': ExportDashboardCompoundComparisonConditionComparison;
|
|
52776
|
+
}
|
|
52777
|
+
|
|
52778
|
+
export declare interface ExportDashboardCompoundComparisonConditionComparison {
|
|
52779
|
+
'operator': ExportDashboardCompoundComparisonConditionComparisonOperatorEnum;
|
|
52780
|
+
'value': number;
|
|
52781
|
+
}
|
|
52782
|
+
|
|
52783
|
+
export declare type ExportDashboardCompoundComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
52784
|
+
|
|
52785
|
+
/**
|
|
52786
|
+
* @type ExportDashboardCompoundConditionItem
|
|
52787
|
+
*/
|
|
52788
|
+
export declare type ExportDashboardCompoundConditionItem = ExportDashboardCompoundComparisonCondition | ExportDashboardCompoundRangeCondition;
|
|
52789
|
+
|
|
52790
|
+
export declare interface ExportDashboardCompoundRangeCondition {
|
|
52791
|
+
'range': ExportDashboardCompoundRangeConditionRange;
|
|
52792
|
+
}
|
|
52793
|
+
|
|
52794
|
+
export declare interface ExportDashboardCompoundRangeConditionRange {
|
|
52795
|
+
'operator': ExportDashboardCompoundRangeConditionRangeOperatorEnum;
|
|
52796
|
+
'from': number;
|
|
52797
|
+
'to': number;
|
|
52798
|
+
}
|
|
52799
|
+
|
|
52800
|
+
export declare type ExportDashboardCompoundRangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
52801
|
+
|
|
52433
52802
|
export declare interface ExportDashboardDateFilter {
|
|
52434
52803
|
'dateFilter': ExportDashboardDateFilterDateFilter;
|
|
52435
52804
|
}
|
|
@@ -52486,7 +52855,7 @@ export declare type ExportDashboardExportSettingsPageSizeEnum = 'A3' | 'A4' | 'L
|
|
|
52486
52855
|
/**
|
|
52487
52856
|
* @type ExportDashboardFilter
|
|
52488
52857
|
*/
|
|
52489
|
-
export declare type ExportDashboardFilter = ExportDashboardArbitraryAttributeFilter | ExportDashboardAttributeFilter | ExportDashboardDateFilter | ExportDashboardMatchAttributeFilter;
|
|
52858
|
+
export declare type ExportDashboardFilter = ExportDashboardArbitraryAttributeFilter | ExportDashboardAttributeFilter | ExportDashboardDateFilter | ExportDashboardMatchAttributeFilter | ExportDashboardMeasureValueFilter;
|
|
52490
52859
|
|
|
52491
52860
|
export declare interface ExportDashboardMatchAttributeFilter {
|
|
52492
52861
|
'matchAttributeFilter': ExportDashboardMatchAttributeFilterMatchAttributeFilter;
|
|
@@ -52504,6 +52873,17 @@ export declare interface ExportDashboardMatchAttributeFilterMatchAttributeFilter
|
|
|
52504
52873
|
|
|
52505
52874
|
export declare type ExportDashboardMatchAttributeFilterMatchAttributeFilterOperatorEnum = 'contains' | 'startsWith' | 'endsWith';
|
|
52506
52875
|
|
|
52876
|
+
export declare interface ExportDashboardMeasureValueFilter {
|
|
52877
|
+
'dashboardMeasureValueFilter': ExportDashboardMeasureValueFilterDashboardMeasureValueFilter;
|
|
52878
|
+
}
|
|
52879
|
+
|
|
52880
|
+
export declare interface ExportDashboardMeasureValueFilterDashboardMeasureValueFilter {
|
|
52881
|
+
'measure': ExportIdentifierRef;
|
|
52882
|
+
'conditions': Array<ExportDashboardCompoundConditionItem>;
|
|
52883
|
+
'title'?: string;
|
|
52884
|
+
'localIdentifier'?: string;
|
|
52885
|
+
}
|
|
52886
|
+
|
|
52507
52887
|
/**
|
|
52508
52888
|
* Export request object describing the export properties for dashboard tabular exports.
|
|
52509
52889
|
*/
|
|
@@ -61647,12 +62027,12 @@ export declare class InvalidateCacheApi extends MetadataBaseApi implements Inval
|
|
|
61647
62027
|
/**
|
|
61648
62028
|
* Notification sets up all reports to be computed again with new data.
|
|
61649
62029
|
* @summary Register an upload notification
|
|
61650
|
-
* @param {
|
|
62030
|
+
* @param {InvalidateCacheApiRegisterWorkspaceUploadNotificationRequest} requestParameters Request parameters.
|
|
61651
62031
|
* @param {*} [options] Override http request option.
|
|
61652
62032
|
* @throws {RequiredError}
|
|
61653
62033
|
* @memberof InvalidateCacheApi
|
|
61654
62034
|
*/
|
|
61655
|
-
|
|
62035
|
+
registerWorkspaceUploadNotification(requestParameters: InvalidateCacheApiRegisterWorkspaceUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
61656
62036
|
}
|
|
61657
62037
|
|
|
61658
62038
|
/**
|
|
@@ -61667,18 +62047,6 @@ export declare class InvalidateCacheApi extends MetadataBaseApi implements Inval
|
|
|
61667
62047
|
*/
|
|
61668
62048
|
export declare function InvalidateCacheApi_RegisterUploadNotification(axios: AxiosInstance, basePath: string, requestParameters: InvalidateCacheApiRegisterUploadNotificationRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<void>;
|
|
61669
62049
|
|
|
61670
|
-
/**
|
|
61671
|
-
* Notification sets up all reports to be computed again with new data.
|
|
61672
|
-
* @summary Register an upload notification
|
|
61673
|
-
* @param {AxiosInstance} axios Axios instance.
|
|
61674
|
-
* @param {string} basePath Base path.
|
|
61675
|
-
* @param {InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
61676
|
-
* @param {*} [options] Override http request option.
|
|
61677
|
-
* @param {Configuration} [configuration] Optional configuration.
|
|
61678
|
-
* @throws {RequiredError}
|
|
61679
|
-
*/
|
|
61680
|
-
export declare function InvalidateCacheApi_RegisterUploadNotificationWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: InvalidateCacheApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
61681
|
-
|
|
61682
62050
|
/**
|
|
61683
62051
|
* Notification sets up all reports to be computed again with new data.
|
|
61684
62052
|
* @summary Register an upload notification
|
|
@@ -61689,18 +62057,6 @@ export declare function InvalidateCacheApi_RegisterUploadNotificationWorkspaces(
|
|
|
61689
62057
|
*/
|
|
61690
62058
|
export declare function InvalidateCacheApiAxiosParamCreator_RegisterUploadNotification(dataSourceId: string, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
61691
62059
|
|
|
61692
|
-
/**
|
|
61693
|
-
* Notification sets up all reports to be computed again with new data.
|
|
61694
|
-
* @summary Register an upload notification
|
|
61695
|
-
* @param {string} workspaceId
|
|
61696
|
-
* @param {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
61697
|
-
* @param {object} [body] Request body
|
|
61698
|
-
* @param {*} [options] Override http request option.
|
|
61699
|
-
* @param {Configuration} [configuration] Optional configuration.
|
|
61700
|
-
* @throws {RequiredError}
|
|
61701
|
-
*/
|
|
61702
|
-
export declare function InvalidateCacheApiAxiosParamCreator_RegisterUploadNotificationWorkspaces(workspaceId: string, metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>, body?: object, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
61703
|
-
|
|
61704
62060
|
/**
|
|
61705
62061
|
* InvalidateCacheApi - interface
|
|
61706
62062
|
* @export
|
|
@@ -61719,12 +62075,12 @@ export declare interface InvalidateCacheApiInterface {
|
|
|
61719
62075
|
/**
|
|
61720
62076
|
* Notification sets up all reports to be computed again with new data.
|
|
61721
62077
|
* @summary Register an upload notification
|
|
61722
|
-
* @param {
|
|
62078
|
+
* @param {InvalidateCacheApiRegisterWorkspaceUploadNotificationRequest} requestParameters Request parameters.
|
|
61723
62079
|
* @param {*} [options] Override http request option.
|
|
61724
62080
|
* @throws {RequiredError}
|
|
61725
62081
|
* @memberof InvalidateCacheApiInterface
|
|
61726
62082
|
*/
|
|
61727
|
-
|
|
62083
|
+
registerWorkspaceUploadNotification(requestParameters: InvalidateCacheApiRegisterWorkspaceUploadNotificationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
61728
62084
|
}
|
|
61729
62085
|
|
|
61730
62086
|
/**
|
|
@@ -61742,29 +62098,17 @@ export declare interface InvalidateCacheApiRegisterUploadNotificationRequest {
|
|
|
61742
62098
|
}
|
|
61743
62099
|
|
|
61744
62100
|
/**
|
|
61745
|
-
* Request parameters for
|
|
62101
|
+
* Request parameters for registerWorkspaceUploadNotification operation in InvalidateCacheApi.
|
|
61746
62102
|
* @export
|
|
61747
|
-
* @interface
|
|
62103
|
+
* @interface InvalidateCacheApiRegisterWorkspaceUploadNotificationRequest
|
|
61748
62104
|
*/
|
|
61749
|
-
export declare interface
|
|
62105
|
+
export declare interface InvalidateCacheApiRegisterWorkspaceUploadNotificationRequest {
|
|
61750
62106
|
/**
|
|
61751
62107
|
*
|
|
61752
62108
|
* @type {string}
|
|
61753
|
-
* @memberof
|
|
62109
|
+
* @memberof InvalidateCacheApiRegisterWorkspaceUploadNotification
|
|
61754
62110
|
*/
|
|
61755
62111
|
readonly workspaceId: string;
|
|
61756
|
-
/**
|
|
61757
|
-
* Include Meta objects.
|
|
61758
|
-
* @type {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>}
|
|
61759
|
-
* @memberof InvalidateCacheApiRegisterUploadNotificationWorkspaces
|
|
61760
|
-
*/
|
|
61761
|
-
readonly metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>;
|
|
61762
|
-
/**
|
|
61763
|
-
* Request body
|
|
61764
|
-
* @type {object}
|
|
61765
|
-
* @memberof InvalidateCacheApiRegisterUploadNotificationWorkspaces
|
|
61766
|
-
*/
|
|
61767
|
-
readonly body?: object;
|
|
61768
62112
|
}
|
|
61769
62113
|
|
|
61770
62114
|
export declare interface Invitation {
|
|
@@ -62548,9 +62892,10 @@ export declare interface ITigerInsightWidget extends ITigerBaseWidget {
|
|
|
62548
62892
|
type: "insight";
|
|
62549
62893
|
insight: ObjRef;
|
|
62550
62894
|
ignoreDashboardFilters?: Array<{
|
|
62551
|
-
type: "attributeFilterReference" | "dateFilterReference";
|
|
62895
|
+
type: "attributeFilterReference" | "dateFilterReference" | "measureValueFilterReference";
|
|
62552
62896
|
displayForm?: ObjRef;
|
|
62553
62897
|
dataSet?: ObjRef;
|
|
62898
|
+
measure?: ObjRef;
|
|
62554
62899
|
}>;
|
|
62555
62900
|
drills?: any[];
|
|
62556
62901
|
title?: string;
|
|
@@ -62920,7 +63265,7 @@ export declare interface JsonApiAgentInAttributes {
|
|
|
62920
63265
|
'isPreview'?: boolean;
|
|
62921
63266
|
}
|
|
62922
63267
|
|
|
62923
|
-
export declare type JsonApiAgentInAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'what_if_analysis' | 'knowledge';
|
|
63268
|
+
export declare type JsonApiAgentInAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
62924
63269
|
|
|
62925
63270
|
export declare type JsonApiAgentInAttributesSkillsModeEnum = 'all' | 'custom';
|
|
62926
63271
|
|
|
@@ -62960,7 +63305,7 @@ export declare interface JsonApiAgentOutAttributes {
|
|
|
62960
63305
|
'modifiedAt'?: string;
|
|
62961
63306
|
}
|
|
62962
63307
|
|
|
62963
|
-
export declare type JsonApiAgentOutAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'what_if_analysis' | 'knowledge';
|
|
63308
|
+
export declare type JsonApiAgentOutAttributesCustomSkillsEnum = 'alert' | 'anomaly_detection' | 'clustering' | 'forecasting' | 'key_driver_analysis' | 'metric' | 'schedule_export' | 'visualization' | 'visualization_summary' | 'dashboard_summary' | 'what_if_analysis' | 'knowledge';
|
|
62964
63309
|
|
|
62965
63310
|
export declare type JsonApiAgentOutAttributesSkillsModeEnum = 'all' | 'custom';
|
|
62966
63311
|
|
|
@@ -63244,7 +63589,7 @@ export declare interface JsonApiAnalyticalDashboardOutDocument {
|
|
|
63244
63589
|
/**
|
|
63245
63590
|
* @type JsonApiAnalyticalDashboardOutIncludes
|
|
63246
63591
|
*/
|
|
63247
|
-
export declare type JsonApiAnalyticalDashboardOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiDashboardPluginOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFilterContextOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiVisualizationObjectOutWithLinks;
|
|
63592
|
+
export declare type JsonApiAnalyticalDashboardOutIncludes = JsonApiAnalyticalDashboardOutWithLinks | JsonApiDashboardPluginOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFilterContextOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiParameterOutWithLinks | JsonApiUserIdentifierOutWithLinks | JsonApiVisualizationObjectOutWithLinks;
|
|
63248
63593
|
|
|
63249
63594
|
/**
|
|
63250
63595
|
* A JSON:API document with a list of resources
|
|
@@ -63298,6 +63643,7 @@ export declare interface JsonApiAnalyticalDashboardOutRelationships {
|
|
|
63298
63643
|
'analyticalDashboards'?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
63299
63644
|
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
63300
63645
|
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
63646
|
+
'parameters'?: JsonApiAnalyticalDashboardOutRelationshipsParameters;
|
|
63301
63647
|
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
63302
63648
|
'filterContexts'?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
63303
63649
|
'dashboardPlugins'?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
@@ -63345,6 +63691,13 @@ export declare interface JsonApiAnalyticalDashboardOutRelationshipsMetrics {
|
|
|
63345
63691
|
'data': Array<JsonApiMetricLinkage>;
|
|
63346
63692
|
}
|
|
63347
63693
|
|
|
63694
|
+
export declare interface JsonApiAnalyticalDashboardOutRelationshipsParameters {
|
|
63695
|
+
/**
|
|
63696
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
63697
|
+
*/
|
|
63698
|
+
'data': Array<JsonApiParameterLinkage>;
|
|
63699
|
+
}
|
|
63700
|
+
|
|
63348
63701
|
export declare interface JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects {
|
|
63349
63702
|
/**
|
|
63350
63703
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -64226,7 +64579,15 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
64226
64579
|
* API identifier of an object
|
|
64227
64580
|
*/
|
|
64228
64581
|
'id': string;
|
|
64229
|
-
'attributes'?:
|
|
64582
|
+
'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
64583
|
+
}
|
|
64584
|
+
|
|
64585
|
+
export declare interface JsonApiCookieSecurityConfigurationInAttributes {
|
|
64586
|
+
'lastRotation'?: string;
|
|
64587
|
+
/**
|
|
64588
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
64589
|
+
*/
|
|
64590
|
+
'rotationInterval'?: string;
|
|
64230
64591
|
}
|
|
64231
64592
|
|
|
64232
64593
|
export declare interface JsonApiCookieSecurityConfigurationInDocument {
|
|
@@ -64247,7 +64608,7 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
64247
64608
|
* API identifier of an object
|
|
64248
64609
|
*/
|
|
64249
64610
|
'id': string;
|
|
64250
|
-
'attributes'?:
|
|
64611
|
+
'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
64251
64612
|
}
|
|
64252
64613
|
|
|
64253
64614
|
export declare interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
@@ -64269,15 +64630,7 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
64269
64630
|
* API identifier of an object
|
|
64270
64631
|
*/
|
|
64271
64632
|
'id': string;
|
|
64272
|
-
'attributes'?:
|
|
64273
|
-
}
|
|
64274
|
-
|
|
64275
|
-
export declare interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
64276
|
-
'lastRotation'?: string;
|
|
64277
|
-
/**
|
|
64278
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
64279
|
-
*/
|
|
64280
|
-
'rotationInterval'?: string;
|
|
64633
|
+
'attributes'?: JsonApiCookieSecurityConfigurationInAttributes;
|
|
64281
64634
|
}
|
|
64282
64635
|
|
|
64283
64636
|
export declare interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
@@ -64602,6 +64955,106 @@ export declare interface JsonApiCustomGeoCollectionPatchDocument {
|
|
|
64602
64955
|
|
|
64603
64956
|
export declare type JsonApiCustomGeoCollectionPatchTypeEnum = 'customGeoCollection';
|
|
64604
64957
|
|
|
64958
|
+
/**
|
|
64959
|
+
* JSON:API representation of customUserApplicationSetting entity.
|
|
64960
|
+
*/
|
|
64961
|
+
export declare interface JsonApiCustomUserApplicationSettingIn {
|
|
64962
|
+
/**
|
|
64963
|
+
* Object type
|
|
64964
|
+
*/
|
|
64965
|
+
'type': JsonApiCustomUserApplicationSettingInTypeEnum;
|
|
64966
|
+
/**
|
|
64967
|
+
* API identifier of an object
|
|
64968
|
+
*/
|
|
64969
|
+
'id': string;
|
|
64970
|
+
'attributes': JsonApiCustomUserApplicationSettingPostOptionalIdAttributes;
|
|
64971
|
+
}
|
|
64972
|
+
|
|
64973
|
+
export declare interface JsonApiCustomUserApplicationSettingInDocument {
|
|
64974
|
+
'data': JsonApiCustomUserApplicationSettingIn;
|
|
64975
|
+
}
|
|
64976
|
+
|
|
64977
|
+
export declare type JsonApiCustomUserApplicationSettingInTypeEnum = 'customUserApplicationSetting';
|
|
64978
|
+
|
|
64979
|
+
/**
|
|
64980
|
+
* JSON:API representation of customUserApplicationSetting entity.
|
|
64981
|
+
*/
|
|
64982
|
+
export declare interface JsonApiCustomUserApplicationSettingOut {
|
|
64983
|
+
/**
|
|
64984
|
+
* Object type
|
|
64985
|
+
*/
|
|
64986
|
+
'type': JsonApiCustomUserApplicationSettingOutTypeEnum;
|
|
64987
|
+
/**
|
|
64988
|
+
* API identifier of an object
|
|
64989
|
+
*/
|
|
64990
|
+
'id': string;
|
|
64991
|
+
'attributes': JsonApiCustomUserApplicationSettingPostOptionalIdAttributes;
|
|
64992
|
+
}
|
|
64993
|
+
|
|
64994
|
+
export declare interface JsonApiCustomUserApplicationSettingOutDocument {
|
|
64995
|
+
'data': JsonApiCustomUserApplicationSettingOut;
|
|
64996
|
+
'links'?: ObjectLinks;
|
|
64997
|
+
}
|
|
64998
|
+
|
|
64999
|
+
/**
|
|
65000
|
+
* A JSON:API document with a list of resources
|
|
65001
|
+
*/
|
|
65002
|
+
export declare interface JsonApiCustomUserApplicationSettingOutList {
|
|
65003
|
+
'data': Array<JsonApiCustomUserApplicationSettingOutWithLinks>;
|
|
65004
|
+
'links'?: ListLinks;
|
|
65005
|
+
'meta'?: JsonApiAgentOutListMeta;
|
|
65006
|
+
}
|
|
65007
|
+
|
|
65008
|
+
export declare type JsonApiCustomUserApplicationSettingOutTypeEnum = 'customUserApplicationSetting';
|
|
65009
|
+
|
|
65010
|
+
export declare interface JsonApiCustomUserApplicationSettingOutWithLinks {
|
|
65011
|
+
/**
|
|
65012
|
+
* Object type
|
|
65013
|
+
*/
|
|
65014
|
+
'type': JsonApiCustomUserApplicationSettingOutWithLinksTypeEnum;
|
|
65015
|
+
/**
|
|
65016
|
+
* API identifier of an object
|
|
65017
|
+
*/
|
|
65018
|
+
'id': string;
|
|
65019
|
+
'attributes': JsonApiCustomUserApplicationSettingPostOptionalIdAttributes;
|
|
65020
|
+
'links'?: ObjectLinks;
|
|
65021
|
+
}
|
|
65022
|
+
|
|
65023
|
+
export declare type JsonApiCustomUserApplicationSettingOutWithLinksTypeEnum = 'customUserApplicationSetting';
|
|
65024
|
+
|
|
65025
|
+
/**
|
|
65026
|
+
* JSON:API representation of customUserApplicationSetting entity.
|
|
65027
|
+
*/
|
|
65028
|
+
export declare interface JsonApiCustomUserApplicationSettingPostOptionalId {
|
|
65029
|
+
/**
|
|
65030
|
+
* Object type
|
|
65031
|
+
*/
|
|
65032
|
+
'type': JsonApiCustomUserApplicationSettingPostOptionalIdTypeEnum;
|
|
65033
|
+
/**
|
|
65034
|
+
* API identifier of an object
|
|
65035
|
+
*/
|
|
65036
|
+
'id'?: string;
|
|
65037
|
+
'attributes': JsonApiCustomUserApplicationSettingPostOptionalIdAttributes;
|
|
65038
|
+
}
|
|
65039
|
+
|
|
65040
|
+
export declare interface JsonApiCustomUserApplicationSettingPostOptionalIdAttributes {
|
|
65041
|
+
'applicationName': string;
|
|
65042
|
+
/**
|
|
65043
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
65044
|
+
*/
|
|
65045
|
+
'content': object;
|
|
65046
|
+
/**
|
|
65047
|
+
* Workspace scope for this setting. Must reference an existing workspace the caller has at least VIEW access to. Null means user-level (no workspace scope).
|
|
65048
|
+
*/
|
|
65049
|
+
'workspaceId'?: string | null;
|
|
65050
|
+
}
|
|
65051
|
+
|
|
65052
|
+
export declare interface JsonApiCustomUserApplicationSettingPostOptionalIdDocument {
|
|
65053
|
+
'data': JsonApiCustomUserApplicationSettingPostOptionalId;
|
|
65054
|
+
}
|
|
65055
|
+
|
|
65056
|
+
export declare type JsonApiCustomUserApplicationSettingPostOptionalIdTypeEnum = 'customUserApplicationSetting';
|
|
65057
|
+
|
|
64605
65058
|
/**
|
|
64606
65059
|
* JSON:API representation of dashboardPlugin entity.
|
|
64607
65060
|
*/
|
|
@@ -65097,7 +65550,7 @@ export declare interface JsonApiDataSourceInAttributes {
|
|
|
65097
65550
|
*/
|
|
65098
65551
|
'alternativeDataSourceId'?: string | null;
|
|
65099
65552
|
/**
|
|
65100
|
-
* Determines how datetime values are interpreted in data sources without native support for specifying this.
|
|
65553
|
+
* Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.
|
|
65101
65554
|
*/
|
|
65102
65555
|
'dateTimeSemantics'?: JsonApiDataSourceInAttributesDateTimeSemanticsEnum | null;
|
|
65103
65556
|
}
|
|
@@ -65181,7 +65634,7 @@ export declare interface JsonApiDataSourceOutAttributes {
|
|
|
65181
65634
|
*/
|
|
65182
65635
|
'alternativeDataSourceId'?: string | null;
|
|
65183
65636
|
/**
|
|
65184
|
-
* Determines how datetime values are interpreted in data sources without native support for specifying this.
|
|
65637
|
+
* Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.
|
|
65185
65638
|
*/
|
|
65186
65639
|
'dateTimeSemantics'?: JsonApiDataSourceOutAttributesDateTimeSemanticsEnum | null;
|
|
65187
65640
|
}
|
|
@@ -65299,7 +65752,7 @@ export declare interface JsonApiDataSourcePatchAttributes {
|
|
|
65299
65752
|
*/
|
|
65300
65753
|
'alternativeDataSourceId'?: string | null;
|
|
65301
65754
|
/**
|
|
65302
|
-
* Determines how datetime values are interpreted in data sources without native support for specifying this.
|
|
65755
|
+
* Determines how datetime values are interpreted in data sources without native support for specifying this. Only StarRocks and AI Lakehouse data sources currently support this.
|
|
65303
65756
|
*/
|
|
65304
65757
|
'dateTimeSemantics'?: JsonApiDataSourcePatchAttributesDateTimeSemanticsEnum | null;
|
|
65305
65758
|
}
|
|
@@ -66000,34 +66453,14 @@ export declare interface JsonApiFilterViewIn {
|
|
|
66000
66453
|
* API identifier of an object
|
|
66001
66454
|
*/
|
|
66002
66455
|
'id': string;
|
|
66003
|
-
'attributes':
|
|
66004
|
-
'relationships'?:
|
|
66005
|
-
}
|
|
66006
|
-
|
|
66007
|
-
export declare interface JsonApiFilterViewInAttributes {
|
|
66008
|
-
'title': string;
|
|
66009
|
-
'description'?: string;
|
|
66010
|
-
'tags'?: Array<string>;
|
|
66011
|
-
'areRelationsValid'?: boolean;
|
|
66012
|
-
/**
|
|
66013
|
-
* Indicator whether the filter view should by applied by default.
|
|
66014
|
-
*/
|
|
66015
|
-
'isDefault'?: boolean;
|
|
66016
|
-
/**
|
|
66017
|
-
* The respective filter context.
|
|
66018
|
-
*/
|
|
66019
|
-
'content': object;
|
|
66456
|
+
'attributes': JsonApiFilterViewOutAttributes;
|
|
66457
|
+
'relationships'?: JsonApiFilterViewOutRelationships;
|
|
66020
66458
|
}
|
|
66021
66459
|
|
|
66022
66460
|
export declare interface JsonApiFilterViewInDocument {
|
|
66023
66461
|
'data': JsonApiFilterViewIn;
|
|
66024
66462
|
}
|
|
66025
66463
|
|
|
66026
|
-
export declare interface JsonApiFilterViewInRelationships {
|
|
66027
|
-
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
66028
|
-
'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
66029
|
-
}
|
|
66030
|
-
|
|
66031
66464
|
export declare type JsonApiFilterViewInTypeEnum = 'filterView';
|
|
66032
66465
|
|
|
66033
66466
|
/**
|
|
@@ -66042,8 +66475,23 @@ export declare interface JsonApiFilterViewOut {
|
|
|
66042
66475
|
* API identifier of an object
|
|
66043
66476
|
*/
|
|
66044
66477
|
'id': string;
|
|
66045
|
-
'attributes':
|
|
66046
|
-
'relationships'?:
|
|
66478
|
+
'attributes': JsonApiFilterViewOutAttributes;
|
|
66479
|
+
'relationships'?: JsonApiFilterViewOutRelationships;
|
|
66480
|
+
}
|
|
66481
|
+
|
|
66482
|
+
export declare interface JsonApiFilterViewOutAttributes {
|
|
66483
|
+
'title': string;
|
|
66484
|
+
'description'?: string;
|
|
66485
|
+
'tags'?: Array<string>;
|
|
66486
|
+
'areRelationsValid'?: boolean;
|
|
66487
|
+
/**
|
|
66488
|
+
* Indicator whether the filter view should by applied by default.
|
|
66489
|
+
*/
|
|
66490
|
+
'isDefault'?: boolean;
|
|
66491
|
+
/**
|
|
66492
|
+
* The respective filter context.
|
|
66493
|
+
*/
|
|
66494
|
+
'content': object;
|
|
66047
66495
|
}
|
|
66048
66496
|
|
|
66049
66497
|
export declare interface JsonApiFilterViewOutDocument {
|
|
@@ -66073,6 +66521,11 @@ export declare interface JsonApiFilterViewOutList {
|
|
|
66073
66521
|
'included'?: Array<JsonApiFilterViewOutIncludes>;
|
|
66074
66522
|
}
|
|
66075
66523
|
|
|
66524
|
+
export declare interface JsonApiFilterViewOutRelationships {
|
|
66525
|
+
'analyticalDashboard'?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
66526
|
+
'user'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
66527
|
+
}
|
|
66528
|
+
|
|
66076
66529
|
export declare type JsonApiFilterViewOutTypeEnum = 'filterView';
|
|
66077
66530
|
|
|
66078
66531
|
export declare interface JsonApiFilterViewOutWithLinks {
|
|
@@ -66084,8 +66537,8 @@ export declare interface JsonApiFilterViewOutWithLinks {
|
|
|
66084
66537
|
* API identifier of an object
|
|
66085
66538
|
*/
|
|
66086
66539
|
'id': string;
|
|
66087
|
-
'attributes':
|
|
66088
|
-
'relationships'?:
|
|
66540
|
+
'attributes': JsonApiFilterViewOutAttributes;
|
|
66541
|
+
'relationships'?: JsonApiFilterViewOutRelationships;
|
|
66089
66542
|
'links'?: ObjectLinks;
|
|
66090
66543
|
}
|
|
66091
66544
|
|
|
@@ -66104,7 +66557,7 @@ export declare interface JsonApiFilterViewPatch {
|
|
|
66104
66557
|
*/
|
|
66105
66558
|
'id': string;
|
|
66106
66559
|
'attributes': JsonApiFilterViewPatchAttributes;
|
|
66107
|
-
'relationships'?:
|
|
66560
|
+
'relationships'?: JsonApiFilterViewOutRelationships;
|
|
66108
66561
|
}
|
|
66109
66562
|
|
|
66110
66563
|
export declare interface JsonApiFilterViewPatchAttributes {
|
|
@@ -66345,11 +66798,7 @@ export declare interface JsonApiJwkIn {
|
|
|
66345
66798
|
* API identifier of an object
|
|
66346
66799
|
*/
|
|
66347
66800
|
'id': string;
|
|
66348
|
-
'attributes'?:
|
|
66349
|
-
}
|
|
66350
|
-
|
|
66351
|
-
export declare interface JsonApiJwkInAttributes {
|
|
66352
|
-
'content'?: RsaSpecification;
|
|
66801
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
66353
66802
|
}
|
|
66354
66803
|
|
|
66355
66804
|
export declare interface JsonApiJwkInDocument {
|
|
@@ -66370,7 +66819,11 @@ export declare interface JsonApiJwkOut {
|
|
|
66370
66819
|
* API identifier of an object
|
|
66371
66820
|
*/
|
|
66372
66821
|
'id': string;
|
|
66373
|
-
'attributes'?:
|
|
66822
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
66823
|
+
}
|
|
66824
|
+
|
|
66825
|
+
export declare interface JsonApiJwkOutAttributes {
|
|
66826
|
+
'content'?: RsaSpecification;
|
|
66374
66827
|
}
|
|
66375
66828
|
|
|
66376
66829
|
export declare interface JsonApiJwkOutDocument {
|
|
@@ -66398,7 +66851,7 @@ export declare interface JsonApiJwkOutWithLinks {
|
|
|
66398
66851
|
* API identifier of an object
|
|
66399
66852
|
*/
|
|
66400
66853
|
'id': string;
|
|
66401
|
-
'attributes'?:
|
|
66854
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
66402
66855
|
'links'?: ObjectLinks;
|
|
66403
66856
|
}
|
|
66404
66857
|
|
|
@@ -66416,7 +66869,7 @@ export declare interface JsonApiJwkPatch {
|
|
|
66416
66869
|
* API identifier of an object
|
|
66417
66870
|
*/
|
|
66418
66871
|
'id': string;
|
|
66419
|
-
'attributes'?:
|
|
66872
|
+
'attributes'?: JsonApiJwkOutAttributes;
|
|
66420
66873
|
}
|
|
66421
66874
|
|
|
66422
66875
|
export declare interface JsonApiJwkPatchDocument {
|
|
@@ -67097,10 +67550,31 @@ export declare interface JsonApiLlmProviderIn {
|
|
|
67097
67550
|
* API identifier of an object
|
|
67098
67551
|
*/
|
|
67099
67552
|
'id': string;
|
|
67100
|
-
'attributes'?:
|
|
67553
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
67554
|
+
}
|
|
67555
|
+
|
|
67556
|
+
export declare interface JsonApiLlmProviderInDocument {
|
|
67557
|
+
'data': JsonApiLlmProviderIn;
|
|
67558
|
+
}
|
|
67559
|
+
|
|
67560
|
+
export declare type JsonApiLlmProviderInTypeEnum = 'llmProvider';
|
|
67561
|
+
|
|
67562
|
+
/**
|
|
67563
|
+
* LLM Provider configuration for connecting to LLM services.
|
|
67564
|
+
*/
|
|
67565
|
+
export declare interface JsonApiLlmProviderOut {
|
|
67566
|
+
/**
|
|
67567
|
+
* Object type
|
|
67568
|
+
*/
|
|
67569
|
+
'type': JsonApiLlmProviderOutTypeEnum;
|
|
67570
|
+
/**
|
|
67571
|
+
* API identifier of an object
|
|
67572
|
+
*/
|
|
67573
|
+
'id': string;
|
|
67574
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
67101
67575
|
}
|
|
67102
67576
|
|
|
67103
|
-
export declare interface
|
|
67577
|
+
export declare interface JsonApiLlmProviderOutAttributes {
|
|
67104
67578
|
'name'?: string | null;
|
|
67105
67579
|
/**
|
|
67106
67580
|
* Description of the LLM Provider.
|
|
@@ -67110,17 +67584,17 @@ export declare interface JsonApiLlmProviderInAttributes {
|
|
|
67110
67584
|
* Required ID of the default model to use from the models list.
|
|
67111
67585
|
*/
|
|
67112
67586
|
'defaultModelId'?: string | null;
|
|
67113
|
-
'providerConfig'?:
|
|
67587
|
+
'providerConfig'?: JsonApiLlmProviderOutAttributesProviderConfig | null;
|
|
67114
67588
|
/**
|
|
67115
67589
|
* List of LLM models available for this provider.
|
|
67116
67590
|
*/
|
|
67117
|
-
'models'?: Array<
|
|
67591
|
+
'models'?: Array<JsonApiLlmProviderOutAttributesModelsInner> | null;
|
|
67118
67592
|
}
|
|
67119
67593
|
|
|
67120
67594
|
/**
|
|
67121
67595
|
* LLM Model configuration (id, family) within a provider.
|
|
67122
67596
|
*/
|
|
67123
|
-
export declare interface
|
|
67597
|
+
export declare interface JsonApiLlmProviderOutAttributesModelsInner {
|
|
67124
67598
|
/**
|
|
67125
67599
|
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
67126
67600
|
*/
|
|
@@ -67128,37 +67602,16 @@ export declare interface JsonApiLlmProviderInAttributesModelsInner {
|
|
|
67128
67602
|
/**
|
|
67129
67603
|
* Family of LLM models.
|
|
67130
67604
|
*/
|
|
67131
|
-
'family':
|
|
67605
|
+
'family': JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum;
|
|
67132
67606
|
}
|
|
67133
67607
|
|
|
67134
|
-
export declare type
|
|
67608
|
+
export declare type JsonApiLlmProviderOutAttributesModelsInnerFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE' | 'UNKNOWN';
|
|
67135
67609
|
|
|
67136
67610
|
/**
|
|
67137
|
-
* @type
|
|
67611
|
+
* @type JsonApiLlmProviderOutAttributesProviderConfig
|
|
67138
67612
|
* Provider-specific configuration including authentication.
|
|
67139
67613
|
*/
|
|
67140
|
-
export declare type
|
|
67141
|
-
|
|
67142
|
-
export declare interface JsonApiLlmProviderInDocument {
|
|
67143
|
-
'data': JsonApiLlmProviderIn;
|
|
67144
|
-
}
|
|
67145
|
-
|
|
67146
|
-
export declare type JsonApiLlmProviderInTypeEnum = 'llmProvider';
|
|
67147
|
-
|
|
67148
|
-
/**
|
|
67149
|
-
* LLM Provider configuration for connecting to LLM services.
|
|
67150
|
-
*/
|
|
67151
|
-
export declare interface JsonApiLlmProviderOut {
|
|
67152
|
-
/**
|
|
67153
|
-
* Object type
|
|
67154
|
-
*/
|
|
67155
|
-
'type': JsonApiLlmProviderOutTypeEnum;
|
|
67156
|
-
/**
|
|
67157
|
-
* API identifier of an object
|
|
67158
|
-
*/
|
|
67159
|
-
'id': string;
|
|
67160
|
-
'attributes'?: JsonApiLlmProviderInAttributes;
|
|
67161
|
-
}
|
|
67614
|
+
export declare type JsonApiLlmProviderOutAttributesProviderConfig = AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
67162
67615
|
|
|
67163
67616
|
export declare interface JsonApiLlmProviderOutDocument {
|
|
67164
67617
|
'data': JsonApiLlmProviderOut;
|
|
@@ -67185,7 +67638,7 @@ export declare interface JsonApiLlmProviderOutWithLinks {
|
|
|
67185
67638
|
* API identifier of an object
|
|
67186
67639
|
*/
|
|
67187
67640
|
'id': string;
|
|
67188
|
-
'attributes'?:
|
|
67641
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
67189
67642
|
'links'?: ObjectLinks;
|
|
67190
67643
|
}
|
|
67191
67644
|
|
|
@@ -67203,7 +67656,7 @@ export declare interface JsonApiLlmProviderPatch {
|
|
|
67203
67656
|
* API identifier of an object
|
|
67204
67657
|
*/
|
|
67205
67658
|
'id': string;
|
|
67206
|
-
'attributes'?:
|
|
67659
|
+
'attributes'?: JsonApiLlmProviderOutAttributes;
|
|
67207
67660
|
}
|
|
67208
67661
|
|
|
67209
67662
|
export declare interface JsonApiLlmProviderPatchDocument {
|
|
@@ -67546,14 +67999,7 @@ export declare interface JsonApiMetricOutRelationships {
|
|
|
67546
67999
|
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
67547
68000
|
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
67548
68001
|
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
67549
|
-
'parameters'?:
|
|
67550
|
-
}
|
|
67551
|
-
|
|
67552
|
-
export declare interface JsonApiMetricOutRelationshipsParameters {
|
|
67553
|
-
/**
|
|
67554
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
67555
|
-
*/
|
|
67556
|
-
'data': Array<JsonApiParameterLinkage>;
|
|
68002
|
+
'parameters'?: JsonApiAnalyticalDashboardOutRelationshipsParameters;
|
|
67557
68003
|
}
|
|
67558
68004
|
|
|
67559
68005
|
export declare type JsonApiMetricOutTypeEnum = 'metric';
|
|
@@ -67746,7 +68192,7 @@ export declare interface JsonApiNotificationChannelOut {
|
|
|
67746
68192
|
export declare interface JsonApiNotificationChannelOutAttributes {
|
|
67747
68193
|
'name'?: string | null;
|
|
67748
68194
|
'description'?: string | null;
|
|
67749
|
-
'destination'?:
|
|
68195
|
+
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
67750
68196
|
'destinationType'?: JsonApiNotificationChannelOutAttributesDestinationTypeEnum | null;
|
|
67751
68197
|
/**
|
|
67752
68198
|
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
@@ -67774,6 +68220,12 @@ export declare type JsonApiNotificationChannelOutAttributesAllowedRecipientsEnum
|
|
|
67774
68220
|
|
|
67775
68221
|
export declare type JsonApiNotificationChannelOutAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
67776
68222
|
|
|
68223
|
+
/**
|
|
68224
|
+
* @type JsonApiNotificationChannelOutAttributesDestination
|
|
68225
|
+
* The destination where the notifications are to be sent.
|
|
68226
|
+
*/
|
|
68227
|
+
export declare type JsonApiNotificationChannelOutAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
68228
|
+
|
|
67777
68229
|
export declare type JsonApiNotificationChannelOutAttributesDestinationTypeEnum = 'WEBHOOK' | 'SMTP' | 'DEFAULT_SMTP' | 'IN_PLATFORM';
|
|
67778
68230
|
|
|
67779
68231
|
export declare type JsonApiNotificationChannelOutAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
@@ -67848,7 +68300,7 @@ export declare interface JsonApiNotificationChannelPostOptionalId {
|
|
|
67848
68300
|
export declare interface JsonApiNotificationChannelPostOptionalIdAttributes {
|
|
67849
68301
|
'name'?: string | null;
|
|
67850
68302
|
'description'?: string | null;
|
|
67851
|
-
'destination'?:
|
|
68303
|
+
'destination'?: JsonApiNotificationChannelOutAttributesDestination;
|
|
67852
68304
|
/**
|
|
67853
68305
|
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
67854
68306
|
*/
|
|
@@ -67875,12 +68327,6 @@ export declare type JsonApiNotificationChannelPostOptionalIdAttributesAllowedRec
|
|
|
67875
68327
|
|
|
67876
68328
|
export declare type JsonApiNotificationChannelPostOptionalIdAttributesDashboardLinkVisibilityEnum = 'HIDDEN' | 'INTERNAL_ONLY' | 'ALL';
|
|
67877
68329
|
|
|
67878
|
-
/**
|
|
67879
|
-
* @type JsonApiNotificationChannelPostOptionalIdAttributesDestination
|
|
67880
|
-
* The destination where the notifications are to be sent.
|
|
67881
|
-
*/
|
|
67882
|
-
export declare type JsonApiNotificationChannelPostOptionalIdAttributesDestination = DefaultSmtp | InPlatform | Smtp | Webhook;
|
|
67883
|
-
|
|
67884
68330
|
export declare type JsonApiNotificationChannelPostOptionalIdAttributesInPlatformNotificationEnum = 'DISABLED' | 'ENABLED';
|
|
67885
68331
|
|
|
67886
68332
|
export declare interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
@@ -67901,14 +68347,33 @@ export declare interface JsonApiOrganizationIn {
|
|
|
67901
68347
|
* API identifier of an object
|
|
67902
68348
|
*/
|
|
67903
68349
|
'id': string;
|
|
67904
|
-
'attributes'?:
|
|
67905
|
-
'relationships'?:
|
|
68350
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
68351
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
68352
|
+
}
|
|
68353
|
+
|
|
68354
|
+
export declare interface JsonApiOrganizationInAttributes {
|
|
68355
|
+
'name'?: string | null;
|
|
68356
|
+
'hostname'?: string;
|
|
68357
|
+
'allowedOrigins'?: Array<string>;
|
|
68358
|
+
/**
|
|
68359
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
68360
|
+
* @deprecated
|
|
68361
|
+
*/
|
|
68362
|
+
'earlyAccess'?: string | null;
|
|
68363
|
+
/**
|
|
68364
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
68365
|
+
*/
|
|
68366
|
+
'earlyAccessValues'?: Array<string> | null;
|
|
67906
68367
|
}
|
|
67907
68368
|
|
|
67908
68369
|
export declare interface JsonApiOrganizationInDocument {
|
|
67909
68370
|
'data': JsonApiOrganizationIn;
|
|
67910
68371
|
}
|
|
67911
68372
|
|
|
68373
|
+
export declare interface JsonApiOrganizationInRelationships {
|
|
68374
|
+
'identityProvider'?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
68375
|
+
}
|
|
68376
|
+
|
|
67912
68377
|
export declare type JsonApiOrganizationInTypeEnum = 'organization';
|
|
67913
68378
|
|
|
67914
68379
|
/**
|
|
@@ -67985,7 +68450,7 @@ export declare type JsonApiOrganizationOutMetaPermissionsEnum = 'MANAGE' | 'SELF
|
|
|
67985
68450
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
67986
68451
|
'bootstrapUser'?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
67987
68452
|
'bootstrapUserGroup'?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
67988
|
-
'identityProvider'?:
|
|
68453
|
+
'identityProvider'?: JsonApiOrganizationOutRelationshipsIdentityProvider;
|
|
67989
68454
|
}
|
|
67990
68455
|
|
|
67991
68456
|
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
@@ -67996,6 +68461,10 @@ export declare interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
|
67996
68461
|
'data': JsonApiUserGroupLinkage | null;
|
|
67997
68462
|
}
|
|
67998
68463
|
|
|
68464
|
+
export declare interface JsonApiOrganizationOutRelationshipsIdentityProvider {
|
|
68465
|
+
'data': JsonApiIdentityProviderLinkage | null;
|
|
68466
|
+
}
|
|
68467
|
+
|
|
67999
68468
|
export declare type JsonApiOrganizationOutTypeEnum = 'organization';
|
|
68000
68469
|
|
|
68001
68470
|
/**
|
|
@@ -68010,37 +68479,14 @@ export declare interface JsonApiOrganizationPatch {
|
|
|
68010
68479
|
* API identifier of an object
|
|
68011
68480
|
*/
|
|
68012
68481
|
'id': string;
|
|
68013
|
-
'attributes'?:
|
|
68014
|
-
'relationships'?:
|
|
68015
|
-
}
|
|
68016
|
-
|
|
68017
|
-
export declare interface JsonApiOrganizationPatchAttributes {
|
|
68018
|
-
'name'?: string | null;
|
|
68019
|
-
'hostname'?: string;
|
|
68020
|
-
'allowedOrigins'?: Array<string>;
|
|
68021
|
-
/**
|
|
68022
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
68023
|
-
* @deprecated
|
|
68024
|
-
*/
|
|
68025
|
-
'earlyAccess'?: string | null;
|
|
68026
|
-
/**
|
|
68027
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
68028
|
-
*/
|
|
68029
|
-
'earlyAccessValues'?: Array<string> | null;
|
|
68482
|
+
'attributes'?: JsonApiOrganizationInAttributes;
|
|
68483
|
+
'relationships'?: JsonApiOrganizationInRelationships;
|
|
68030
68484
|
}
|
|
68031
68485
|
|
|
68032
68486
|
export declare interface JsonApiOrganizationPatchDocument {
|
|
68033
68487
|
'data': JsonApiOrganizationPatch;
|
|
68034
68488
|
}
|
|
68035
68489
|
|
|
68036
|
-
export declare interface JsonApiOrganizationPatchRelationships {
|
|
68037
|
-
'identityProvider'?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
68038
|
-
}
|
|
68039
|
-
|
|
68040
|
-
export declare interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
68041
|
-
'data': JsonApiIdentityProviderLinkage | null;
|
|
68042
|
-
}
|
|
68043
|
-
|
|
68044
68490
|
export declare type JsonApiOrganizationPatchTypeEnum = 'organization';
|
|
68045
68491
|
|
|
68046
68492
|
/**
|
|
@@ -68055,9 +68501,19 @@ export declare interface JsonApiOrganizationSettingIn {
|
|
|
68055
68501
|
* API identifier of an object
|
|
68056
68502
|
*/
|
|
68057
68503
|
'id': string;
|
|
68058
|
-
'attributes'?:
|
|
68504
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68505
|
+
}
|
|
68506
|
+
|
|
68507
|
+
export declare interface JsonApiOrganizationSettingInAttributes {
|
|
68508
|
+
/**
|
|
68509
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
68510
|
+
*/
|
|
68511
|
+
'content'?: object;
|
|
68512
|
+
'type'?: JsonApiOrganizationSettingInAttributesTypeEnum;
|
|
68059
68513
|
}
|
|
68060
68514
|
|
|
68515
|
+
export declare type JsonApiOrganizationSettingInAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
68516
|
+
|
|
68061
68517
|
export declare interface JsonApiOrganizationSettingInDocument {
|
|
68062
68518
|
'data': JsonApiOrganizationSettingIn;
|
|
68063
68519
|
}
|
|
@@ -68076,19 +68532,9 @@ export declare interface JsonApiOrganizationSettingOut {
|
|
|
68076
68532
|
* API identifier of an object
|
|
68077
68533
|
*/
|
|
68078
68534
|
'id': string;
|
|
68079
|
-
'attributes'?:
|
|
68080
|
-
}
|
|
68081
|
-
|
|
68082
|
-
export declare interface JsonApiOrganizationSettingOutAttributes {
|
|
68083
|
-
/**
|
|
68084
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
68085
|
-
*/
|
|
68086
|
-
'content'?: object;
|
|
68087
|
-
'type'?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
68535
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68088
68536
|
}
|
|
68089
68537
|
|
|
68090
|
-
export declare type JsonApiOrganizationSettingOutAttributesTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
68091
|
-
|
|
68092
68538
|
export declare interface JsonApiOrganizationSettingOutDocument {
|
|
68093
68539
|
'data': JsonApiOrganizationSettingOut;
|
|
68094
68540
|
'links'?: ObjectLinks;
|
|
@@ -68114,7 +68560,7 @@ export declare interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
68114
68560
|
* API identifier of an object
|
|
68115
68561
|
*/
|
|
68116
68562
|
'id': string;
|
|
68117
|
-
'attributes'?:
|
|
68563
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68118
68564
|
'links'?: ObjectLinks;
|
|
68119
68565
|
}
|
|
68120
68566
|
|
|
@@ -68132,7 +68578,7 @@ export declare interface JsonApiOrganizationSettingPatch {
|
|
|
68132
68578
|
* API identifier of an object
|
|
68133
68579
|
*/
|
|
68134
68580
|
'id': string;
|
|
68135
|
-
'attributes'?:
|
|
68581
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68136
68582
|
}
|
|
68137
68583
|
|
|
68138
68584
|
export declare interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -68194,7 +68640,7 @@ export declare interface JsonApiParameterOutAttributes {
|
|
|
68194
68640
|
'description'?: string;
|
|
68195
68641
|
'tags'?: Array<string>;
|
|
68196
68642
|
'areRelationsValid'?: boolean;
|
|
68197
|
-
'definition':
|
|
68643
|
+
'definition': JsonApiParameterOutAttributesDefinition;
|
|
68198
68644
|
/**
|
|
68199
68645
|
* Time of the entity creation.
|
|
68200
68646
|
*/
|
|
@@ -68205,6 +68651,11 @@ export declare interface JsonApiParameterOutAttributes {
|
|
|
68205
68651
|
'modifiedAt'?: string | null;
|
|
68206
68652
|
}
|
|
68207
68653
|
|
|
68654
|
+
/**
|
|
68655
|
+
* @type JsonApiParameterOutAttributesDefinition
|
|
68656
|
+
*/
|
|
68657
|
+
export declare type JsonApiParameterOutAttributesDefinition = NumberParameterDefinition | StringParameterDefinition;
|
|
68658
|
+
|
|
68208
68659
|
export declare interface JsonApiParameterOutDocument {
|
|
68209
68660
|
'data': JsonApiParameterOut;
|
|
68210
68661
|
'links'?: ObjectLinks;
|
|
@@ -68266,7 +68717,7 @@ export declare interface JsonApiParameterPatchAttributes {
|
|
|
68266
68717
|
'description'?: string;
|
|
68267
68718
|
'tags'?: Array<string>;
|
|
68268
68719
|
'areRelationsValid'?: boolean;
|
|
68269
|
-
'definition'?:
|
|
68720
|
+
'definition'?: JsonApiParameterOutAttributesDefinition;
|
|
68270
68721
|
}
|
|
68271
68722
|
|
|
68272
68723
|
export declare interface JsonApiParameterPatchDocument {
|
|
@@ -68295,7 +68746,7 @@ export declare interface JsonApiParameterPostOptionalIdAttributes {
|
|
|
68295
68746
|
'description'?: string;
|
|
68296
68747
|
'tags'?: Array<string>;
|
|
68297
68748
|
'areRelationsValid'?: boolean;
|
|
68298
|
-
'definition':
|
|
68749
|
+
'definition': JsonApiParameterOutAttributesDefinition;
|
|
68299
68750
|
}
|
|
68300
68751
|
|
|
68301
68752
|
export declare interface JsonApiParameterPostOptionalIdDocument {
|
|
@@ -68404,7 +68855,7 @@ export declare interface JsonApiUserDataFilterIn {
|
|
|
68404
68855
|
* API identifier of an object
|
|
68405
68856
|
*/
|
|
68406
68857
|
'id': string;
|
|
68407
|
-
'attributes':
|
|
68858
|
+
'attributes': JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
68408
68859
|
'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
68409
68860
|
}
|
|
68410
68861
|
|
|
@@ -68427,18 +68878,10 @@ export declare interface JsonApiUserDataFilterOut {
|
|
|
68427
68878
|
*/
|
|
68428
68879
|
'id': string;
|
|
68429
68880
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
68430
|
-
'attributes':
|
|
68881
|
+
'attributes': JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
68431
68882
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
68432
68883
|
}
|
|
68433
68884
|
|
|
68434
|
-
export declare interface JsonApiUserDataFilterOutAttributes {
|
|
68435
|
-
'title'?: string;
|
|
68436
|
-
'description'?: string;
|
|
68437
|
-
'tags'?: Array<string>;
|
|
68438
|
-
'areRelationsValid'?: boolean;
|
|
68439
|
-
'maql': string;
|
|
68440
|
-
}
|
|
68441
|
-
|
|
68442
68885
|
export declare interface JsonApiUserDataFilterOutDocument {
|
|
68443
68886
|
'data': JsonApiUserDataFilterOut;
|
|
68444
68887
|
'links'?: ObjectLinks;
|
|
@@ -68474,7 +68917,7 @@ export declare interface JsonApiUserDataFilterOutRelationships {
|
|
|
68474
68917
|
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
68475
68918
|
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
68476
68919
|
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
68477
|
-
'parameters'?:
|
|
68920
|
+
'parameters'?: JsonApiAnalyticalDashboardOutRelationshipsParameters;
|
|
68478
68921
|
}
|
|
68479
68922
|
|
|
68480
68923
|
export declare type JsonApiUserDataFilterOutTypeEnum = 'userDataFilter';
|
|
@@ -68489,7 +68932,7 @@ export declare interface JsonApiUserDataFilterOutWithLinks {
|
|
|
68489
68932
|
*/
|
|
68490
68933
|
'id': string;
|
|
68491
68934
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
68492
|
-
'attributes':
|
|
68935
|
+
'attributes': JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
68493
68936
|
'relationships'?: JsonApiUserDataFilterOutRelationships;
|
|
68494
68937
|
'links'?: ObjectLinks;
|
|
68495
68938
|
}
|
|
@@ -68538,10 +68981,18 @@ export declare interface JsonApiUserDataFilterPostOptionalId {
|
|
|
68538
68981
|
* API identifier of an object
|
|
68539
68982
|
*/
|
|
68540
68983
|
'id'?: string;
|
|
68541
|
-
'attributes':
|
|
68984
|
+
'attributes': JsonApiUserDataFilterPostOptionalIdAttributes;
|
|
68542
68985
|
'relationships'?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
68543
68986
|
}
|
|
68544
68987
|
|
|
68988
|
+
export declare interface JsonApiUserDataFilterPostOptionalIdAttributes {
|
|
68989
|
+
'title'?: string;
|
|
68990
|
+
'description'?: string;
|
|
68991
|
+
'tags'?: Array<string>;
|
|
68992
|
+
'areRelationsValid'?: boolean;
|
|
68993
|
+
'maql': string;
|
|
68994
|
+
}
|
|
68995
|
+
|
|
68545
68996
|
export declare interface JsonApiUserDataFilterPostOptionalIdDocument {
|
|
68546
68997
|
'data': JsonApiUserDataFilterPostOptionalId;
|
|
68547
68998
|
}
|
|
@@ -68873,7 +69324,7 @@ export declare interface JsonApiUserSettingIn {
|
|
|
68873
69324
|
* API identifier of an object
|
|
68874
69325
|
*/
|
|
68875
69326
|
'id': string;
|
|
68876
|
-
'attributes'?:
|
|
69327
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68877
69328
|
}
|
|
68878
69329
|
|
|
68879
69330
|
export declare interface JsonApiUserSettingInDocument {
|
|
@@ -68894,7 +69345,7 @@ export declare interface JsonApiUserSettingOut {
|
|
|
68894
69345
|
* API identifier of an object
|
|
68895
69346
|
*/
|
|
68896
69347
|
'id': string;
|
|
68897
|
-
'attributes'?:
|
|
69348
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68898
69349
|
}
|
|
68899
69350
|
|
|
68900
69351
|
export declare interface JsonApiUserSettingOutDocument {
|
|
@@ -68922,7 +69373,7 @@ export declare interface JsonApiUserSettingOutWithLinks {
|
|
|
68922
69373
|
* API identifier of an object
|
|
68923
69374
|
*/
|
|
68924
69375
|
'id': string;
|
|
68925
|
-
'attributes'?:
|
|
69376
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
68926
69377
|
'links'?: ObjectLinks;
|
|
68927
69378
|
}
|
|
68928
69379
|
|
|
@@ -69016,14 +69467,9 @@ export declare interface JsonApiVisualizationObjectOutDocument {
|
|
|
69016
69467
|
/**
|
|
69017
69468
|
* Included resources
|
|
69018
69469
|
*/
|
|
69019
|
-
'included'?: Array<
|
|
69470
|
+
'included'?: Array<JsonApiMetricOutIncludes>;
|
|
69020
69471
|
}
|
|
69021
69472
|
|
|
69022
|
-
/**
|
|
69023
|
-
* @type JsonApiVisualizationObjectOutIncludes
|
|
69024
|
-
*/
|
|
69025
|
-
export declare type JsonApiVisualizationObjectOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiLabelOutWithLinks | JsonApiMetricOutWithLinks | JsonApiUserIdentifierOutWithLinks;
|
|
69026
|
-
|
|
69027
69473
|
/**
|
|
69028
69474
|
* A JSON:API document with a list of resources
|
|
69029
69475
|
*/
|
|
@@ -69034,7 +69480,7 @@ export declare interface JsonApiVisualizationObjectOutList {
|
|
|
69034
69480
|
/**
|
|
69035
69481
|
* Included resources
|
|
69036
69482
|
*/
|
|
69037
|
-
'included'?: Array<
|
|
69483
|
+
'included'?: Array<JsonApiMetricOutIncludes>;
|
|
69038
69484
|
}
|
|
69039
69485
|
|
|
69040
69486
|
export declare interface JsonApiVisualizationObjectOutRelationships {
|
|
@@ -69045,6 +69491,7 @@ export declare interface JsonApiVisualizationObjectOutRelationships {
|
|
|
69045
69491
|
'attributes'?: JsonApiDatasetOutRelationshipsAttributes;
|
|
69046
69492
|
'labels'?: JsonApiAnalyticalDashboardOutRelationshipsLabels;
|
|
69047
69493
|
'metrics'?: JsonApiAnalyticalDashboardOutRelationshipsMetrics;
|
|
69494
|
+
'parameters'?: JsonApiAnalyticalDashboardOutRelationshipsParameters;
|
|
69048
69495
|
'datasets'?: JsonApiAnalyticalDashboardOutRelationshipsDatasets;
|
|
69049
69496
|
}
|
|
69050
69497
|
|
|
@@ -69797,7 +70244,7 @@ export declare interface JsonApiWorkspaceSettingIn {
|
|
|
69797
70244
|
* API identifier of an object
|
|
69798
70245
|
*/
|
|
69799
70246
|
'id': string;
|
|
69800
|
-
'attributes'?:
|
|
70247
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
69801
70248
|
}
|
|
69802
70249
|
|
|
69803
70250
|
export declare interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -69819,7 +70266,7 @@ export declare interface JsonApiWorkspaceSettingOut {
|
|
|
69819
70266
|
*/
|
|
69820
70267
|
'id': string;
|
|
69821
70268
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
69822
|
-
'attributes'?:
|
|
70269
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
69823
70270
|
}
|
|
69824
70271
|
|
|
69825
70272
|
export declare interface JsonApiWorkspaceSettingOutDocument {
|
|
@@ -69848,7 +70295,7 @@ export declare interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
69848
70295
|
*/
|
|
69849
70296
|
'id': string;
|
|
69850
70297
|
'meta'?: JsonApiExportDefinitionOutMeta;
|
|
69851
|
-
'attributes'?:
|
|
70298
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
69852
70299
|
'links'?: ObjectLinks;
|
|
69853
70300
|
}
|
|
69854
70301
|
|
|
@@ -69866,7 +70313,7 @@ export declare interface JsonApiWorkspaceSettingPatch {
|
|
|
69866
70313
|
* API identifier of an object
|
|
69867
70314
|
*/
|
|
69868
70315
|
'id': string;
|
|
69869
|
-
'attributes'?:
|
|
70316
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
69870
70317
|
}
|
|
69871
70318
|
|
|
69872
70319
|
export declare interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -69887,7 +70334,7 @@ export declare interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
69887
70334
|
* API identifier of an object
|
|
69888
70335
|
*/
|
|
69889
70336
|
'id'?: string;
|
|
69890
|
-
'attributes'?:
|
|
70337
|
+
'attributes'?: JsonApiOrganizationSettingInAttributes;
|
|
69891
70338
|
}
|
|
69892
70339
|
|
|
69893
70340
|
export declare interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
@@ -87472,7 +87919,7 @@ export declare interface ResolvedSetting {
|
|
|
87472
87919
|
'type'?: ResolvedSettingTypeEnum;
|
|
87473
87920
|
}
|
|
87474
87921
|
|
|
87475
|
-
export declare type ResolvedSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS';
|
|
87922
|
+
export declare type ResolvedSettingTypeEnum = 'TIMEZONE' | 'ACTIVE_THEME' | 'ACTIVE_COLOR_PALETTE' | 'ACTIVE_LLM_ENDPOINT' | 'ACTIVE_LLM_PROVIDER' | 'ACTIVE_CALENDARS' | 'WHITE_LABELING' | 'LOCALE' | 'METADATA_LOCALE' | 'FORMAT_LOCALE' | 'MAPBOX_TOKEN' | 'GEO_ICON_SHEET' | 'AG_GRID_TOKEN' | 'WEEK_START' | 'FISCAL_YEAR' | 'SHOW_HIDDEN_CATALOG_ITEMS' | 'OPERATOR_OVERRIDES' | 'TIMEZONE_VALIDATION_ENABLED' | 'OPENAI_CONFIG' | 'ENABLE_FILE_ANALYTICS' | 'ALERT' | 'SEPARATORS' | 'DATE_FILTER_CONFIG' | 'JIT_PROVISIONING' | 'JWT_JIT_PROVISIONING' | 'DASHBOARD_FILTERS_APPLY_MODE' | 'ENABLE_SLIDES_EXPORT' | 'ENABLE_SNAPSHOT_EXPORT' | 'AI_RATE_LIMIT' | 'ATTACHMENT_SIZE_LIMIT' | 'ATTACHMENT_LINK_TTL' | 'AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE' | 'ENABLE_DRILL_TO_URL_BY_DEFAULT' | 'ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS' | 'ENABLE_AUTOMATION_EVALUATION_MODE' | 'ENABLE_ACCESSIBILITY_MODE' | 'REGISTERED_PLUGGABLE_APPLICATIONS' | 'DATA_LOCALE' | 'LDM_DEFAULT_LOCALE' | 'EXPORT_RESULT_POLLING_TIMEOUT_SECONDS' | 'MAX_ZOOM_LEVEL' | 'SORT_CASE_SENSITIVE' | 'SORT_COLLATION' | 'METRIC_FORMAT_OVERRIDE' | 'ENABLE_AI_ON_DATA' | 'API_ENTITIES_DEFAULT_CONTENT_MEDIA_TYPE' | 'EXPORT_CSV_CUSTOM_DELIMITER' | 'ENABLE_QUERY_TAGS' | 'RESTRICT_BASE_UI' | 'CERTIFY_PARENT_OBJECTS' | 'HLL_TYPE';
|
|
87476
87923
|
|
|
87477
87924
|
/**
|
|
87478
87925
|
* A request containing setting IDs to resolve.
|
|
@@ -88063,7 +88510,7 @@ export declare interface ScanModelConfigurationParameters {
|
|
|
88063
88510
|
*/
|
|
88064
88511
|
export declare interface ScanModelDeclarativeColumn {
|
|
88065
88512
|
/**
|
|
88066
|
-
* Column name
|
|
88513
|
+
* Column name. Must not contain NUL (0x00) characters.
|
|
88067
88514
|
*/
|
|
88068
88515
|
'name': string;
|
|
88069
88516
|
/**
|
|
@@ -88926,6 +89373,104 @@ export declare interface SqlQuery {
|
|
|
88926
89373
|
'sql': string;
|
|
88927
89374
|
}
|
|
88928
89375
|
|
|
89376
|
+
export declare interface StringConstraints {
|
|
89377
|
+
'minLength'?: number;
|
|
89378
|
+
'maxLength'?: number;
|
|
89379
|
+
}
|
|
89380
|
+
|
|
89381
|
+
export declare interface StringParameterDefinition {
|
|
89382
|
+
'defaultValue': string;
|
|
89383
|
+
'constraints'?: StringConstraints;
|
|
89384
|
+
/**
|
|
89385
|
+
* The parameter type.
|
|
89386
|
+
*/
|
|
89387
|
+
'type': StringParameterDefinitionTypeEnum;
|
|
89388
|
+
}
|
|
89389
|
+
|
|
89390
|
+
export declare type StringParameterDefinitionTypeEnum = 'STRING';
|
|
89391
|
+
|
|
89392
|
+
/**
|
|
89393
|
+
* SummaryAi - object-oriented interface
|
|
89394
|
+
* @export
|
|
89395
|
+
* @class SummaryAi
|
|
89396
|
+
* @extends {BaseAPI}
|
|
89397
|
+
*/
|
|
89398
|
+
export declare class SummaryAi extends AiBaseAPI implements SummaryAiInterface {
|
|
89399
|
+
/**
|
|
89400
|
+
*
|
|
89401
|
+
* @summary Post Summary
|
|
89402
|
+
* @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
|
|
89403
|
+
* @param {*} [options] Override http request option.
|
|
89404
|
+
* @throws {RequiredError}
|
|
89405
|
+
* @memberof SummaryAi
|
|
89406
|
+
*/
|
|
89407
|
+
summarizeDashboard(requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig): AxiosPromise<AiSummarizeResponse>;
|
|
89408
|
+
}
|
|
89409
|
+
|
|
89410
|
+
/**
|
|
89411
|
+
*
|
|
89412
|
+
* @summary Post Summary
|
|
89413
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
89414
|
+
* @param {string} basePath Base path.
|
|
89415
|
+
* @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
|
|
89416
|
+
* @param {*} [options] Override http request option.
|
|
89417
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
89418
|
+
* @throws {RequiredError}
|
|
89419
|
+
*/
|
|
89420
|
+
declare function SummaryAi_SummarizeDashboard(axios: AxiosInstance, basePath: string, requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig, configuration?: AiConfiguration): AxiosPromise<AiSummarizeResponse>;
|
|
89421
|
+
export { SummaryAi_SummarizeDashboard as GenAiApi_SummarizeDashboard }
|
|
89422
|
+
export { SummaryAi_SummarizeDashboard }
|
|
89423
|
+
|
|
89424
|
+
/**
|
|
89425
|
+
*
|
|
89426
|
+
* @summary Post Summary
|
|
89427
|
+
* @param {string} workspaceId
|
|
89428
|
+
* @param {AiSummarizeRequest} aiSummarizeRequest
|
|
89429
|
+
* @param {*} [options] Override http request option.
|
|
89430
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
89431
|
+
* @throws {RequiredError}
|
|
89432
|
+
*/
|
|
89433
|
+
export declare function SummaryAiAxiosParamCreator_SummarizeDashboard(workspaceId: string, aiSummarizeRequest: AiSummarizeRequest, options?: AxiosRequestConfig, configuration?: AiConfiguration): Promise<AiRequestArgs>;
|
|
89434
|
+
|
|
89435
|
+
/**
|
|
89436
|
+
* SummaryAi - interface
|
|
89437
|
+
* @export
|
|
89438
|
+
* @interface SummaryAi
|
|
89439
|
+
*/
|
|
89440
|
+
export declare interface SummaryAiInterface {
|
|
89441
|
+
/**
|
|
89442
|
+
*
|
|
89443
|
+
* @summary Post Summary
|
|
89444
|
+
* @param {SummaryAiSummarizeDashboardRequest} requestParameters Request parameters.
|
|
89445
|
+
* @param {*} [options] Override http request option.
|
|
89446
|
+
* @throws {RequiredError}
|
|
89447
|
+
* @memberof SummaryAiInterface
|
|
89448
|
+
*/
|
|
89449
|
+
summarizeDashboard(requestParameters: SummaryAiSummarizeDashboardRequest, options?: AxiosRequestConfig): AxiosPromise<AiSummarizeResponse>;
|
|
89450
|
+
}
|
|
89451
|
+
|
|
89452
|
+
/**
|
|
89453
|
+
* Request parameters for summarizeDashboard operation in SummaryAi.
|
|
89454
|
+
* @export
|
|
89455
|
+
* @interface SummaryAiSummarizeDashboardRequest
|
|
89456
|
+
*/
|
|
89457
|
+
declare interface SummaryAiSummarizeDashboardRequest {
|
|
89458
|
+
/**
|
|
89459
|
+
*
|
|
89460
|
+
* @type {string}
|
|
89461
|
+
* @memberof SummaryAiSummarizeDashboard
|
|
89462
|
+
*/
|
|
89463
|
+
readonly workspaceId: string;
|
|
89464
|
+
/**
|
|
89465
|
+
*
|
|
89466
|
+
* @type {AiSummarizeRequest}
|
|
89467
|
+
* @memberof SummaryAiSummarizeDashboard
|
|
89468
|
+
*/
|
|
89469
|
+
readonly aiSummarizeRequest: AiSummarizeRequest;
|
|
89470
|
+
}
|
|
89471
|
+
export { SummaryAiSummarizeDashboardRequest as GenAiApiSummarizeDashboardRequest }
|
|
89472
|
+
export { SummaryAiSummarizeDashboardRequest }
|
|
89473
|
+
|
|
88929
89474
|
export declare interface SwitchIdentityProviderRequest {
|
|
88930
89475
|
/**
|
|
88931
89476
|
* Identity provider ID to set as active for the organization.
|
|
@@ -94939,6 +95484,15 @@ export declare interface UserSettingControllerApiUpdateEntityUserSettingsRequest
|
|
|
94939
95484
|
* @extends {BaseAPI}
|
|
94940
95485
|
*/
|
|
94941
95486
|
export declare class UserSettingsApi extends MetadataBaseApi implements UserSettingsApiInterface {
|
|
95487
|
+
/**
|
|
95488
|
+
*
|
|
95489
|
+
* @summary Post a new custom application setting for the user
|
|
95490
|
+
* @param {UserSettingsApiCreateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95491
|
+
* @param {*} [options] Override http request option.
|
|
95492
|
+
* @throws {RequiredError}
|
|
95493
|
+
* @memberof UserSettingsApi
|
|
95494
|
+
*/
|
|
95495
|
+
createEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiCreateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
94942
95496
|
/**
|
|
94943
95497
|
*
|
|
94944
95498
|
* @summary Post new user settings for the user
|
|
@@ -94948,6 +95502,15 @@ export declare class UserSettingsApi extends MetadataBaseApi implements UserSett
|
|
|
94948
95502
|
* @memberof UserSettingsApi
|
|
94949
95503
|
*/
|
|
94950
95504
|
createEntityUserSettings(requestParameters: UserSettingsApiCreateEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutDocument>;
|
|
95505
|
+
/**
|
|
95506
|
+
*
|
|
95507
|
+
* @summary Delete a custom application setting for a user
|
|
95508
|
+
* @param {UserSettingsApiDeleteEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95509
|
+
* @param {*} [options] Override http request option.
|
|
95510
|
+
* @throws {RequiredError}
|
|
95511
|
+
* @memberof UserSettingsApi
|
|
95512
|
+
*/
|
|
95513
|
+
deleteEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiDeleteEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
94951
95514
|
/**
|
|
94952
95515
|
*
|
|
94953
95516
|
* @summary Delete a setting for a user
|
|
@@ -94957,6 +95520,15 @@ export declare class UserSettingsApi extends MetadataBaseApi implements UserSett
|
|
|
94957
95520
|
* @memberof UserSettingsApi
|
|
94958
95521
|
*/
|
|
94959
95522
|
deleteEntityUserSettings(requestParameters: UserSettingsApiDeleteEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
95523
|
+
/**
|
|
95524
|
+
*
|
|
95525
|
+
* @summary List all custom application settings for a user
|
|
95526
|
+
* @param {UserSettingsApiGetAllEntitiesCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95527
|
+
* @param {*} [options] Override http request option.
|
|
95528
|
+
* @throws {RequiredError}
|
|
95529
|
+
* @memberof UserSettingsApi
|
|
95530
|
+
*/
|
|
95531
|
+
getAllEntitiesCustomUserApplicationSettings(requestParameters: UserSettingsApiGetAllEntitiesCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutList>;
|
|
94960
95532
|
/**
|
|
94961
95533
|
*
|
|
94962
95534
|
* @summary List all settings for a user
|
|
@@ -94966,6 +95538,15 @@ export declare class UserSettingsApi extends MetadataBaseApi implements UserSett
|
|
|
94966
95538
|
* @memberof UserSettingsApi
|
|
94967
95539
|
*/
|
|
94968
95540
|
getAllEntitiesUserSettings(requestParameters: UserSettingsApiGetAllEntitiesUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutList>;
|
|
95541
|
+
/**
|
|
95542
|
+
*
|
|
95543
|
+
* @summary Get a custom application setting for a user
|
|
95544
|
+
* @param {UserSettingsApiGetEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95545
|
+
* @param {*} [options] Override http request option.
|
|
95546
|
+
* @throws {RequiredError}
|
|
95547
|
+
* @memberof UserSettingsApi
|
|
95548
|
+
*/
|
|
95549
|
+
getEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiGetEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
94969
95550
|
/**
|
|
94970
95551
|
*
|
|
94971
95552
|
* @summary Get a setting for a user
|
|
@@ -94975,6 +95556,15 @@ export declare class UserSettingsApi extends MetadataBaseApi implements UserSett
|
|
|
94975
95556
|
* @memberof UserSettingsApi
|
|
94976
95557
|
*/
|
|
94977
95558
|
getEntityUserSettings(requestParameters: UserSettingsApiGetEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutDocument>;
|
|
95559
|
+
/**
|
|
95560
|
+
*
|
|
95561
|
+
* @summary Put a custom application setting for the user
|
|
95562
|
+
* @param {UserSettingsApiUpdateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95563
|
+
* @param {*} [options] Override http request option.
|
|
95564
|
+
* @throws {RequiredError}
|
|
95565
|
+
* @memberof UserSettingsApi
|
|
95566
|
+
*/
|
|
95567
|
+
updateEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiUpdateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
94978
95568
|
/**
|
|
94979
95569
|
*
|
|
94980
95570
|
* @summary Put new user settings for the user
|
|
@@ -95108,6 +95698,26 @@ export declare function UserSettingsApiAxiosParamCreator_GetEntityUserSettings(u
|
|
|
95108
95698
|
*/
|
|
95109
95699
|
export declare function UserSettingsApiAxiosParamCreator_UpdateEntityUserSettings(userId: string, id: string, jsonApiUserSettingInDocument: JsonApiUserSettingInDocument, filter?: string, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
95110
95700
|
|
|
95701
|
+
/**
|
|
95702
|
+
* Request parameters for createEntityCustomUserApplicationSettings operation in UserSettingsApi.
|
|
95703
|
+
* @export
|
|
95704
|
+
* @interface UserSettingsApiCreateEntityCustomUserApplicationSettingsRequest
|
|
95705
|
+
*/
|
|
95706
|
+
export declare interface UserSettingsApiCreateEntityCustomUserApplicationSettingsRequest {
|
|
95707
|
+
/**
|
|
95708
|
+
*
|
|
95709
|
+
* @type {string}
|
|
95710
|
+
* @memberof UserSettingsApiCreateEntityCustomUserApplicationSettings
|
|
95711
|
+
*/
|
|
95712
|
+
readonly userId: string;
|
|
95713
|
+
/**
|
|
95714
|
+
*
|
|
95715
|
+
* @type {JsonApiCustomUserApplicationSettingPostOptionalIdDocument}
|
|
95716
|
+
* @memberof UserSettingsApiCreateEntityCustomUserApplicationSettings
|
|
95717
|
+
*/
|
|
95718
|
+
readonly jsonApiCustomUserApplicationSettingPostOptionalIdDocument: JsonApiCustomUserApplicationSettingPostOptionalIdDocument;
|
|
95719
|
+
}
|
|
95720
|
+
|
|
95111
95721
|
/**
|
|
95112
95722
|
* Request parameters for createEntityUserSettings operation in UserSettingsApi.
|
|
95113
95723
|
* @export
|
|
@@ -95128,6 +95738,26 @@ export declare interface UserSettingsApiCreateEntityUserSettingsRequest {
|
|
|
95128
95738
|
readonly jsonApiUserSettingInDocument: JsonApiUserSettingInDocument;
|
|
95129
95739
|
}
|
|
95130
95740
|
|
|
95741
|
+
/**
|
|
95742
|
+
* Request parameters for deleteEntityCustomUserApplicationSettings operation in UserSettingsApi.
|
|
95743
|
+
* @export
|
|
95744
|
+
* @interface UserSettingsApiDeleteEntityCustomUserApplicationSettingsRequest
|
|
95745
|
+
*/
|
|
95746
|
+
export declare interface UserSettingsApiDeleteEntityCustomUserApplicationSettingsRequest {
|
|
95747
|
+
/**
|
|
95748
|
+
*
|
|
95749
|
+
* @type {string}
|
|
95750
|
+
* @memberof UserSettingsApiDeleteEntityCustomUserApplicationSettings
|
|
95751
|
+
*/
|
|
95752
|
+
readonly userId: string;
|
|
95753
|
+
/**
|
|
95754
|
+
*
|
|
95755
|
+
* @type {string}
|
|
95756
|
+
* @memberof UserSettingsApiDeleteEntityCustomUserApplicationSettings
|
|
95757
|
+
*/
|
|
95758
|
+
readonly id: string;
|
|
95759
|
+
}
|
|
95760
|
+
|
|
95131
95761
|
/**
|
|
95132
95762
|
* Request parameters for deleteEntityUserSettings operation in UserSettingsApi.
|
|
95133
95763
|
* @export
|
|
@@ -95148,6 +95778,50 @@ export declare interface UserSettingsApiDeleteEntityUserSettingsRequest {
|
|
|
95148
95778
|
readonly id: string;
|
|
95149
95779
|
}
|
|
95150
95780
|
|
|
95781
|
+
/**
|
|
95782
|
+
* Request parameters for getAllEntitiesCustomUserApplicationSettings operation in UserSettingsApi.
|
|
95783
|
+
* @export
|
|
95784
|
+
* @interface UserSettingsApiGetAllEntitiesCustomUserApplicationSettingsRequest
|
|
95785
|
+
*/
|
|
95786
|
+
export declare interface UserSettingsApiGetAllEntitiesCustomUserApplicationSettingsRequest {
|
|
95787
|
+
/**
|
|
95788
|
+
*
|
|
95789
|
+
* @type {string}
|
|
95790
|
+
* @memberof UserSettingsApiGetAllEntitiesCustomUserApplicationSettings
|
|
95791
|
+
*/
|
|
95792
|
+
readonly userId: string;
|
|
95793
|
+
/**
|
|
95794
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
95795
|
+
* @type {string}
|
|
95796
|
+
* @memberof UserSettingsApiGetAllEntitiesCustomUserApplicationSettings
|
|
95797
|
+
*/
|
|
95798
|
+
readonly filter?: string;
|
|
95799
|
+
/**
|
|
95800
|
+
* Zero-based page index (0..N)
|
|
95801
|
+
* @type {number}
|
|
95802
|
+
* @memberof UserSettingsApiGetAllEntitiesCustomUserApplicationSettings
|
|
95803
|
+
*/
|
|
95804
|
+
readonly page?: number;
|
|
95805
|
+
/**
|
|
95806
|
+
* The size of the page to be returned
|
|
95807
|
+
* @type {number}
|
|
95808
|
+
* @memberof UserSettingsApiGetAllEntitiesCustomUserApplicationSettings
|
|
95809
|
+
*/
|
|
95810
|
+
readonly size?: number;
|
|
95811
|
+
/**
|
|
95812
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
95813
|
+
* @type {Array<string>}
|
|
95814
|
+
* @memberof UserSettingsApiGetAllEntitiesCustomUserApplicationSettings
|
|
95815
|
+
*/
|
|
95816
|
+
readonly sort?: Array<string>;
|
|
95817
|
+
/**
|
|
95818
|
+
* Include Meta objects.
|
|
95819
|
+
* @type {Array<'page' | 'all' | 'ALL'>}
|
|
95820
|
+
* @memberof UserSettingsApiGetAllEntitiesCustomUserApplicationSettings
|
|
95821
|
+
*/
|
|
95822
|
+
readonly metaInclude?: Array<'page' | 'all' | 'ALL'>;
|
|
95823
|
+
}
|
|
95824
|
+
|
|
95151
95825
|
/**
|
|
95152
95826
|
* Request parameters for getAllEntitiesUserSettings operation in UserSettingsApi.
|
|
95153
95827
|
* @export
|
|
@@ -95192,6 +95866,32 @@ export declare interface UserSettingsApiGetAllEntitiesUserSettingsRequest {
|
|
|
95192
95866
|
readonly metaInclude?: Array<'page' | 'all' | 'ALL'>;
|
|
95193
95867
|
}
|
|
95194
95868
|
|
|
95869
|
+
/**
|
|
95870
|
+
* Request parameters for getEntityCustomUserApplicationSettings operation in UserSettingsApi.
|
|
95871
|
+
* @export
|
|
95872
|
+
* @interface UserSettingsApiGetEntityCustomUserApplicationSettingsRequest
|
|
95873
|
+
*/
|
|
95874
|
+
export declare interface UserSettingsApiGetEntityCustomUserApplicationSettingsRequest {
|
|
95875
|
+
/**
|
|
95876
|
+
*
|
|
95877
|
+
* @type {string}
|
|
95878
|
+
* @memberof UserSettingsApiGetEntityCustomUserApplicationSettings
|
|
95879
|
+
*/
|
|
95880
|
+
readonly userId: string;
|
|
95881
|
+
/**
|
|
95882
|
+
*
|
|
95883
|
+
* @type {string}
|
|
95884
|
+
* @memberof UserSettingsApiGetEntityCustomUserApplicationSettings
|
|
95885
|
+
*/
|
|
95886
|
+
readonly id: string;
|
|
95887
|
+
/**
|
|
95888
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
95889
|
+
* @type {string}
|
|
95890
|
+
* @memberof UserSettingsApiGetEntityCustomUserApplicationSettings
|
|
95891
|
+
*/
|
|
95892
|
+
readonly filter?: string;
|
|
95893
|
+
}
|
|
95894
|
+
|
|
95195
95895
|
/**
|
|
95196
95896
|
* Request parameters for getEntityUserSettings operation in UserSettingsApi.
|
|
95197
95897
|
* @export
|
|
@@ -95224,6 +95924,15 @@ export declare interface UserSettingsApiGetEntityUserSettingsRequest {
|
|
|
95224
95924
|
* @interface UserSettingsApi
|
|
95225
95925
|
*/
|
|
95226
95926
|
export declare interface UserSettingsApiInterface {
|
|
95927
|
+
/**
|
|
95928
|
+
*
|
|
95929
|
+
* @summary Post a new custom application setting for the user
|
|
95930
|
+
* @param {UserSettingsApiCreateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95931
|
+
* @param {*} [options] Override http request option.
|
|
95932
|
+
* @throws {RequiredError}
|
|
95933
|
+
* @memberof UserSettingsApiInterface
|
|
95934
|
+
*/
|
|
95935
|
+
createEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiCreateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
95227
95936
|
/**
|
|
95228
95937
|
*
|
|
95229
95938
|
* @summary Post new user settings for the user
|
|
@@ -95233,6 +95942,15 @@ export declare interface UserSettingsApiInterface {
|
|
|
95233
95942
|
* @memberof UserSettingsApiInterface
|
|
95234
95943
|
*/
|
|
95235
95944
|
createEntityUserSettings(requestParameters: UserSettingsApiCreateEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutDocument>;
|
|
95945
|
+
/**
|
|
95946
|
+
*
|
|
95947
|
+
* @summary Delete a custom application setting for a user
|
|
95948
|
+
* @param {UserSettingsApiDeleteEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95949
|
+
* @param {*} [options] Override http request option.
|
|
95950
|
+
* @throws {RequiredError}
|
|
95951
|
+
* @memberof UserSettingsApiInterface
|
|
95952
|
+
*/
|
|
95953
|
+
deleteEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiDeleteEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
95236
95954
|
/**
|
|
95237
95955
|
*
|
|
95238
95956
|
* @summary Delete a setting for a user
|
|
@@ -95242,6 +95960,15 @@ export declare interface UserSettingsApiInterface {
|
|
|
95242
95960
|
* @memberof UserSettingsApiInterface
|
|
95243
95961
|
*/
|
|
95244
95962
|
deleteEntityUserSettings(requestParameters: UserSettingsApiDeleteEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
95963
|
+
/**
|
|
95964
|
+
*
|
|
95965
|
+
* @summary List all custom application settings for a user
|
|
95966
|
+
* @param {UserSettingsApiGetAllEntitiesCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95967
|
+
* @param {*} [options] Override http request option.
|
|
95968
|
+
* @throws {RequiredError}
|
|
95969
|
+
* @memberof UserSettingsApiInterface
|
|
95970
|
+
*/
|
|
95971
|
+
getAllEntitiesCustomUserApplicationSettings(requestParameters: UserSettingsApiGetAllEntitiesCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutList>;
|
|
95245
95972
|
/**
|
|
95246
95973
|
*
|
|
95247
95974
|
* @summary List all settings for a user
|
|
@@ -95251,6 +95978,15 @@ export declare interface UserSettingsApiInterface {
|
|
|
95251
95978
|
* @memberof UserSettingsApiInterface
|
|
95252
95979
|
*/
|
|
95253
95980
|
getAllEntitiesUserSettings(requestParameters: UserSettingsApiGetAllEntitiesUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutList>;
|
|
95981
|
+
/**
|
|
95982
|
+
*
|
|
95983
|
+
* @summary Get a custom application setting for a user
|
|
95984
|
+
* @param {UserSettingsApiGetEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
95985
|
+
* @param {*} [options] Override http request option.
|
|
95986
|
+
* @throws {RequiredError}
|
|
95987
|
+
* @memberof UserSettingsApiInterface
|
|
95988
|
+
*/
|
|
95989
|
+
getEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiGetEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
95254
95990
|
/**
|
|
95255
95991
|
*
|
|
95256
95992
|
* @summary Get a setting for a user
|
|
@@ -95260,6 +95996,15 @@ export declare interface UserSettingsApiInterface {
|
|
|
95260
95996
|
* @memberof UserSettingsApiInterface
|
|
95261
95997
|
*/
|
|
95262
95998
|
getEntityUserSettings(requestParameters: UserSettingsApiGetEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutDocument>;
|
|
95999
|
+
/**
|
|
96000
|
+
*
|
|
96001
|
+
* @summary Put a custom application setting for the user
|
|
96002
|
+
* @param {UserSettingsApiUpdateEntityCustomUserApplicationSettingsRequest} requestParameters Request parameters.
|
|
96003
|
+
* @param {*} [options] Override http request option.
|
|
96004
|
+
* @throws {RequiredError}
|
|
96005
|
+
* @memberof UserSettingsApiInterface
|
|
96006
|
+
*/
|
|
96007
|
+
updateEntityCustomUserApplicationSettings(requestParameters: UserSettingsApiUpdateEntityCustomUserApplicationSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiCustomUserApplicationSettingOutDocument>;
|
|
95263
96008
|
/**
|
|
95264
96009
|
*
|
|
95265
96010
|
* @summary Put new user settings for the user
|
|
@@ -95271,6 +96016,38 @@ export declare interface UserSettingsApiInterface {
|
|
|
95271
96016
|
updateEntityUserSettings(requestParameters: UserSettingsApiUpdateEntityUserSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiUserSettingOutDocument>;
|
|
95272
96017
|
}
|
|
95273
96018
|
|
|
96019
|
+
/**
|
|
96020
|
+
* Request parameters for updateEntityCustomUserApplicationSettings operation in UserSettingsApi.
|
|
96021
|
+
* @export
|
|
96022
|
+
* @interface UserSettingsApiUpdateEntityCustomUserApplicationSettingsRequest
|
|
96023
|
+
*/
|
|
96024
|
+
export declare interface UserSettingsApiUpdateEntityCustomUserApplicationSettingsRequest {
|
|
96025
|
+
/**
|
|
96026
|
+
*
|
|
96027
|
+
* @type {string}
|
|
96028
|
+
* @memberof UserSettingsApiUpdateEntityCustomUserApplicationSettings
|
|
96029
|
+
*/
|
|
96030
|
+
readonly userId: string;
|
|
96031
|
+
/**
|
|
96032
|
+
*
|
|
96033
|
+
* @type {string}
|
|
96034
|
+
* @memberof UserSettingsApiUpdateEntityCustomUserApplicationSettings
|
|
96035
|
+
*/
|
|
96036
|
+
readonly id: string;
|
|
96037
|
+
/**
|
|
96038
|
+
*
|
|
96039
|
+
* @type {JsonApiCustomUserApplicationSettingInDocument}
|
|
96040
|
+
* @memberof UserSettingsApiUpdateEntityCustomUserApplicationSettings
|
|
96041
|
+
*/
|
|
96042
|
+
readonly jsonApiCustomUserApplicationSettingInDocument: JsonApiCustomUserApplicationSettingInDocument;
|
|
96043
|
+
/**
|
|
96044
|
+
* Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
96045
|
+
* @type {string}
|
|
96046
|
+
* @memberof UserSettingsApiUpdateEntityCustomUserApplicationSettings
|
|
96047
|
+
*/
|
|
96048
|
+
readonly filter?: string;
|
|
96049
|
+
}
|
|
96050
|
+
|
|
95274
96051
|
/**
|
|
95275
96052
|
* Request parameters for updateEntityUserSettings operation in UserSettingsApi.
|
|
95276
96053
|
* @export
|
|
@@ -95787,13 +96564,13 @@ export declare function VisualizationObjectApi_UpdateEntityVisualizationObjects(
|
|
|
95787
96564
|
* @summary Post Visualization Objects
|
|
95788
96565
|
* @param {string} workspaceId
|
|
95789
96566
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
95790
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96567
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95791
96568
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
95792
96569
|
* @param {*} [options] Override http request option.
|
|
95793
96570
|
* @param {Configuration} [configuration] Optional configuration.
|
|
95794
96571
|
* @throws {RequiredError}
|
|
95795
96572
|
*/
|
|
95796
|
-
export declare function VisualizationObjectApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96573
|
+
export declare function VisualizationObjectApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
95797
96574
|
|
|
95798
96575
|
/**
|
|
95799
96576
|
*
|
|
@@ -95812,7 +96589,7 @@ export declare function VisualizationObjectApiAxiosParamCreator_DeleteEntityVisu
|
|
|
95812
96589
|
* @param {string} workspaceId
|
|
95813
96590
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
95814
96591
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
95815
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96592
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95816
96593
|
* @param {number} [page] Zero-based page index (0..N)
|
|
95817
96594
|
* @param {number} [size] The size of the page to be returned
|
|
95818
96595
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -95822,7 +96599,7 @@ export declare function VisualizationObjectApiAxiosParamCreator_DeleteEntityVisu
|
|
|
95822
96599
|
* @param {Configuration} [configuration] Optional configuration.
|
|
95823
96600
|
* @throws {RequiredError}
|
|
95824
96601
|
*/
|
|
95825
|
-
export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96602
|
+
export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
95826
96603
|
|
|
95827
96604
|
/**
|
|
95828
96605
|
*
|
|
@@ -95830,14 +96607,14 @@ export declare function VisualizationObjectApiAxiosParamCreator_GetAllEntitiesVi
|
|
|
95830
96607
|
* @param {string} workspaceId
|
|
95831
96608
|
* @param {string} objectId
|
|
95832
96609
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
95833
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96610
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95834
96611
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
95835
96612
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
95836
96613
|
* @param {*} [options] Override http request option.
|
|
95837
96614
|
* @param {Configuration} [configuration] Optional configuration.
|
|
95838
96615
|
* @throws {RequiredError}
|
|
95839
96616
|
*/
|
|
95840
|
-
export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96617
|
+
export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
95841
96618
|
|
|
95842
96619
|
/**
|
|
95843
96620
|
*
|
|
@@ -95846,12 +96623,12 @@ export declare function VisualizationObjectApiAxiosParamCreator_GetEntityVisuali
|
|
|
95846
96623
|
* @param {string} objectId
|
|
95847
96624
|
* @param {JsonApiVisualizationObjectPatchDocument} jsonApiVisualizationObjectPatchDocument
|
|
95848
96625
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
95849
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96626
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95850
96627
|
* @param {*} [options] Override http request option.
|
|
95851
96628
|
* @param {Configuration} [configuration] Optional configuration.
|
|
95852
96629
|
* @throws {RequiredError}
|
|
95853
96630
|
*/
|
|
95854
|
-
export declare function VisualizationObjectApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96631
|
+
export declare function VisualizationObjectApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
95855
96632
|
|
|
95856
96633
|
/**
|
|
95857
96634
|
*
|
|
@@ -95873,12 +96650,12 @@ export declare function VisualizationObjectApiAxiosParamCreator_SearchEntitiesVi
|
|
|
95873
96650
|
* @param {string} objectId
|
|
95874
96651
|
* @param {JsonApiVisualizationObjectInDocument} jsonApiVisualizationObjectInDocument
|
|
95875
96652
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
95876
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96653
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95877
96654
|
* @param {*} [options] Override http request option.
|
|
95878
96655
|
* @param {Configuration} [configuration] Optional configuration.
|
|
95879
96656
|
* @throws {RequiredError}
|
|
95880
96657
|
*/
|
|
95881
|
-
export declare function VisualizationObjectApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96658
|
+
export declare function VisualizationObjectApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
95882
96659
|
|
|
95883
96660
|
/**
|
|
95884
96661
|
* Request parameters for createEntityVisualizationObjects operation in VisualizationObjectApi.
|
|
@@ -95900,10 +96677,10 @@ export declare interface VisualizationObjectApiCreateEntityVisualizationObjectsR
|
|
|
95900
96677
|
readonly jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument;
|
|
95901
96678
|
/**
|
|
95902
96679
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95903
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96680
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
95904
96681
|
* @memberof VisualizationObjectApiCreateEntityVisualizationObjects
|
|
95905
96682
|
*/
|
|
95906
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96683
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
95907
96684
|
/**
|
|
95908
96685
|
* Include Meta objects.
|
|
95909
96686
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -95958,10 +96735,10 @@ export declare interface VisualizationObjectApiGetAllEntitiesVisualizationObject
|
|
|
95958
96735
|
readonly filter?: string;
|
|
95959
96736
|
/**
|
|
95960
96737
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
95961
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96738
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
95962
96739
|
* @memberof VisualizationObjectApiGetAllEntitiesVisualizationObjects
|
|
95963
96740
|
*/
|
|
95964
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96741
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
95965
96742
|
/**
|
|
95966
96743
|
* Zero-based page index (0..N)
|
|
95967
96744
|
* @type {number}
|
|
@@ -96020,10 +96797,10 @@ export declare interface VisualizationObjectApiGetEntityVisualizationObjectsRequ
|
|
|
96020
96797
|
readonly filter?: string;
|
|
96021
96798
|
/**
|
|
96022
96799
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96023
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96800
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96024
96801
|
* @memberof VisualizationObjectApiGetEntityVisualizationObjects
|
|
96025
96802
|
*/
|
|
96026
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96803
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96027
96804
|
/**
|
|
96028
96805
|
*
|
|
96029
96806
|
* @type {boolean}
|
|
@@ -96141,10 +96918,10 @@ export declare interface VisualizationObjectApiPatchEntityVisualizationObjectsRe
|
|
|
96141
96918
|
readonly filter?: string;
|
|
96142
96919
|
/**
|
|
96143
96920
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96144
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96921
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96145
96922
|
* @memberof VisualizationObjectApiPatchEntityVisualizationObjects
|
|
96146
96923
|
*/
|
|
96147
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96924
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96148
96925
|
}
|
|
96149
96926
|
|
|
96150
96927
|
/**
|
|
@@ -96211,10 +96988,10 @@ export declare interface VisualizationObjectApiUpdateEntityVisualizationObjectsR
|
|
|
96211
96988
|
readonly filter?: string;
|
|
96212
96989
|
/**
|
|
96213
96990
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96214
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96991
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96215
96992
|
* @memberof VisualizationObjectApiUpdateEntityVisualizationObjects
|
|
96216
96993
|
*/
|
|
96217
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96994
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96218
96995
|
}
|
|
96219
96996
|
|
|
96220
96997
|
/**
|
|
@@ -96378,13 +97155,13 @@ export declare function VisualizationObjectControllerApi_UpdateEntityVisualizati
|
|
|
96378
97155
|
* @summary Post Visualization Objects
|
|
96379
97156
|
* @param {string} workspaceId
|
|
96380
97157
|
* @param {JsonApiVisualizationObjectPostOptionalIdDocument} jsonApiVisualizationObjectPostOptionalIdDocument
|
|
96381
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
97158
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96382
97159
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
96383
97160
|
* @param {*} [options] Override http request option.
|
|
96384
97161
|
* @param {Configuration} [configuration] Optional configuration.
|
|
96385
97162
|
* @throws {RequiredError}
|
|
96386
97163
|
*/
|
|
96387
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97164
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_CreateEntityVisualizationObjects(workspaceId: string, jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96388
97165
|
|
|
96389
97166
|
/**
|
|
96390
97167
|
*
|
|
@@ -96403,7 +97180,7 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Delete
|
|
|
96403
97180
|
* @param {string} workspaceId
|
|
96404
97181
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
96405
97182
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
96406
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
97183
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96407
97184
|
* @param {number} [page] Zero-based page index (0..N)
|
|
96408
97185
|
* @param {number} [size] The size of the page to be returned
|
|
96409
97186
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -96413,7 +97190,7 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Delete
|
|
|
96413
97190
|
* @param {Configuration} [configuration] Optional configuration.
|
|
96414
97191
|
* @throws {RequiredError}
|
|
96415
97192
|
*/
|
|
96416
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97193
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAllEntitiesVisualizationObjects(workspaceId: string, origin?: 'ALL' | 'PARENTS' | 'NATIVE', filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'page' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96417
97194
|
|
|
96418
97195
|
/**
|
|
96419
97196
|
*
|
|
@@ -96421,14 +97198,14 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_GetAll
|
|
|
96421
97198
|
* @param {string} workspaceId
|
|
96422
97199
|
* @param {string} objectId
|
|
96423
97200
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
96424
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
97201
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96425
97202
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
96426
97203
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
96427
97204
|
* @param {*} [options] Override http request option.
|
|
96428
97205
|
* @param {Configuration} [configuration] Optional configuration.
|
|
96429
97206
|
* @throws {RequiredError}
|
|
96430
97207
|
*/
|
|
96431
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97208
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEntityVisualizationObjects(workspaceId: string, objectId: string, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<'origin' | 'all' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96432
97209
|
|
|
96433
97210
|
/**
|
|
96434
97211
|
*
|
|
@@ -96437,12 +97214,12 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_GetEnt
|
|
|
96437
97214
|
* @param {string} objectId
|
|
96438
97215
|
* @param {JsonApiVisualizationObjectPatchDocument} jsonApiVisualizationObjectPatchDocument
|
|
96439
97216
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
96440
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
97217
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96441
97218
|
* @param {*} [options] Override http request option.
|
|
96442
97219
|
* @param {Configuration} [configuration] Optional configuration.
|
|
96443
97220
|
* @throws {RequiredError}
|
|
96444
97221
|
*/
|
|
96445
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97222
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_PatchEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectPatchDocument: JsonApiVisualizationObjectPatchDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96446
97223
|
|
|
96447
97224
|
/**
|
|
96448
97225
|
*
|
|
@@ -96464,12 +97241,12 @@ export declare function VisualizationObjectControllerApiAxiosParamCreator_Search
|
|
|
96464
97241
|
* @param {string} objectId
|
|
96465
97242
|
* @param {JsonApiVisualizationObjectInDocument} jsonApiVisualizationObjectInDocument
|
|
96466
97243
|
* @param {string} [filter] Filtering parameter in RSQL. See https://github.com/jirutka/rsql-parser. You can specify any object parameter and parameter of related entity (for example title==\'Some Title\';description==\'desc\'). Additionally, if the entity relationship represents a polymorphic entity type, it can be casted to its subtypes (for example relatedEntity::subtype.subtypeProperty==\'Value 123\').
|
|
96467
|
-
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
97244
|
+
* @param {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>} [include] Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96468
97245
|
* @param {*} [options] Override http request option.
|
|
96469
97246
|
* @param {Configuration} [configuration] Optional configuration.
|
|
96470
97247
|
* @throws {RequiredError}
|
|
96471
97248
|
*/
|
|
96472
|
-
export declare function VisualizationObjectControllerApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97249
|
+
export declare function VisualizationObjectControllerApiAxiosParamCreator_UpdateEntityVisualizationObjects(workspaceId: string, objectId: string, jsonApiVisualizationObjectInDocument: JsonApiVisualizationObjectInDocument, filter?: string, include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
96473
97250
|
|
|
96474
97251
|
/**
|
|
96475
97252
|
* Request parameters for createEntityVisualizationObjects operation in VisualizationObjectControllerApi.
|
|
@@ -96491,10 +97268,10 @@ export declare interface VisualizationObjectControllerApiCreateEntityVisualizati
|
|
|
96491
97268
|
readonly jsonApiVisualizationObjectPostOptionalIdDocument: JsonApiVisualizationObjectPostOptionalIdDocument;
|
|
96492
97269
|
/**
|
|
96493
97270
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96494
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
97271
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96495
97272
|
* @memberof VisualizationObjectControllerApiCreateEntityVisualizationObjects
|
|
96496
97273
|
*/
|
|
96497
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
97274
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96498
97275
|
/**
|
|
96499
97276
|
* Include Meta objects.
|
|
96500
97277
|
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
@@ -96549,10 +97326,10 @@ export declare interface VisualizationObjectControllerApiGetAllEntitiesVisualiza
|
|
|
96549
97326
|
readonly filter?: string;
|
|
96550
97327
|
/**
|
|
96551
97328
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96552
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
97329
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96553
97330
|
* @memberof VisualizationObjectControllerApiGetAllEntitiesVisualizationObjects
|
|
96554
97331
|
*/
|
|
96555
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
97332
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96556
97333
|
/**
|
|
96557
97334
|
* Zero-based page index (0..N)
|
|
96558
97335
|
* @type {number}
|
|
@@ -96611,10 +97388,10 @@ export declare interface VisualizationObjectControllerApiGetEntityVisualizationO
|
|
|
96611
97388
|
readonly filter?: string;
|
|
96612
97389
|
/**
|
|
96613
97390
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96614
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
97391
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96615
97392
|
* @memberof VisualizationObjectControllerApiGetEntityVisualizationObjects
|
|
96616
97393
|
*/
|
|
96617
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
97394
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96618
97395
|
/**
|
|
96619
97396
|
*
|
|
96620
97397
|
* @type {boolean}
|
|
@@ -96732,10 +97509,10 @@ export declare interface VisualizationObjectControllerApiPatchEntityVisualizatio
|
|
|
96732
97509
|
readonly filter?: string;
|
|
96733
97510
|
/**
|
|
96734
97511
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96735
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
97512
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96736
97513
|
* @memberof VisualizationObjectControllerApiPatchEntityVisualizationObjects
|
|
96737
97514
|
*/
|
|
96738
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
97515
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96739
97516
|
}
|
|
96740
97517
|
|
|
96741
97518
|
/**
|
|
@@ -96802,10 +97579,10 @@ export declare interface VisualizationObjectControllerApiUpdateEntityVisualizati
|
|
|
96802
97579
|
readonly filter?: string;
|
|
96803
97580
|
/**
|
|
96804
97581
|
* Array of included collections or individual relationships. Includes are separated by commas (e.g. include=entity1s,entity2s). Collection include represents the inclusion of every relationship between this entity and the given collection. Relationship include represents the inclusion of the particular relationships only. If single parameter \"ALL\" is present, all possible includes are used (include=ALL). __WARNING:__ Individual include types (collection, relationship or ALL) cannot be combined together.
|
|
96805
|
-
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
97582
|
+
* @type {Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>}
|
|
96806
97583
|
* @memberof VisualizationObjectControllerApiUpdateEntityVisualizationObjects
|
|
96807
97584
|
*/
|
|
96808
|
-
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
97585
|
+
readonly include?: Array<'userIdentifiers' | 'facts' | 'attributes' | 'labels' | 'metrics' | 'parameters' | 'datasets' | 'createdBy' | 'modifiedBy' | 'certifiedBy' | 'ALL'>;
|
|
96809
97586
|
}
|
|
96810
97587
|
|
|
96811
97588
|
export declare interface VisualizationObjectExecution {
|
|
@@ -97142,15 +97919,6 @@ export declare class WorkspaceControllerApi extends MetadataBaseApi implements W
|
|
|
97142
97919
|
* @memberof WorkspaceControllerApi
|
|
97143
97920
|
*/
|
|
97144
97921
|
patchEntityWorkspaces(requestParameters: WorkspaceControllerApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
97145
|
-
/**
|
|
97146
|
-
* Notification sets up all reports to be computed again with new data.
|
|
97147
|
-
* @summary Register an upload notification
|
|
97148
|
-
* @param {WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
97149
|
-
* @param {*} [options] Override http request option.
|
|
97150
|
-
* @throws {RequiredError}
|
|
97151
|
-
* @memberof WorkspaceControllerApi
|
|
97152
|
-
*/
|
|
97153
|
-
registerUploadNotificationWorkspaces(requestParameters: WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
97154
97922
|
/**
|
|
97155
97923
|
* Space of the shared interest
|
|
97156
97924
|
* @summary Put Workspace entity
|
|
@@ -97222,18 +97990,6 @@ export declare function WorkspaceControllerApi_GetEntityWorkspaces(axios: AxiosI
|
|
|
97222
97990
|
*/
|
|
97223
97991
|
export declare function WorkspaceControllerApi_PatchEntityWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceControllerApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
97224
97992
|
|
|
97225
|
-
/**
|
|
97226
|
-
* Notification sets up all reports to be computed again with new data.
|
|
97227
|
-
* @summary Register an upload notification
|
|
97228
|
-
* @param {AxiosInstance} axios Axios instance.
|
|
97229
|
-
* @param {string} basePath Base path.
|
|
97230
|
-
* @param {WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
97231
|
-
* @param {*} [options] Override http request option.
|
|
97232
|
-
* @param {Configuration} [configuration] Optional configuration.
|
|
97233
|
-
* @throws {RequiredError}
|
|
97234
|
-
*/
|
|
97235
|
-
export declare function WorkspaceControllerApi_RegisterUploadNotificationWorkspaces(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
97236
|
-
|
|
97237
97993
|
/**
|
|
97238
97994
|
* Space of the shared interest
|
|
97239
97995
|
* @summary Put Workspace entity
|
|
@@ -97309,18 +98065,6 @@ export declare function WorkspaceControllerApiAxiosParamCreator_GetEntityWorkspa
|
|
|
97309
98065
|
*/
|
|
97310
98066
|
export declare function WorkspaceControllerApiAxiosParamCreator_PatchEntityWorkspaces(id: string, jsonApiWorkspacePatchDocument: JsonApiWorkspacePatchDocument, filter?: string, include?: Array<'workspaces' | 'parent' | 'ALL'>, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97311
98067
|
|
|
97312
|
-
/**
|
|
97313
|
-
* Notification sets up all reports to be computed again with new data.
|
|
97314
|
-
* @summary Register an upload notification
|
|
97315
|
-
* @param {string} workspaceId
|
|
97316
|
-
* @param {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
97317
|
-
* @param {object} [body] Request body
|
|
97318
|
-
* @param {*} [options] Override http request option.
|
|
97319
|
-
* @param {Configuration} [configuration] Optional configuration.
|
|
97320
|
-
* @throws {RequiredError}
|
|
97321
|
-
*/
|
|
97322
|
-
export declare function WorkspaceControllerApiAxiosParamCreator_RegisterUploadNotificationWorkspaces(workspaceId: string, metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>, body?: object, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
97323
|
-
|
|
97324
98068
|
/**
|
|
97325
98069
|
* Space of the shared interest
|
|
97326
98070
|
* @summary Put Workspace entity
|
|
@@ -97501,15 +98245,6 @@ export declare interface WorkspaceControllerApiInterface {
|
|
|
97501
98245
|
* @memberof WorkspaceControllerApiInterface
|
|
97502
98246
|
*/
|
|
97503
98247
|
patchEntityWorkspaces(requestParameters: WorkspaceControllerApiPatchEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
97504
|
-
/**
|
|
97505
|
-
* Notification sets up all reports to be computed again with new data.
|
|
97506
|
-
* @summary Register an upload notification
|
|
97507
|
-
* @param {WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest} requestParameters Request parameters.
|
|
97508
|
-
* @param {*} [options] Override http request option.
|
|
97509
|
-
* @throws {RequiredError}
|
|
97510
|
-
* @memberof WorkspaceControllerApiInterface
|
|
97511
|
-
*/
|
|
97512
|
-
registerUploadNotificationWorkspaces(requestParameters: WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceOutDocument>;
|
|
97513
98248
|
/**
|
|
97514
98249
|
* Space of the shared interest
|
|
97515
98250
|
* @summary Put Workspace entity
|
|
@@ -97553,32 +98288,6 @@ export declare interface WorkspaceControllerApiPatchEntityWorkspacesRequest {
|
|
|
97553
98288
|
readonly include?: Array<'workspaces' | 'parent' | 'ALL'>;
|
|
97554
98289
|
}
|
|
97555
98290
|
|
|
97556
|
-
/**
|
|
97557
|
-
* Request parameters for registerUploadNotificationWorkspaces operation in WorkspaceControllerApi.
|
|
97558
|
-
* @export
|
|
97559
|
-
* @interface WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest
|
|
97560
|
-
*/
|
|
97561
|
-
export declare interface WorkspaceControllerApiRegisterUploadNotificationWorkspacesRequest {
|
|
97562
|
-
/**
|
|
97563
|
-
*
|
|
97564
|
-
* @type {string}
|
|
97565
|
-
* @memberof WorkspaceControllerApiRegisterUploadNotificationWorkspaces
|
|
97566
|
-
*/
|
|
97567
|
-
readonly workspaceId: string;
|
|
97568
|
-
/**
|
|
97569
|
-
* Include Meta objects.
|
|
97570
|
-
* @type {Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>}
|
|
97571
|
-
* @memberof WorkspaceControllerApiRegisterUploadNotificationWorkspaces
|
|
97572
|
-
*/
|
|
97573
|
-
readonly metaInclude?: Array<'config' | 'permissions' | 'hierarchy' | 'dataModelDatasets' | 'all' | 'ALL'>;
|
|
97574
|
-
/**
|
|
97575
|
-
* Request body
|
|
97576
|
-
* @type {object}
|
|
97577
|
-
* @memberof WorkspaceControllerApiRegisterUploadNotificationWorkspaces
|
|
97578
|
-
*/
|
|
97579
|
-
readonly body?: object;
|
|
97580
|
-
}
|
|
97581
|
-
|
|
97582
98291
|
/**
|
|
97583
98292
|
* Request parameters for updateEntityWorkspaces operation in WorkspaceControllerApi.
|
|
97584
98293
|
* @export
|