@gooddata/api-client-tiger 10.35.0-alpha.2 → 10.35.0-alpha.21
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.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1639 -478
- package/esm/generated/afm-rest-api/api.d.ts +11 -11
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +8 -8
- package/esm/generated/afm-rest-api/openapi-spec.json +3 -3
- package/esm/generated/auth-json-api/api.d.ts +0 -561
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +0 -696
- package/esm/generated/auth-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/openapi-spec.json +0 -166
- package/esm/generated/automation-json-api/api.d.ts +19 -12
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +2 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +6 -2
- package/esm/generated/export-json-api/api.d.ts +1 -0
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +1 -0
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +1 -0
- package/esm/generated/metadata-json-api/api.d.ts +1533 -409
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +1835 -940
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +9099 -8671
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.js +1 -1
- package/esm/generated/result-json-api/base.js.map +1 -1
- package/esm/generated/result-json-api/openapi-spec.json +1 -1
- package/esm/generated/scan-json-api/api.d.ts +96 -0
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +112 -0
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +1 -1
- package/package.json +3 -3
|
@@ -4660,7 +4660,7 @@ export declare class AfmActionsApi extends LabelElementsBaseApi implements AfmAc
|
|
|
4660
4660
|
*/
|
|
4661
4661
|
retrieveResult(requestParameters: ActionsApiRetrieveResultRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<ExecutionResult, any>>;
|
|
4662
4662
|
/**
|
|
4663
|
-
* Validates LLM
|
|
4663
|
+
* Validates LLM endpoint with provided parameters.
|
|
4664
4664
|
* @summary Validate LLM Endpoint
|
|
4665
4665
|
* @param {ActionsApiValidateLLMEndpointRequest} requestParameters Request parameters.
|
|
4666
4666
|
* @param {*} [options] Override http request option.
|
|
@@ -4897,7 +4897,7 @@ export declare const AfmActionsApiAxiosParamCreator: (configuration?: LabelEleme
|
|
|
4897
4897
|
*/
|
|
4898
4898
|
retrieveResult: (workspaceId: string, resultId: string, offset?: Array<number>, limit?: Array<number>, excludedTotalDimensions?: Array<string>, xGDCCANCELTOKEN?: string, options?: AxiosRequestConfig) => Promise<LabelElementsRequestArgs>;
|
|
4899
4899
|
/**
|
|
4900
|
-
* Validates LLM
|
|
4900
|
+
* Validates LLM endpoint with provided parameters.
|
|
4901
4901
|
* @summary Validate LLM Endpoint
|
|
4902
4902
|
* @param {ValidateLLMEndpointRequest} validateLLMEndpointRequest
|
|
4903
4903
|
* @param {*} [options] Override http request option.
|
|
@@ -5088,7 +5088,7 @@ export declare const AfmActionsApiFactory: (configuration?: LabelElementsConfigu
|
|
|
5088
5088
|
*/
|
|
5089
5089
|
retrieveResult(requestParameters: ActionsApiRetrieveResultRequest, options?: AxiosRequestConfig): AxiosPromise<ExecutionResult>;
|
|
5090
5090
|
/**
|
|
5091
|
-
* Validates LLM
|
|
5091
|
+
* Validates LLM endpoint with provided parameters.
|
|
5092
5092
|
* @summary Validate LLM Endpoint
|
|
5093
5093
|
* @param {ActionsApiValidateLLMEndpointRequest} requestParameters Request parameters.
|
|
5094
5094
|
* @param {*} [options] Override http request option.
|
|
@@ -5324,7 +5324,7 @@ export declare const AfmActionsApiFp: (configuration?: LabelElementsConfiguratio
|
|
|
5324
5324
|
*/
|
|
5325
5325
|
retrieveResult(workspaceId: string, resultId: string, offset?: Array<number>, limit?: Array<number>, excludedTotalDimensions?: Array<string>, xGDCCANCELTOKEN?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExecutionResult>>;
|
|
5326
5326
|
/**
|
|
5327
|
-
* Validates LLM
|
|
5327
|
+
* Validates LLM endpoint with provided parameters.
|
|
5328
5328
|
* @summary Validate LLM Endpoint
|
|
5329
5329
|
* @param {ValidateLLMEndpointRequest} validateLLMEndpointRequest
|
|
5330
5330
|
* @param {*} [options] Override http request option.
|
|
@@ -5538,7 +5538,7 @@ export declare interface AfmActionsApiInterface {
|
|
|
5538
5538
|
*/
|
|
5539
5539
|
retrieveResult(requestParameters: ActionsApiRetrieveResultRequest, options?: AxiosRequestConfig): AxiosPromise<ExecutionResult>;
|
|
5540
5540
|
/**
|
|
5541
|
-
* Validates LLM
|
|
5541
|
+
* Validates LLM endpoint with provided parameters.
|
|
5542
5542
|
* @summary Validate LLM Endpoint
|
|
5543
5543
|
* @param {ActionsApiValidateLLMEndpointRequest} requestParameters Request parameters.
|
|
5544
5544
|
* @param {*} [options] Override http request option.
|
|
@@ -11137,10 +11137,10 @@ export declare interface AutomationAutomationNotificationAllOf {
|
|
|
11137
11137
|
export declare interface AutomationAutomationRawExport {
|
|
11138
11138
|
/**
|
|
11139
11139
|
*
|
|
11140
|
-
* @type {
|
|
11140
|
+
* @type {AutomationRawExportAutomationRequest}
|
|
11141
11141
|
* @memberof AutomationAutomationRawExport
|
|
11142
11142
|
*/
|
|
11143
|
-
requestPayload:
|
|
11143
|
+
requestPayload: AutomationRawExportAutomationRequest;
|
|
11144
11144
|
}
|
|
11145
11145
|
|
|
11146
11146
|
/**
|
|
@@ -12081,6 +12081,7 @@ export declare const AutomationIdentifierRefIdentifierTypeEnum: {
|
|
|
12081
12081
|
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
12082
12082
|
readonly DATASET: "dataset";
|
|
12083
12083
|
readonly FACT: "fact";
|
|
12084
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
12084
12085
|
readonly LABEL: "label";
|
|
12085
12086
|
readonly METRIC: "metric";
|
|
12086
12087
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
@@ -12997,57 +12998,63 @@ export declare interface AutomationRawCustomOverride {
|
|
|
12997
12998
|
export declare interface AutomationRawExport {
|
|
12998
12999
|
/**
|
|
12999
13000
|
*
|
|
13000
|
-
* @type {
|
|
13001
|
+
* @type {RawExportAutomationRequest}
|
|
13001
13002
|
* @memberof AutomationRawExport
|
|
13002
13003
|
*/
|
|
13003
|
-
requestPayload:
|
|
13004
|
+
requestPayload: RawExportAutomationRequest;
|
|
13004
13005
|
}
|
|
13005
13006
|
|
|
13006
13007
|
/**
|
|
13007
13008
|
* Export request object describing the export properties and overrides for raw exports.
|
|
13008
13009
|
* @export
|
|
13009
|
-
* @interface
|
|
13010
|
+
* @interface AutomationRawExportAutomationRequest
|
|
13010
13011
|
*/
|
|
13011
|
-
export declare interface
|
|
13012
|
+
export declare interface AutomationRawExportAutomationRequest {
|
|
13012
13013
|
/**
|
|
13013
13014
|
* Requested resulting file type.
|
|
13014
13015
|
* @type {string}
|
|
13015
|
-
* @memberof
|
|
13016
|
+
* @memberof AutomationRawExportAutomationRequest
|
|
13016
13017
|
*/
|
|
13017
|
-
format:
|
|
13018
|
+
format: AutomationRawExportAutomationRequestFormatEnum;
|
|
13018
13019
|
/**
|
|
13019
13020
|
*
|
|
13020
13021
|
* @type {AutomationAFM}
|
|
13021
|
-
* @memberof
|
|
13022
|
+
* @memberof AutomationRawExportAutomationRequest
|
|
13022
13023
|
*/
|
|
13023
13024
|
execution: AutomationAFM;
|
|
13024
13025
|
/**
|
|
13025
13026
|
* Filename of downloaded file without extension.
|
|
13026
13027
|
* @type {string}
|
|
13027
|
-
* @memberof
|
|
13028
|
+
* @memberof AutomationRawExportAutomationRequest
|
|
13028
13029
|
*/
|
|
13029
13030
|
fileName: string;
|
|
13030
13031
|
/**
|
|
13031
13032
|
*
|
|
13032
13033
|
* @type {AutomationRawCustomOverride}
|
|
13033
|
-
* @memberof
|
|
13034
|
+
* @memberof AutomationRawExportAutomationRequest
|
|
13034
13035
|
*/
|
|
13035
13036
|
customOverride?: AutomationRawCustomOverride;
|
|
13036
13037
|
/**
|
|
13037
13038
|
*
|
|
13038
13039
|
* @type {AutomationExecutionSettings}
|
|
13039
|
-
* @memberof
|
|
13040
|
+
* @memberof AutomationRawExportAutomationRequest
|
|
13040
13041
|
*/
|
|
13041
13042
|
executionSettings?: AutomationExecutionSettings;
|
|
13043
|
+
/**
|
|
13044
|
+
* Metadata definition in free-form JSON format.
|
|
13045
|
+
* @type {object}
|
|
13046
|
+
* @memberof AutomationRawExportAutomationRequest
|
|
13047
|
+
*/
|
|
13048
|
+
metadata?: object | null;
|
|
13042
13049
|
}
|
|
13043
13050
|
|
|
13044
|
-
export declare const
|
|
13051
|
+
export declare const AutomationRawExportAutomationRequestFormatEnum: {
|
|
13045
13052
|
readonly ARROW_FILE: "ARROW_FILE";
|
|
13046
13053
|
readonly ARROW_STREAM: "ARROW_STREAM";
|
|
13047
13054
|
readonly CSV: "CSV";
|
|
13048
13055
|
};
|
|
13049
13056
|
|
|
13050
|
-
export declare type
|
|
13057
|
+
export declare type AutomationRawExportAutomationRequestFormatEnum = typeof AutomationRawExportAutomationRequestFormatEnum[keyof typeof AutomationRawExportAutomationRequestFormatEnum];
|
|
13051
13058
|
|
|
13052
13059
|
/**
|
|
13053
13060
|
*
|
|
@@ -13261,6 +13268,32 @@ export declare class AutomationsApi extends MetadataBaseApi implements Automatio
|
|
|
13261
13268
|
* @memberof AutomationsApi
|
|
13262
13269
|
*/
|
|
13263
13270
|
setAutomations(requestParameters: AutomationsApiSetAutomationsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
13271
|
+
/**
|
|
13272
|
+
*
|
|
13273
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
13274
|
+
* @param {*} [options] Override http request option.
|
|
13275
|
+
* @throws {RequiredError}
|
|
13276
|
+
* @memberof AutomationsApi
|
|
13277
|
+
*/
|
|
13278
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
13279
|
+
/**
|
|
13280
|
+
*
|
|
13281
|
+
* @summary Unsubscribe from an automation
|
|
13282
|
+
* @param {AutomationsApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
13283
|
+
* @param {*} [options] Override http request option.
|
|
13284
|
+
* @throws {RequiredError}
|
|
13285
|
+
* @memberof AutomationsApi
|
|
13286
|
+
*/
|
|
13287
|
+
unsubscribeAutomation(requestParameters: AutomationsApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
13288
|
+
/**
|
|
13289
|
+
*
|
|
13290
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
13291
|
+
* @param {AutomationsApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
13292
|
+
* @param {*} [options] Override http request option.
|
|
13293
|
+
* @throws {RequiredError}
|
|
13294
|
+
* @memberof AutomationsApi
|
|
13295
|
+
*/
|
|
13296
|
+
unsubscribeWorkspaceAutomations(requestParameters: AutomationsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
13264
13297
|
/**
|
|
13265
13298
|
*
|
|
13266
13299
|
* @summary Put an Automation
|
|
@@ -13357,6 +13390,30 @@ export declare const AutomationsApiAxiosParamCreator: (configuration?: MetadataC
|
|
|
13357
13390
|
* @throws {RequiredError}
|
|
13358
13391
|
*/
|
|
13359
13392
|
setAutomations: (workspaceId: string, declarativeAutomation: Array<DeclarativeAutomation>, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
13393
|
+
/**
|
|
13394
|
+
*
|
|
13395
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
13396
|
+
* @param {*} [options] Override http request option.
|
|
13397
|
+
* @throws {RequiredError}
|
|
13398
|
+
*/
|
|
13399
|
+
unsubscribeAllAutomations: (options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
13400
|
+
/**
|
|
13401
|
+
*
|
|
13402
|
+
* @summary Unsubscribe from an automation
|
|
13403
|
+
* @param {string} workspaceId
|
|
13404
|
+
* @param {string} automationId
|
|
13405
|
+
* @param {*} [options] Override http request option.
|
|
13406
|
+
* @throws {RequiredError}
|
|
13407
|
+
*/
|
|
13408
|
+
unsubscribeAutomation: (workspaceId: string, automationId: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
13409
|
+
/**
|
|
13410
|
+
*
|
|
13411
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
13412
|
+
* @param {string} workspaceId
|
|
13413
|
+
* @param {*} [options] Override http request option.
|
|
13414
|
+
* @throws {RequiredError}
|
|
13415
|
+
*/
|
|
13416
|
+
unsubscribeWorkspaceAutomations: (workspaceId: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
13360
13417
|
/**
|
|
13361
13418
|
*
|
|
13362
13419
|
* @summary Put an Automation
|
|
@@ -13490,6 +13547,29 @@ export declare const AutomationsApiFactory: (configuration?: MetadataConfigurati
|
|
|
13490
13547
|
* @throws {RequiredError}
|
|
13491
13548
|
*/
|
|
13492
13549
|
setAutomations(requestParameters: AutomationsApiSetAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13550
|
+
/**
|
|
13551
|
+
*
|
|
13552
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
13553
|
+
* @param {*} [options] Override http request option.
|
|
13554
|
+
* @throws {RequiredError}
|
|
13555
|
+
*/
|
|
13556
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13557
|
+
/**
|
|
13558
|
+
*
|
|
13559
|
+
* @summary Unsubscribe from an automation
|
|
13560
|
+
* @param {AutomationsApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
13561
|
+
* @param {*} [options] Override http request option.
|
|
13562
|
+
* @throws {RequiredError}
|
|
13563
|
+
*/
|
|
13564
|
+
unsubscribeAutomation(requestParameters: AutomationsApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13565
|
+
/**
|
|
13566
|
+
*
|
|
13567
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
13568
|
+
* @param {AutomationsApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
13569
|
+
* @param {*} [options] Override http request option.
|
|
13570
|
+
* @throws {RequiredError}
|
|
13571
|
+
*/
|
|
13572
|
+
unsubscribeWorkspaceAutomations(requestParameters: AutomationsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13493
13573
|
/**
|
|
13494
13574
|
*
|
|
13495
13575
|
* @summary Put an Automation
|
|
@@ -13585,6 +13665,30 @@ export declare const AutomationsApiFp: (configuration?: MetadataConfiguration) =
|
|
|
13585
13665
|
* @throws {RequiredError}
|
|
13586
13666
|
*/
|
|
13587
13667
|
setAutomations(workspaceId: string, declarativeAutomation: Array<DeclarativeAutomation>, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
13668
|
+
/**
|
|
13669
|
+
*
|
|
13670
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
13671
|
+
* @param {*} [options] Override http request option.
|
|
13672
|
+
* @throws {RequiredError}
|
|
13673
|
+
*/
|
|
13674
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
13675
|
+
/**
|
|
13676
|
+
*
|
|
13677
|
+
* @summary Unsubscribe from an automation
|
|
13678
|
+
* @param {string} workspaceId
|
|
13679
|
+
* @param {string} automationId
|
|
13680
|
+
* @param {*} [options] Override http request option.
|
|
13681
|
+
* @throws {RequiredError}
|
|
13682
|
+
*/
|
|
13683
|
+
unsubscribeAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
13684
|
+
/**
|
|
13685
|
+
*
|
|
13686
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
13687
|
+
* @param {string} workspaceId
|
|
13688
|
+
* @param {*} [options] Override http request option.
|
|
13689
|
+
* @throws {RequiredError}
|
|
13690
|
+
*/
|
|
13691
|
+
unsubscribeWorkspaceAutomations(workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
13588
13692
|
/**
|
|
13589
13693
|
*
|
|
13590
13694
|
* @summary Put an Automation
|
|
@@ -13794,6 +13898,32 @@ export declare interface AutomationsApiInterface {
|
|
|
13794
13898
|
* @memberof AutomationsApiInterface
|
|
13795
13899
|
*/
|
|
13796
13900
|
setAutomations(requestParameters: AutomationsApiSetAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13901
|
+
/**
|
|
13902
|
+
*
|
|
13903
|
+
* @summary Unsubscribe from all automations in all workspaces
|
|
13904
|
+
* @param {*} [options] Override http request option.
|
|
13905
|
+
* @throws {RequiredError}
|
|
13906
|
+
* @memberof AutomationsApiInterface
|
|
13907
|
+
*/
|
|
13908
|
+
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13909
|
+
/**
|
|
13910
|
+
*
|
|
13911
|
+
* @summary Unsubscribe from an automation
|
|
13912
|
+
* @param {AutomationsApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
13913
|
+
* @param {*} [options] Override http request option.
|
|
13914
|
+
* @throws {RequiredError}
|
|
13915
|
+
* @memberof AutomationsApiInterface
|
|
13916
|
+
*/
|
|
13917
|
+
unsubscribeAutomation(requestParameters: AutomationsApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13918
|
+
/**
|
|
13919
|
+
*
|
|
13920
|
+
* @summary Unsubscribe from all automations in the workspace
|
|
13921
|
+
* @param {AutomationsApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
13922
|
+
* @param {*} [options] Override http request option.
|
|
13923
|
+
* @throws {RequiredError}
|
|
13924
|
+
* @memberof AutomationsApiInterface
|
|
13925
|
+
*/
|
|
13926
|
+
unsubscribeWorkspaceAutomations(requestParameters: AutomationsApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
13797
13927
|
/**
|
|
13798
13928
|
*
|
|
13799
13929
|
* @summary Put an Automation
|
|
@@ -13863,6 +13993,40 @@ export declare interface AutomationsApiSetAutomationsRequest {
|
|
|
13863
13993
|
readonly declarativeAutomation: Array<DeclarativeAutomation>;
|
|
13864
13994
|
}
|
|
13865
13995
|
|
|
13996
|
+
/**
|
|
13997
|
+
* Request parameters for unsubscribeAutomation operation in AutomationsApi.
|
|
13998
|
+
* @export
|
|
13999
|
+
* @interface AutomationsApiUnsubscribeAutomationRequest
|
|
14000
|
+
*/
|
|
14001
|
+
export declare interface AutomationsApiUnsubscribeAutomationRequest {
|
|
14002
|
+
/**
|
|
14003
|
+
*
|
|
14004
|
+
* @type {string}
|
|
14005
|
+
* @memberof AutomationsApiUnsubscribeAutomation
|
|
14006
|
+
*/
|
|
14007
|
+
readonly workspaceId: string;
|
|
14008
|
+
/**
|
|
14009
|
+
*
|
|
14010
|
+
* @type {string}
|
|
14011
|
+
* @memberof AutomationsApiUnsubscribeAutomation
|
|
14012
|
+
*/
|
|
14013
|
+
readonly automationId: string;
|
|
14014
|
+
}
|
|
14015
|
+
|
|
14016
|
+
/**
|
|
14017
|
+
* Request parameters for unsubscribeWorkspaceAutomations operation in AutomationsApi.
|
|
14018
|
+
* @export
|
|
14019
|
+
* @interface AutomationsApiUnsubscribeWorkspaceAutomationsRequest
|
|
14020
|
+
*/
|
|
14021
|
+
export declare interface AutomationsApiUnsubscribeWorkspaceAutomationsRequest {
|
|
14022
|
+
/**
|
|
14023
|
+
*
|
|
14024
|
+
* @type {string}
|
|
14025
|
+
* @memberof AutomationsApiUnsubscribeWorkspaceAutomations
|
|
14026
|
+
*/
|
|
14027
|
+
readonly workspaceId: string;
|
|
14028
|
+
}
|
|
14029
|
+
|
|
13866
14030
|
/**
|
|
13867
14031
|
* Request parameters for updateEntityAutomations operation in AutomationsApi.
|
|
13868
14032
|
* @export
|
|
@@ -20352,7 +20516,7 @@ export declare const DatasetsApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
20352
20516
|
* @param {string} workspaceId
|
|
20353
20517
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
20354
20518
|
* @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\').
|
|
20355
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20519
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20356
20520
|
* @param {number} [page] Zero-based page index (0..N)
|
|
20357
20521
|
* @param {number} [size] The size of the page to be returned
|
|
20358
20522
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -20361,20 +20525,20 @@ export declare const DatasetsApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
20361
20525
|
* @param {*} [options] Override http request option.
|
|
20362
20526
|
* @throws {RequiredError}
|
|
20363
20527
|
*/
|
|
20364
|
-
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
20528
|
+
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
20365
20529
|
/**
|
|
20366
20530
|
*
|
|
20367
20531
|
* @summary Get a Dataset
|
|
20368
20532
|
* @param {string} workspaceId
|
|
20369
20533
|
* @param {string} objectId
|
|
20370
20534
|
* @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\').
|
|
20371
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20535
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20372
20536
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
20373
20537
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
20374
20538
|
* @param {*} [options] Override http request option.
|
|
20375
20539
|
* @throws {RequiredError}
|
|
20376
20540
|
*/
|
|
20377
|
-
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
20541
|
+
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
20378
20542
|
};
|
|
20379
20543
|
|
|
20380
20544
|
/**
|
|
@@ -20411,7 +20575,7 @@ export declare const DatasetsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
20411
20575
|
* @param {string} workspaceId
|
|
20412
20576
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
20413
20577
|
* @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\').
|
|
20414
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20578
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20415
20579
|
* @param {number} [page] Zero-based page index (0..N)
|
|
20416
20580
|
* @param {number} [size] The size of the page to be returned
|
|
20417
20581
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -20420,20 +20584,20 @@ export declare const DatasetsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
20420
20584
|
* @param {*} [options] Override http request option.
|
|
20421
20585
|
* @throws {RequiredError}
|
|
20422
20586
|
*/
|
|
20423
|
-
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
20587
|
+
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
20424
20588
|
/**
|
|
20425
20589
|
*
|
|
20426
20590
|
* @summary Get a Dataset
|
|
20427
20591
|
* @param {string} workspaceId
|
|
20428
20592
|
* @param {string} objectId
|
|
20429
20593
|
* @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\').
|
|
20430
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20594
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
20431
20595
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
20432
20596
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
20433
20597
|
* @param {*} [options] Override http request option.
|
|
20434
20598
|
* @throws {RequiredError}
|
|
20435
20599
|
*/
|
|
20436
|
-
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
20600
|
+
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
20437
20601
|
};
|
|
20438
20602
|
|
|
20439
20603
|
/**
|
|
@@ -20462,10 +20626,10 @@ export declare interface DatasetsApiGetAllEntitiesDatasetsRequest {
|
|
|
20462
20626
|
readonly filter?: string;
|
|
20463
20627
|
/**
|
|
20464
20628
|
* 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.
|
|
20465
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
20629
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
20466
20630
|
* @memberof DatasetsApiGetAllEntitiesDatasets
|
|
20467
20631
|
*/
|
|
20468
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
20632
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
20469
20633
|
/**
|
|
20470
20634
|
* Zero-based page index (0..N)
|
|
20471
20635
|
* @type {number}
|
|
@@ -20524,10 +20688,10 @@ export declare interface DatasetsApiGetEntityDatasetsRequest {
|
|
|
20524
20688
|
readonly filter?: string;
|
|
20525
20689
|
/**
|
|
20526
20690
|
* 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.
|
|
20527
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
20691
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
20528
20692
|
* @memberof DatasetsApiGetEntityDatasets
|
|
20529
20693
|
*/
|
|
20530
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
20694
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
20531
20695
|
/**
|
|
20532
20696
|
*
|
|
20533
20697
|
* @type {boolean}
|
|
@@ -21553,6 +21717,62 @@ export declare interface DateValue {
|
|
|
21553
21717
|
value: string;
|
|
21554
21718
|
}
|
|
21555
21719
|
|
|
21720
|
+
/**
|
|
21721
|
+
* A dataset fact.
|
|
21722
|
+
* @export
|
|
21723
|
+
* @interface DeclarativeAggregatedFact
|
|
21724
|
+
*/
|
|
21725
|
+
export declare interface DeclarativeAggregatedFact {
|
|
21726
|
+
/**
|
|
21727
|
+
* Fact ID.
|
|
21728
|
+
* @type {string}
|
|
21729
|
+
* @memberof DeclarativeAggregatedFact
|
|
21730
|
+
*/
|
|
21731
|
+
id: string;
|
|
21732
|
+
/**
|
|
21733
|
+
* Fact description.
|
|
21734
|
+
* @type {string}
|
|
21735
|
+
* @memberof DeclarativeAggregatedFact
|
|
21736
|
+
*/
|
|
21737
|
+
description?: string;
|
|
21738
|
+
/**
|
|
21739
|
+
* A name of the source column in the table.
|
|
21740
|
+
* @type {string}
|
|
21741
|
+
* @memberof DeclarativeAggregatedFact
|
|
21742
|
+
*/
|
|
21743
|
+
sourceColumn: string;
|
|
21744
|
+
/**
|
|
21745
|
+
* A type of the source column
|
|
21746
|
+
* @type {string}
|
|
21747
|
+
* @memberof DeclarativeAggregatedFact
|
|
21748
|
+
*/
|
|
21749
|
+
sourceColumnDataType?: DeclarativeAggregatedFactSourceColumnDataTypeEnum;
|
|
21750
|
+
/**
|
|
21751
|
+
* A list of tags.
|
|
21752
|
+
* @type {Array<string>}
|
|
21753
|
+
* @memberof DeclarativeAggregatedFact
|
|
21754
|
+
*/
|
|
21755
|
+
tags?: Array<string>;
|
|
21756
|
+
/**
|
|
21757
|
+
*
|
|
21758
|
+
* @type {DeclarativeSourceFactReference}
|
|
21759
|
+
* @memberof DeclarativeAggregatedFact
|
|
21760
|
+
*/
|
|
21761
|
+
sourceFactReference: DeclarativeSourceFactReference;
|
|
21762
|
+
}
|
|
21763
|
+
|
|
21764
|
+
export declare const DeclarativeAggregatedFactSourceColumnDataTypeEnum: {
|
|
21765
|
+
readonly INT: "INT";
|
|
21766
|
+
readonly STRING: "STRING";
|
|
21767
|
+
readonly DATE: "DATE";
|
|
21768
|
+
readonly NUMERIC: "NUMERIC";
|
|
21769
|
+
readonly TIMESTAMP: "TIMESTAMP";
|
|
21770
|
+
readonly TIMESTAMP_TZ: "TIMESTAMP_TZ";
|
|
21771
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
21772
|
+
};
|
|
21773
|
+
|
|
21774
|
+
export declare type DeclarativeAggregatedFactSourceColumnDataTypeEnum = typeof DeclarativeAggregatedFactSourceColumnDataTypeEnum[keyof typeof DeclarativeAggregatedFactSourceColumnDataTypeEnum];
|
|
21775
|
+
|
|
21556
21776
|
/**
|
|
21557
21777
|
*
|
|
21558
21778
|
* @export
|
|
@@ -22379,6 +22599,12 @@ export declare interface DeclarativeDataset {
|
|
|
22379
22599
|
* @memberof DeclarativeDataset
|
|
22380
22600
|
*/
|
|
22381
22601
|
facts?: Array<DeclarativeFact>;
|
|
22602
|
+
/**
|
|
22603
|
+
* An array of aggregated facts.
|
|
22604
|
+
* @type {Array<DeclarativeAggregatedFact>}
|
|
22605
|
+
* @memberof DeclarativeDataset
|
|
22606
|
+
*/
|
|
22607
|
+
aggregatedFacts?: Array<DeclarativeAggregatedFact>;
|
|
22382
22608
|
/**
|
|
22383
22609
|
* An array of references.
|
|
22384
22610
|
* @type {Array<DeclarativeReference>}
|
|
@@ -22915,12 +23141,6 @@ export declare interface DeclarativeFact {
|
|
|
22915
23141
|
* @memberof DeclarativeFact
|
|
22916
23142
|
*/
|
|
22917
23143
|
tags?: Array<string>;
|
|
22918
|
-
/**
|
|
22919
|
-
*
|
|
22920
|
-
* @type {DeclarativeSourceFactReference}
|
|
22921
|
-
* @memberof DeclarativeFact
|
|
22922
|
-
*/
|
|
22923
|
-
sourceFactReference?: DeclarativeSourceFactReference;
|
|
22924
23144
|
}
|
|
22925
23145
|
|
|
22926
23146
|
export declare const DeclarativeFactSourceColumnDataTypeEnum: {
|
|
@@ -25960,6 +26180,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
25960
26180
|
* @memberof EntitiesApi
|
|
25961
26181
|
*/
|
|
25962
26182
|
deleteEntityWorkspaces(requestParameters: EntitiesApiDeleteEntityWorkspacesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
26183
|
+
/**
|
|
26184
|
+
*
|
|
26185
|
+
* @param {EntitiesApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
26186
|
+
* @param {*} [options] Override http request option.
|
|
26187
|
+
* @throws {RequiredError}
|
|
26188
|
+
* @memberof EntitiesApi
|
|
26189
|
+
*/
|
|
26190
|
+
getAllEntitiesAggregatedFacts(requestParameters: EntitiesApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiAggregatedFactOutList, any>>;
|
|
25963
26191
|
/**
|
|
25964
26192
|
*
|
|
25965
26193
|
* @summary Get all Dashboards
|
|
@@ -26310,6 +26538,14 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
26310
26538
|
getDataSourceDrivers(options?: AxiosRequestConfig): Promise<AxiosResponse< {
|
|
26311
26539
|
[key: string]: string;
|
|
26312
26540
|
}, any>>;
|
|
26541
|
+
/**
|
|
26542
|
+
*
|
|
26543
|
+
* @param {EntitiesApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
26544
|
+
* @param {*} [options] Override http request option.
|
|
26545
|
+
* @throws {RequiredError}
|
|
26546
|
+
* @memberof EntitiesApi
|
|
26547
|
+
*/
|
|
26548
|
+
getEntityAggregatedFacts(requestParameters: EntitiesApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiAggregatedFactOutDocument, any>>;
|
|
26313
26549
|
/**
|
|
26314
26550
|
*
|
|
26315
26551
|
* @summary Get a Dashboard
|
|
@@ -27761,6 +27997,21 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27761
27997
|
* @throws {RequiredError}
|
|
27762
27998
|
*/
|
|
27763
27999
|
deleteEntityWorkspaces: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28000
|
+
/**
|
|
28001
|
+
*
|
|
28002
|
+
* @param {string} workspaceId
|
|
28003
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
28004
|
+
* @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\').
|
|
28005
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
28006
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
28007
|
+
* @param {number} [size] The size of the page to be returned
|
|
28008
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
28009
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28010
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28011
|
+
* @param {*} [options] Override http request option.
|
|
28012
|
+
* @throws {RequiredError}
|
|
28013
|
+
*/
|
|
28014
|
+
getAllEntitiesAggregatedFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
27764
28015
|
/**
|
|
27765
28016
|
*
|
|
27766
28017
|
* @summary Get all Dashboards
|
|
@@ -27923,7 +28174,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27923
28174
|
* @param {string} workspaceId
|
|
27924
28175
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
27925
28176
|
* @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\').
|
|
27926
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
28177
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
27927
28178
|
* @param {number} [page] Zero-based page index (0..N)
|
|
27928
28179
|
* @param {number} [size] The size of the page to be returned
|
|
27929
28180
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -27932,7 +28183,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27932
28183
|
* @param {*} [options] Override http request option.
|
|
27933
28184
|
* @throws {RequiredError}
|
|
27934
28185
|
*/
|
|
27935
|
-
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28186
|
+
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
27936
28187
|
/**
|
|
27937
28188
|
* Space of the shared interest
|
|
27938
28189
|
* @summary Get Entitlements
|
|
@@ -27979,7 +28230,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27979
28230
|
* @param {string} workspaceId
|
|
27980
28231
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
27981
28232
|
* @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\').
|
|
27982
|
-
* @param {Array<'datasets' | '
|
|
28233
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
27983
28234
|
* @param {number} [page] Zero-based page index (0..N)
|
|
27984
28235
|
* @param {number} [size] The size of the page to be returned
|
|
27985
28236
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -27988,7 +28239,7 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
27988
28239
|
* @param {*} [options] Override http request option.
|
|
27989
28240
|
* @throws {RequiredError}
|
|
27990
28241
|
*/
|
|
27991
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
28242
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
27992
28243
|
/**
|
|
27993
28244
|
*
|
|
27994
28245
|
* @summary Get all Context Filters
|
|
@@ -28293,6 +28544,18 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28293
28544
|
* @throws {RequiredError}
|
|
28294
28545
|
*/
|
|
28295
28546
|
getDataSourceDrivers: (options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28547
|
+
/**
|
|
28548
|
+
*
|
|
28549
|
+
* @param {string} workspaceId
|
|
28550
|
+
* @param {string} objectId
|
|
28551
|
+
* @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\').
|
|
28552
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
28553
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28554
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28555
|
+
* @param {*} [options] Override http request option.
|
|
28556
|
+
* @throws {RequiredError}
|
|
28557
|
+
*/
|
|
28558
|
+
getEntityAggregatedFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28296
28559
|
/**
|
|
28297
28560
|
*
|
|
28298
28561
|
* @summary Get a Dashboard
|
|
@@ -28433,13 +28696,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28433
28696
|
* @param {string} workspaceId
|
|
28434
28697
|
* @param {string} objectId
|
|
28435
28698
|
* @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\').
|
|
28436
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
28699
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
28437
28700
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28438
28701
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28439
28702
|
* @param {*} [options] Override http request option.
|
|
28440
28703
|
* @throws {RequiredError}
|
|
28441
28704
|
*/
|
|
28442
|
-
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28705
|
+
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28443
28706
|
/**
|
|
28444
28707
|
* Space of the shared interest
|
|
28445
28708
|
* @summary Get Entitlement
|
|
@@ -28477,13 +28740,13 @@ export declare const EntitiesApiAxiosParamCreator: (configuration?: MetadataConf
|
|
|
28477
28740
|
* @param {string} workspaceId
|
|
28478
28741
|
* @param {string} objectId
|
|
28479
28742
|
* @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\').
|
|
28480
|
-
* @param {Array<'datasets' | '
|
|
28743
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
28481
28744
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
28482
28745
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
28483
28746
|
* @param {*} [options] Override http request option.
|
|
28484
28747
|
* @throws {RequiredError}
|
|
28485
28748
|
*/
|
|
28486
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
28749
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
28487
28750
|
/**
|
|
28488
28751
|
*
|
|
28489
28752
|
* @summary Get a Context Filter
|
|
@@ -31209,6 +31472,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
31209
31472
|
* @throws {RequiredError}
|
|
31210
31473
|
*/
|
|
31211
31474
|
deleteEntityWorkspaces(requestParameters: EntitiesApiDeleteEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
31475
|
+
/**
|
|
31476
|
+
*
|
|
31477
|
+
* @param {EntitiesApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
31478
|
+
* @param {*} [options] Override http request option.
|
|
31479
|
+
* @throws {RequiredError}
|
|
31480
|
+
*/
|
|
31481
|
+
getAllEntitiesAggregatedFacts(requestParameters: EntitiesApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
31212
31482
|
/**
|
|
31213
31483
|
*
|
|
31214
31484
|
* @summary Get all Dashboards
|
|
@@ -31520,6 +31790,13 @@ export declare const EntitiesApiFactory: (configuration?: MetadataConfiguration,
|
|
|
31520
31790
|
getDataSourceDrivers(options?: AxiosRequestConfig): AxiosPromise<{
|
|
31521
31791
|
[key: string]: string;
|
|
31522
31792
|
}>;
|
|
31793
|
+
/**
|
|
31794
|
+
*
|
|
31795
|
+
* @param {EntitiesApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
31796
|
+
* @param {*} [options] Override http request option.
|
|
31797
|
+
* @throws {RequiredError}
|
|
31798
|
+
*/
|
|
31799
|
+
getEntityAggregatedFacts(requestParameters: EntitiesApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
31523
31800
|
/**
|
|
31524
31801
|
*
|
|
31525
31802
|
* @summary Get a Dashboard
|
|
@@ -32872,6 +33149,21 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
32872
33149
|
* @throws {RequiredError}
|
|
32873
33150
|
*/
|
|
32874
33151
|
deleteEntityWorkspaces(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
33152
|
+
/**
|
|
33153
|
+
*
|
|
33154
|
+
* @param {string} workspaceId
|
|
33155
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
33156
|
+
* @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\').
|
|
33157
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
33158
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
33159
|
+
* @param {number} [size] The size of the page to be returned
|
|
33160
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
33161
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33162
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33163
|
+
* @param {*} [options] Override http request option.
|
|
33164
|
+
* @throws {RequiredError}
|
|
33165
|
+
*/
|
|
33166
|
+
getAllEntitiesAggregatedFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutList>>;
|
|
32875
33167
|
/**
|
|
32876
33168
|
*
|
|
32877
33169
|
* @summary Get all Dashboards
|
|
@@ -33034,7 +33326,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33034
33326
|
* @param {string} workspaceId
|
|
33035
33327
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
33036
33328
|
* @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\').
|
|
33037
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
33329
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
33038
33330
|
* @param {number} [page] Zero-based page index (0..N)
|
|
33039
33331
|
* @param {number} [size] The size of the page to be returned
|
|
33040
33332
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -33043,7 +33335,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33043
33335
|
* @param {*} [options] Override http request option.
|
|
33044
33336
|
* @throws {RequiredError}
|
|
33045
33337
|
*/
|
|
33046
|
-
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
33338
|
+
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
33047
33339
|
/**
|
|
33048
33340
|
* Space of the shared interest
|
|
33049
33341
|
* @summary Get Entitlements
|
|
@@ -33090,7 +33382,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33090
33382
|
* @param {string} workspaceId
|
|
33091
33383
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
33092
33384
|
* @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\').
|
|
33093
|
-
* @param {Array<'datasets' | '
|
|
33385
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
33094
33386
|
* @param {number} [page] Zero-based page index (0..N)
|
|
33095
33387
|
* @param {number} [size] The size of the page to be returned
|
|
33096
33388
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -33099,7 +33391,7 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33099
33391
|
* @param {*} [options] Override http request option.
|
|
33100
33392
|
* @throws {RequiredError}
|
|
33101
33393
|
*/
|
|
33102
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
33394
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
33103
33395
|
/**
|
|
33104
33396
|
*
|
|
33105
33397
|
* @summary Get all Context Filters
|
|
@@ -33406,6 +33698,18 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33406
33698
|
getDataSourceDrivers(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
33407
33699
|
[key: string]: string;
|
|
33408
33700
|
}>>;
|
|
33701
|
+
/**
|
|
33702
|
+
*
|
|
33703
|
+
* @param {string} workspaceId
|
|
33704
|
+
* @param {string} objectId
|
|
33705
|
+
* @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\').
|
|
33706
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
33707
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33708
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33709
|
+
* @param {*} [options] Override http request option.
|
|
33710
|
+
* @throws {RequiredError}
|
|
33711
|
+
*/
|
|
33712
|
+
getEntityAggregatedFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutDocument>>;
|
|
33409
33713
|
/**
|
|
33410
33714
|
*
|
|
33411
33715
|
* @summary Get a Dashboard
|
|
@@ -33546,13 +33850,13 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33546
33850
|
* @param {string} workspaceId
|
|
33547
33851
|
* @param {string} objectId
|
|
33548
33852
|
* @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\').
|
|
33549
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
33853
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
33550
33854
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33551
33855
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33552
33856
|
* @param {*} [options] Override http request option.
|
|
33553
33857
|
* @throws {RequiredError}
|
|
33554
33858
|
*/
|
|
33555
|
-
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
33859
|
+
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
33556
33860
|
/**
|
|
33557
33861
|
* Space of the shared interest
|
|
33558
33862
|
* @summary Get Entitlement
|
|
@@ -33590,13 +33894,13 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
33590
33894
|
* @param {string} workspaceId
|
|
33591
33895
|
* @param {string} objectId
|
|
33592
33896
|
* @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\').
|
|
33593
|
-
* @param {Array<'datasets' | '
|
|
33897
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
33594
33898
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
33595
33899
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
33596
33900
|
* @param {*} [options] Override http request option.
|
|
33597
33901
|
* @throws {RequiredError}
|
|
33598
33902
|
*/
|
|
33599
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
33903
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
33600
33904
|
/**
|
|
33601
33905
|
*
|
|
33602
33906
|
* @summary Get a Context Filter
|
|
@@ -34496,6 +34800,68 @@ export declare const EntitiesApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
34496
34800
|
updateEntityWorkspaces(id: string, jsonApiWorkspaceInDocument: JsonApiWorkspaceInDocument, filter?: string, include?: Array<"workspaces" | "parent" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceOutDocument>>;
|
|
34497
34801
|
};
|
|
34498
34802
|
|
|
34803
|
+
/**
|
|
34804
|
+
* Request parameters for getAllEntitiesAggregatedFacts operation in EntitiesApi.
|
|
34805
|
+
* @export
|
|
34806
|
+
* @interface EntitiesApiGetAllEntitiesAggregatedFactsRequest
|
|
34807
|
+
*/
|
|
34808
|
+
export declare interface EntitiesApiGetAllEntitiesAggregatedFactsRequest {
|
|
34809
|
+
/**
|
|
34810
|
+
*
|
|
34811
|
+
* @type {string}
|
|
34812
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34813
|
+
*/
|
|
34814
|
+
readonly workspaceId: string;
|
|
34815
|
+
/**
|
|
34816
|
+
*
|
|
34817
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
34818
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34819
|
+
*/
|
|
34820
|
+
readonly origin?: "ALL" | "PARENTS" | "NATIVE";
|
|
34821
|
+
/**
|
|
34822
|
+
* 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\').
|
|
34823
|
+
* @type {string}
|
|
34824
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34825
|
+
*/
|
|
34826
|
+
readonly filter?: string;
|
|
34827
|
+
/**
|
|
34828
|
+
* 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.
|
|
34829
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
34830
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34831
|
+
*/
|
|
34832
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
34833
|
+
/**
|
|
34834
|
+
* Zero-based page index (0..N)
|
|
34835
|
+
* @type {number}
|
|
34836
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34837
|
+
*/
|
|
34838
|
+
readonly page?: number;
|
|
34839
|
+
/**
|
|
34840
|
+
* The size of the page to be returned
|
|
34841
|
+
* @type {number}
|
|
34842
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34843
|
+
*/
|
|
34844
|
+
readonly size?: number;
|
|
34845
|
+
/**
|
|
34846
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
34847
|
+
* @type {Array<string>}
|
|
34848
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34849
|
+
*/
|
|
34850
|
+
readonly sort?: Array<string>;
|
|
34851
|
+
/**
|
|
34852
|
+
*
|
|
34853
|
+
* @type {boolean}
|
|
34854
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34855
|
+
*/
|
|
34856
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
34857
|
+
/**
|
|
34858
|
+
* Include Meta objects.
|
|
34859
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
34860
|
+
* @memberof EntitiesApiGetAllEntitiesAggregatedFacts
|
|
34861
|
+
*/
|
|
34862
|
+
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
34863
|
+
}
|
|
34864
|
+
|
|
34499
34865
|
/**
|
|
34500
34866
|
* Request parameters for getAllEntitiesAnalyticalDashboards operation in EntitiesApi.
|
|
34501
34867
|
* @export
|
|
@@ -35008,10 +35374,10 @@ export declare interface EntitiesApiGetAllEntitiesDatasetsRequest {
|
|
|
35008
35374
|
readonly filter?: string;
|
|
35009
35375
|
/**
|
|
35010
35376
|
* 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.
|
|
35011
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
35377
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
35012
35378
|
* @memberof EntitiesApiGetAllEntitiesDatasets
|
|
35013
35379
|
*/
|
|
35014
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
35380
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
35015
35381
|
/**
|
|
35016
35382
|
* Zero-based page index (0..N)
|
|
35017
35383
|
* @type {number}
|
|
@@ -35284,10 +35650,10 @@ export declare interface EntitiesApiGetAllEntitiesFactsRequest {
|
|
|
35284
35650
|
readonly filter?: string;
|
|
35285
35651
|
/**
|
|
35286
35652
|
* 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.
|
|
35287
|
-
* @type {Array<'datasets' | '
|
|
35653
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
35288
35654
|
* @memberof EntitiesApiGetAllEntitiesFacts
|
|
35289
35655
|
*/
|
|
35290
|
-
readonly include?: Array<"datasets" | "
|
|
35656
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
35291
35657
|
/**
|
|
35292
35658
|
* Zero-based page index (0..N)
|
|
35293
35659
|
* @type {number}
|
|
@@ -36352,6 +36718,50 @@ export declare interface EntitiesApiGetAllEntitiesWorkspacesRequest {
|
|
|
36352
36718
|
readonly metaInclude?: Array<"config" | "permissions" | "hierarchy" | "dataModelDatasets" | "page" | "all" | "ALL">;
|
|
36353
36719
|
}
|
|
36354
36720
|
|
|
36721
|
+
/**
|
|
36722
|
+
* Request parameters for getEntityAggregatedFacts operation in EntitiesApi.
|
|
36723
|
+
* @export
|
|
36724
|
+
* @interface EntitiesApiGetEntityAggregatedFactsRequest
|
|
36725
|
+
*/
|
|
36726
|
+
export declare interface EntitiesApiGetEntityAggregatedFactsRequest {
|
|
36727
|
+
/**
|
|
36728
|
+
*
|
|
36729
|
+
* @type {string}
|
|
36730
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
36731
|
+
*/
|
|
36732
|
+
readonly workspaceId: string;
|
|
36733
|
+
/**
|
|
36734
|
+
*
|
|
36735
|
+
* @type {string}
|
|
36736
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
36737
|
+
*/
|
|
36738
|
+
readonly objectId: string;
|
|
36739
|
+
/**
|
|
36740
|
+
* 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\').
|
|
36741
|
+
* @type {string}
|
|
36742
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
36743
|
+
*/
|
|
36744
|
+
readonly filter?: string;
|
|
36745
|
+
/**
|
|
36746
|
+
* 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.
|
|
36747
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
36748
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
36749
|
+
*/
|
|
36750
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
36751
|
+
/**
|
|
36752
|
+
*
|
|
36753
|
+
* @type {boolean}
|
|
36754
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
36755
|
+
*/
|
|
36756
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
36757
|
+
/**
|
|
36758
|
+
* Include Meta objects.
|
|
36759
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
36760
|
+
* @memberof EntitiesApiGetEntityAggregatedFacts
|
|
36761
|
+
*/
|
|
36762
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
36763
|
+
}
|
|
36764
|
+
|
|
36355
36765
|
/**
|
|
36356
36766
|
* Request parameters for getEntityAnalyticalDashboards operation in EntitiesApi.
|
|
36357
36767
|
* @export
|
|
@@ -36722,10 +37132,10 @@ export declare interface EntitiesApiGetEntityDatasetsRequest {
|
|
|
36722
37132
|
readonly filter?: string;
|
|
36723
37133
|
/**
|
|
36724
37134
|
* 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.
|
|
36725
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
37135
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
36726
37136
|
* @memberof EntitiesApiGetEntityDatasets
|
|
36727
37137
|
*/
|
|
36728
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
37138
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
36729
37139
|
/**
|
|
36730
37140
|
*
|
|
36731
37141
|
* @type {boolean}
|
|
@@ -36902,10 +37312,10 @@ export declare interface EntitiesApiGetEntityFactsRequest {
|
|
|
36902
37312
|
readonly filter?: string;
|
|
36903
37313
|
/**
|
|
36904
37314
|
* 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.
|
|
36905
|
-
* @type {Array<'datasets' | '
|
|
37315
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
36906
37316
|
* @memberof EntitiesApiGetEntityFacts
|
|
36907
37317
|
*/
|
|
36908
|
-
readonly include?: Array<"datasets" | "
|
|
37318
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
36909
37319
|
/**
|
|
36910
37320
|
*
|
|
36911
37321
|
* @type {boolean}
|
|
@@ -38147,6 +38557,14 @@ export declare interface EntitiesApiInterface {
|
|
|
38147
38557
|
* @memberof EntitiesApiInterface
|
|
38148
38558
|
*/
|
|
38149
38559
|
deleteEntityWorkspaces(requestParameters: EntitiesApiDeleteEntityWorkspacesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
38560
|
+
/**
|
|
38561
|
+
*
|
|
38562
|
+
* @param {EntitiesApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
38563
|
+
* @param {*} [options] Override http request option.
|
|
38564
|
+
* @throws {RequiredError}
|
|
38565
|
+
* @memberof EntitiesApiInterface
|
|
38566
|
+
*/
|
|
38567
|
+
getAllEntitiesAggregatedFacts(requestParameters: EntitiesApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
38150
38568
|
/**
|
|
38151
38569
|
*
|
|
38152
38570
|
* @summary Get all Dashboards
|
|
@@ -38497,6 +38915,14 @@ export declare interface EntitiesApiInterface {
|
|
|
38497
38915
|
getDataSourceDrivers(options?: AxiosRequestConfig): AxiosPromise<{
|
|
38498
38916
|
[key: string]: string;
|
|
38499
38917
|
}>;
|
|
38918
|
+
/**
|
|
38919
|
+
*
|
|
38920
|
+
* @param {EntitiesApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
38921
|
+
* @param {*} [options] Override http request option.
|
|
38922
|
+
* @throws {RequiredError}
|
|
38923
|
+
* @memberof EntitiesApiInterface
|
|
38924
|
+
*/
|
|
38925
|
+
getEntityAggregatedFacts(requestParameters: EntitiesApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
38500
38926
|
/**
|
|
38501
38927
|
*
|
|
38502
38928
|
* @summary Get a Dashboard
|
|
@@ -43567,6 +43993,7 @@ export declare const ExportIdentifierRefIdentifierTypeEnum: {
|
|
|
43567
43993
|
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
43568
43994
|
readonly DATASET: "dataset";
|
|
43569
43995
|
readonly FACT: "fact";
|
|
43996
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
43570
43997
|
readonly LABEL: "label";
|
|
43571
43998
|
readonly METRIC: "metric";
|
|
43572
43999
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
@@ -44624,6 +45051,460 @@ export declare const ExportTabularExportRequestFormatEnum: {
|
|
|
44624
45051
|
|
|
44625
45052
|
export declare type ExportTabularExportRequestFormatEnum = typeof ExportTabularExportRequestFormatEnum[keyof typeof ExportTabularExportRequestFormatEnum];
|
|
44626
45053
|
|
|
45054
|
+
/**
|
|
45055
|
+
* ExportTemplatesApi - object-oriented interface
|
|
45056
|
+
* @export
|
|
45057
|
+
* @class ExportTemplatesApi
|
|
45058
|
+
* @extends {BaseAPI}
|
|
45059
|
+
*/
|
|
45060
|
+
export declare class ExportTemplatesApi extends MetadataBaseApi implements ExportTemplatesApiInterface {
|
|
45061
|
+
/**
|
|
45062
|
+
*
|
|
45063
|
+
* @summary Post Export Template entities
|
|
45064
|
+
* @param {ExportTemplatesApiCreateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45065
|
+
* @param {*} [options] Override http request option.
|
|
45066
|
+
* @throws {RequiredError}
|
|
45067
|
+
* @memberof ExportTemplatesApi
|
|
45068
|
+
*/
|
|
45069
|
+
createEntityExportTemplates(requestParameters: ExportTemplatesApiCreateEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
45070
|
+
/**
|
|
45071
|
+
*
|
|
45072
|
+
* @summary Delete Export Template entity
|
|
45073
|
+
* @param {ExportTemplatesApiDeleteEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45074
|
+
* @param {*} [options] Override http request option.
|
|
45075
|
+
* @throws {RequiredError}
|
|
45076
|
+
* @memberof ExportTemplatesApi
|
|
45077
|
+
*/
|
|
45078
|
+
deleteEntityExportTemplates(requestParameters: ExportTemplatesApiDeleteEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
45079
|
+
/**
|
|
45080
|
+
*
|
|
45081
|
+
* @summary GET all Export Template entities
|
|
45082
|
+
* @param {ExportTemplatesApiGetAllEntitiesExportTemplatesRequest} requestParameters Request parameters.
|
|
45083
|
+
* @param {*} [options] Override http request option.
|
|
45084
|
+
* @throws {RequiredError}
|
|
45085
|
+
* @memberof ExportTemplatesApi
|
|
45086
|
+
*/
|
|
45087
|
+
getAllEntitiesExportTemplates(requestParameters?: ExportTemplatesApiGetAllEntitiesExportTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiExportTemplateOutList, any>>;
|
|
45088
|
+
/**
|
|
45089
|
+
*
|
|
45090
|
+
* @summary GET Export Template entity
|
|
45091
|
+
* @param {ExportTemplatesApiGetEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45092
|
+
* @param {*} [options] Override http request option.
|
|
45093
|
+
* @throws {RequiredError}
|
|
45094
|
+
* @memberof ExportTemplatesApi
|
|
45095
|
+
*/
|
|
45096
|
+
getEntityExportTemplates(requestParameters: ExportTemplatesApiGetEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
45097
|
+
/**
|
|
45098
|
+
*
|
|
45099
|
+
* @summary Patch Export Template entity
|
|
45100
|
+
* @param {ExportTemplatesApiPatchEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45101
|
+
* @param {*} [options] Override http request option.
|
|
45102
|
+
* @throws {RequiredError}
|
|
45103
|
+
* @memberof ExportTemplatesApi
|
|
45104
|
+
*/
|
|
45105
|
+
patchEntityExportTemplates(requestParameters: ExportTemplatesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
45106
|
+
/**
|
|
45107
|
+
*
|
|
45108
|
+
* @summary PUT Export Template entity
|
|
45109
|
+
* @param {ExportTemplatesApiUpdateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45110
|
+
* @param {*} [options] Override http request option.
|
|
45111
|
+
* @throws {RequiredError}
|
|
45112
|
+
* @memberof ExportTemplatesApi
|
|
45113
|
+
*/
|
|
45114
|
+
updateEntityExportTemplates(requestParameters: ExportTemplatesApiUpdateEntityExportTemplatesRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiExportTemplateOutDocument, any>>;
|
|
45115
|
+
}
|
|
45116
|
+
|
|
45117
|
+
/**
|
|
45118
|
+
* ExportTemplatesApi - axios parameter creator
|
|
45119
|
+
* @export
|
|
45120
|
+
*/
|
|
45121
|
+
export declare const ExportTemplatesApiAxiosParamCreator: (configuration?: MetadataConfiguration) => {
|
|
45122
|
+
/**
|
|
45123
|
+
*
|
|
45124
|
+
* @summary Post Export Template entities
|
|
45125
|
+
* @param {JsonApiExportTemplatePostOptionalIdDocument} jsonApiExportTemplatePostOptionalIdDocument
|
|
45126
|
+
* @param {*} [options] Override http request option.
|
|
45127
|
+
* @throws {RequiredError}
|
|
45128
|
+
*/
|
|
45129
|
+
createEntityExportTemplates: (jsonApiExportTemplatePostOptionalIdDocument: JsonApiExportTemplatePostOptionalIdDocument, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
45130
|
+
/**
|
|
45131
|
+
*
|
|
45132
|
+
* @summary Delete Export Template entity
|
|
45133
|
+
* @param {string} id
|
|
45134
|
+
* @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\').
|
|
45135
|
+
* @param {*} [options] Override http request option.
|
|
45136
|
+
* @throws {RequiredError}
|
|
45137
|
+
*/
|
|
45138
|
+
deleteEntityExportTemplates: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
45139
|
+
/**
|
|
45140
|
+
*
|
|
45141
|
+
* @summary GET all Export Template entities
|
|
45142
|
+
* @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\').
|
|
45143
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
45144
|
+
* @param {number} [size] The size of the page to be returned
|
|
45145
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
45146
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
45147
|
+
* @param {*} [options] Override http request option.
|
|
45148
|
+
* @throws {RequiredError}
|
|
45149
|
+
*/
|
|
45150
|
+
getAllEntitiesExportTemplates: (filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
45151
|
+
/**
|
|
45152
|
+
*
|
|
45153
|
+
* @summary GET Export Template entity
|
|
45154
|
+
* @param {string} id
|
|
45155
|
+
* @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\').
|
|
45156
|
+
* @param {*} [options] Override http request option.
|
|
45157
|
+
* @throws {RequiredError}
|
|
45158
|
+
*/
|
|
45159
|
+
getEntityExportTemplates: (id: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
45160
|
+
/**
|
|
45161
|
+
*
|
|
45162
|
+
* @summary Patch Export Template entity
|
|
45163
|
+
* @param {string} id
|
|
45164
|
+
* @param {JsonApiExportTemplatePatchDocument} jsonApiExportTemplatePatchDocument
|
|
45165
|
+
* @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\').
|
|
45166
|
+
* @param {*} [options] Override http request option.
|
|
45167
|
+
* @throws {RequiredError}
|
|
45168
|
+
*/
|
|
45169
|
+
patchEntityExportTemplates: (id: string, jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
45170
|
+
/**
|
|
45171
|
+
*
|
|
45172
|
+
* @summary PUT Export Template entity
|
|
45173
|
+
* @param {string} id
|
|
45174
|
+
* @param {JsonApiExportTemplateInDocument} jsonApiExportTemplateInDocument
|
|
45175
|
+
* @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\').
|
|
45176
|
+
* @param {*} [options] Override http request option.
|
|
45177
|
+
* @throws {RequiredError}
|
|
45178
|
+
*/
|
|
45179
|
+
updateEntityExportTemplates: (id: string, jsonApiExportTemplateInDocument: JsonApiExportTemplateInDocument, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
45180
|
+
};
|
|
45181
|
+
|
|
45182
|
+
/**
|
|
45183
|
+
* Request parameters for createEntityExportTemplates operation in ExportTemplatesApi.
|
|
45184
|
+
* @export
|
|
45185
|
+
* @interface ExportTemplatesApiCreateEntityExportTemplatesRequest
|
|
45186
|
+
*/
|
|
45187
|
+
export declare interface ExportTemplatesApiCreateEntityExportTemplatesRequest {
|
|
45188
|
+
/**
|
|
45189
|
+
*
|
|
45190
|
+
* @type {JsonApiExportTemplatePostOptionalIdDocument}
|
|
45191
|
+
* @memberof ExportTemplatesApiCreateEntityExportTemplates
|
|
45192
|
+
*/
|
|
45193
|
+
readonly jsonApiExportTemplatePostOptionalIdDocument: JsonApiExportTemplatePostOptionalIdDocument;
|
|
45194
|
+
}
|
|
45195
|
+
|
|
45196
|
+
/**
|
|
45197
|
+
* Request parameters for deleteEntityExportTemplates operation in ExportTemplatesApi.
|
|
45198
|
+
* @export
|
|
45199
|
+
* @interface ExportTemplatesApiDeleteEntityExportTemplatesRequest
|
|
45200
|
+
*/
|
|
45201
|
+
export declare interface ExportTemplatesApiDeleteEntityExportTemplatesRequest {
|
|
45202
|
+
/**
|
|
45203
|
+
*
|
|
45204
|
+
* @type {string}
|
|
45205
|
+
* @memberof ExportTemplatesApiDeleteEntityExportTemplates
|
|
45206
|
+
*/
|
|
45207
|
+
readonly id: string;
|
|
45208
|
+
/**
|
|
45209
|
+
* 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\').
|
|
45210
|
+
* @type {string}
|
|
45211
|
+
* @memberof ExportTemplatesApiDeleteEntityExportTemplates
|
|
45212
|
+
*/
|
|
45213
|
+
readonly filter?: string;
|
|
45214
|
+
}
|
|
45215
|
+
|
|
45216
|
+
/**
|
|
45217
|
+
* ExportTemplatesApi - factory interface
|
|
45218
|
+
* @export
|
|
45219
|
+
*/
|
|
45220
|
+
export declare const ExportTemplatesApiFactory: (configuration?: MetadataConfiguration, basePath?: string, axios?: AxiosInstance) => {
|
|
45221
|
+
/**
|
|
45222
|
+
*
|
|
45223
|
+
* @summary Post Export Template entities
|
|
45224
|
+
* @param {ExportTemplatesApiCreateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45225
|
+
* @param {*} [options] Override http request option.
|
|
45226
|
+
* @throws {RequiredError}
|
|
45227
|
+
*/
|
|
45228
|
+
createEntityExportTemplates(requestParameters: ExportTemplatesApiCreateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45229
|
+
/**
|
|
45230
|
+
*
|
|
45231
|
+
* @summary Delete Export Template entity
|
|
45232
|
+
* @param {ExportTemplatesApiDeleteEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45233
|
+
* @param {*} [options] Override http request option.
|
|
45234
|
+
* @throws {RequiredError}
|
|
45235
|
+
*/
|
|
45236
|
+
deleteEntityExportTemplates(requestParameters: ExportTemplatesApiDeleteEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
45237
|
+
/**
|
|
45238
|
+
*
|
|
45239
|
+
* @summary GET all Export Template entities
|
|
45240
|
+
* @param {ExportTemplatesApiGetAllEntitiesExportTemplatesRequest} requestParameters Request parameters.
|
|
45241
|
+
* @param {*} [options] Override http request option.
|
|
45242
|
+
* @throws {RequiredError}
|
|
45243
|
+
*/
|
|
45244
|
+
getAllEntitiesExportTemplates(requestParameters: ExportTemplatesApiGetAllEntitiesExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutList>;
|
|
45245
|
+
/**
|
|
45246
|
+
*
|
|
45247
|
+
* @summary GET Export Template entity
|
|
45248
|
+
* @param {ExportTemplatesApiGetEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45249
|
+
* @param {*} [options] Override http request option.
|
|
45250
|
+
* @throws {RequiredError}
|
|
45251
|
+
*/
|
|
45252
|
+
getEntityExportTemplates(requestParameters: ExportTemplatesApiGetEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45253
|
+
/**
|
|
45254
|
+
*
|
|
45255
|
+
* @summary Patch Export Template entity
|
|
45256
|
+
* @param {ExportTemplatesApiPatchEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45257
|
+
* @param {*} [options] Override http request option.
|
|
45258
|
+
* @throws {RequiredError}
|
|
45259
|
+
*/
|
|
45260
|
+
patchEntityExportTemplates(requestParameters: ExportTemplatesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45261
|
+
/**
|
|
45262
|
+
*
|
|
45263
|
+
* @summary PUT Export Template entity
|
|
45264
|
+
* @param {ExportTemplatesApiUpdateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45265
|
+
* @param {*} [options] Override http request option.
|
|
45266
|
+
* @throws {RequiredError}
|
|
45267
|
+
*/
|
|
45268
|
+
updateEntityExportTemplates(requestParameters: ExportTemplatesApiUpdateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45269
|
+
};
|
|
45270
|
+
|
|
45271
|
+
/**
|
|
45272
|
+
* ExportTemplatesApi - functional programming interface
|
|
45273
|
+
* @export
|
|
45274
|
+
*/
|
|
45275
|
+
export declare const ExportTemplatesApiFp: (configuration?: MetadataConfiguration) => {
|
|
45276
|
+
/**
|
|
45277
|
+
*
|
|
45278
|
+
* @summary Post Export Template entities
|
|
45279
|
+
* @param {JsonApiExportTemplatePostOptionalIdDocument} jsonApiExportTemplatePostOptionalIdDocument
|
|
45280
|
+
* @param {*} [options] Override http request option.
|
|
45281
|
+
* @throws {RequiredError}
|
|
45282
|
+
*/
|
|
45283
|
+
createEntityExportTemplates(jsonApiExportTemplatePostOptionalIdDocument: JsonApiExportTemplatePostOptionalIdDocument, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
45284
|
+
/**
|
|
45285
|
+
*
|
|
45286
|
+
* @summary Delete Export Template entity
|
|
45287
|
+
* @param {string} id
|
|
45288
|
+
* @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\').
|
|
45289
|
+
* @param {*} [options] Override http request option.
|
|
45290
|
+
* @throws {RequiredError}
|
|
45291
|
+
*/
|
|
45292
|
+
deleteEntityExportTemplates(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
45293
|
+
/**
|
|
45294
|
+
*
|
|
45295
|
+
* @summary GET all Export Template entities
|
|
45296
|
+
* @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\').
|
|
45297
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
45298
|
+
* @param {number} [size] The size of the page to be returned
|
|
45299
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
45300
|
+
* @param {Array<'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
45301
|
+
* @param {*} [options] Override http request option.
|
|
45302
|
+
* @throws {RequiredError}
|
|
45303
|
+
*/
|
|
45304
|
+
getAllEntitiesExportTemplates(filter?: string, page?: number, size?: number, sort?: Array<string>, metaInclude?: Array<"page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutList>>;
|
|
45305
|
+
/**
|
|
45306
|
+
*
|
|
45307
|
+
* @summary GET Export Template entity
|
|
45308
|
+
* @param {string} id
|
|
45309
|
+
* @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\').
|
|
45310
|
+
* @param {*} [options] Override http request option.
|
|
45311
|
+
* @throws {RequiredError}
|
|
45312
|
+
*/
|
|
45313
|
+
getEntityExportTemplates(id: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
45314
|
+
/**
|
|
45315
|
+
*
|
|
45316
|
+
* @summary Patch Export Template entity
|
|
45317
|
+
* @param {string} id
|
|
45318
|
+
* @param {JsonApiExportTemplatePatchDocument} jsonApiExportTemplatePatchDocument
|
|
45319
|
+
* @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\').
|
|
45320
|
+
* @param {*} [options] Override http request option.
|
|
45321
|
+
* @throws {RequiredError}
|
|
45322
|
+
*/
|
|
45323
|
+
patchEntityExportTemplates(id: string, jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
45324
|
+
/**
|
|
45325
|
+
*
|
|
45326
|
+
* @summary PUT Export Template entity
|
|
45327
|
+
* @param {string} id
|
|
45328
|
+
* @param {JsonApiExportTemplateInDocument} jsonApiExportTemplateInDocument
|
|
45329
|
+
* @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\').
|
|
45330
|
+
* @param {*} [options] Override http request option.
|
|
45331
|
+
* @throws {RequiredError}
|
|
45332
|
+
*/
|
|
45333
|
+
updateEntityExportTemplates(id: string, jsonApiExportTemplateInDocument: JsonApiExportTemplateInDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiExportTemplateOutDocument>>;
|
|
45334
|
+
};
|
|
45335
|
+
|
|
45336
|
+
/**
|
|
45337
|
+
* Request parameters for getAllEntitiesExportTemplates operation in ExportTemplatesApi.
|
|
45338
|
+
* @export
|
|
45339
|
+
* @interface ExportTemplatesApiGetAllEntitiesExportTemplatesRequest
|
|
45340
|
+
*/
|
|
45341
|
+
export declare interface ExportTemplatesApiGetAllEntitiesExportTemplatesRequest {
|
|
45342
|
+
/**
|
|
45343
|
+
* 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\').
|
|
45344
|
+
* @type {string}
|
|
45345
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
45346
|
+
*/
|
|
45347
|
+
readonly filter?: string;
|
|
45348
|
+
/**
|
|
45349
|
+
* Zero-based page index (0..N)
|
|
45350
|
+
* @type {number}
|
|
45351
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
45352
|
+
*/
|
|
45353
|
+
readonly page?: number;
|
|
45354
|
+
/**
|
|
45355
|
+
* The size of the page to be returned
|
|
45356
|
+
* @type {number}
|
|
45357
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
45358
|
+
*/
|
|
45359
|
+
readonly size?: number;
|
|
45360
|
+
/**
|
|
45361
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
45362
|
+
* @type {Array<string>}
|
|
45363
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
45364
|
+
*/
|
|
45365
|
+
readonly sort?: Array<string>;
|
|
45366
|
+
/**
|
|
45367
|
+
* Include Meta objects.
|
|
45368
|
+
* @type {Array<'page' | 'all' | 'ALL'>}
|
|
45369
|
+
* @memberof ExportTemplatesApiGetAllEntitiesExportTemplates
|
|
45370
|
+
*/
|
|
45371
|
+
readonly metaInclude?: Array<"page" | "all" | "ALL">;
|
|
45372
|
+
}
|
|
45373
|
+
|
|
45374
|
+
/**
|
|
45375
|
+
* Request parameters for getEntityExportTemplates operation in ExportTemplatesApi.
|
|
45376
|
+
* @export
|
|
45377
|
+
* @interface ExportTemplatesApiGetEntityExportTemplatesRequest
|
|
45378
|
+
*/
|
|
45379
|
+
export declare interface ExportTemplatesApiGetEntityExportTemplatesRequest {
|
|
45380
|
+
/**
|
|
45381
|
+
*
|
|
45382
|
+
* @type {string}
|
|
45383
|
+
* @memberof ExportTemplatesApiGetEntityExportTemplates
|
|
45384
|
+
*/
|
|
45385
|
+
readonly id: string;
|
|
45386
|
+
/**
|
|
45387
|
+
* 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\').
|
|
45388
|
+
* @type {string}
|
|
45389
|
+
* @memberof ExportTemplatesApiGetEntityExportTemplates
|
|
45390
|
+
*/
|
|
45391
|
+
readonly filter?: string;
|
|
45392
|
+
}
|
|
45393
|
+
|
|
45394
|
+
/**
|
|
45395
|
+
* ExportTemplatesApi - interface
|
|
45396
|
+
* @export
|
|
45397
|
+
* @interface ExportTemplatesApi
|
|
45398
|
+
*/
|
|
45399
|
+
export declare interface ExportTemplatesApiInterface {
|
|
45400
|
+
/**
|
|
45401
|
+
*
|
|
45402
|
+
* @summary Post Export Template entities
|
|
45403
|
+
* @param {ExportTemplatesApiCreateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45404
|
+
* @param {*} [options] Override http request option.
|
|
45405
|
+
* @throws {RequiredError}
|
|
45406
|
+
* @memberof ExportTemplatesApiInterface
|
|
45407
|
+
*/
|
|
45408
|
+
createEntityExportTemplates(requestParameters: ExportTemplatesApiCreateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45409
|
+
/**
|
|
45410
|
+
*
|
|
45411
|
+
* @summary Delete Export Template entity
|
|
45412
|
+
* @param {ExportTemplatesApiDeleteEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45413
|
+
* @param {*} [options] Override http request option.
|
|
45414
|
+
* @throws {RequiredError}
|
|
45415
|
+
* @memberof ExportTemplatesApiInterface
|
|
45416
|
+
*/
|
|
45417
|
+
deleteEntityExportTemplates(requestParameters: ExportTemplatesApiDeleteEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
45418
|
+
/**
|
|
45419
|
+
*
|
|
45420
|
+
* @summary GET all Export Template entities
|
|
45421
|
+
* @param {ExportTemplatesApiGetAllEntitiesExportTemplatesRequest} requestParameters Request parameters.
|
|
45422
|
+
* @param {*} [options] Override http request option.
|
|
45423
|
+
* @throws {RequiredError}
|
|
45424
|
+
* @memberof ExportTemplatesApiInterface
|
|
45425
|
+
*/
|
|
45426
|
+
getAllEntitiesExportTemplates(requestParameters: ExportTemplatesApiGetAllEntitiesExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutList>;
|
|
45427
|
+
/**
|
|
45428
|
+
*
|
|
45429
|
+
* @summary GET Export Template entity
|
|
45430
|
+
* @param {ExportTemplatesApiGetEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45431
|
+
* @param {*} [options] Override http request option.
|
|
45432
|
+
* @throws {RequiredError}
|
|
45433
|
+
* @memberof ExportTemplatesApiInterface
|
|
45434
|
+
*/
|
|
45435
|
+
getEntityExportTemplates(requestParameters: ExportTemplatesApiGetEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45436
|
+
/**
|
|
45437
|
+
*
|
|
45438
|
+
* @summary Patch Export Template entity
|
|
45439
|
+
* @param {ExportTemplatesApiPatchEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45440
|
+
* @param {*} [options] Override http request option.
|
|
45441
|
+
* @throws {RequiredError}
|
|
45442
|
+
* @memberof ExportTemplatesApiInterface
|
|
45443
|
+
*/
|
|
45444
|
+
patchEntityExportTemplates(requestParameters: ExportTemplatesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45445
|
+
/**
|
|
45446
|
+
*
|
|
45447
|
+
* @summary PUT Export Template entity
|
|
45448
|
+
* @param {ExportTemplatesApiUpdateEntityExportTemplatesRequest} requestParameters Request parameters.
|
|
45449
|
+
* @param {*} [options] Override http request option.
|
|
45450
|
+
* @throws {RequiredError}
|
|
45451
|
+
* @memberof ExportTemplatesApiInterface
|
|
45452
|
+
*/
|
|
45453
|
+
updateEntityExportTemplates(requestParameters: ExportTemplatesApiUpdateEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
45454
|
+
}
|
|
45455
|
+
|
|
45456
|
+
/**
|
|
45457
|
+
* Request parameters for patchEntityExportTemplates operation in ExportTemplatesApi.
|
|
45458
|
+
* @export
|
|
45459
|
+
* @interface ExportTemplatesApiPatchEntityExportTemplatesRequest
|
|
45460
|
+
*/
|
|
45461
|
+
export declare interface ExportTemplatesApiPatchEntityExportTemplatesRequest {
|
|
45462
|
+
/**
|
|
45463
|
+
*
|
|
45464
|
+
* @type {string}
|
|
45465
|
+
* @memberof ExportTemplatesApiPatchEntityExportTemplates
|
|
45466
|
+
*/
|
|
45467
|
+
readonly id: string;
|
|
45468
|
+
/**
|
|
45469
|
+
*
|
|
45470
|
+
* @type {JsonApiExportTemplatePatchDocument}
|
|
45471
|
+
* @memberof ExportTemplatesApiPatchEntityExportTemplates
|
|
45472
|
+
*/
|
|
45473
|
+
readonly jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument;
|
|
45474
|
+
/**
|
|
45475
|
+
* 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\').
|
|
45476
|
+
* @type {string}
|
|
45477
|
+
* @memberof ExportTemplatesApiPatchEntityExportTemplates
|
|
45478
|
+
*/
|
|
45479
|
+
readonly filter?: string;
|
|
45480
|
+
}
|
|
45481
|
+
|
|
45482
|
+
/**
|
|
45483
|
+
* Request parameters for updateEntityExportTemplates operation in ExportTemplatesApi.
|
|
45484
|
+
* @export
|
|
45485
|
+
* @interface ExportTemplatesApiUpdateEntityExportTemplatesRequest
|
|
45486
|
+
*/
|
|
45487
|
+
export declare interface ExportTemplatesApiUpdateEntityExportTemplatesRequest {
|
|
45488
|
+
/**
|
|
45489
|
+
*
|
|
45490
|
+
* @type {string}
|
|
45491
|
+
* @memberof ExportTemplatesApiUpdateEntityExportTemplates
|
|
45492
|
+
*/
|
|
45493
|
+
readonly id: string;
|
|
45494
|
+
/**
|
|
45495
|
+
*
|
|
45496
|
+
* @type {JsonApiExportTemplateInDocument}
|
|
45497
|
+
* @memberof ExportTemplatesApiUpdateEntityExportTemplates
|
|
45498
|
+
*/
|
|
45499
|
+
readonly jsonApiExportTemplateInDocument: JsonApiExportTemplateInDocument;
|
|
45500
|
+
/**
|
|
45501
|
+
* 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\').
|
|
45502
|
+
* @type {string}
|
|
45503
|
+
* @memberof ExportTemplatesApiUpdateEntityExportTemplates
|
|
45504
|
+
*/
|
|
45505
|
+
readonly filter?: string;
|
|
45506
|
+
}
|
|
45507
|
+
|
|
44627
45508
|
/**
|
|
44628
45509
|
* Export request object describing the export properties and metadata for dashboard PDF exports.
|
|
44629
45510
|
* @export
|
|
@@ -44714,7 +45595,7 @@ export declare const FactsApiAxiosParamCreator: (configuration?: MetadataConfigu
|
|
|
44714
45595
|
* @param {string} workspaceId
|
|
44715
45596
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
44716
45597
|
* @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\').
|
|
44717
|
-
* @param {Array<'datasets' | '
|
|
45598
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
44718
45599
|
* @param {number} [page] Zero-based page index (0..N)
|
|
44719
45600
|
* @param {number} [size] The size of the page to be returned
|
|
44720
45601
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -44723,20 +45604,20 @@ export declare const FactsApiAxiosParamCreator: (configuration?: MetadataConfigu
|
|
|
44723
45604
|
* @param {*} [options] Override http request option.
|
|
44724
45605
|
* @throws {RequiredError}
|
|
44725
45606
|
*/
|
|
44726
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
45607
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
44727
45608
|
/**
|
|
44728
45609
|
*
|
|
44729
45610
|
* @summary Get a Fact
|
|
44730
45611
|
* @param {string} workspaceId
|
|
44731
45612
|
* @param {string} objectId
|
|
44732
45613
|
* @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\').
|
|
44733
|
-
* @param {Array<'datasets' | '
|
|
45614
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
44734
45615
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
44735
45616
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
44736
45617
|
* @param {*} [options] Override http request option.
|
|
44737
45618
|
* @throws {RequiredError}
|
|
44738
45619
|
*/
|
|
44739
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
45620
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
44740
45621
|
};
|
|
44741
45622
|
|
|
44742
45623
|
/**
|
|
@@ -44773,7 +45654,7 @@ export declare const FactsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
44773
45654
|
* @param {string} workspaceId
|
|
44774
45655
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
44775
45656
|
* @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\').
|
|
44776
|
-
* @param {Array<'datasets' | '
|
|
45657
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
44777
45658
|
* @param {number} [page] Zero-based page index (0..N)
|
|
44778
45659
|
* @param {number} [size] The size of the page to be returned
|
|
44779
45660
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -44782,20 +45663,20 @@ export declare const FactsApiFp: (configuration?: MetadataConfiguration) => {
|
|
|
44782
45663
|
* @param {*} [options] Override http request option.
|
|
44783
45664
|
* @throws {RequiredError}
|
|
44784
45665
|
*/
|
|
44785
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
45666
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
44786
45667
|
/**
|
|
44787
45668
|
*
|
|
44788
45669
|
* @summary Get a Fact
|
|
44789
45670
|
* @param {string} workspaceId
|
|
44790
45671
|
* @param {string} objectId
|
|
44791
45672
|
* @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\').
|
|
44792
|
-
* @param {Array<'datasets' | '
|
|
45673
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
44793
45674
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
44794
45675
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
44795
45676
|
* @param {*} [options] Override http request option.
|
|
44796
45677
|
* @throws {RequiredError}
|
|
44797
45678
|
*/
|
|
44798
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
45679
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
44799
45680
|
};
|
|
44800
45681
|
|
|
44801
45682
|
/**
|
|
@@ -44824,10 +45705,10 @@ export declare interface FactsApiGetAllEntitiesFactsRequest {
|
|
|
44824
45705
|
readonly filter?: string;
|
|
44825
45706
|
/**
|
|
44826
45707
|
* 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.
|
|
44827
|
-
* @type {Array<'datasets' | '
|
|
45708
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
44828
45709
|
* @memberof FactsApiGetAllEntitiesFacts
|
|
44829
45710
|
*/
|
|
44830
|
-
readonly include?: Array<"datasets" | "
|
|
45711
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
44831
45712
|
/**
|
|
44832
45713
|
* Zero-based page index (0..N)
|
|
44833
45714
|
* @type {number}
|
|
@@ -44886,10 +45767,10 @@ export declare interface FactsApiGetEntityFactsRequest {
|
|
|
44886
45767
|
readonly filter?: string;
|
|
44887
45768
|
/**
|
|
44888
45769
|
* 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.
|
|
44889
|
-
* @type {Array<'datasets' | '
|
|
45770
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
44890
45771
|
* @memberof FactsApiGetEntityFacts
|
|
44891
45772
|
*/
|
|
44892
|
-
readonly include?: Array<"datasets" | "
|
|
45773
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
44893
45774
|
/**
|
|
44894
45775
|
*
|
|
44895
45776
|
* @type {boolean}
|
|
@@ -46649,6 +47530,7 @@ export declare const IdentifierRefIdentifierTypeEnum: {
|
|
|
46649
47530
|
readonly DASHBOARD_PLUGIN: "dashboardPlugin";
|
|
46650
47531
|
readonly DATASET: "dataset";
|
|
46651
47532
|
readonly FACT: "fact";
|
|
47533
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
46652
47534
|
readonly LABEL: "label";
|
|
46653
47535
|
readonly METRIC: "metric";
|
|
46654
47536
|
readonly USER_DATA_FILTER: "userDataFilter";
|
|
@@ -48147,6 +49029,288 @@ declare interface IVisualizationObject_2 {
|
|
|
48147
49029
|
|
|
48148
49030
|
export declare const JSON_API_HEADER_VALUE = "application/vnd.gooddata.api+json";
|
|
48149
49031
|
|
|
49032
|
+
/**
|
|
49033
|
+
* The \\\"type\\\" and \\\"id\\\" to non-empty members.
|
|
49034
|
+
* @export
|
|
49035
|
+
* @interface JsonApiAggregatedFactLinkage
|
|
49036
|
+
*/
|
|
49037
|
+
export declare interface JsonApiAggregatedFactLinkage {
|
|
49038
|
+
/**
|
|
49039
|
+
*
|
|
49040
|
+
* @type {string}
|
|
49041
|
+
* @memberof JsonApiAggregatedFactLinkage
|
|
49042
|
+
*/
|
|
49043
|
+
id: string;
|
|
49044
|
+
/**
|
|
49045
|
+
*
|
|
49046
|
+
* @type {string}
|
|
49047
|
+
* @memberof JsonApiAggregatedFactLinkage
|
|
49048
|
+
*/
|
|
49049
|
+
type: JsonApiAggregatedFactLinkageTypeEnum;
|
|
49050
|
+
}
|
|
49051
|
+
|
|
49052
|
+
export declare const JsonApiAggregatedFactLinkageTypeEnum: {
|
|
49053
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
49054
|
+
};
|
|
49055
|
+
|
|
49056
|
+
export declare type JsonApiAggregatedFactLinkageTypeEnum = typeof JsonApiAggregatedFactLinkageTypeEnum[keyof typeof JsonApiAggregatedFactLinkageTypeEnum];
|
|
49057
|
+
|
|
49058
|
+
/**
|
|
49059
|
+
* JSON:API representation of aggregatedFact entity.
|
|
49060
|
+
* @export
|
|
49061
|
+
* @interface JsonApiAggregatedFactOut
|
|
49062
|
+
*/
|
|
49063
|
+
export declare interface JsonApiAggregatedFactOut {
|
|
49064
|
+
/**
|
|
49065
|
+
* Object type
|
|
49066
|
+
* @type {string}
|
|
49067
|
+
* @memberof JsonApiAggregatedFactOut
|
|
49068
|
+
*/
|
|
49069
|
+
type: JsonApiAggregatedFactOutTypeEnum;
|
|
49070
|
+
/**
|
|
49071
|
+
* API identifier of an object
|
|
49072
|
+
* @type {string}
|
|
49073
|
+
* @memberof JsonApiAggregatedFactOut
|
|
49074
|
+
*/
|
|
49075
|
+
id: string;
|
|
49076
|
+
/**
|
|
49077
|
+
*
|
|
49078
|
+
* @type {JsonApiVisualizationObjectOutMeta}
|
|
49079
|
+
* @memberof JsonApiAggregatedFactOut
|
|
49080
|
+
*/
|
|
49081
|
+
meta?: JsonApiVisualizationObjectOutMeta;
|
|
49082
|
+
/**
|
|
49083
|
+
*
|
|
49084
|
+
* @type {JsonApiAggregatedFactOutAttributes}
|
|
49085
|
+
* @memberof JsonApiAggregatedFactOut
|
|
49086
|
+
*/
|
|
49087
|
+
attributes: JsonApiAggregatedFactOutAttributes;
|
|
49088
|
+
/**
|
|
49089
|
+
*
|
|
49090
|
+
* @type {JsonApiAggregatedFactOutRelationships}
|
|
49091
|
+
* @memberof JsonApiAggregatedFactOut
|
|
49092
|
+
*/
|
|
49093
|
+
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
49094
|
+
}
|
|
49095
|
+
|
|
49096
|
+
/**
|
|
49097
|
+
*
|
|
49098
|
+
* @export
|
|
49099
|
+
* @interface JsonApiAggregatedFactOutAttributes
|
|
49100
|
+
*/
|
|
49101
|
+
export declare interface JsonApiAggregatedFactOutAttributes {
|
|
49102
|
+
/**
|
|
49103
|
+
*
|
|
49104
|
+
* @type {string}
|
|
49105
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
49106
|
+
*/
|
|
49107
|
+
description?: string;
|
|
49108
|
+
/**
|
|
49109
|
+
*
|
|
49110
|
+
* @type {Array<string>}
|
|
49111
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
49112
|
+
*/
|
|
49113
|
+
tags?: Array<string>;
|
|
49114
|
+
/**
|
|
49115
|
+
*
|
|
49116
|
+
* @type {string}
|
|
49117
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
49118
|
+
*/
|
|
49119
|
+
sourceColumn?: string;
|
|
49120
|
+
/**
|
|
49121
|
+
*
|
|
49122
|
+
* @type {string}
|
|
49123
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
49124
|
+
*/
|
|
49125
|
+
sourceColumnDataType?: JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum;
|
|
49126
|
+
/**
|
|
49127
|
+
*
|
|
49128
|
+
* @type {boolean}
|
|
49129
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
49130
|
+
*/
|
|
49131
|
+
areRelationsValid?: boolean;
|
|
49132
|
+
/**
|
|
49133
|
+
*
|
|
49134
|
+
* @type {string}
|
|
49135
|
+
* @memberof JsonApiAggregatedFactOutAttributes
|
|
49136
|
+
*/
|
|
49137
|
+
operation: JsonApiAggregatedFactOutAttributesOperationEnum;
|
|
49138
|
+
}
|
|
49139
|
+
|
|
49140
|
+
export declare const JsonApiAggregatedFactOutAttributesOperationEnum: {
|
|
49141
|
+
readonly SUM: "SUM";
|
|
49142
|
+
readonly MIN: "MIN";
|
|
49143
|
+
readonly MAX: "MAX";
|
|
49144
|
+
};
|
|
49145
|
+
|
|
49146
|
+
export declare type JsonApiAggregatedFactOutAttributesOperationEnum = typeof JsonApiAggregatedFactOutAttributesOperationEnum[keyof typeof JsonApiAggregatedFactOutAttributesOperationEnum];
|
|
49147
|
+
|
|
49148
|
+
export declare const JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum: {
|
|
49149
|
+
readonly INT: "INT";
|
|
49150
|
+
readonly STRING: "STRING";
|
|
49151
|
+
readonly DATE: "DATE";
|
|
49152
|
+
readonly NUMERIC: "NUMERIC";
|
|
49153
|
+
readonly TIMESTAMP: "TIMESTAMP";
|
|
49154
|
+
readonly TIMESTAMP_TZ: "TIMESTAMP_TZ";
|
|
49155
|
+
readonly BOOLEAN: "BOOLEAN";
|
|
49156
|
+
};
|
|
49157
|
+
|
|
49158
|
+
export declare type JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum = typeof JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum[keyof typeof JsonApiAggregatedFactOutAttributesSourceColumnDataTypeEnum];
|
|
49159
|
+
|
|
49160
|
+
/**
|
|
49161
|
+
*
|
|
49162
|
+
* @export
|
|
49163
|
+
* @interface JsonApiAggregatedFactOutDocument
|
|
49164
|
+
*/
|
|
49165
|
+
export declare interface JsonApiAggregatedFactOutDocument {
|
|
49166
|
+
/**
|
|
49167
|
+
*
|
|
49168
|
+
* @type {JsonApiAggregatedFactOut}
|
|
49169
|
+
* @memberof JsonApiAggregatedFactOutDocument
|
|
49170
|
+
*/
|
|
49171
|
+
data: JsonApiAggregatedFactOut;
|
|
49172
|
+
/**
|
|
49173
|
+
*
|
|
49174
|
+
* @type {ObjectLinks}
|
|
49175
|
+
* @memberof JsonApiAggregatedFactOutDocument
|
|
49176
|
+
*/
|
|
49177
|
+
links?: ObjectLinks;
|
|
49178
|
+
/**
|
|
49179
|
+
* Included resources
|
|
49180
|
+
* @type {Array<JsonApiAggregatedFactOutIncludes>}
|
|
49181
|
+
* @memberof JsonApiAggregatedFactOutDocument
|
|
49182
|
+
*/
|
|
49183
|
+
included?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
49184
|
+
}
|
|
49185
|
+
|
|
49186
|
+
/**
|
|
49187
|
+
* @type JsonApiAggregatedFactOutIncludes
|
|
49188
|
+
* @export
|
|
49189
|
+
*/
|
|
49190
|
+
export declare type JsonApiAggregatedFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
49191
|
+
|
|
49192
|
+
/**
|
|
49193
|
+
* A JSON:API document with a list of resources
|
|
49194
|
+
* @export
|
|
49195
|
+
* @interface JsonApiAggregatedFactOutList
|
|
49196
|
+
*/
|
|
49197
|
+
export declare interface JsonApiAggregatedFactOutList {
|
|
49198
|
+
/**
|
|
49199
|
+
*
|
|
49200
|
+
* @type {Array<JsonApiAggregatedFactOutWithLinks>}
|
|
49201
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
49202
|
+
*/
|
|
49203
|
+
data: Array<JsonApiAggregatedFactOutWithLinks>;
|
|
49204
|
+
/**
|
|
49205
|
+
*
|
|
49206
|
+
* @type {ListLinks}
|
|
49207
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
49208
|
+
*/
|
|
49209
|
+
links?: ListLinks;
|
|
49210
|
+
/**
|
|
49211
|
+
*
|
|
49212
|
+
* @type {JsonApiColorPaletteOutListMeta}
|
|
49213
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
49214
|
+
*/
|
|
49215
|
+
meta?: JsonApiColorPaletteOutListMeta;
|
|
49216
|
+
/**
|
|
49217
|
+
* Included resources
|
|
49218
|
+
* @type {Array<JsonApiAggregatedFactOutIncludes>}
|
|
49219
|
+
* @memberof JsonApiAggregatedFactOutList
|
|
49220
|
+
*/
|
|
49221
|
+
included?: Array<JsonApiAggregatedFactOutIncludes>;
|
|
49222
|
+
}
|
|
49223
|
+
|
|
49224
|
+
/**
|
|
49225
|
+
*
|
|
49226
|
+
* @export
|
|
49227
|
+
* @interface JsonApiAggregatedFactOutRelationships
|
|
49228
|
+
*/
|
|
49229
|
+
export declare interface JsonApiAggregatedFactOutRelationships {
|
|
49230
|
+
/**
|
|
49231
|
+
*
|
|
49232
|
+
* @type {JsonApiAttributeOutRelationshipsDataset}
|
|
49233
|
+
* @memberof JsonApiAggregatedFactOutRelationships
|
|
49234
|
+
*/
|
|
49235
|
+
dataset?: JsonApiAttributeOutRelationshipsDataset;
|
|
49236
|
+
/**
|
|
49237
|
+
*
|
|
49238
|
+
* @type {JsonApiAggregatedFactOutRelationshipsSourceFact}
|
|
49239
|
+
* @memberof JsonApiAggregatedFactOutRelationships
|
|
49240
|
+
*/
|
|
49241
|
+
sourceFact?: JsonApiAggregatedFactOutRelationshipsSourceFact;
|
|
49242
|
+
}
|
|
49243
|
+
|
|
49244
|
+
/**
|
|
49245
|
+
*
|
|
49246
|
+
* @export
|
|
49247
|
+
* @interface JsonApiAggregatedFactOutRelationshipsSourceFact
|
|
49248
|
+
*/
|
|
49249
|
+
export declare interface JsonApiAggregatedFactOutRelationshipsSourceFact {
|
|
49250
|
+
/**
|
|
49251
|
+
*
|
|
49252
|
+
* @type {JsonApiFactToOneLinkage}
|
|
49253
|
+
* @memberof JsonApiAggregatedFactOutRelationshipsSourceFact
|
|
49254
|
+
*/
|
|
49255
|
+
data: JsonApiFactToOneLinkage | null;
|
|
49256
|
+
}
|
|
49257
|
+
|
|
49258
|
+
export declare const JsonApiAggregatedFactOutTypeEnum: {
|
|
49259
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
49260
|
+
};
|
|
49261
|
+
|
|
49262
|
+
export declare type JsonApiAggregatedFactOutTypeEnum = typeof JsonApiAggregatedFactOutTypeEnum[keyof typeof JsonApiAggregatedFactOutTypeEnum];
|
|
49263
|
+
|
|
49264
|
+
/**
|
|
49265
|
+
*
|
|
49266
|
+
* @export
|
|
49267
|
+
* @interface JsonApiAggregatedFactOutWithLinks
|
|
49268
|
+
*/
|
|
49269
|
+
export declare interface JsonApiAggregatedFactOutWithLinks {
|
|
49270
|
+
/**
|
|
49271
|
+
* Object type
|
|
49272
|
+
* @type {string}
|
|
49273
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
49274
|
+
*/
|
|
49275
|
+
type: JsonApiAggregatedFactOutWithLinksTypeEnum;
|
|
49276
|
+
/**
|
|
49277
|
+
* API identifier of an object
|
|
49278
|
+
* @type {string}
|
|
49279
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
49280
|
+
*/
|
|
49281
|
+
id: string;
|
|
49282
|
+
/**
|
|
49283
|
+
*
|
|
49284
|
+
* @type {JsonApiVisualizationObjectOutMeta}
|
|
49285
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
49286
|
+
*/
|
|
49287
|
+
meta?: JsonApiVisualizationObjectOutMeta;
|
|
49288
|
+
/**
|
|
49289
|
+
*
|
|
49290
|
+
* @type {JsonApiAggregatedFactOutAttributes}
|
|
49291
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
49292
|
+
*/
|
|
49293
|
+
attributes: JsonApiAggregatedFactOutAttributes;
|
|
49294
|
+
/**
|
|
49295
|
+
*
|
|
49296
|
+
* @type {JsonApiAggregatedFactOutRelationships}
|
|
49297
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
49298
|
+
*/
|
|
49299
|
+
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
49300
|
+
/**
|
|
49301
|
+
*
|
|
49302
|
+
* @type {ObjectLinks}
|
|
49303
|
+
* @memberof JsonApiAggregatedFactOutWithLinks
|
|
49304
|
+
*/
|
|
49305
|
+
links?: ObjectLinks;
|
|
49306
|
+
}
|
|
49307
|
+
|
|
49308
|
+
export declare const JsonApiAggregatedFactOutWithLinksTypeEnum: {
|
|
49309
|
+
readonly AGGREGATED_FACT: "aggregatedFact";
|
|
49310
|
+
};
|
|
49311
|
+
|
|
49312
|
+
export declare type JsonApiAggregatedFactOutWithLinksTypeEnum = typeof JsonApiAggregatedFactOutWithLinksTypeEnum[keyof typeof JsonApiAggregatedFactOutWithLinksTypeEnum];
|
|
49313
|
+
|
|
48150
49314
|
/**
|
|
48151
49315
|
* JSON:API representation of analyticalDashboard entity.
|
|
48152
49316
|
* @export
|
|
@@ -49883,10 +51047,10 @@ export declare interface JsonApiAutomationInAttributesMetadata {
|
|
|
49883
51047
|
export declare interface JsonApiAutomationInAttributesRawExports {
|
|
49884
51048
|
/**
|
|
49885
51049
|
*
|
|
49886
|
-
* @type {
|
|
51050
|
+
* @type {RawExportAutomationRequest}
|
|
49887
51051
|
* @memberof JsonApiAutomationInAttributesRawExports
|
|
49888
51052
|
*/
|
|
49889
|
-
requestPayload:
|
|
51053
|
+
requestPayload: RawExportAutomationRequest;
|
|
49890
51054
|
}
|
|
49891
51055
|
|
|
49892
51056
|
/**
|
|
@@ -52234,7 +53398,7 @@ export declare interface JsonApiDatasetOutDocument {
|
|
|
52234
53398
|
* @type JsonApiDatasetOutIncludes
|
|
52235
53399
|
* @export
|
|
52236
53400
|
*/
|
|
52237
|
-
export declare type JsonApiDatasetOutIncludes = JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiWorkspaceDataFilterOutWithLinks;
|
|
53401
|
+
export declare type JsonApiDatasetOutIncludes = JsonApiAggregatedFactOutWithLinks | JsonApiAttributeOutWithLinks | JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks | JsonApiWorkspaceDataFilterOutWithLinks;
|
|
52238
53402
|
|
|
52239
53403
|
/**
|
|
52240
53404
|
* A JSON:API document with a list of resources
|
|
@@ -52286,6 +53450,12 @@ export declare interface JsonApiDatasetOutRelationships {
|
|
|
52286
53450
|
* @memberof JsonApiDatasetOutRelationships
|
|
52287
53451
|
*/
|
|
52288
53452
|
facts?: JsonApiVisualizationObjectOutRelationshipsFacts;
|
|
53453
|
+
/**
|
|
53454
|
+
*
|
|
53455
|
+
* @type {JsonApiDatasetOutRelationshipsAggregatedFacts}
|
|
53456
|
+
* @memberof JsonApiDatasetOutRelationships
|
|
53457
|
+
*/
|
|
53458
|
+
aggregatedFacts?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
52289
53459
|
/**
|
|
52290
53460
|
*
|
|
52291
53461
|
* @type {JsonApiVisualizationObjectOutRelationshipsDatasets}
|
|
@@ -52300,6 +53470,20 @@ export declare interface JsonApiDatasetOutRelationships {
|
|
|
52300
53470
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
52301
53471
|
}
|
|
52302
53472
|
|
|
53473
|
+
/**
|
|
53474
|
+
*
|
|
53475
|
+
* @export
|
|
53476
|
+
* @interface JsonApiDatasetOutRelationshipsAggregatedFacts
|
|
53477
|
+
*/
|
|
53478
|
+
export declare interface JsonApiDatasetOutRelationshipsAggregatedFacts {
|
|
53479
|
+
/**
|
|
53480
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
53481
|
+
* @type {Array<JsonApiAggregatedFactLinkage>}
|
|
53482
|
+
* @memberof JsonApiDatasetOutRelationshipsAggregatedFacts
|
|
53483
|
+
*/
|
|
53484
|
+
data: Array<JsonApiAggregatedFactLinkage>;
|
|
53485
|
+
}
|
|
53486
|
+
|
|
52303
53487
|
/**
|
|
52304
53488
|
*
|
|
52305
53489
|
* @export
|
|
@@ -54317,22 +55501,8 @@ export declare interface JsonApiFactOutAttributes {
|
|
|
54317
55501
|
* @memberof JsonApiFactOutAttributes
|
|
54318
55502
|
*/
|
|
54319
55503
|
areRelationsValid?: boolean;
|
|
54320
|
-
/**
|
|
54321
|
-
*
|
|
54322
|
-
* @type {string}
|
|
54323
|
-
* @memberof JsonApiFactOutAttributes
|
|
54324
|
-
*/
|
|
54325
|
-
operation?: JsonApiFactOutAttributesOperationEnum;
|
|
54326
55504
|
}
|
|
54327
55505
|
|
|
54328
|
-
export declare const JsonApiFactOutAttributesOperationEnum: {
|
|
54329
|
-
readonly SUM: "SUM";
|
|
54330
|
-
readonly MIN: "MIN";
|
|
54331
|
-
readonly MAX: "MAX";
|
|
54332
|
-
};
|
|
54333
|
-
|
|
54334
|
-
export declare type JsonApiFactOutAttributesOperationEnum = typeof JsonApiFactOutAttributesOperationEnum[keyof typeof JsonApiFactOutAttributesOperationEnum];
|
|
54335
|
-
|
|
54336
55506
|
export declare const JsonApiFactOutAttributesSourceColumnDataTypeEnum: {
|
|
54337
55507
|
readonly INT: "INT";
|
|
54338
55508
|
readonly STRING: "STRING";
|
|
@@ -54365,18 +55535,12 @@ export declare interface JsonApiFactOutDocument {
|
|
|
54365
55535
|
links?: ObjectLinks;
|
|
54366
55536
|
/**
|
|
54367
55537
|
* Included resources
|
|
54368
|
-
* @type {Array<
|
|
55538
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
54369
55539
|
* @memberof JsonApiFactOutDocument
|
|
54370
55540
|
*/
|
|
54371
|
-
included?: Array<
|
|
55541
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
54372
55542
|
}
|
|
54373
55543
|
|
|
54374
|
-
/**
|
|
54375
|
-
* @type JsonApiFactOutIncludes
|
|
54376
|
-
* @export
|
|
54377
|
-
*/
|
|
54378
|
-
export declare type JsonApiFactOutIncludes = JsonApiDatasetOutWithLinks | JsonApiFactOutWithLinks;
|
|
54379
|
-
|
|
54380
55544
|
/**
|
|
54381
55545
|
* A JSON:API document with a list of resources
|
|
54382
55546
|
* @export
|
|
@@ -54403,10 +55567,10 @@ export declare interface JsonApiFactOutList {
|
|
|
54403
55567
|
meta?: JsonApiColorPaletteOutListMeta;
|
|
54404
55568
|
/**
|
|
54405
55569
|
* Included resources
|
|
54406
|
-
* @type {Array<
|
|
55570
|
+
* @type {Array<JsonApiDatasetOutWithLinks>}
|
|
54407
55571
|
* @memberof JsonApiFactOutList
|
|
54408
55572
|
*/
|
|
54409
|
-
included?: Array<
|
|
55573
|
+
included?: Array<JsonApiDatasetOutWithLinks>;
|
|
54410
55574
|
}
|
|
54411
55575
|
|
|
54412
55576
|
/**
|
|
@@ -54421,26 +55585,6 @@ export declare interface JsonApiFactOutRelationships {
|
|
|
54421
55585
|
* @memberof JsonApiFactOutRelationships
|
|
54422
55586
|
*/
|
|
54423
55587
|
dataset?: JsonApiAttributeOutRelationshipsDataset;
|
|
54424
|
-
/**
|
|
54425
|
-
*
|
|
54426
|
-
* @type {JsonApiFactOutRelationshipsSourceFact}
|
|
54427
|
-
* @memberof JsonApiFactOutRelationships
|
|
54428
|
-
*/
|
|
54429
|
-
sourceFact?: JsonApiFactOutRelationshipsSourceFact;
|
|
54430
|
-
}
|
|
54431
|
-
|
|
54432
|
-
/**
|
|
54433
|
-
*
|
|
54434
|
-
* @export
|
|
54435
|
-
* @interface JsonApiFactOutRelationshipsSourceFact
|
|
54436
|
-
*/
|
|
54437
|
-
export declare interface JsonApiFactOutRelationshipsSourceFact {
|
|
54438
|
-
/**
|
|
54439
|
-
*
|
|
54440
|
-
* @type {JsonApiFactToOneLinkage}
|
|
54441
|
-
* @memberof JsonApiFactOutRelationshipsSourceFact
|
|
54442
|
-
*/
|
|
54443
|
-
data: JsonApiFactToOneLinkage | null;
|
|
54444
55588
|
}
|
|
54445
55589
|
|
|
54446
55590
|
export declare const JsonApiFactOutTypeEnum: {
|
|
@@ -58062,10 +59206,10 @@ export declare interface JsonApiOrganizationSettingIn {
|
|
|
58062
59206
|
id: string;
|
|
58063
59207
|
/**
|
|
58064
59208
|
*
|
|
58065
|
-
* @type {
|
|
59209
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
58066
59210
|
* @memberof JsonApiOrganizationSettingIn
|
|
58067
59211
|
*/
|
|
58068
|
-
attributes?:
|
|
59212
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
58069
59213
|
}
|
|
58070
59214
|
|
|
58071
59215
|
/**
|
|
@@ -58108,62 +59252,12 @@ export declare interface JsonApiOrganizationSettingOut {
|
|
|
58108
59252
|
id: string;
|
|
58109
59253
|
/**
|
|
58110
59254
|
*
|
|
58111
|
-
* @type {
|
|
59255
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
58112
59256
|
* @memberof JsonApiOrganizationSettingOut
|
|
58113
59257
|
*/
|
|
58114
|
-
attributes?:
|
|
59258
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
58115
59259
|
}
|
|
58116
59260
|
|
|
58117
|
-
/**
|
|
58118
|
-
*
|
|
58119
|
-
* @export
|
|
58120
|
-
* @interface JsonApiOrganizationSettingOutAttributes
|
|
58121
|
-
*/
|
|
58122
|
-
export declare interface JsonApiOrganizationSettingOutAttributes {
|
|
58123
|
-
/**
|
|
58124
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
58125
|
-
* @type {object}
|
|
58126
|
-
* @memberof JsonApiOrganizationSettingOutAttributes
|
|
58127
|
-
*/
|
|
58128
|
-
content?: object;
|
|
58129
|
-
/**
|
|
58130
|
-
*
|
|
58131
|
-
* @type {string}
|
|
58132
|
-
* @memberof JsonApiOrganizationSettingOutAttributes
|
|
58133
|
-
*/
|
|
58134
|
-
type?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
58135
|
-
}
|
|
58136
|
-
|
|
58137
|
-
export declare const JsonApiOrganizationSettingOutAttributesTypeEnum: {
|
|
58138
|
-
readonly TIMEZONE: "TIMEZONE";
|
|
58139
|
-
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
58140
|
-
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
58141
|
-
readonly ACTIVE_LLM_ENDPOINT: "ACTIVE_LLM_ENDPOINT";
|
|
58142
|
-
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
58143
|
-
readonly LOCALE: "LOCALE";
|
|
58144
|
-
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
58145
|
-
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
58146
|
-
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
58147
|
-
readonly WEEK_START: "WEEK_START";
|
|
58148
|
-
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
58149
|
-
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
58150
|
-
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
58151
|
-
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
58152
|
-
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
58153
|
-
readonly ALERT: "ALERT";
|
|
58154
|
-
readonly SEPARATORS: "SEPARATORS";
|
|
58155
|
-
readonly DATE_FILTER_CONFIG: "DATE_FILTER_CONFIG";
|
|
58156
|
-
readonly JIT_PROVISIONING: "JIT_PROVISIONING";
|
|
58157
|
-
readonly JWT_JIT_PROVISIONING: "JWT_JIT_PROVISIONING";
|
|
58158
|
-
readonly DASHBOARD_FILTERS_APPLY_MODE: "DASHBOARD_FILTERS_APPLY_MODE";
|
|
58159
|
-
readonly ENABLE_SLIDES_EXPORT: "ENABLE_SLIDES_EXPORT";
|
|
58160
|
-
readonly AI_RATE_LIMIT: "AI_RATE_LIMIT";
|
|
58161
|
-
readonly ATTACHMENT_SIZE_LIMIT: "ATTACHMENT_SIZE_LIMIT";
|
|
58162
|
-
readonly ATTACHMENT_LINK_TTL: "ATTACHMENT_LINK_TTL";
|
|
58163
|
-
};
|
|
58164
|
-
|
|
58165
|
-
export declare type JsonApiOrganizationSettingOutAttributesTypeEnum = typeof JsonApiOrganizationSettingOutAttributesTypeEnum[keyof typeof JsonApiOrganizationSettingOutAttributesTypeEnum];
|
|
58166
|
-
|
|
58167
59261
|
/**
|
|
58168
59262
|
*
|
|
58169
59263
|
* @export
|
|
@@ -58236,10 +59330,10 @@ export declare interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
58236
59330
|
id: string;
|
|
58237
59331
|
/**
|
|
58238
59332
|
*
|
|
58239
|
-
* @type {
|
|
59333
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
58240
59334
|
* @memberof JsonApiOrganizationSettingOutWithLinks
|
|
58241
59335
|
*/
|
|
58242
|
-
attributes?:
|
|
59336
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
58243
59337
|
/**
|
|
58244
59338
|
*
|
|
58245
59339
|
* @type {ObjectLinks}
|
|
@@ -58274,10 +59368,10 @@ export declare interface JsonApiOrganizationSettingPatch {
|
|
|
58274
59368
|
id: string;
|
|
58275
59369
|
/**
|
|
58276
59370
|
*
|
|
58277
|
-
* @type {
|
|
59371
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
58278
59372
|
* @memberof JsonApiOrganizationSettingPatch
|
|
58279
59373
|
*/
|
|
58280
|
-
attributes?:
|
|
59374
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
58281
59375
|
}
|
|
58282
59376
|
|
|
58283
59377
|
/**
|
|
@@ -59172,24 +60266,10 @@ export declare interface JsonApiUserGroupOutList {
|
|
|
59172
60266
|
export declare interface JsonApiUserGroupOutRelationships {
|
|
59173
60267
|
/**
|
|
59174
60268
|
*
|
|
59175
|
-
* @type {
|
|
60269
|
+
* @type {JsonApiUserOutRelationshipsUserGroups}
|
|
59176
60270
|
* @memberof JsonApiUserGroupOutRelationships
|
|
59177
60271
|
*/
|
|
59178
|
-
parents?:
|
|
59179
|
-
}
|
|
59180
|
-
|
|
59181
|
-
/**
|
|
59182
|
-
*
|
|
59183
|
-
* @export
|
|
59184
|
-
* @interface JsonApiUserGroupOutRelationshipsParents
|
|
59185
|
-
*/
|
|
59186
|
-
export declare interface JsonApiUserGroupOutRelationshipsParents {
|
|
59187
|
-
/**
|
|
59188
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
59189
|
-
* @type {Array<JsonApiUserGroupLinkage>}
|
|
59190
|
-
* @memberof JsonApiUserGroupOutRelationshipsParents
|
|
59191
|
-
*/
|
|
59192
|
-
data: Array<JsonApiUserGroupLinkage>;
|
|
60272
|
+
parents?: JsonApiUserOutRelationshipsUserGroups;
|
|
59193
60273
|
}
|
|
59194
60274
|
|
|
59195
60275
|
export declare const JsonApiUserGroupOutTypeEnum: {
|
|
@@ -59684,10 +60764,24 @@ export declare interface JsonApiUserOutList {
|
|
|
59684
60764
|
export declare interface JsonApiUserOutRelationships {
|
|
59685
60765
|
/**
|
|
59686
60766
|
*
|
|
59687
|
-
* @type {
|
|
60767
|
+
* @type {JsonApiUserOutRelationshipsUserGroups}
|
|
59688
60768
|
* @memberof JsonApiUserOutRelationships
|
|
59689
60769
|
*/
|
|
59690
|
-
userGroups?:
|
|
60770
|
+
userGroups?: JsonApiUserOutRelationshipsUserGroups;
|
|
60771
|
+
}
|
|
60772
|
+
|
|
60773
|
+
/**
|
|
60774
|
+
*
|
|
60775
|
+
* @export
|
|
60776
|
+
* @interface JsonApiUserOutRelationshipsUserGroups
|
|
60777
|
+
*/
|
|
60778
|
+
export declare interface JsonApiUserOutRelationshipsUserGroups {
|
|
60779
|
+
/**
|
|
60780
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
60781
|
+
* @type {Array<JsonApiUserGroupLinkage>}
|
|
60782
|
+
* @memberof JsonApiUserOutRelationshipsUserGroups
|
|
60783
|
+
*/
|
|
60784
|
+
data: Array<JsonApiUserGroupLinkage>;
|
|
59691
60785
|
}
|
|
59692
60786
|
|
|
59693
60787
|
export declare const JsonApiUserOutTypeEnum: {
|
|
@@ -59812,10 +60906,10 @@ export declare interface JsonApiUserSettingIn {
|
|
|
59812
60906
|
id: string;
|
|
59813
60907
|
/**
|
|
59814
60908
|
*
|
|
59815
|
-
* @type {
|
|
60909
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
59816
60910
|
* @memberof JsonApiUserSettingIn
|
|
59817
60911
|
*/
|
|
59818
|
-
attributes?:
|
|
60912
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
59819
60913
|
}
|
|
59820
60914
|
|
|
59821
60915
|
/**
|
|
@@ -59858,10 +60952,10 @@ export declare interface JsonApiUserSettingOut {
|
|
|
59858
60952
|
id: string;
|
|
59859
60953
|
/**
|
|
59860
60954
|
*
|
|
59861
|
-
* @type {
|
|
60955
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
59862
60956
|
* @memberof JsonApiUserSettingOut
|
|
59863
60957
|
*/
|
|
59864
|
-
attributes?:
|
|
60958
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
59865
60959
|
}
|
|
59866
60960
|
|
|
59867
60961
|
/**
|
|
@@ -59936,10 +61030,10 @@ export declare interface JsonApiUserSettingOutWithLinks {
|
|
|
59936
61030
|
id: string;
|
|
59937
61031
|
/**
|
|
59938
61032
|
*
|
|
59939
|
-
* @type {
|
|
61033
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
59940
61034
|
* @memberof JsonApiUserSettingOutWithLinks
|
|
59941
61035
|
*/
|
|
59942
|
-
attributes?:
|
|
61036
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
59943
61037
|
/**
|
|
59944
61038
|
*
|
|
59945
61039
|
* @type {ObjectLinks}
|
|
@@ -61689,12 +62783,62 @@ export declare interface JsonApiWorkspaceSettingIn {
|
|
|
61689
62783
|
id: string;
|
|
61690
62784
|
/**
|
|
61691
62785
|
*
|
|
61692
|
-
* @type {
|
|
62786
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
61693
62787
|
* @memberof JsonApiWorkspaceSettingIn
|
|
61694
62788
|
*/
|
|
61695
|
-
attributes?:
|
|
62789
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
62790
|
+
}
|
|
62791
|
+
|
|
62792
|
+
/**
|
|
62793
|
+
*
|
|
62794
|
+
* @export
|
|
62795
|
+
* @interface JsonApiWorkspaceSettingInAttributes
|
|
62796
|
+
*/
|
|
62797
|
+
export declare interface JsonApiWorkspaceSettingInAttributes {
|
|
62798
|
+
/**
|
|
62799
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
62800
|
+
* @type {object}
|
|
62801
|
+
* @memberof JsonApiWorkspaceSettingInAttributes
|
|
62802
|
+
*/
|
|
62803
|
+
content?: object;
|
|
62804
|
+
/**
|
|
62805
|
+
*
|
|
62806
|
+
* @type {string}
|
|
62807
|
+
* @memberof JsonApiWorkspaceSettingInAttributes
|
|
62808
|
+
*/
|
|
62809
|
+
type?: JsonApiWorkspaceSettingInAttributesTypeEnum;
|
|
61696
62810
|
}
|
|
61697
62811
|
|
|
62812
|
+
export declare const JsonApiWorkspaceSettingInAttributesTypeEnum: {
|
|
62813
|
+
readonly TIMEZONE: "TIMEZONE";
|
|
62814
|
+
readonly ACTIVE_THEME: "ACTIVE_THEME";
|
|
62815
|
+
readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
|
|
62816
|
+
readonly ACTIVE_LLM_ENDPOINT: "ACTIVE_LLM_ENDPOINT";
|
|
62817
|
+
readonly WHITE_LABELING: "WHITE_LABELING";
|
|
62818
|
+
readonly LOCALE: "LOCALE";
|
|
62819
|
+
readonly METADATA_LOCALE: "METADATA_LOCALE";
|
|
62820
|
+
readonly FORMAT_LOCALE: "FORMAT_LOCALE";
|
|
62821
|
+
readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
|
|
62822
|
+
readonly WEEK_START: "WEEK_START";
|
|
62823
|
+
readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
|
|
62824
|
+
readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
|
|
62825
|
+
readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
|
|
62826
|
+
readonly OPENAI_CONFIG: "OPENAI_CONFIG";
|
|
62827
|
+
readonly ENABLE_FILE_ANALYTICS: "ENABLE_FILE_ANALYTICS";
|
|
62828
|
+
readonly ALERT: "ALERT";
|
|
62829
|
+
readonly SEPARATORS: "SEPARATORS";
|
|
62830
|
+
readonly DATE_FILTER_CONFIG: "DATE_FILTER_CONFIG";
|
|
62831
|
+
readonly JIT_PROVISIONING: "JIT_PROVISIONING";
|
|
62832
|
+
readonly JWT_JIT_PROVISIONING: "JWT_JIT_PROVISIONING";
|
|
62833
|
+
readonly DASHBOARD_FILTERS_APPLY_MODE: "DASHBOARD_FILTERS_APPLY_MODE";
|
|
62834
|
+
readonly ENABLE_SLIDES_EXPORT: "ENABLE_SLIDES_EXPORT";
|
|
62835
|
+
readonly AI_RATE_LIMIT: "AI_RATE_LIMIT";
|
|
62836
|
+
readonly ATTACHMENT_SIZE_LIMIT: "ATTACHMENT_SIZE_LIMIT";
|
|
62837
|
+
readonly ATTACHMENT_LINK_TTL: "ATTACHMENT_LINK_TTL";
|
|
62838
|
+
};
|
|
62839
|
+
|
|
62840
|
+
export declare type JsonApiWorkspaceSettingInAttributesTypeEnum = typeof JsonApiWorkspaceSettingInAttributesTypeEnum[keyof typeof JsonApiWorkspaceSettingInAttributesTypeEnum];
|
|
62841
|
+
|
|
61698
62842
|
/**
|
|
61699
62843
|
*
|
|
61700
62844
|
* @export
|
|
@@ -61741,10 +62885,10 @@ export declare interface JsonApiWorkspaceSettingOut {
|
|
|
61741
62885
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
61742
62886
|
/**
|
|
61743
62887
|
*
|
|
61744
|
-
* @type {
|
|
62888
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
61745
62889
|
* @memberof JsonApiWorkspaceSettingOut
|
|
61746
62890
|
*/
|
|
61747
|
-
attributes?:
|
|
62891
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
61748
62892
|
}
|
|
61749
62893
|
|
|
61750
62894
|
/**
|
|
@@ -61825,10 +62969,10 @@ export declare interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
61825
62969
|
meta?: JsonApiVisualizationObjectOutMeta;
|
|
61826
62970
|
/**
|
|
61827
62971
|
*
|
|
61828
|
-
* @type {
|
|
62972
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
61829
62973
|
* @memberof JsonApiWorkspaceSettingOutWithLinks
|
|
61830
62974
|
*/
|
|
61831
|
-
attributes?:
|
|
62975
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
61832
62976
|
/**
|
|
61833
62977
|
*
|
|
61834
62978
|
* @type {ObjectLinks}
|
|
@@ -61863,10 +63007,10 @@ export declare interface JsonApiWorkspaceSettingPatch {
|
|
|
61863
63007
|
id: string;
|
|
61864
63008
|
/**
|
|
61865
63009
|
*
|
|
61866
|
-
* @type {
|
|
63010
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
61867
63011
|
* @memberof JsonApiWorkspaceSettingPatch
|
|
61868
63012
|
*/
|
|
61869
|
-
attributes?:
|
|
63013
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
61870
63014
|
}
|
|
61871
63015
|
|
|
61872
63016
|
/**
|
|
@@ -61909,10 +63053,10 @@ export declare interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
61909
63053
|
id?: string;
|
|
61910
63054
|
/**
|
|
61911
63055
|
*
|
|
61912
|
-
* @type {
|
|
63056
|
+
* @type {JsonApiWorkspaceSettingInAttributes}
|
|
61913
63057
|
* @memberof JsonApiWorkspaceSettingPostOptionalId
|
|
61914
63058
|
*/
|
|
61915
|
-
attributes?:
|
|
63059
|
+
attributes?: JsonApiWorkspaceSettingInAttributes;
|
|
61916
63060
|
}
|
|
61917
63061
|
|
|
61918
63062
|
/**
|
|
@@ -78823,6 +79967,58 @@ export declare interface RawCustomOverride {
|
|
|
78823
79967
|
};
|
|
78824
79968
|
}
|
|
78825
79969
|
|
|
79970
|
+
/**
|
|
79971
|
+
* Export request object describing the export properties and overrides for raw exports.
|
|
79972
|
+
* @export
|
|
79973
|
+
* @interface RawExportAutomationRequest
|
|
79974
|
+
*/
|
|
79975
|
+
export declare interface RawExportAutomationRequest {
|
|
79976
|
+
/**
|
|
79977
|
+
* Requested resulting file type.
|
|
79978
|
+
* @type {string}
|
|
79979
|
+
* @memberof RawExportAutomationRequest
|
|
79980
|
+
*/
|
|
79981
|
+
format: RawExportAutomationRequestFormatEnum;
|
|
79982
|
+
/**
|
|
79983
|
+
*
|
|
79984
|
+
* @type {AFM}
|
|
79985
|
+
* @memberof RawExportAutomationRequest
|
|
79986
|
+
*/
|
|
79987
|
+
execution: AFM;
|
|
79988
|
+
/**
|
|
79989
|
+
* Filename of downloaded file without extension.
|
|
79990
|
+
* @type {string}
|
|
79991
|
+
* @memberof RawExportAutomationRequest
|
|
79992
|
+
*/
|
|
79993
|
+
fileName: string;
|
|
79994
|
+
/**
|
|
79995
|
+
*
|
|
79996
|
+
* @type {RawCustomOverride}
|
|
79997
|
+
* @memberof RawExportAutomationRequest
|
|
79998
|
+
*/
|
|
79999
|
+
customOverride?: RawCustomOverride;
|
|
80000
|
+
/**
|
|
80001
|
+
*
|
|
80002
|
+
* @type {ExecutionSettings}
|
|
80003
|
+
* @memberof RawExportAutomationRequest
|
|
80004
|
+
*/
|
|
80005
|
+
executionSettings?: ExecutionSettings;
|
|
80006
|
+
/**
|
|
80007
|
+
* Free-form JSON object
|
|
80008
|
+
* @type {object}
|
|
80009
|
+
* @memberof RawExportAutomationRequest
|
|
80010
|
+
*/
|
|
80011
|
+
metadata?: object | null;
|
|
80012
|
+
}
|
|
80013
|
+
|
|
80014
|
+
export declare const RawExportAutomationRequestFormatEnum: {
|
|
80015
|
+
readonly ARROW_FILE: "ARROW_FILE";
|
|
80016
|
+
readonly ARROW_STREAM: "ARROW_STREAM";
|
|
80017
|
+
readonly CSV: "CSV";
|
|
80018
|
+
};
|
|
80019
|
+
|
|
80020
|
+
export declare type RawExportAutomationRequestFormatEnum = typeof RawExportAutomationRequestFormatEnum[keyof typeof RawExportAutomationRequestFormatEnum];
|
|
80021
|
+
|
|
78826
80022
|
/**
|
|
78827
80023
|
* RawExportExport - object-oriented interface
|
|
78828
80024
|
* @export
|
|
@@ -78989,52 +80185,6 @@ export declare interface RawExportExportInterface {
|
|
|
78989
80185
|
getRawExport(requestParameters: RawExportExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
78990
80186
|
}
|
|
78991
80187
|
|
|
78992
|
-
/**
|
|
78993
|
-
* Export request object describing the export properties and overrides for raw exports.
|
|
78994
|
-
* @export
|
|
78995
|
-
* @interface RawExportRequest
|
|
78996
|
-
*/
|
|
78997
|
-
export declare interface RawExportRequest {
|
|
78998
|
-
/**
|
|
78999
|
-
* Requested resulting file type.
|
|
79000
|
-
* @type {string}
|
|
79001
|
-
* @memberof RawExportRequest
|
|
79002
|
-
*/
|
|
79003
|
-
format: RawExportRequestFormatEnum;
|
|
79004
|
-
/**
|
|
79005
|
-
*
|
|
79006
|
-
* @type {AFM}
|
|
79007
|
-
* @memberof RawExportRequest
|
|
79008
|
-
*/
|
|
79009
|
-
execution: AFM;
|
|
79010
|
-
/**
|
|
79011
|
-
* Filename of downloaded file without extension.
|
|
79012
|
-
* @type {string}
|
|
79013
|
-
* @memberof RawExportRequest
|
|
79014
|
-
*/
|
|
79015
|
-
fileName: string;
|
|
79016
|
-
/**
|
|
79017
|
-
*
|
|
79018
|
-
* @type {RawCustomOverride}
|
|
79019
|
-
* @memberof RawExportRequest
|
|
79020
|
-
*/
|
|
79021
|
-
customOverride?: RawCustomOverride;
|
|
79022
|
-
/**
|
|
79023
|
-
*
|
|
79024
|
-
* @type {ExecutionSettings}
|
|
79025
|
-
* @memberof RawExportRequest
|
|
79026
|
-
*/
|
|
79027
|
-
executionSettings?: ExecutionSettings;
|
|
79028
|
-
}
|
|
79029
|
-
|
|
79030
|
-
export declare const RawExportRequestFormatEnum: {
|
|
79031
|
-
readonly ARROW_FILE: "ARROW_FILE";
|
|
79032
|
-
readonly ARROW_STREAM: "ARROW_STREAM";
|
|
79033
|
-
readonly CSV: "CSV";
|
|
79034
|
-
};
|
|
79035
|
-
|
|
79036
|
-
export declare type RawExportRequestFormatEnum = typeof RawExportRequestFormatEnum[keyof typeof RawExportRequestFormatEnum];
|
|
79037
|
-
|
|
79038
80188
|
/**
|
|
79039
80189
|
* Request to read the manifests of the specified CSV files.
|
|
79040
80190
|
* @export
|
|
@@ -82345,201 +83495,6 @@ export declare interface TranslationsApiSetTranslationsRequest {
|
|
|
82345
83495
|
readonly xliff: Xliff;
|
|
82346
83496
|
}
|
|
82347
83497
|
|
|
82348
|
-
/**
|
|
82349
|
-
* UnsubscribeApi - object-oriented interface
|
|
82350
|
-
* @export
|
|
82351
|
-
* @class UnsubscribeApi
|
|
82352
|
-
* @extends {BaseAPI}
|
|
82353
|
-
*/
|
|
82354
|
-
export declare class UnsubscribeApi extends MetadataBaseApi implements UnsubscribeApiInterface {
|
|
82355
|
-
/**
|
|
82356
|
-
*
|
|
82357
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
82358
|
-
* @param {*} [options] Override http request option.
|
|
82359
|
-
* @throws {RequiredError}
|
|
82360
|
-
* @memberof UnsubscribeApi
|
|
82361
|
-
*/
|
|
82362
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
82363
|
-
/**
|
|
82364
|
-
*
|
|
82365
|
-
* @summary Unsubscribe from an automation
|
|
82366
|
-
* @param {UnsubscribeApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
82367
|
-
* @param {*} [options] Override http request option.
|
|
82368
|
-
* @throws {RequiredError}
|
|
82369
|
-
* @memberof UnsubscribeApi
|
|
82370
|
-
*/
|
|
82371
|
-
unsubscribeAutomation(requestParameters: UnsubscribeApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
82372
|
-
/**
|
|
82373
|
-
*
|
|
82374
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
82375
|
-
* @param {UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
82376
|
-
* @param {*} [options] Override http request option.
|
|
82377
|
-
* @throws {RequiredError}
|
|
82378
|
-
* @memberof UnsubscribeApi
|
|
82379
|
-
*/
|
|
82380
|
-
unsubscribeWorkspaceAutomations(requestParameters: UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
82381
|
-
}
|
|
82382
|
-
|
|
82383
|
-
/**
|
|
82384
|
-
* UnsubscribeApi - axios parameter creator
|
|
82385
|
-
* @export
|
|
82386
|
-
*/
|
|
82387
|
-
export declare const UnsubscribeApiAxiosParamCreator: (configuration?: MetadataConfiguration) => {
|
|
82388
|
-
/**
|
|
82389
|
-
*
|
|
82390
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
82391
|
-
* @param {*} [options] Override http request option.
|
|
82392
|
-
* @throws {RequiredError}
|
|
82393
|
-
*/
|
|
82394
|
-
unsubscribeAllAutomations: (options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
82395
|
-
/**
|
|
82396
|
-
*
|
|
82397
|
-
* @summary Unsubscribe from an automation
|
|
82398
|
-
* @param {string} workspaceId
|
|
82399
|
-
* @param {string} automationId
|
|
82400
|
-
* @param {*} [options] Override http request option.
|
|
82401
|
-
* @throws {RequiredError}
|
|
82402
|
-
*/
|
|
82403
|
-
unsubscribeAutomation: (workspaceId: string, automationId: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
82404
|
-
/**
|
|
82405
|
-
*
|
|
82406
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
82407
|
-
* @param {string} workspaceId
|
|
82408
|
-
* @param {*} [options] Override http request option.
|
|
82409
|
-
* @throws {RequiredError}
|
|
82410
|
-
*/
|
|
82411
|
-
unsubscribeWorkspaceAutomations: (workspaceId: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
82412
|
-
};
|
|
82413
|
-
|
|
82414
|
-
/**
|
|
82415
|
-
* UnsubscribeApi - factory interface
|
|
82416
|
-
* @export
|
|
82417
|
-
*/
|
|
82418
|
-
export declare const UnsubscribeApiFactory: (configuration?: MetadataConfiguration, basePath?: string, axios?: AxiosInstance) => {
|
|
82419
|
-
/**
|
|
82420
|
-
*
|
|
82421
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
82422
|
-
* @param {*} [options] Override http request option.
|
|
82423
|
-
* @throws {RequiredError}
|
|
82424
|
-
*/
|
|
82425
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82426
|
-
/**
|
|
82427
|
-
*
|
|
82428
|
-
* @summary Unsubscribe from an automation
|
|
82429
|
-
* @param {UnsubscribeApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
82430
|
-
* @param {*} [options] Override http request option.
|
|
82431
|
-
* @throws {RequiredError}
|
|
82432
|
-
*/
|
|
82433
|
-
unsubscribeAutomation(requestParameters: UnsubscribeApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82434
|
-
/**
|
|
82435
|
-
*
|
|
82436
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
82437
|
-
* @param {UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
82438
|
-
* @param {*} [options] Override http request option.
|
|
82439
|
-
* @throws {RequiredError}
|
|
82440
|
-
*/
|
|
82441
|
-
unsubscribeWorkspaceAutomations(requestParameters: UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82442
|
-
};
|
|
82443
|
-
|
|
82444
|
-
/**
|
|
82445
|
-
* UnsubscribeApi - functional programming interface
|
|
82446
|
-
* @export
|
|
82447
|
-
*/
|
|
82448
|
-
export declare const UnsubscribeApiFp: (configuration?: MetadataConfiguration) => {
|
|
82449
|
-
/**
|
|
82450
|
-
*
|
|
82451
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
82452
|
-
* @param {*} [options] Override http request option.
|
|
82453
|
-
* @throws {RequiredError}
|
|
82454
|
-
*/
|
|
82455
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82456
|
-
/**
|
|
82457
|
-
*
|
|
82458
|
-
* @summary Unsubscribe from an automation
|
|
82459
|
-
* @param {string} workspaceId
|
|
82460
|
-
* @param {string} automationId
|
|
82461
|
-
* @param {*} [options] Override http request option.
|
|
82462
|
-
* @throws {RequiredError}
|
|
82463
|
-
*/
|
|
82464
|
-
unsubscribeAutomation(workspaceId: string, automationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82465
|
-
/**
|
|
82466
|
-
*
|
|
82467
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
82468
|
-
* @param {string} workspaceId
|
|
82469
|
-
* @param {*} [options] Override http request option.
|
|
82470
|
-
* @throws {RequiredError}
|
|
82471
|
-
*/
|
|
82472
|
-
unsubscribeWorkspaceAutomations(workspaceId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
82473
|
-
};
|
|
82474
|
-
|
|
82475
|
-
/**
|
|
82476
|
-
* UnsubscribeApi - interface
|
|
82477
|
-
* @export
|
|
82478
|
-
* @interface UnsubscribeApi
|
|
82479
|
-
*/
|
|
82480
|
-
export declare interface UnsubscribeApiInterface {
|
|
82481
|
-
/**
|
|
82482
|
-
*
|
|
82483
|
-
* @summary Unsubscribe from all automations in all workspaces
|
|
82484
|
-
* @param {*} [options] Override http request option.
|
|
82485
|
-
* @throws {RequiredError}
|
|
82486
|
-
* @memberof UnsubscribeApiInterface
|
|
82487
|
-
*/
|
|
82488
|
-
unsubscribeAllAutomations(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82489
|
-
/**
|
|
82490
|
-
*
|
|
82491
|
-
* @summary Unsubscribe from an automation
|
|
82492
|
-
* @param {UnsubscribeApiUnsubscribeAutomationRequest} requestParameters Request parameters.
|
|
82493
|
-
* @param {*} [options] Override http request option.
|
|
82494
|
-
* @throws {RequiredError}
|
|
82495
|
-
* @memberof UnsubscribeApiInterface
|
|
82496
|
-
*/
|
|
82497
|
-
unsubscribeAutomation(requestParameters: UnsubscribeApiUnsubscribeAutomationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82498
|
-
/**
|
|
82499
|
-
*
|
|
82500
|
-
* @summary Unsubscribe from all automations in the workspace
|
|
82501
|
-
* @param {UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest} requestParameters Request parameters.
|
|
82502
|
-
* @param {*} [options] Override http request option.
|
|
82503
|
-
* @throws {RequiredError}
|
|
82504
|
-
* @memberof UnsubscribeApiInterface
|
|
82505
|
-
*/
|
|
82506
|
-
unsubscribeWorkspaceAutomations(requestParameters: UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
82507
|
-
}
|
|
82508
|
-
|
|
82509
|
-
/**
|
|
82510
|
-
* Request parameters for unsubscribeAutomation operation in UnsubscribeApi.
|
|
82511
|
-
* @export
|
|
82512
|
-
* @interface UnsubscribeApiUnsubscribeAutomationRequest
|
|
82513
|
-
*/
|
|
82514
|
-
export declare interface UnsubscribeApiUnsubscribeAutomationRequest {
|
|
82515
|
-
/**
|
|
82516
|
-
*
|
|
82517
|
-
* @type {string}
|
|
82518
|
-
* @memberof UnsubscribeApiUnsubscribeAutomation
|
|
82519
|
-
*/
|
|
82520
|
-
readonly workspaceId: string;
|
|
82521
|
-
/**
|
|
82522
|
-
*
|
|
82523
|
-
* @type {string}
|
|
82524
|
-
* @memberof UnsubscribeApiUnsubscribeAutomation
|
|
82525
|
-
*/
|
|
82526
|
-
readonly automationId: string;
|
|
82527
|
-
}
|
|
82528
|
-
|
|
82529
|
-
/**
|
|
82530
|
-
* Request parameters for unsubscribeWorkspaceAutomations operation in UnsubscribeApi.
|
|
82531
|
-
* @export
|
|
82532
|
-
* @interface UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest
|
|
82533
|
-
*/
|
|
82534
|
-
export declare interface UnsubscribeApiUnsubscribeWorkspaceAutomationsRequest {
|
|
82535
|
-
/**
|
|
82536
|
-
*
|
|
82537
|
-
* @type {string}
|
|
82538
|
-
* @memberof UnsubscribeApiUnsubscribeWorkspaceAutomations
|
|
82539
|
-
*/
|
|
82540
|
-
readonly workspaceId: string;
|
|
82541
|
-
}
|
|
82542
|
-
|
|
82543
83498
|
/**
|
|
82544
83499
|
* Information related to the file uploaded to the staging area.
|
|
82545
83500
|
* @export
|
|
@@ -86766,7 +87721,7 @@ export declare interface ValidateLLMEndpointResponse {
|
|
|
86766
87721
|
* @type {boolean}
|
|
86767
87722
|
* @memberof ValidateLLMEndpointResponse
|
|
86768
87723
|
*/
|
|
86769
|
-
|
|
87724
|
+
successful: boolean;
|
|
86770
87725
|
/**
|
|
86771
87726
|
* Additional message about the LLM endpoint validation
|
|
86772
87727
|
* @type {string}
|
|
@@ -88160,6 +89115,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
88160
89115
|
* @memberof WorkspaceObjectControllerApi
|
|
88161
89116
|
*/
|
|
88162
89117
|
deleteEntityWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<void, any>>;
|
|
89118
|
+
/**
|
|
89119
|
+
*
|
|
89120
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
89121
|
+
* @param {*} [options] Override http request option.
|
|
89122
|
+
* @throws {RequiredError}
|
|
89123
|
+
* @memberof WorkspaceObjectControllerApi
|
|
89124
|
+
*/
|
|
89125
|
+
getAllEntitiesAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiAggregatedFactOutList, any>>;
|
|
88163
89126
|
/**
|
|
88164
89127
|
*
|
|
88165
89128
|
* @summary Get all Dashboards
|
|
@@ -88322,6 +89285,14 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
88322
89285
|
* @memberof WorkspaceObjectControllerApi
|
|
88323
89286
|
*/
|
|
88324
89287
|
getAllEntitiesWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiWorkspaceSettingOutList, any>>;
|
|
89288
|
+
/**
|
|
89289
|
+
*
|
|
89290
|
+
* @param {WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
89291
|
+
* @param {*} [options] Override http request option.
|
|
89292
|
+
* @throws {RequiredError}
|
|
89293
|
+
* @memberof WorkspaceObjectControllerApi
|
|
89294
|
+
*/
|
|
89295
|
+
getEntityAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<JsonApiAggregatedFactOutDocument, any>>;
|
|
88325
89296
|
/**
|
|
88326
89297
|
*
|
|
88327
89298
|
* @summary Get a Dashboard
|
|
@@ -89034,6 +90005,21 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89034
90005
|
* @throws {RequiredError}
|
|
89035
90006
|
*/
|
|
89036
90007
|
deleteEntityWorkspaceSettings: (workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
90008
|
+
/**
|
|
90009
|
+
*
|
|
90010
|
+
* @param {string} workspaceId
|
|
90011
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
90012
|
+
* @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\').
|
|
90013
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
90014
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
90015
|
+
* @param {number} [size] The size of the page to be returned
|
|
90016
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
90017
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
90018
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
90019
|
+
* @param {*} [options] Override http request option.
|
|
90020
|
+
* @throws {RequiredError}
|
|
90021
|
+
*/
|
|
90022
|
+
getAllEntitiesAggregatedFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
89037
90023
|
/**
|
|
89038
90024
|
*
|
|
89039
90025
|
* @summary Get all Dashboards
|
|
@@ -89135,7 +90121,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89135
90121
|
* @param {string} workspaceId
|
|
89136
90122
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
89137
90123
|
* @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\').
|
|
89138
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
90124
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
89139
90125
|
* @param {number} [page] Zero-based page index (0..N)
|
|
89140
90126
|
* @param {number} [size] The size of the page to be returned
|
|
89141
90127
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -89144,7 +90130,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89144
90130
|
* @param {*} [options] Override http request option.
|
|
89145
90131
|
* @throws {RequiredError}
|
|
89146
90132
|
*/
|
|
89147
|
-
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
90133
|
+
getAllEntitiesDatasets: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
89148
90134
|
/**
|
|
89149
90135
|
*
|
|
89150
90136
|
* @summary Get all Export Definitions
|
|
@@ -89167,7 +90153,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89167
90153
|
* @param {string} workspaceId
|
|
89168
90154
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
89169
90155
|
* @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\').
|
|
89170
|
-
* @param {Array<'datasets' | '
|
|
90156
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
89171
90157
|
* @param {number} [page] Zero-based page index (0..N)
|
|
89172
90158
|
* @param {number} [size] The size of the page to be returned
|
|
89173
90159
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -89176,7 +90162,7 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89176
90162
|
* @param {*} [options] Override http request option.
|
|
89177
90163
|
* @throws {RequiredError}
|
|
89178
90164
|
*/
|
|
89179
|
-
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
90165
|
+
getAllEntitiesFacts: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
89180
90166
|
/**
|
|
89181
90167
|
*
|
|
89182
90168
|
* @summary Get all Context Filters
|
|
@@ -89320,6 +90306,18 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89320
90306
|
* @throws {RequiredError}
|
|
89321
90307
|
*/
|
|
89322
90308
|
getAllEntitiesWorkspaceSettings: (workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
90309
|
+
/**
|
|
90310
|
+
*
|
|
90311
|
+
* @param {string} workspaceId
|
|
90312
|
+
* @param {string} objectId
|
|
90313
|
+
* @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\').
|
|
90314
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
90315
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
90316
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
90317
|
+
* @param {*} [options] Override http request option.
|
|
90318
|
+
* @throws {RequiredError}
|
|
90319
|
+
*/
|
|
90320
|
+
getEntityAggregatedFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
89323
90321
|
/**
|
|
89324
90322
|
*
|
|
89325
90323
|
* @summary Get a Dashboard
|
|
@@ -89403,13 +90401,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89403
90401
|
* @param {string} workspaceId
|
|
89404
90402
|
* @param {string} objectId
|
|
89405
90403
|
* @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\').
|
|
89406
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
90404
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
89407
90405
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
89408
90406
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
89409
90407
|
* @param {*} [options] Override http request option.
|
|
89410
90408
|
* @throws {RequiredError}
|
|
89411
90409
|
*/
|
|
89412
|
-
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
90410
|
+
getEntityDatasets: (workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
89413
90411
|
/**
|
|
89414
90412
|
*
|
|
89415
90413
|
* @summary Get an Export Definition
|
|
@@ -89429,13 +90427,13 @@ export declare const WorkspaceObjectControllerApiAxiosParamCreator: (configurati
|
|
|
89429
90427
|
* @param {string} workspaceId
|
|
89430
90428
|
* @param {string} objectId
|
|
89431
90429
|
* @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\').
|
|
89432
|
-
* @param {Array<'datasets' | '
|
|
90430
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
89433
90431
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
89434
90432
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
89435
90433
|
* @param {*} [options] Override http request option.
|
|
89436
90434
|
* @throws {RequiredError}
|
|
89437
90435
|
*/
|
|
89438
|
-
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
90436
|
+
getEntityFacts: (workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig) => Promise<MetadataRequestArgs>;
|
|
89439
90437
|
/**
|
|
89440
90438
|
*
|
|
89441
90439
|
* @summary Get a Context Filter
|
|
@@ -90908,6 +91906,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
90908
91906
|
* @throws {RequiredError}
|
|
90909
91907
|
*/
|
|
90910
91908
|
deleteEntityWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91909
|
+
/**
|
|
91910
|
+
*
|
|
91911
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
91912
|
+
* @param {*} [options] Override http request option.
|
|
91913
|
+
* @throws {RequiredError}
|
|
91914
|
+
*/
|
|
91915
|
+
getAllEntitiesAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
90911
91916
|
/**
|
|
90912
91917
|
*
|
|
90913
91918
|
* @summary Get all Dashboards
|
|
@@ -91052,6 +92057,13 @@ export declare const WorkspaceObjectControllerApiFactory: (configuration?: Metad
|
|
|
91052
92057
|
* @throws {RequiredError}
|
|
91053
92058
|
*/
|
|
91054
92059
|
getAllEntitiesWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceSettingOutList>;
|
|
92060
|
+
/**
|
|
92061
|
+
*
|
|
92062
|
+
* @param {WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
92063
|
+
* @param {*} [options] Override http request option.
|
|
92064
|
+
* @throws {RequiredError}
|
|
92065
|
+
*/
|
|
92066
|
+
getEntityAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
91055
92067
|
/**
|
|
91056
92068
|
*
|
|
91057
92069
|
* @summary Get a Dashboard
|
|
@@ -91718,6 +92730,21 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
91718
92730
|
* @throws {RequiredError}
|
|
91719
92731
|
*/
|
|
91720
92732
|
deleteEntityWorkspaceSettings(workspaceId: string, objectId: string, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
92733
|
+
/**
|
|
92734
|
+
*
|
|
92735
|
+
* @param {string} workspaceId
|
|
92736
|
+
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
92737
|
+
* @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\').
|
|
92738
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
92739
|
+
* @param {number} [page] Zero-based page index (0..N)
|
|
92740
|
+
* @param {number} [size] The size of the page to be returned
|
|
92741
|
+
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
92742
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92743
|
+
* @param {Array<'origin' | 'page' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92744
|
+
* @param {*} [options] Override http request option.
|
|
92745
|
+
* @throws {RequiredError}
|
|
92746
|
+
*/
|
|
92747
|
+
getAllEntitiesAggregatedFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutList>>;
|
|
91721
92748
|
/**
|
|
91722
92749
|
*
|
|
91723
92750
|
* @summary Get all Dashboards
|
|
@@ -91819,7 +92846,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
91819
92846
|
* @param {string} workspaceId
|
|
91820
92847
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
91821
92848
|
* @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\').
|
|
91822
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
92849
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
91823
92850
|
* @param {number} [page] Zero-based page index (0..N)
|
|
91824
92851
|
* @param {number} [size] The size of the page to be returned
|
|
91825
92852
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -91828,7 +92855,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
91828
92855
|
* @param {*} [options] Override http request option.
|
|
91829
92856
|
* @throws {RequiredError}
|
|
91830
92857
|
*/
|
|
91831
|
-
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
92858
|
+
getAllEntitiesDatasets(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutList>>;
|
|
91832
92859
|
/**
|
|
91833
92860
|
*
|
|
91834
92861
|
* @summary Get all Export Definitions
|
|
@@ -91851,7 +92878,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
91851
92878
|
* @param {string} workspaceId
|
|
91852
92879
|
* @param {'ALL' | 'PARENTS' | 'NATIVE'} [origin]
|
|
91853
92880
|
* @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\').
|
|
91854
|
-
* @param {Array<'datasets' | '
|
|
92881
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
91855
92882
|
* @param {number} [page] Zero-based page index (0..N)
|
|
91856
92883
|
* @param {number} [size] The size of the page to be returned
|
|
91857
92884
|
* @param {Array<string>} [sort] Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
@@ -91860,7 +92887,7 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
91860
92887
|
* @param {*} [options] Override http request option.
|
|
91861
92888
|
* @throws {RequiredError}
|
|
91862
92889
|
*/
|
|
91863
|
-
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "
|
|
92890
|
+
getAllEntitiesFacts(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutList>>;
|
|
91864
92891
|
/**
|
|
91865
92892
|
*
|
|
91866
92893
|
* @summary Get all Context Filters
|
|
@@ -92004,6 +93031,18 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
92004
93031
|
* @throws {RequiredError}
|
|
92005
93032
|
*/
|
|
92006
93033
|
getAllEntitiesWorkspaceSettings(workspaceId: string, origin?: "ALL" | "PARENTS" | "NATIVE", filter?: string, page?: number, size?: number, sort?: Array<string>, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "page" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceSettingOutList>>;
|
|
93034
|
+
/**
|
|
93035
|
+
*
|
|
93036
|
+
* @param {string} workspaceId
|
|
93037
|
+
* @param {string} objectId
|
|
93038
|
+
* @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\').
|
|
93039
|
+
* @param {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | '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.
|
|
93040
|
+
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
93041
|
+
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
93042
|
+
* @param {*} [options] Override http request option.
|
|
93043
|
+
* @throws {RequiredError}
|
|
93044
|
+
*/
|
|
93045
|
+
getEntityAggregatedFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiAggregatedFactOutDocument>>;
|
|
92007
93046
|
/**
|
|
92008
93047
|
*
|
|
92009
93048
|
* @summary Get a Dashboard
|
|
@@ -92087,13 +93126,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
92087
93126
|
* @param {string} workspaceId
|
|
92088
93127
|
* @param {string} objectId
|
|
92089
93128
|
* @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\').
|
|
92090
|
-
* @param {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
93129
|
+
* @param {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | '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.
|
|
92091
93130
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92092
93131
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92093
93132
|
* @param {*} [options] Override http request option.
|
|
92094
93133
|
* @throws {RequiredError}
|
|
92095
93134
|
*/
|
|
92096
|
-
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
93135
|
+
getEntityDatasets(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiDatasetOutDocument>>;
|
|
92097
93136
|
/**
|
|
92098
93137
|
*
|
|
92099
93138
|
* @summary Get an Export Definition
|
|
@@ -92113,13 +93152,13 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
92113
93152
|
* @param {string} workspaceId
|
|
92114
93153
|
* @param {string} objectId
|
|
92115
93154
|
* @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\').
|
|
92116
|
-
* @param {Array<'datasets' | '
|
|
93155
|
+
* @param {Array<'datasets' | 'dataset' | '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.
|
|
92117
93156
|
* @param {boolean} [xGDCVALIDATERELATIONS]
|
|
92118
93157
|
* @param {Array<'origin' | 'all' | 'ALL'>} [metaInclude] Include Meta objects.
|
|
92119
93158
|
* @param {*} [options] Override http request option.
|
|
92120
93159
|
* @throws {RequiredError}
|
|
92121
93160
|
*/
|
|
92122
|
-
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "
|
|
93161
|
+
getEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiFactOutDocument>>;
|
|
92123
93162
|
/**
|
|
92124
93163
|
*
|
|
92125
93164
|
* @summary Get a Context Filter
|
|
@@ -92569,6 +93608,68 @@ export declare const WorkspaceObjectControllerApiFp: (configuration?: MetadataCo
|
|
|
92569
93608
|
updateEntityWorkspaceSettings(workspaceId: string, objectId: string, jsonApiWorkspaceSettingInDocument: JsonApiWorkspaceSettingInDocument, filter?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<JsonApiWorkspaceSettingOutDocument>>;
|
|
92570
93609
|
};
|
|
92571
93610
|
|
|
93611
|
+
/**
|
|
93612
|
+
* Request parameters for getAllEntitiesAggregatedFacts operation in WorkspaceObjectControllerApi.
|
|
93613
|
+
* @export
|
|
93614
|
+
* @interface WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest
|
|
93615
|
+
*/
|
|
93616
|
+
export declare interface WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest {
|
|
93617
|
+
/**
|
|
93618
|
+
*
|
|
93619
|
+
* @type {string}
|
|
93620
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93621
|
+
*/
|
|
93622
|
+
readonly workspaceId: string;
|
|
93623
|
+
/**
|
|
93624
|
+
*
|
|
93625
|
+
* @type {'ALL' | 'PARENTS' | 'NATIVE'}
|
|
93626
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93627
|
+
*/
|
|
93628
|
+
readonly origin?: "ALL" | "PARENTS" | "NATIVE";
|
|
93629
|
+
/**
|
|
93630
|
+
* 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\').
|
|
93631
|
+
* @type {string}
|
|
93632
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93633
|
+
*/
|
|
93634
|
+
readonly filter?: string;
|
|
93635
|
+
/**
|
|
93636
|
+
* 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.
|
|
93637
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
93638
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93639
|
+
*/
|
|
93640
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
93641
|
+
/**
|
|
93642
|
+
* Zero-based page index (0..N)
|
|
93643
|
+
* @type {number}
|
|
93644
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93645
|
+
*/
|
|
93646
|
+
readonly page?: number;
|
|
93647
|
+
/**
|
|
93648
|
+
* The size of the page to be returned
|
|
93649
|
+
* @type {number}
|
|
93650
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93651
|
+
*/
|
|
93652
|
+
readonly size?: number;
|
|
93653
|
+
/**
|
|
93654
|
+
* Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
|
|
93655
|
+
* @type {Array<string>}
|
|
93656
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93657
|
+
*/
|
|
93658
|
+
readonly sort?: Array<string>;
|
|
93659
|
+
/**
|
|
93660
|
+
*
|
|
93661
|
+
* @type {boolean}
|
|
93662
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93663
|
+
*/
|
|
93664
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
93665
|
+
/**
|
|
93666
|
+
* Include Meta objects.
|
|
93667
|
+
* @type {Array<'origin' | 'page' | 'all' | 'ALL'>}
|
|
93668
|
+
* @memberof WorkspaceObjectControllerApiGetAllEntitiesAggregatedFacts
|
|
93669
|
+
*/
|
|
93670
|
+
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
93671
|
+
}
|
|
93672
|
+
|
|
92572
93673
|
/**
|
|
92573
93674
|
* Request parameters for getAllEntitiesAnalyticalDashboards operation in WorkspaceObjectControllerApi.
|
|
92574
93675
|
* @export
|
|
@@ -92961,10 +94062,10 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesDatasetsReque
|
|
|
92961
94062
|
readonly filter?: string;
|
|
92962
94063
|
/**
|
|
92963
94064
|
* 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.
|
|
92964
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
94065
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
92965
94066
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesDatasets
|
|
92966
94067
|
*/
|
|
92967
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
94068
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
92968
94069
|
/**
|
|
92969
94070
|
* Zero-based page index (0..N)
|
|
92970
94071
|
* @type {number}
|
|
@@ -93085,10 +94186,10 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesFactsRequest
|
|
|
93085
94186
|
readonly filter?: string;
|
|
93086
94187
|
/**
|
|
93087
94188
|
* 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.
|
|
93088
|
-
* @type {Array<'datasets' | '
|
|
94189
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
93089
94190
|
* @memberof WorkspaceObjectControllerApiGetAllEntitiesFacts
|
|
93090
94191
|
*/
|
|
93091
|
-
readonly include?: Array<"datasets" | "
|
|
94192
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
93092
94193
|
/**
|
|
93093
94194
|
* Zero-based page index (0..N)
|
|
93094
94195
|
* @type {number}
|
|
@@ -93673,6 +94774,50 @@ export declare interface WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSett
|
|
|
93673
94774
|
readonly metaInclude?: Array<"origin" | "page" | "all" | "ALL">;
|
|
93674
94775
|
}
|
|
93675
94776
|
|
|
94777
|
+
/**
|
|
94778
|
+
* Request parameters for getEntityAggregatedFacts operation in WorkspaceObjectControllerApi.
|
|
94779
|
+
* @export
|
|
94780
|
+
* @interface WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest
|
|
94781
|
+
*/
|
|
94782
|
+
export declare interface WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest {
|
|
94783
|
+
/**
|
|
94784
|
+
*
|
|
94785
|
+
* @type {string}
|
|
94786
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
94787
|
+
*/
|
|
94788
|
+
readonly workspaceId: string;
|
|
94789
|
+
/**
|
|
94790
|
+
*
|
|
94791
|
+
* @type {string}
|
|
94792
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
94793
|
+
*/
|
|
94794
|
+
readonly objectId: string;
|
|
94795
|
+
/**
|
|
94796
|
+
* 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\').
|
|
94797
|
+
* @type {string}
|
|
94798
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
94799
|
+
*/
|
|
94800
|
+
readonly filter?: string;
|
|
94801
|
+
/**
|
|
94802
|
+
* 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.
|
|
94803
|
+
* @type {Array<'datasets' | 'facts' | 'dataset' | 'sourceFact' | 'ALL'>}
|
|
94804
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
94805
|
+
*/
|
|
94806
|
+
readonly include?: Array<"datasets" | "facts" | "dataset" | "sourceFact" | "ALL">;
|
|
94807
|
+
/**
|
|
94808
|
+
*
|
|
94809
|
+
* @type {boolean}
|
|
94810
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
94811
|
+
*/
|
|
94812
|
+
readonly xGDCVALIDATERELATIONS?: boolean;
|
|
94813
|
+
/**
|
|
94814
|
+
* Include Meta objects.
|
|
94815
|
+
* @type {Array<'origin' | 'all' | 'ALL'>}
|
|
94816
|
+
* @memberof WorkspaceObjectControllerApiGetEntityAggregatedFacts
|
|
94817
|
+
*/
|
|
94818
|
+
readonly metaInclude?: Array<"origin" | "all" | "ALL">;
|
|
94819
|
+
}
|
|
94820
|
+
|
|
93676
94821
|
/**
|
|
93677
94822
|
* Request parameters for getEntityAnalyticalDashboards operation in WorkspaceObjectControllerApi.
|
|
93678
94823
|
* @export
|
|
@@ -93957,10 +95102,10 @@ export declare interface WorkspaceObjectControllerApiGetEntityDatasetsRequest {
|
|
|
93957
95102
|
readonly filter?: string;
|
|
93958
95103
|
/**
|
|
93959
95104
|
* 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.
|
|
93960
|
-
* @type {Array<'attributes' | 'facts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
95105
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
93961
95106
|
* @memberof WorkspaceObjectControllerApiGetEntityDatasets
|
|
93962
95107
|
*/
|
|
93963
|
-
readonly include?: Array<"attributes" | "facts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
95108
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
93964
95109
|
/**
|
|
93965
95110
|
*
|
|
93966
95111
|
* @type {boolean}
|
|
@@ -94045,10 +95190,10 @@ export declare interface WorkspaceObjectControllerApiGetEntityFactsRequest {
|
|
|
94045
95190
|
readonly filter?: string;
|
|
94046
95191
|
/**
|
|
94047
95192
|
* 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.
|
|
94048
|
-
* @type {Array<'datasets' | '
|
|
95193
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
94049
95194
|
* @memberof WorkspaceObjectControllerApiGetEntityFacts
|
|
94050
95195
|
*/
|
|
94051
|
-
readonly include?: Array<"datasets" | "
|
|
95196
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
94052
95197
|
/**
|
|
94053
95198
|
*
|
|
94054
95199
|
* @type {boolean}
|
|
@@ -94705,6 +95850,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
94705
95850
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
94706
95851
|
*/
|
|
94707
95852
|
deleteEntityWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiDeleteEntityWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
95853
|
+
/**
|
|
95854
|
+
*
|
|
95855
|
+
* @param {WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest} requestParameters Request parameters.
|
|
95856
|
+
* @param {*} [options] Override http request option.
|
|
95857
|
+
* @throws {RequiredError}
|
|
95858
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
95859
|
+
*/
|
|
95860
|
+
getAllEntitiesAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutList>;
|
|
94708
95861
|
/**
|
|
94709
95862
|
*
|
|
94710
95863
|
* @summary Get all Dashboards
|
|
@@ -94867,6 +96020,14 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
94867
96020
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
94868
96021
|
*/
|
|
94869
96022
|
getAllEntitiesWorkspaceSettings(requestParameters: WorkspaceObjectControllerApiGetAllEntitiesWorkspaceSettingsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiWorkspaceSettingOutList>;
|
|
96023
|
+
/**
|
|
96024
|
+
*
|
|
96025
|
+
* @param {WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest} requestParameters Request parameters.
|
|
96026
|
+
* @param {*} [options] Override http request option.
|
|
96027
|
+
* @throws {RequiredError}
|
|
96028
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
96029
|
+
*/
|
|
96030
|
+
getEntityAggregatedFacts(requestParameters: WorkspaceObjectControllerApiGetEntityAggregatedFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAggregatedFactOutDocument>;
|
|
94870
96031
|
/**
|
|
94871
96032
|
*
|
|
94872
96033
|
* @summary Get a Dashboard
|