@gooddata/api-client-tiger 11.11.0-alpha.5 → 11.11.0-alpha.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +1648 -536
- package/esm/generated/afm-rest-api/api.d.ts +13 -0
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +24 -0
- package/esm/generated/automation-json-api/api.d.ts +2 -2
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +2 -2
- package/esm/generated/metadata-json-api/api.d.ts +1531 -486
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +984 -0
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +10039 -9501
- package/package.json +4 -4
|
@@ -6454,12 +6454,12 @@ export declare interface AnomalyDetection {
|
|
|
6454
6454
|
*/
|
|
6455
6455
|
sensitivity?: AnomalyDetectionSensitivityEnum;
|
|
6456
6456
|
/**
|
|
6457
|
-
* Date granularity for anomaly detection. Only time-based granularities are supported (
|
|
6457
|
+
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
6458
6458
|
*/
|
|
6459
6459
|
granularity: AnomalyDetectionGranularityEnum;
|
|
6460
6460
|
}
|
|
6461
6461
|
|
|
6462
|
-
export declare type AnomalyDetectionGranularityEnum = "
|
|
6462
|
+
export declare type AnomalyDetectionGranularityEnum = "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR";
|
|
6463
6463
|
|
|
6464
6464
|
export declare interface AnomalyDetectionRequest {
|
|
6465
6465
|
/**
|
|
@@ -7742,6 +7742,7 @@ export declare interface AttributeHeaderAttributeHeader {
|
|
|
7742
7742
|
* Attribute value type.
|
|
7743
7743
|
*/
|
|
7744
7744
|
valueType?: AttributeHeaderAttributeHeaderValueTypeEnum;
|
|
7745
|
+
geoAreaConfig?: GeoAreaConfig_2;
|
|
7745
7746
|
}
|
|
7746
7747
|
|
|
7747
7748
|
export declare type AttributeHeaderAttributeHeaderGranularityEnum = "MINUTE" | "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR" | "MINUTE_OF_HOUR" | "HOUR_OF_DAY" | "DAY_OF_WEEK" | "DAY_OF_MONTH" | "DAY_OF_QUARTER" | "DAY_OF_YEAR" | "WEEK_OF_YEAR" | "MONTH_OF_YEAR" | "QUARTER_OF_YEAR";
|
|
@@ -8332,6 +8333,15 @@ export declare class AttributesApi extends MetadataBaseApi implements Attributes
|
|
|
8332
8333
|
* @memberof AttributesApi
|
|
8333
8334
|
*/
|
|
8334
8335
|
getEntityAttributes(requestParameters: AttributesApiGetEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
8336
|
+
/**
|
|
8337
|
+
*
|
|
8338
|
+
* @summary Patch an Attribute (beta)
|
|
8339
|
+
* @param {AttributesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
8340
|
+
* @param {*} [options] Override http request option.
|
|
8341
|
+
* @throws {RequiredError}
|
|
8342
|
+
* @memberof AttributesApi
|
|
8343
|
+
*/
|
|
8344
|
+
patchEntityAttributes(requestParameters: AttributesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
8335
8345
|
}
|
|
8336
8346
|
|
|
8337
8347
|
/**
|
|
@@ -8358,6 +8368,18 @@ export declare function AttributesApi_GetAllEntitiesAttributes(axios: AxiosInsta
|
|
|
8358
8368
|
*/
|
|
8359
8369
|
export declare function AttributesApi_GetEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: AttributesApiGetEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
8360
8370
|
|
|
8371
|
+
/**
|
|
8372
|
+
*
|
|
8373
|
+
* @summary Patch an Attribute (beta)
|
|
8374
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
8375
|
+
* @param {string} basePath Base path.
|
|
8376
|
+
* @param {AttributesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
8377
|
+
* @param {*} [options] Override http request option.
|
|
8378
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8379
|
+
* @throws {RequiredError}
|
|
8380
|
+
*/
|
|
8381
|
+
export declare function AttributesApi_PatchEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: AttributesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
8382
|
+
|
|
8361
8383
|
/**
|
|
8362
8384
|
*
|
|
8363
8385
|
* @summary Get all Attributes
|
|
@@ -8391,6 +8413,20 @@ export declare function AttributesApiAxiosParamCreator_GetAllEntitiesAttributes(
|
|
|
8391
8413
|
*/
|
|
8392
8414
|
export declare function AttributesApiAxiosParamCreator_GetEntityAttributes(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
8393
8415
|
|
|
8416
|
+
/**
|
|
8417
|
+
*
|
|
8418
|
+
* @summary Patch an Attribute (beta)
|
|
8419
|
+
* @param {string} workspaceId
|
|
8420
|
+
* @param {string} objectId
|
|
8421
|
+
* @param {JsonApiAttributePatchDocument} jsonApiAttributePatchDocument
|
|
8422
|
+
* @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\').
|
|
8423
|
+
* @param {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | '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.
|
|
8424
|
+
* @param {*} [options] Override http request option.
|
|
8425
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
8426
|
+
* @throws {RequiredError}
|
|
8427
|
+
*/
|
|
8428
|
+
export declare function AttributesApiAxiosParamCreator_PatchEntityAttributes(workspaceId: string, objectId: string, jsonApiAttributePatchDocument: JsonApiAttributePatchDocument, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
8429
|
+
|
|
8394
8430
|
/**
|
|
8395
8431
|
* Request parameters for getAllEntitiesAttributes operation in AttributesApi.
|
|
8396
8432
|
* @export
|
|
@@ -8521,6 +8557,53 @@ export declare interface AttributesApiInterface {
|
|
|
8521
8557
|
* @memberof AttributesApiInterface
|
|
8522
8558
|
*/
|
|
8523
8559
|
getEntityAttributes(requestParameters: AttributesApiGetEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
8560
|
+
/**
|
|
8561
|
+
*
|
|
8562
|
+
* @summary Patch an Attribute (beta)
|
|
8563
|
+
* @param {AttributesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
8564
|
+
* @param {*} [options] Override http request option.
|
|
8565
|
+
* @throws {RequiredError}
|
|
8566
|
+
* @memberof AttributesApiInterface
|
|
8567
|
+
*/
|
|
8568
|
+
patchEntityAttributes(requestParameters: AttributesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
8569
|
+
}
|
|
8570
|
+
|
|
8571
|
+
/**
|
|
8572
|
+
* Request parameters for patchEntityAttributes operation in AttributesApi.
|
|
8573
|
+
* @export
|
|
8574
|
+
* @interface AttributesApiPatchEntityAttributesRequest
|
|
8575
|
+
*/
|
|
8576
|
+
export declare interface AttributesApiPatchEntityAttributesRequest {
|
|
8577
|
+
/**
|
|
8578
|
+
*
|
|
8579
|
+
* @type {string}
|
|
8580
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
8581
|
+
*/
|
|
8582
|
+
readonly workspaceId: string;
|
|
8583
|
+
/**
|
|
8584
|
+
*
|
|
8585
|
+
* @type {string}
|
|
8586
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
8587
|
+
*/
|
|
8588
|
+
readonly objectId: string;
|
|
8589
|
+
/**
|
|
8590
|
+
*
|
|
8591
|
+
* @type {JsonApiAttributePatchDocument}
|
|
8592
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
8593
|
+
*/
|
|
8594
|
+
readonly jsonApiAttributePatchDocument: JsonApiAttributePatchDocument;
|
|
8595
|
+
/**
|
|
8596
|
+
* 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\').
|
|
8597
|
+
* @type {string}
|
|
8598
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
8599
|
+
*/
|
|
8600
|
+
readonly filter?: string;
|
|
8601
|
+
/**
|
|
8602
|
+
* 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.
|
|
8603
|
+
* @type {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | 'ALL'>}
|
|
8604
|
+
* @memberof AttributesApiPatchEntityAttributes
|
|
8605
|
+
*/
|
|
8606
|
+
readonly include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">;
|
|
8524
8607
|
}
|
|
8525
8608
|
|
|
8526
8609
|
/**
|
|
@@ -8775,12 +8858,12 @@ declare interface AutomationAnomalyDetection {
|
|
|
8775
8858
|
*/
|
|
8776
8859
|
sensitivity?: AutomationAnomalyDetectionSensitivityEnum;
|
|
8777
8860
|
/**
|
|
8778
|
-
* Date granularity for anomaly detection. Only time-based granularities are supported (
|
|
8861
|
+
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
8779
8862
|
*/
|
|
8780
8863
|
granularity: AutomationAnomalyDetectionGranularityEnum;
|
|
8781
8864
|
}
|
|
8782
8865
|
|
|
8783
|
-
declare type AutomationAnomalyDetectionGranularityEnum = "
|
|
8866
|
+
declare type AutomationAnomalyDetectionGranularityEnum = "HOUR" | "DAY" | "WEEK" | "MONTH" | "QUARTER" | "YEAR";
|
|
8784
8867
|
|
|
8785
8868
|
declare type AutomationAnomalyDetectionSensitivityEnum = "LOW" | "MEDIUM" | "HIGH";
|
|
8786
8869
|
|
|
@@ -16103,6 +16186,15 @@ export declare class DatasetsApi extends MetadataBaseApi implements DatasetsApiI
|
|
|
16103
16186
|
* @memberof DatasetsApi
|
|
16104
16187
|
*/
|
|
16105
16188
|
getEntityDatasets(requestParameters: DatasetsApiGetEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
16189
|
+
/**
|
|
16190
|
+
*
|
|
16191
|
+
* @summary Patch a Dataset (beta)
|
|
16192
|
+
* @param {DatasetsApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
16193
|
+
* @param {*} [options] Override http request option.
|
|
16194
|
+
* @throws {RequiredError}
|
|
16195
|
+
* @memberof DatasetsApi
|
|
16196
|
+
*/
|
|
16197
|
+
patchEntityDatasets(requestParameters: DatasetsApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
16106
16198
|
}
|
|
16107
16199
|
|
|
16108
16200
|
/**
|
|
@@ -16129,6 +16221,18 @@ export declare function DatasetsApi_GetAllEntitiesDatasets(axios: AxiosInstance,
|
|
|
16129
16221
|
*/
|
|
16130
16222
|
export declare function DatasetsApi_GetEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: DatasetsApiGetEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
16131
16223
|
|
|
16224
|
+
/**
|
|
16225
|
+
*
|
|
16226
|
+
* @summary Patch a Dataset (beta)
|
|
16227
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
16228
|
+
* @param {string} basePath Base path.
|
|
16229
|
+
* @param {DatasetsApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
16230
|
+
* @param {*} [options] Override http request option.
|
|
16231
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
16232
|
+
* @throws {RequiredError}
|
|
16233
|
+
*/
|
|
16234
|
+
export declare function DatasetsApi_PatchEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: DatasetsApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
16235
|
+
|
|
16132
16236
|
/**
|
|
16133
16237
|
*
|
|
16134
16238
|
* @summary Get all Datasets
|
|
@@ -16162,6 +16266,20 @@ export declare function DatasetsApiAxiosParamCreator_GetAllEntitiesDatasets(work
|
|
|
16162
16266
|
*/
|
|
16163
16267
|
export declare function DatasetsApiAxiosParamCreator_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, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
16164
16268
|
|
|
16269
|
+
/**
|
|
16270
|
+
*
|
|
16271
|
+
* @summary Patch a Dataset (beta)
|
|
16272
|
+
* @param {string} workspaceId
|
|
16273
|
+
* @param {string} objectId
|
|
16274
|
+
* @param {JsonApiDatasetPatchDocument} jsonApiDatasetPatchDocument
|
|
16275
|
+
* @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\').
|
|
16276
|
+
* @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.
|
|
16277
|
+
* @param {*} [options] Override http request option.
|
|
16278
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
16279
|
+
* @throws {RequiredError}
|
|
16280
|
+
*/
|
|
16281
|
+
export declare function DatasetsApiAxiosParamCreator_PatchEntityDatasets(workspaceId: string, objectId: string, jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
16282
|
+
|
|
16165
16283
|
/**
|
|
16166
16284
|
* Request parameters for getAllEntitiesDatasets operation in DatasetsApi.
|
|
16167
16285
|
* @export
|
|
@@ -16292,6 +16410,53 @@ export declare interface DatasetsApiInterface {
|
|
|
16292
16410
|
* @memberof DatasetsApiInterface
|
|
16293
16411
|
*/
|
|
16294
16412
|
getEntityDatasets(requestParameters: DatasetsApiGetEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
16413
|
+
/**
|
|
16414
|
+
*
|
|
16415
|
+
* @summary Patch a Dataset (beta)
|
|
16416
|
+
* @param {DatasetsApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
16417
|
+
* @param {*} [options] Override http request option.
|
|
16418
|
+
* @throws {RequiredError}
|
|
16419
|
+
* @memberof DatasetsApiInterface
|
|
16420
|
+
*/
|
|
16421
|
+
patchEntityDatasets(requestParameters: DatasetsApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
16422
|
+
}
|
|
16423
|
+
|
|
16424
|
+
/**
|
|
16425
|
+
* Request parameters for patchEntityDatasets operation in DatasetsApi.
|
|
16426
|
+
* @export
|
|
16427
|
+
* @interface DatasetsApiPatchEntityDatasetsRequest
|
|
16428
|
+
*/
|
|
16429
|
+
export declare interface DatasetsApiPatchEntityDatasetsRequest {
|
|
16430
|
+
/**
|
|
16431
|
+
*
|
|
16432
|
+
* @type {string}
|
|
16433
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
16434
|
+
*/
|
|
16435
|
+
readonly workspaceId: string;
|
|
16436
|
+
/**
|
|
16437
|
+
*
|
|
16438
|
+
* @type {string}
|
|
16439
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
16440
|
+
*/
|
|
16441
|
+
readonly objectId: string;
|
|
16442
|
+
/**
|
|
16443
|
+
*
|
|
16444
|
+
* @type {JsonApiDatasetPatchDocument}
|
|
16445
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
16446
|
+
*/
|
|
16447
|
+
readonly jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument;
|
|
16448
|
+
/**
|
|
16449
|
+
* 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\').
|
|
16450
|
+
* @type {string}
|
|
16451
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
16452
|
+
*/
|
|
16453
|
+
readonly filter?: string;
|
|
16454
|
+
/**
|
|
16455
|
+
* 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.
|
|
16456
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
16457
|
+
* @memberof DatasetsApiPatchEntityDatasets
|
|
16458
|
+
*/
|
|
16459
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
16295
16460
|
}
|
|
16296
16461
|
|
|
16297
16462
|
/**
|
|
@@ -18322,7 +18487,7 @@ export declare interface DeclarativeSetting {
|
|
|
18322
18487
|
type?: DeclarativeSettingTypeEnum;
|
|
18323
18488
|
}
|
|
18324
18489
|
|
|
18325
|
-
export declare type DeclarativeSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE";
|
|
18490
|
+
export declare type DeclarativeSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE" | "ENABLE_AI_ON_DATA";
|
|
18326
18491
|
|
|
18327
18492
|
export declare interface DeclarativeSingleWorkspacePermission {
|
|
18328
18493
|
/**
|
|
@@ -20432,6 +20597,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
20432
20597
|
* @memberof EntitiesApi
|
|
20433
20598
|
*/
|
|
20434
20599
|
patchEntityAttributeHierarchies(requestParameters: EntitiesApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
20600
|
+
/**
|
|
20601
|
+
*
|
|
20602
|
+
* @summary Patch an Attribute (beta)
|
|
20603
|
+
* @param {EntitiesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
20604
|
+
* @param {*} [options] Override http request option.
|
|
20605
|
+
* @throws {RequiredError}
|
|
20606
|
+
* @memberof EntitiesApi
|
|
20607
|
+
*/
|
|
20608
|
+
patchEntityAttributes(requestParameters: EntitiesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
20435
20609
|
/**
|
|
20436
20610
|
*
|
|
20437
20611
|
* @summary Patch an Automation
|
|
@@ -20495,6 +20669,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
20495
20669
|
* @memberof EntitiesApi
|
|
20496
20670
|
*/
|
|
20497
20671
|
patchEntityDataSources(requestParameters: EntitiesApiPatchEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
20672
|
+
/**
|
|
20673
|
+
*
|
|
20674
|
+
* @summary Patch a Dataset (beta)
|
|
20675
|
+
* @param {EntitiesApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
20676
|
+
* @param {*} [options] Override http request option.
|
|
20677
|
+
* @throws {RequiredError}
|
|
20678
|
+
* @memberof EntitiesApi
|
|
20679
|
+
*/
|
|
20680
|
+
patchEntityDatasets(requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
20498
20681
|
/**
|
|
20499
20682
|
*
|
|
20500
20683
|
* @summary Patch an Export Definition
|
|
@@ -20513,6 +20696,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
20513
20696
|
* @memberof EntitiesApi
|
|
20514
20697
|
*/
|
|
20515
20698
|
patchEntityExportTemplates(requestParameters: EntitiesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
20699
|
+
/**
|
|
20700
|
+
*
|
|
20701
|
+
* @summary Patch a Fact (beta)
|
|
20702
|
+
* @param {EntitiesApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
20703
|
+
* @param {*} [options] Override http request option.
|
|
20704
|
+
* @throws {RequiredError}
|
|
20705
|
+
* @memberof EntitiesApi
|
|
20706
|
+
*/
|
|
20707
|
+
patchEntityFacts(requestParameters: EntitiesApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
20516
20708
|
/**
|
|
20517
20709
|
*
|
|
20518
20710
|
* @summary Patch a Context Filter
|
|
@@ -20549,6 +20741,15 @@ export declare class EntitiesApi extends MetadataBaseApi implements EntitiesApiI
|
|
|
20549
20741
|
* @memberof EntitiesApi
|
|
20550
20742
|
*/
|
|
20551
20743
|
patchEntityJwks(requestParameters: EntitiesApiPatchEntityJwksRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiJwkOutDocument>;
|
|
20744
|
+
/**
|
|
20745
|
+
*
|
|
20746
|
+
* @summary Patch a Label (beta)
|
|
20747
|
+
* @param {EntitiesApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
20748
|
+
* @param {*} [options] Override http request option.
|
|
20749
|
+
* @throws {RequiredError}
|
|
20750
|
+
* @memberof EntitiesApi
|
|
20751
|
+
*/
|
|
20752
|
+
patchEntityLabels(requestParameters: EntitiesApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
20552
20753
|
/**
|
|
20553
20754
|
*
|
|
20554
20755
|
* @summary Patch LLM endpoint entity
|
|
@@ -22894,6 +23095,18 @@ export declare function EntitiesApi_PatchEntityAnalyticalDashboards(axios: Axios
|
|
|
22894
23095
|
*/
|
|
22895
23096
|
export declare function EntitiesApi_PatchEntityAttributeHierarchies(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
22896
23097
|
|
|
23098
|
+
/**
|
|
23099
|
+
*
|
|
23100
|
+
* @summary Patch an Attribute (beta)
|
|
23101
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23102
|
+
* @param {string} basePath Base path.
|
|
23103
|
+
* @param {EntitiesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
23104
|
+
* @param {*} [options] Override http request option.
|
|
23105
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23106
|
+
* @throws {RequiredError}
|
|
23107
|
+
*/
|
|
23108
|
+
export declare function EntitiesApi_PatchEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
23109
|
+
|
|
22897
23110
|
/**
|
|
22898
23111
|
*
|
|
22899
23112
|
* @summary Patch an Automation
|
|
@@ -22966,6 +23179,18 @@ export declare function EntitiesApi_PatchEntityCustomApplicationSettings(axios:
|
|
|
22966
23179
|
*/
|
|
22967
23180
|
export declare function EntitiesApi_PatchEntityDashboardPlugins(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
22968
23181
|
|
|
23182
|
+
/**
|
|
23183
|
+
*
|
|
23184
|
+
* @summary Patch a Dataset (beta)
|
|
23185
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23186
|
+
* @param {string} basePath Base path.
|
|
23187
|
+
* @param {EntitiesApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
23188
|
+
* @param {*} [options] Override http request option.
|
|
23189
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23190
|
+
* @throws {RequiredError}
|
|
23191
|
+
*/
|
|
23192
|
+
export declare function EntitiesApi_PatchEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
23193
|
+
|
|
22969
23194
|
/**
|
|
22970
23195
|
* Data Source - represents data source for the workspace
|
|
22971
23196
|
* @summary Patch Data Source entity
|
|
@@ -23002,6 +23227,18 @@ export declare function EntitiesApi_PatchEntityExportDefinitions(axios: AxiosIns
|
|
|
23002
23227
|
*/
|
|
23003
23228
|
export declare function EntitiesApi_PatchEntityExportTemplates(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
23004
23229
|
|
|
23230
|
+
/**
|
|
23231
|
+
*
|
|
23232
|
+
* @summary Patch a Fact (beta)
|
|
23233
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23234
|
+
* @param {string} basePath Base path.
|
|
23235
|
+
* @param {EntitiesApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
23236
|
+
* @param {*} [options] Override http request option.
|
|
23237
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23238
|
+
* @throws {RequiredError}
|
|
23239
|
+
*/
|
|
23240
|
+
export declare function EntitiesApi_PatchEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityFactsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiFactOutDocument>;
|
|
23241
|
+
|
|
23005
23242
|
/**
|
|
23006
23243
|
*
|
|
23007
23244
|
* @summary Patch a Context Filter
|
|
@@ -23050,6 +23287,18 @@ export declare function EntitiesApi_PatchEntityIdentityProviders(axios: AxiosIns
|
|
|
23050
23287
|
*/
|
|
23051
23288
|
export declare function EntitiesApi_PatchEntityJwks(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityJwksRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiJwkOutDocument>;
|
|
23052
23289
|
|
|
23290
|
+
/**
|
|
23291
|
+
*
|
|
23292
|
+
* @summary Patch a Label (beta)
|
|
23293
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
23294
|
+
* @param {string} basePath Base path.
|
|
23295
|
+
* @param {EntitiesApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
23296
|
+
* @param {*} [options] Override http request option.
|
|
23297
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
23298
|
+
* @throws {RequiredError}
|
|
23299
|
+
*/
|
|
23300
|
+
export declare function EntitiesApi_PatchEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: EntitiesApiPatchEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
23301
|
+
|
|
23053
23302
|
/**
|
|
23054
23303
|
*
|
|
23055
23304
|
* @summary Patch LLM endpoint entity
|
|
@@ -25776,6 +26025,20 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityAnalyticalDashbo
|
|
|
25776
26025
|
*/
|
|
25777
26026
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityAttributeHierarchies(workspaceId: string, objectId: string, jsonApiAttributeHierarchyPatchDocument: JsonApiAttributeHierarchyPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
25778
26027
|
|
|
26028
|
+
/**
|
|
26029
|
+
*
|
|
26030
|
+
* @summary Patch an Attribute (beta)
|
|
26031
|
+
* @param {string} workspaceId
|
|
26032
|
+
* @param {string} objectId
|
|
26033
|
+
* @param {JsonApiAttributePatchDocument} jsonApiAttributePatchDocument
|
|
26034
|
+
* @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\').
|
|
26035
|
+
* @param {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | '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.
|
|
26036
|
+
* @param {*} [options] Override http request option.
|
|
26037
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
26038
|
+
* @throws {RequiredError}
|
|
26039
|
+
*/
|
|
26040
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityAttributes(workspaceId: string, objectId: string, jsonApiAttributePatchDocument: JsonApiAttributePatchDocument, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
26041
|
+
|
|
25779
26042
|
/**
|
|
25780
26043
|
*
|
|
25781
26044
|
* @summary Patch an Automation
|
|
@@ -25853,6 +26116,20 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityCustomApplicatio
|
|
|
25853
26116
|
*/
|
|
25854
26117
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityDashboardPlugins(workspaceId: string, objectId: string, jsonApiDashboardPluginPatchDocument: JsonApiDashboardPluginPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
25855
26118
|
|
|
26119
|
+
/**
|
|
26120
|
+
*
|
|
26121
|
+
* @summary Patch a Dataset (beta)
|
|
26122
|
+
* @param {string} workspaceId
|
|
26123
|
+
* @param {string} objectId
|
|
26124
|
+
* @param {JsonApiDatasetPatchDocument} jsonApiDatasetPatchDocument
|
|
26125
|
+
* @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\').
|
|
26126
|
+
* @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.
|
|
26127
|
+
* @param {*} [options] Override http request option.
|
|
26128
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
26129
|
+
* @throws {RequiredError}
|
|
26130
|
+
*/
|
|
26131
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityDatasets(workspaceId: string, objectId: string, jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
26132
|
+
|
|
25856
26133
|
/**
|
|
25857
26134
|
* Data Source - represents data source for the workspace
|
|
25858
26135
|
* @summary Patch Data Source entity
|
|
@@ -25891,6 +26168,20 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityExportDefinition
|
|
|
25891
26168
|
*/
|
|
25892
26169
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityExportTemplates(id: string, jsonApiExportTemplatePatchDocument: JsonApiExportTemplatePatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
25893
26170
|
|
|
26171
|
+
/**
|
|
26172
|
+
*
|
|
26173
|
+
* @summary Patch a Fact (beta)
|
|
26174
|
+
* @param {string} workspaceId
|
|
26175
|
+
* @param {string} objectId
|
|
26176
|
+
* @param {JsonApiFactPatchDocument} jsonApiFactPatchDocument
|
|
26177
|
+
* @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\').
|
|
26178
|
+
* @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.
|
|
26179
|
+
* @param {*} [options] Override http request option.
|
|
26180
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
26181
|
+
* @throws {RequiredError}
|
|
26182
|
+
*/
|
|
26183
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityFacts(workspaceId: string, objectId: string, jsonApiFactPatchDocument: JsonApiFactPatchDocument, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
26184
|
+
|
|
25894
26185
|
/**
|
|
25895
26186
|
*
|
|
25896
26187
|
* @summary Patch a Context Filter
|
|
@@ -25943,6 +26234,20 @@ export declare function EntitiesApiAxiosParamCreator_PatchEntityIdentityProvider
|
|
|
25943
26234
|
*/
|
|
25944
26235
|
export declare function EntitiesApiAxiosParamCreator_PatchEntityJwks(id: string, jsonApiJwkPatchDocument: JsonApiJwkPatchDocument, filter?: string, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
25945
26236
|
|
|
26237
|
+
/**
|
|
26238
|
+
*
|
|
26239
|
+
* @summary Patch a Label (beta)
|
|
26240
|
+
* @param {string} workspaceId
|
|
26241
|
+
* @param {string} objectId
|
|
26242
|
+
* @param {JsonApiLabelPatchDocument} jsonApiLabelPatchDocument
|
|
26243
|
+
* @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\').
|
|
26244
|
+
* @param {Array<'attributes' | 'attribute' | '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.
|
|
26245
|
+
* @param {*} [options] Override http request option.
|
|
26246
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
26247
|
+
* @throws {RequiredError}
|
|
26248
|
+
*/
|
|
26249
|
+
export declare function EntitiesApiAxiosParamCreator_PatchEntityLabels(workspaceId: string, objectId: string, jsonApiLabelPatchDocument: JsonApiLabelPatchDocument, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
26250
|
+
|
|
25946
26251
|
/**
|
|
25947
26252
|
*
|
|
25948
26253
|
* @summary Patch LLM endpoint entity
|
|
@@ -32922,6 +33227,15 @@ export declare interface EntitiesApiInterface {
|
|
|
32922
33227
|
* @memberof EntitiesApiInterface
|
|
32923
33228
|
*/
|
|
32924
33229
|
patchEntityAttributeHierarchies(requestParameters: EntitiesApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
33230
|
+
/**
|
|
33231
|
+
*
|
|
33232
|
+
* @summary Patch an Attribute (beta)
|
|
33233
|
+
* @param {EntitiesApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
33234
|
+
* @param {*} [options] Override http request option.
|
|
33235
|
+
* @throws {RequiredError}
|
|
33236
|
+
* @memberof EntitiesApiInterface
|
|
33237
|
+
*/
|
|
33238
|
+
patchEntityAttributes(requestParameters: EntitiesApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
32925
33239
|
/**
|
|
32926
33240
|
*
|
|
32927
33241
|
* @summary Patch an Automation
|
|
@@ -32985,6 +33299,15 @@ export declare interface EntitiesApiInterface {
|
|
|
32985
33299
|
* @memberof EntitiesApiInterface
|
|
32986
33300
|
*/
|
|
32987
33301
|
patchEntityDataSources(requestParameters: EntitiesApiPatchEntityDataSourcesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDataSourceOutDocument>;
|
|
33302
|
+
/**
|
|
33303
|
+
*
|
|
33304
|
+
* @summary Patch a Dataset (beta)
|
|
33305
|
+
* @param {EntitiesApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
33306
|
+
* @param {*} [options] Override http request option.
|
|
33307
|
+
* @throws {RequiredError}
|
|
33308
|
+
* @memberof EntitiesApiInterface
|
|
33309
|
+
*/
|
|
33310
|
+
patchEntityDatasets(requestParameters: EntitiesApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
32988
33311
|
/**
|
|
32989
33312
|
*
|
|
32990
33313
|
* @summary Patch an Export Definition
|
|
@@ -33003,6 +33326,15 @@ export declare interface EntitiesApiInterface {
|
|
|
33003
33326
|
* @memberof EntitiesApiInterface
|
|
33004
33327
|
*/
|
|
33005
33328
|
patchEntityExportTemplates(requestParameters: EntitiesApiPatchEntityExportTemplatesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportTemplateOutDocument>;
|
|
33329
|
+
/**
|
|
33330
|
+
*
|
|
33331
|
+
* @summary Patch a Fact (beta)
|
|
33332
|
+
* @param {EntitiesApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
33333
|
+
* @param {*} [options] Override http request option.
|
|
33334
|
+
* @throws {RequiredError}
|
|
33335
|
+
* @memberof EntitiesApiInterface
|
|
33336
|
+
*/
|
|
33337
|
+
patchEntityFacts(requestParameters: EntitiesApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
33006
33338
|
/**
|
|
33007
33339
|
*
|
|
33008
33340
|
* @summary Patch a Context Filter
|
|
@@ -33039,6 +33371,15 @@ export declare interface EntitiesApiInterface {
|
|
|
33039
33371
|
* @memberof EntitiesApiInterface
|
|
33040
33372
|
*/
|
|
33041
33373
|
patchEntityJwks(requestParameters: EntitiesApiPatchEntityJwksRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiJwkOutDocument>;
|
|
33374
|
+
/**
|
|
33375
|
+
*
|
|
33376
|
+
* @summary Patch a Label (beta)
|
|
33377
|
+
* @param {EntitiesApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
33378
|
+
* @param {*} [options] Override http request option.
|
|
33379
|
+
* @throws {RequiredError}
|
|
33380
|
+
* @memberof EntitiesApiInterface
|
|
33381
|
+
*/
|
|
33382
|
+
patchEntityLabels(requestParameters: EntitiesApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
33042
33383
|
/**
|
|
33043
33384
|
*
|
|
33044
33385
|
* @summary Patch LLM endpoint entity
|
|
@@ -33717,6 +34058,44 @@ export declare interface EntitiesApiPatchEntityAttributeHierarchiesRequest {
|
|
|
33717
34058
|
readonly include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">;
|
|
33718
34059
|
}
|
|
33719
34060
|
|
|
34061
|
+
/**
|
|
34062
|
+
* Request parameters for patchEntityAttributes operation in EntitiesApi.
|
|
34063
|
+
* @export
|
|
34064
|
+
* @interface EntitiesApiPatchEntityAttributesRequest
|
|
34065
|
+
*/
|
|
34066
|
+
export declare interface EntitiesApiPatchEntityAttributesRequest {
|
|
34067
|
+
/**
|
|
34068
|
+
*
|
|
34069
|
+
* @type {string}
|
|
34070
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
34071
|
+
*/
|
|
34072
|
+
readonly workspaceId: string;
|
|
34073
|
+
/**
|
|
34074
|
+
*
|
|
34075
|
+
* @type {string}
|
|
34076
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
34077
|
+
*/
|
|
34078
|
+
readonly objectId: string;
|
|
34079
|
+
/**
|
|
34080
|
+
*
|
|
34081
|
+
* @type {JsonApiAttributePatchDocument}
|
|
34082
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
34083
|
+
*/
|
|
34084
|
+
readonly jsonApiAttributePatchDocument: JsonApiAttributePatchDocument;
|
|
34085
|
+
/**
|
|
34086
|
+
* 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\').
|
|
34087
|
+
* @type {string}
|
|
34088
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
34089
|
+
*/
|
|
34090
|
+
readonly filter?: string;
|
|
34091
|
+
/**
|
|
34092
|
+
* 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.
|
|
34093
|
+
* @type {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | 'ALL'>}
|
|
34094
|
+
* @memberof EntitiesApiPatchEntityAttributes
|
|
34095
|
+
*/
|
|
34096
|
+
readonly include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">;
|
|
34097
|
+
}
|
|
34098
|
+
|
|
33720
34099
|
/**
|
|
33721
34100
|
* Request parameters for patchEntityAutomations operation in EntitiesApi.
|
|
33722
34101
|
* @export
|
|
@@ -33903,6 +34282,44 @@ export declare interface EntitiesApiPatchEntityDashboardPluginsRequest {
|
|
|
33903
34282
|
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
33904
34283
|
}
|
|
33905
34284
|
|
|
34285
|
+
/**
|
|
34286
|
+
* Request parameters for patchEntityDatasets operation in EntitiesApi.
|
|
34287
|
+
* @export
|
|
34288
|
+
* @interface EntitiesApiPatchEntityDatasetsRequest
|
|
34289
|
+
*/
|
|
34290
|
+
export declare interface EntitiesApiPatchEntityDatasetsRequest {
|
|
34291
|
+
/**
|
|
34292
|
+
*
|
|
34293
|
+
* @type {string}
|
|
34294
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
34295
|
+
*/
|
|
34296
|
+
readonly workspaceId: string;
|
|
34297
|
+
/**
|
|
34298
|
+
*
|
|
34299
|
+
* @type {string}
|
|
34300
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
34301
|
+
*/
|
|
34302
|
+
readonly objectId: string;
|
|
34303
|
+
/**
|
|
34304
|
+
*
|
|
34305
|
+
* @type {JsonApiDatasetPatchDocument}
|
|
34306
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
34307
|
+
*/
|
|
34308
|
+
readonly jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument;
|
|
34309
|
+
/**
|
|
34310
|
+
* 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\').
|
|
34311
|
+
* @type {string}
|
|
34312
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
34313
|
+
*/
|
|
34314
|
+
readonly filter?: string;
|
|
34315
|
+
/**
|
|
34316
|
+
* 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.
|
|
34317
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
34318
|
+
* @memberof EntitiesApiPatchEntityDatasets
|
|
34319
|
+
*/
|
|
34320
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
34321
|
+
}
|
|
34322
|
+
|
|
33906
34323
|
/**
|
|
33907
34324
|
* Request parameters for patchEntityDataSources operation in EntitiesApi.
|
|
33908
34325
|
* @export
|
|
@@ -33993,6 +34410,44 @@ export declare interface EntitiesApiPatchEntityExportTemplatesRequest {
|
|
|
33993
34410
|
readonly filter?: string;
|
|
33994
34411
|
}
|
|
33995
34412
|
|
|
34413
|
+
/**
|
|
34414
|
+
* Request parameters for patchEntityFacts operation in EntitiesApi.
|
|
34415
|
+
* @export
|
|
34416
|
+
* @interface EntitiesApiPatchEntityFactsRequest
|
|
34417
|
+
*/
|
|
34418
|
+
export declare interface EntitiesApiPatchEntityFactsRequest {
|
|
34419
|
+
/**
|
|
34420
|
+
*
|
|
34421
|
+
* @type {string}
|
|
34422
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
34423
|
+
*/
|
|
34424
|
+
readonly workspaceId: string;
|
|
34425
|
+
/**
|
|
34426
|
+
*
|
|
34427
|
+
* @type {string}
|
|
34428
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
34429
|
+
*/
|
|
34430
|
+
readonly objectId: string;
|
|
34431
|
+
/**
|
|
34432
|
+
*
|
|
34433
|
+
* @type {JsonApiFactPatchDocument}
|
|
34434
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
34435
|
+
*/
|
|
34436
|
+
readonly jsonApiFactPatchDocument: JsonApiFactPatchDocument;
|
|
34437
|
+
/**
|
|
34438
|
+
* 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\').
|
|
34439
|
+
* @type {string}
|
|
34440
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
34441
|
+
*/
|
|
34442
|
+
readonly filter?: string;
|
|
34443
|
+
/**
|
|
34444
|
+
* 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.
|
|
34445
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
34446
|
+
* @memberof EntitiesApiPatchEntityFacts
|
|
34447
|
+
*/
|
|
34448
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
34449
|
+
}
|
|
34450
|
+
|
|
33996
34451
|
/**
|
|
33997
34452
|
* Request parameters for patchEntityFilterContexts operation in EntitiesApi.
|
|
33998
34453
|
* @export
|
|
@@ -34121,6 +34576,44 @@ export declare interface EntitiesApiPatchEntityJwksRequest {
|
|
|
34121
34576
|
readonly filter?: string;
|
|
34122
34577
|
}
|
|
34123
34578
|
|
|
34579
|
+
/**
|
|
34580
|
+
* Request parameters for patchEntityLabels operation in EntitiesApi.
|
|
34581
|
+
* @export
|
|
34582
|
+
* @interface EntitiesApiPatchEntityLabelsRequest
|
|
34583
|
+
*/
|
|
34584
|
+
export declare interface EntitiesApiPatchEntityLabelsRequest {
|
|
34585
|
+
/**
|
|
34586
|
+
*
|
|
34587
|
+
* @type {string}
|
|
34588
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
34589
|
+
*/
|
|
34590
|
+
readonly workspaceId: string;
|
|
34591
|
+
/**
|
|
34592
|
+
*
|
|
34593
|
+
* @type {string}
|
|
34594
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
34595
|
+
*/
|
|
34596
|
+
readonly objectId: string;
|
|
34597
|
+
/**
|
|
34598
|
+
*
|
|
34599
|
+
* @type {JsonApiLabelPatchDocument}
|
|
34600
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
34601
|
+
*/
|
|
34602
|
+
readonly jsonApiLabelPatchDocument: JsonApiLabelPatchDocument;
|
|
34603
|
+
/**
|
|
34604
|
+
* 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\').
|
|
34605
|
+
* @type {string}
|
|
34606
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
34607
|
+
*/
|
|
34608
|
+
readonly filter?: string;
|
|
34609
|
+
/**
|
|
34610
|
+
* 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.
|
|
34611
|
+
* @type {Array<'attributes' | 'attribute' | 'ALL'>}
|
|
34612
|
+
* @memberof EntitiesApiPatchEntityLabels
|
|
34613
|
+
*/
|
|
34614
|
+
readonly include?: Array<"attributes" | "attribute" | "ALL">;
|
|
34615
|
+
}
|
|
34616
|
+
|
|
34124
34617
|
/**
|
|
34125
34618
|
* Request parameters for patchEntityLlmEndpoints operation in EntitiesApi.
|
|
34126
34619
|
* @export
|
|
@@ -38767,6 +39260,15 @@ export declare class FactsApi extends MetadataBaseApi implements FactsApiInterfa
|
|
|
38767
39260
|
* @memberof FactsApi
|
|
38768
39261
|
*/
|
|
38769
39262
|
getEntityFacts(requestParameters: FactsApiGetEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
39263
|
+
/**
|
|
39264
|
+
*
|
|
39265
|
+
* @summary Patch a Fact (beta)
|
|
39266
|
+
* @param {FactsApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
39267
|
+
* @param {*} [options] Override http request option.
|
|
39268
|
+
* @throws {RequiredError}
|
|
39269
|
+
* @memberof FactsApi
|
|
39270
|
+
*/
|
|
39271
|
+
patchEntityFacts(requestParameters: FactsApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
38770
39272
|
}
|
|
38771
39273
|
|
|
38772
39274
|
/**
|
|
@@ -38793,6 +39295,18 @@ export declare function FactsApi_GetAllEntitiesFacts(axios: AxiosInstance, baseP
|
|
|
38793
39295
|
*/
|
|
38794
39296
|
export declare function FactsApi_GetEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: FactsApiGetEntityFactsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiFactOutDocument>;
|
|
38795
39297
|
|
|
39298
|
+
/**
|
|
39299
|
+
*
|
|
39300
|
+
* @summary Patch a Fact (beta)
|
|
39301
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
39302
|
+
* @param {string} basePath Base path.
|
|
39303
|
+
* @param {FactsApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
39304
|
+
* @param {*} [options] Override http request option.
|
|
39305
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
39306
|
+
* @throws {RequiredError}
|
|
39307
|
+
*/
|
|
39308
|
+
export declare function FactsApi_PatchEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: FactsApiPatchEntityFactsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiFactOutDocument>;
|
|
39309
|
+
|
|
38796
39310
|
/**
|
|
38797
39311
|
*
|
|
38798
39312
|
* @summary Get all Facts
|
|
@@ -38826,6 +39340,20 @@ export declare function FactsApiAxiosParamCreator_GetAllEntitiesFacts(workspaceI
|
|
|
38826
39340
|
*/
|
|
38827
39341
|
export declare function FactsApiAxiosParamCreator_GetEntityFacts(workspaceId: string, objectId: string, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
38828
39342
|
|
|
39343
|
+
/**
|
|
39344
|
+
*
|
|
39345
|
+
* @summary Patch a Fact (beta)
|
|
39346
|
+
* @param {string} workspaceId
|
|
39347
|
+
* @param {string} objectId
|
|
39348
|
+
* @param {JsonApiFactPatchDocument} jsonApiFactPatchDocument
|
|
39349
|
+
* @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\').
|
|
39350
|
+
* @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.
|
|
39351
|
+
* @param {*} [options] Override http request option.
|
|
39352
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
39353
|
+
* @throws {RequiredError}
|
|
39354
|
+
*/
|
|
39355
|
+
export declare function FactsApiAxiosParamCreator_PatchEntityFacts(workspaceId: string, objectId: string, jsonApiFactPatchDocument: JsonApiFactPatchDocument, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
39356
|
+
|
|
38829
39357
|
/**
|
|
38830
39358
|
* Request parameters for getAllEntitiesFacts operation in FactsApi.
|
|
38831
39359
|
* @export
|
|
@@ -38956,6 +39484,53 @@ export declare interface FactsApiInterface {
|
|
|
38956
39484
|
* @memberof FactsApiInterface
|
|
38957
39485
|
*/
|
|
38958
39486
|
getEntityFacts(requestParameters: FactsApiGetEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
39487
|
+
/**
|
|
39488
|
+
*
|
|
39489
|
+
* @summary Patch a Fact (beta)
|
|
39490
|
+
* @param {FactsApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
39491
|
+
* @param {*} [options] Override http request option.
|
|
39492
|
+
* @throws {RequiredError}
|
|
39493
|
+
* @memberof FactsApiInterface
|
|
39494
|
+
*/
|
|
39495
|
+
patchEntityFacts(requestParameters: FactsApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
39496
|
+
}
|
|
39497
|
+
|
|
39498
|
+
/**
|
|
39499
|
+
* Request parameters for patchEntityFacts operation in FactsApi.
|
|
39500
|
+
* @export
|
|
39501
|
+
* @interface FactsApiPatchEntityFactsRequest
|
|
39502
|
+
*/
|
|
39503
|
+
export declare interface FactsApiPatchEntityFactsRequest {
|
|
39504
|
+
/**
|
|
39505
|
+
*
|
|
39506
|
+
* @type {string}
|
|
39507
|
+
* @memberof FactsApiPatchEntityFacts
|
|
39508
|
+
*/
|
|
39509
|
+
readonly workspaceId: string;
|
|
39510
|
+
/**
|
|
39511
|
+
*
|
|
39512
|
+
* @type {string}
|
|
39513
|
+
* @memberof FactsApiPatchEntityFacts
|
|
39514
|
+
*/
|
|
39515
|
+
readonly objectId: string;
|
|
39516
|
+
/**
|
|
39517
|
+
*
|
|
39518
|
+
* @type {JsonApiFactPatchDocument}
|
|
39519
|
+
* @memberof FactsApiPatchEntityFacts
|
|
39520
|
+
*/
|
|
39521
|
+
readonly jsonApiFactPatchDocument: JsonApiFactPatchDocument;
|
|
39522
|
+
/**
|
|
39523
|
+
* 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\').
|
|
39524
|
+
* @type {string}
|
|
39525
|
+
* @memberof FactsApiPatchEntityFacts
|
|
39526
|
+
*/
|
|
39527
|
+
readonly filter?: string;
|
|
39528
|
+
/**
|
|
39529
|
+
* 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.
|
|
39530
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
39531
|
+
* @memberof FactsApiPatchEntityFacts
|
|
39532
|
+
*/
|
|
39533
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
38959
39534
|
}
|
|
38960
39535
|
|
|
38961
39536
|
export declare type FeatureContext = {
|
|
@@ -39868,7 +40443,24 @@ export declare interface GeoAreaConfig {
|
|
|
39868
40443
|
collection: GeoCollection;
|
|
39869
40444
|
}
|
|
39870
40445
|
|
|
40446
|
+
/**
|
|
40447
|
+
* Configuration specific to geo area labels.
|
|
40448
|
+
*/
|
|
40449
|
+
declare interface GeoAreaConfig_2 {
|
|
40450
|
+
collection: GeoCollection_2;
|
|
40451
|
+
}
|
|
40452
|
+
|
|
39871
40453
|
export declare interface GeoCollection {
|
|
40454
|
+
/**
|
|
40455
|
+
* Geo collection identifier.
|
|
40456
|
+
*/
|
|
40457
|
+
id: string;
|
|
40458
|
+
}
|
|
40459
|
+
|
|
40460
|
+
declare interface GeoCollection_2 {
|
|
40461
|
+
/**
|
|
40462
|
+
* Geo collection identifier.
|
|
40463
|
+
*/
|
|
39872
40464
|
id: string;
|
|
39873
40465
|
}
|
|
39874
40466
|
|
|
@@ -41630,7 +42222,7 @@ export declare interface JsonApiAggregatedFactOut {
|
|
|
41630
42222
|
* API identifier of an object
|
|
41631
42223
|
*/
|
|
41632
42224
|
id: string;
|
|
41633
|
-
meta?:
|
|
42225
|
+
meta?: JsonApiDatasetOutMeta;
|
|
41634
42226
|
attributes: JsonApiAggregatedFactOutAttributes;
|
|
41635
42227
|
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
41636
42228
|
}
|
|
@@ -41695,7 +42287,7 @@ export declare interface JsonApiAggregatedFactOutWithLinks {
|
|
|
41695
42287
|
* API identifier of an object
|
|
41696
42288
|
*/
|
|
41697
42289
|
id: string;
|
|
41698
|
-
meta?:
|
|
42290
|
+
meta?: JsonApiDatasetOutMeta;
|
|
41699
42291
|
attributes: JsonApiAggregatedFactOutAttributes;
|
|
41700
42292
|
relationships?: JsonApiAggregatedFactOutRelationships;
|
|
41701
42293
|
links?: ObjectLinks;
|
|
@@ -41796,7 +42388,7 @@ export declare interface JsonApiAnalyticalDashboardOutMeta {
|
|
|
41796
42388
|
* List of valid permissions for a logged-in user.
|
|
41797
42389
|
*/
|
|
41798
42390
|
permissions?: Array<JsonApiAnalyticalDashboardOutMetaPermissionsEnum>;
|
|
41799
|
-
origin?:
|
|
42391
|
+
origin?: JsonApiDatasetOutMetaOrigin;
|
|
41800
42392
|
accessInfo?: JsonApiAnalyticalDashboardOutMetaAccessInfo;
|
|
41801
42393
|
}
|
|
41802
42394
|
|
|
@@ -41807,29 +42399,16 @@ export declare interface JsonApiAnalyticalDashboardOutMetaAccessInfo {
|
|
|
41807
42399
|
private: boolean;
|
|
41808
42400
|
}
|
|
41809
42401
|
|
|
41810
|
-
export declare interface JsonApiAnalyticalDashboardOutMetaOrigin {
|
|
41811
|
-
/**
|
|
41812
|
-
* defines type of the origin of the entity
|
|
41813
|
-
*/
|
|
41814
|
-
originType: JsonApiAnalyticalDashboardOutMetaOriginOriginTypeEnum;
|
|
41815
|
-
/**
|
|
41816
|
-
* defines id of the workspace where the entity comes from
|
|
41817
|
-
*/
|
|
41818
|
-
originId: string;
|
|
41819
|
-
}
|
|
41820
|
-
|
|
41821
|
-
export declare type JsonApiAnalyticalDashboardOutMetaOriginOriginTypeEnum = "NATIVE" | "PARENT";
|
|
41822
|
-
|
|
41823
42402
|
export declare type JsonApiAnalyticalDashboardOutMetaPermissionsEnum = "EDIT" | "SHARE" | "VIEW";
|
|
41824
42403
|
|
|
41825
42404
|
export declare interface JsonApiAnalyticalDashboardOutRelationships {
|
|
41826
|
-
createdBy?:
|
|
41827
|
-
modifiedBy?:
|
|
42405
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
42406
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
41828
42407
|
visualizationObjects?: JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects;
|
|
41829
42408
|
analyticalDashboards?: JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDashboards;
|
|
41830
|
-
labels?:
|
|
41831
|
-
metrics?:
|
|
41832
|
-
datasets?:
|
|
42409
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
42410
|
+
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
42411
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
41833
42412
|
filterContexts?: JsonApiAnalyticalDashboardOutRelationshipsFilterContexts;
|
|
41834
42413
|
dashboardPlugins?: JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins;
|
|
41835
42414
|
}
|
|
@@ -41841,10 +42420,6 @@ export declare interface JsonApiAnalyticalDashboardOutRelationshipsAnalyticalDas
|
|
|
41841
42420
|
data: Array<JsonApiAnalyticalDashboardLinkage>;
|
|
41842
42421
|
}
|
|
41843
42422
|
|
|
41844
|
-
export declare interface JsonApiAnalyticalDashboardOutRelationshipsCreatedBy {
|
|
41845
|
-
data: JsonApiUserIdentifierLinkage | null;
|
|
41846
|
-
}
|
|
41847
|
-
|
|
41848
42423
|
export declare interface JsonApiAnalyticalDashboardOutRelationshipsDashboardPlugins {
|
|
41849
42424
|
/**
|
|
41850
42425
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -41852,13 +42427,6 @@ export declare interface JsonApiAnalyticalDashboardOutRelationshipsDashboardPlug
|
|
|
41852
42427
|
data: Array<JsonApiDashboardPluginLinkage>;
|
|
41853
42428
|
}
|
|
41854
42429
|
|
|
41855
|
-
export declare interface JsonApiAnalyticalDashboardOutRelationshipsDatasets {
|
|
41856
|
-
/**
|
|
41857
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
41858
|
-
*/
|
|
41859
|
-
data: Array<JsonApiDatasetLinkage>;
|
|
41860
|
-
}
|
|
41861
|
-
|
|
41862
42430
|
export declare interface JsonApiAnalyticalDashboardOutRelationshipsFilterContexts {
|
|
41863
42431
|
/**
|
|
41864
42432
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -41866,20 +42434,6 @@ export declare interface JsonApiAnalyticalDashboardOutRelationshipsFilterContext
|
|
|
41866
42434
|
data: Array<JsonApiFilterContextLinkage>;
|
|
41867
42435
|
}
|
|
41868
42436
|
|
|
41869
|
-
export declare interface JsonApiAnalyticalDashboardOutRelationshipsLabels {
|
|
41870
|
-
/**
|
|
41871
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
41872
|
-
*/
|
|
41873
|
-
data: Array<JsonApiLabelLinkage>;
|
|
41874
|
-
}
|
|
41875
|
-
|
|
41876
|
-
export declare interface JsonApiAnalyticalDashboardOutRelationshipsMetrics {
|
|
41877
|
-
/**
|
|
41878
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
41879
|
-
*/
|
|
41880
|
-
data: Array<JsonApiMetricLinkage>;
|
|
41881
|
-
}
|
|
41882
|
-
|
|
41883
42437
|
export declare interface JsonApiAnalyticalDashboardOutRelationshipsVisualizationObjects {
|
|
41884
42438
|
/**
|
|
41885
42439
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -42086,7 +42640,7 @@ export declare interface JsonApiAttributeHierarchyOut {
|
|
|
42086
42640
|
* API identifier of an object
|
|
42087
42641
|
*/
|
|
42088
42642
|
id: string;
|
|
42089
|
-
meta?:
|
|
42643
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42090
42644
|
attributes?: JsonApiAttributeHierarchyOutAttributes;
|
|
42091
42645
|
relationships?: JsonApiAttributeHierarchyOutRelationships;
|
|
42092
42646
|
}
|
|
@@ -42132,8 +42686,8 @@ export declare interface JsonApiAttributeHierarchyOutList {
|
|
|
42132
42686
|
}
|
|
42133
42687
|
|
|
42134
42688
|
export declare interface JsonApiAttributeHierarchyOutRelationships {
|
|
42135
|
-
createdBy?:
|
|
42136
|
-
modifiedBy?:
|
|
42689
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
42690
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
42137
42691
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
42138
42692
|
}
|
|
42139
42693
|
|
|
@@ -42148,7 +42702,7 @@ export declare interface JsonApiAttributeHierarchyOutWithLinks {
|
|
|
42148
42702
|
* API identifier of an object
|
|
42149
42703
|
*/
|
|
42150
42704
|
id: string;
|
|
42151
|
-
meta?:
|
|
42705
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42152
42706
|
attributes?: JsonApiAttributeHierarchyOutAttributes;
|
|
42153
42707
|
relationships?: JsonApiAttributeHierarchyOutRelationships;
|
|
42154
42708
|
links?: ObjectLinks;
|
|
@@ -42199,7 +42753,7 @@ export declare interface JsonApiAttributeOut {
|
|
|
42199
42753
|
* API identifier of an object
|
|
42200
42754
|
*/
|
|
42201
42755
|
id: string;
|
|
42202
|
-
meta?:
|
|
42756
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42203
42757
|
attributes?: JsonApiAttributeOutAttributes;
|
|
42204
42758
|
relationships?: JsonApiAttributeOutRelationships;
|
|
42205
42759
|
}
|
|
@@ -42254,7 +42808,7 @@ export declare interface JsonApiAttributeOutList {
|
|
|
42254
42808
|
export declare interface JsonApiAttributeOutRelationships {
|
|
42255
42809
|
dataset?: JsonApiFactOutRelationshipsDataset;
|
|
42256
42810
|
defaultView?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
42257
|
-
labels?:
|
|
42811
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
42258
42812
|
attributeHierarchies?: JsonApiAttributeOutRelationshipsAttributeHierarchies;
|
|
42259
42813
|
}
|
|
42260
42814
|
|
|
@@ -42280,7 +42834,7 @@ export declare interface JsonApiAttributeOutWithLinks {
|
|
|
42280
42834
|
* API identifier of an object
|
|
42281
42835
|
*/
|
|
42282
42836
|
id: string;
|
|
42283
|
-
meta?:
|
|
42837
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42284
42838
|
attributes?: JsonApiAttributeOutAttributes;
|
|
42285
42839
|
relationships?: JsonApiAttributeOutRelationships;
|
|
42286
42840
|
links?: ObjectLinks;
|
|
@@ -42288,6 +42842,39 @@ export declare interface JsonApiAttributeOutWithLinks {
|
|
|
42288
42842
|
|
|
42289
42843
|
export declare type JsonApiAttributeOutWithLinksTypeEnum = "attribute";
|
|
42290
42844
|
|
|
42845
|
+
/**
|
|
42846
|
+
* JSON:API representation of patching attribute entity.
|
|
42847
|
+
*/
|
|
42848
|
+
export declare interface JsonApiAttributePatch {
|
|
42849
|
+
/**
|
|
42850
|
+
* Object type
|
|
42851
|
+
*/
|
|
42852
|
+
type: JsonApiAttributePatchTypeEnum;
|
|
42853
|
+
/**
|
|
42854
|
+
* API identifier of an object
|
|
42855
|
+
*/
|
|
42856
|
+
id: string;
|
|
42857
|
+
attributes?: JsonApiAttributePatchAttributes;
|
|
42858
|
+
relationships?: JsonApiAttributePatchRelationships;
|
|
42859
|
+
}
|
|
42860
|
+
|
|
42861
|
+
export declare interface JsonApiAttributePatchAttributes {
|
|
42862
|
+
title?: string;
|
|
42863
|
+
description?: string;
|
|
42864
|
+
tags?: Array<string>;
|
|
42865
|
+
locale?: string;
|
|
42866
|
+
}
|
|
42867
|
+
|
|
42868
|
+
export declare interface JsonApiAttributePatchDocument {
|
|
42869
|
+
data: JsonApiAttributePatch;
|
|
42870
|
+
}
|
|
42871
|
+
|
|
42872
|
+
export declare interface JsonApiAttributePatchRelationships {
|
|
42873
|
+
defaultView?: JsonApiAttributeOutRelationshipsDefaultView;
|
|
42874
|
+
}
|
|
42875
|
+
|
|
42876
|
+
export declare type JsonApiAttributePatchTypeEnum = "attribute";
|
|
42877
|
+
|
|
42291
42878
|
/**
|
|
42292
42879
|
* JSON:API representation of automation entity.
|
|
42293
42880
|
*/
|
|
@@ -42313,7 +42900,7 @@ export declare interface JsonApiAutomationInAttributes {
|
|
|
42313
42900
|
* Additional details to be included in the automated message.
|
|
42314
42901
|
*/
|
|
42315
42902
|
details?: object;
|
|
42316
|
-
metadata?:
|
|
42903
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
42317
42904
|
/**
|
|
42318
42905
|
* Current state of the automation.
|
|
42319
42906
|
*/
|
|
@@ -42322,18 +42909,18 @@ export declare interface JsonApiAutomationInAttributes {
|
|
|
42322
42909
|
* Specify automation evaluation mode.
|
|
42323
42910
|
*/
|
|
42324
42911
|
evaluationMode?: JsonApiAutomationInAttributesEvaluationModeEnum;
|
|
42325
|
-
schedule?:
|
|
42326
|
-
alert?:
|
|
42327
|
-
tabularExports?: Array<
|
|
42328
|
-
visualExports?: Array<
|
|
42329
|
-
imageExports?: Array<
|
|
42330
|
-
rawExports?: Array<
|
|
42331
|
-
slidesExports?: Array<
|
|
42332
|
-
dashboardTabularExports?: Array<
|
|
42912
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
42913
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
42914
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
42915
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
42916
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
42917
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
42918
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
42919
|
+
dashboardTabularExports?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
42333
42920
|
/**
|
|
42334
42921
|
* External recipients of the automation action results.
|
|
42335
42922
|
*/
|
|
42336
|
-
externalRecipients?: Array<
|
|
42923
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
42337
42924
|
}
|
|
42338
42925
|
|
|
42339
42926
|
export declare type JsonApiAutomationInAttributesEvaluationModeEnum = "SHARED" | "PER_RECIPIENT";
|
|
@@ -42345,10 +42932,10 @@ export declare interface JsonApiAutomationInDocument {
|
|
|
42345
42932
|
}
|
|
42346
42933
|
|
|
42347
42934
|
export declare interface JsonApiAutomationInRelationships {
|
|
42348
|
-
notificationChannel?:
|
|
42935
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
42349
42936
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
42350
|
-
exportDefinitions?:
|
|
42351
|
-
recipients?:
|
|
42937
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
42938
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
42352
42939
|
}
|
|
42353
42940
|
|
|
42354
42941
|
export declare type JsonApiAutomationInTypeEnum = "automation";
|
|
@@ -42375,11 +42962,119 @@ export declare interface JsonApiAutomationOut {
|
|
|
42375
42962
|
* API identifier of an object
|
|
42376
42963
|
*/
|
|
42377
42964
|
id: string;
|
|
42378
|
-
meta?:
|
|
42379
|
-
attributes?:
|
|
42965
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42966
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
42380
42967
|
relationships?: JsonApiAutomationOutRelationships;
|
|
42381
42968
|
}
|
|
42382
42969
|
|
|
42970
|
+
export declare interface JsonApiAutomationOutAttributes {
|
|
42971
|
+
title?: string;
|
|
42972
|
+
description?: string;
|
|
42973
|
+
tags?: Array<string>;
|
|
42974
|
+
areRelationsValid?: boolean;
|
|
42975
|
+
/**
|
|
42976
|
+
* Additional details to be included in the automated message.
|
|
42977
|
+
*/
|
|
42978
|
+
details?: object;
|
|
42979
|
+
metadata?: JsonApiAutomationOutAttributesMetadata | null;
|
|
42980
|
+
/**
|
|
42981
|
+
* Current state of the automation.
|
|
42982
|
+
*/
|
|
42983
|
+
state?: JsonApiAutomationOutAttributesStateEnum;
|
|
42984
|
+
/**
|
|
42985
|
+
* Specify automation evaluation mode.
|
|
42986
|
+
*/
|
|
42987
|
+
evaluationMode?: JsonApiAutomationOutAttributesEvaluationModeEnum;
|
|
42988
|
+
schedule?: JsonApiAutomationOutAttributesSchedule;
|
|
42989
|
+
alert?: JsonApiAutomationOutAttributesAlert;
|
|
42990
|
+
tabularExports?: Array<JsonApiAutomationOutAttributesTabularExportsInner>;
|
|
42991
|
+
visualExports?: Array<JsonApiAutomationOutAttributesVisualExportsInner>;
|
|
42992
|
+
imageExports?: Array<JsonApiAutomationOutAttributesImageExportsInner>;
|
|
42993
|
+
rawExports?: Array<JsonApiAutomationOutAttributesRawExportsInner>;
|
|
42994
|
+
slidesExports?: Array<JsonApiAutomationOutAttributesSlidesExportsInner>;
|
|
42995
|
+
dashboardTabularExports?: Array<JsonApiAutomationOutAttributesDashboardTabularExportsInner>;
|
|
42996
|
+
/**
|
|
42997
|
+
* External recipients of the automation action results.
|
|
42998
|
+
*/
|
|
42999
|
+
externalRecipients?: Array<JsonApiAutomationOutAttributesExternalRecipientsInner>;
|
|
43000
|
+
createdAt?: string;
|
|
43001
|
+
modifiedAt?: string;
|
|
43002
|
+
}
|
|
43003
|
+
|
|
43004
|
+
export declare interface JsonApiAutomationOutAttributesAlert {
|
|
43005
|
+
execution: AlertAfm;
|
|
43006
|
+
condition: AlertCondition;
|
|
43007
|
+
/**
|
|
43008
|
+
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
43009
|
+
*/
|
|
43010
|
+
trigger?: JsonApiAutomationOutAttributesAlertTriggerEnum;
|
|
43011
|
+
}
|
|
43012
|
+
|
|
43013
|
+
export declare type JsonApiAutomationOutAttributesAlertTriggerEnum = "ALWAYS" | "ONCE";
|
|
43014
|
+
|
|
43015
|
+
export declare interface JsonApiAutomationOutAttributesDashboardTabularExportsInner {
|
|
43016
|
+
requestPayload: DashboardTabularExportRequestV2;
|
|
43017
|
+
}
|
|
43018
|
+
|
|
43019
|
+
export declare type JsonApiAutomationOutAttributesEvaluationModeEnum = "SHARED" | "PER_RECIPIENT";
|
|
43020
|
+
|
|
43021
|
+
export declare interface JsonApiAutomationOutAttributesExternalRecipientsInner {
|
|
43022
|
+
/**
|
|
43023
|
+
* E-mail address to send notifications from.
|
|
43024
|
+
*/
|
|
43025
|
+
email: string;
|
|
43026
|
+
}
|
|
43027
|
+
|
|
43028
|
+
export declare interface JsonApiAutomationOutAttributesImageExportsInner {
|
|
43029
|
+
requestPayload: ImageExportRequest;
|
|
43030
|
+
}
|
|
43031
|
+
|
|
43032
|
+
/**
|
|
43033
|
+
* Additional information for the automation.
|
|
43034
|
+
*/
|
|
43035
|
+
export declare interface JsonApiAutomationOutAttributesMetadata {
|
|
43036
|
+
[key: string]: any;
|
|
43037
|
+
widget?: string;
|
|
43038
|
+
visibleFilters?: Array<VisibleFilter>;
|
|
43039
|
+
}
|
|
43040
|
+
|
|
43041
|
+
export declare interface JsonApiAutomationOutAttributesRawExportsInner {
|
|
43042
|
+
requestPayload: RawExportAutomationRequest;
|
|
43043
|
+
}
|
|
43044
|
+
|
|
43045
|
+
export declare interface JsonApiAutomationOutAttributesSchedule {
|
|
43046
|
+
/**
|
|
43047
|
+
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
43048
|
+
*/
|
|
43049
|
+
cron: string;
|
|
43050
|
+
/**
|
|
43051
|
+
* Human-readable description of the cron expression.
|
|
43052
|
+
*/
|
|
43053
|
+
cronDescription?: string;
|
|
43054
|
+
/**
|
|
43055
|
+
* Timezone in which the schedule is defined.
|
|
43056
|
+
*/
|
|
43057
|
+
timezone: string;
|
|
43058
|
+
/**
|
|
43059
|
+
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
43060
|
+
*/
|
|
43061
|
+
firstRun?: string;
|
|
43062
|
+
}
|
|
43063
|
+
|
|
43064
|
+
export declare interface JsonApiAutomationOutAttributesSlidesExportsInner {
|
|
43065
|
+
requestPayload: SlidesExportRequest;
|
|
43066
|
+
}
|
|
43067
|
+
|
|
43068
|
+
export declare type JsonApiAutomationOutAttributesStateEnum = "ACTIVE" | "PAUSED";
|
|
43069
|
+
|
|
43070
|
+
export declare interface JsonApiAutomationOutAttributesTabularExportsInner {
|
|
43071
|
+
requestPayload: TabularExportRequest;
|
|
43072
|
+
}
|
|
43073
|
+
|
|
43074
|
+
export declare interface JsonApiAutomationOutAttributesVisualExportsInner {
|
|
43075
|
+
requestPayload: VisualExportRequest;
|
|
43076
|
+
}
|
|
43077
|
+
|
|
42383
43078
|
export declare interface JsonApiAutomationOutDocument {
|
|
42384
43079
|
data: JsonApiAutomationOut;
|
|
42385
43080
|
links?: ObjectLinks;
|
|
@@ -42408,13 +43103,38 @@ export declare interface JsonApiAutomationOutList {
|
|
|
42408
43103
|
}
|
|
42409
43104
|
|
|
42410
43105
|
export declare interface JsonApiAutomationOutRelationships {
|
|
42411
|
-
notificationChannel?:
|
|
43106
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
42412
43107
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
42413
|
-
createdBy?:
|
|
42414
|
-
modifiedBy?:
|
|
42415
|
-
exportDefinitions?:
|
|
42416
|
-
recipients?:
|
|
42417
|
-
automationResults?:
|
|
43108
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
43109
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
43110
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
43111
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
43112
|
+
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
43113
|
+
}
|
|
43114
|
+
|
|
43115
|
+
export declare interface JsonApiAutomationOutRelationshipsAutomationResults {
|
|
43116
|
+
/**
|
|
43117
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
43118
|
+
*/
|
|
43119
|
+
data: Array<JsonApiAutomationResultLinkage>;
|
|
43120
|
+
}
|
|
43121
|
+
|
|
43122
|
+
export declare interface JsonApiAutomationOutRelationshipsExportDefinitions {
|
|
43123
|
+
/**
|
|
43124
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
43125
|
+
*/
|
|
43126
|
+
data: Array<JsonApiExportDefinitionLinkage>;
|
|
43127
|
+
}
|
|
43128
|
+
|
|
43129
|
+
export declare interface JsonApiAutomationOutRelationshipsNotificationChannel {
|
|
43130
|
+
data: JsonApiNotificationChannelLinkage | null;
|
|
43131
|
+
}
|
|
43132
|
+
|
|
43133
|
+
export declare interface JsonApiAutomationOutRelationshipsRecipients {
|
|
43134
|
+
/**
|
|
43135
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
43136
|
+
*/
|
|
43137
|
+
data: Array<JsonApiUserLinkage>;
|
|
42418
43138
|
}
|
|
42419
43139
|
|
|
42420
43140
|
export declare type JsonApiAutomationOutTypeEnum = "automation";
|
|
@@ -42428,8 +43148,8 @@ export declare interface JsonApiAutomationOutWithLinks {
|
|
|
42428
43148
|
* API identifier of an object
|
|
42429
43149
|
*/
|
|
42430
43150
|
id: string;
|
|
42431
|
-
meta?:
|
|
42432
|
-
attributes?:
|
|
43151
|
+
meta?: JsonApiDatasetOutMeta;
|
|
43152
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
42433
43153
|
relationships?: JsonApiAutomationOutRelationships;
|
|
42434
43154
|
links?: ObjectLinks;
|
|
42435
43155
|
}
|
|
@@ -42650,15 +43370,7 @@ export declare interface JsonApiCookieSecurityConfigurationIn {
|
|
|
42650
43370
|
* API identifier of an object
|
|
42651
43371
|
*/
|
|
42652
43372
|
id: string;
|
|
42653
|
-
attributes?:
|
|
42654
|
-
}
|
|
42655
|
-
|
|
42656
|
-
export declare interface JsonApiCookieSecurityConfigurationInAttributes {
|
|
42657
|
-
lastRotation?: string;
|
|
42658
|
-
/**
|
|
42659
|
-
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
42660
|
-
*/
|
|
42661
|
-
rotationInterval?: string;
|
|
43373
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
42662
43374
|
}
|
|
42663
43375
|
|
|
42664
43376
|
export declare interface JsonApiCookieSecurityConfigurationInDocument {
|
|
@@ -42679,7 +43391,7 @@ export declare interface JsonApiCookieSecurityConfigurationOut {
|
|
|
42679
43391
|
* API identifier of an object
|
|
42680
43392
|
*/
|
|
42681
43393
|
id: string;
|
|
42682
|
-
attributes?:
|
|
43394
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
42683
43395
|
}
|
|
42684
43396
|
|
|
42685
43397
|
export declare interface JsonApiCookieSecurityConfigurationOutDocument {
|
|
@@ -42701,7 +43413,15 @@ export declare interface JsonApiCookieSecurityConfigurationPatch {
|
|
|
42701
43413
|
* API identifier of an object
|
|
42702
43414
|
*/
|
|
42703
43415
|
id: string;
|
|
42704
|
-
attributes?:
|
|
43416
|
+
attributes?: JsonApiCookieSecurityConfigurationPatchAttributes;
|
|
43417
|
+
}
|
|
43418
|
+
|
|
43419
|
+
export declare interface JsonApiCookieSecurityConfigurationPatchAttributes {
|
|
43420
|
+
lastRotation?: string;
|
|
43421
|
+
/**
|
|
43422
|
+
* Length of interval between automatic rotations expressed in format of ISO 8601 duration
|
|
43423
|
+
*/
|
|
43424
|
+
rotationInterval?: string;
|
|
42705
43425
|
}
|
|
42706
43426
|
|
|
42707
43427
|
export declare interface JsonApiCookieSecurityConfigurationPatchDocument {
|
|
@@ -42839,7 +43559,7 @@ export declare interface JsonApiCustomApplicationSettingOut {
|
|
|
42839
43559
|
* API identifier of an object
|
|
42840
43560
|
*/
|
|
42841
43561
|
id: string;
|
|
42842
|
-
meta?:
|
|
43562
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42843
43563
|
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
42844
43564
|
}
|
|
42845
43565
|
|
|
@@ -42876,7 +43596,7 @@ export declare interface JsonApiCustomApplicationSettingOutWithLinks {
|
|
|
42876
43596
|
* API identifier of an object
|
|
42877
43597
|
*/
|
|
42878
43598
|
id: string;
|
|
42879
|
-
meta?:
|
|
43599
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42880
43600
|
attributes: JsonApiCustomApplicationSettingOutAttributes;
|
|
42881
43601
|
links?: ObjectLinks;
|
|
42882
43602
|
}
|
|
@@ -42945,18 +43665,7 @@ export declare interface JsonApiDashboardPluginIn {
|
|
|
42945
43665
|
* API identifier of an object
|
|
42946
43666
|
*/
|
|
42947
43667
|
id: string;
|
|
42948
|
-
attributes?:
|
|
42949
|
-
}
|
|
42950
|
-
|
|
42951
|
-
export declare interface JsonApiDashboardPluginInAttributes {
|
|
42952
|
-
title?: string;
|
|
42953
|
-
description?: string;
|
|
42954
|
-
tags?: Array<string>;
|
|
42955
|
-
areRelationsValid?: boolean;
|
|
42956
|
-
/**
|
|
42957
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
42958
|
-
*/
|
|
42959
|
-
content?: object;
|
|
43668
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
42960
43669
|
}
|
|
42961
43670
|
|
|
42962
43671
|
export declare interface JsonApiDashboardPluginInDocument {
|
|
@@ -42987,7 +43696,7 @@ export declare interface JsonApiDashboardPluginOut {
|
|
|
42987
43696
|
* API identifier of an object
|
|
42988
43697
|
*/
|
|
42989
43698
|
id: string;
|
|
42990
|
-
meta?:
|
|
43699
|
+
meta?: JsonApiDatasetOutMeta;
|
|
42991
43700
|
attributes?: JsonApiDashboardPluginOutAttributes;
|
|
42992
43701
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
42993
43702
|
}
|
|
@@ -43028,8 +43737,8 @@ export declare interface JsonApiDashboardPluginOutList {
|
|
|
43028
43737
|
}
|
|
43029
43738
|
|
|
43030
43739
|
export declare interface JsonApiDashboardPluginOutRelationships {
|
|
43031
|
-
createdBy?:
|
|
43032
|
-
modifiedBy?:
|
|
43740
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
43741
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
43033
43742
|
}
|
|
43034
43743
|
|
|
43035
43744
|
export declare type JsonApiDashboardPluginOutTypeEnum = "dashboardPlugin";
|
|
@@ -43043,7 +43752,7 @@ export declare interface JsonApiDashboardPluginOutWithLinks {
|
|
|
43043
43752
|
* API identifier of an object
|
|
43044
43753
|
*/
|
|
43045
43754
|
id: string;
|
|
43046
|
-
meta?:
|
|
43755
|
+
meta?: JsonApiDatasetOutMeta;
|
|
43047
43756
|
attributes?: JsonApiDashboardPluginOutAttributes;
|
|
43048
43757
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
43049
43758
|
links?: ObjectLinks;
|
|
@@ -43063,7 +43772,7 @@ export declare interface JsonApiDashboardPluginPatch {
|
|
|
43063
43772
|
* API identifier of an object
|
|
43064
43773
|
*/
|
|
43065
43774
|
id: string;
|
|
43066
|
-
attributes?:
|
|
43775
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
43067
43776
|
}
|
|
43068
43777
|
|
|
43069
43778
|
export declare interface JsonApiDashboardPluginPatchDocument {
|
|
@@ -43084,7 +43793,18 @@ export declare interface JsonApiDashboardPluginPostOptionalId {
|
|
|
43084
43793
|
* API identifier of an object
|
|
43085
43794
|
*/
|
|
43086
43795
|
id?: string;
|
|
43087
|
-
attributes?:
|
|
43796
|
+
attributes?: JsonApiDashboardPluginPostOptionalIdAttributes;
|
|
43797
|
+
}
|
|
43798
|
+
|
|
43799
|
+
export declare interface JsonApiDashboardPluginPostOptionalIdAttributes {
|
|
43800
|
+
title?: string;
|
|
43801
|
+
description?: string;
|
|
43802
|
+
tags?: Array<string>;
|
|
43803
|
+
areRelationsValid?: boolean;
|
|
43804
|
+
/**
|
|
43805
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
43806
|
+
*/
|
|
43807
|
+
content?: object;
|
|
43088
43808
|
}
|
|
43089
43809
|
|
|
43090
43810
|
export declare interface JsonApiDashboardPluginPostOptionalIdDocument {
|
|
@@ -43115,7 +43835,7 @@ export declare interface JsonApiDatasetOut {
|
|
|
43115
43835
|
* API identifier of an object
|
|
43116
43836
|
*/
|
|
43117
43837
|
id: string;
|
|
43118
|
-
meta?:
|
|
43838
|
+
meta?: JsonApiDatasetOutMeta;
|
|
43119
43839
|
attributes: JsonApiDatasetOutAttributes;
|
|
43120
43840
|
relationships?: JsonApiDatasetOutRelationships;
|
|
43121
43841
|
}
|
|
@@ -43208,11 +43928,28 @@ export declare interface JsonApiDatasetOutList {
|
|
|
43208
43928
|
included?: Array<JsonApiDatasetOutIncludes>;
|
|
43209
43929
|
}
|
|
43210
43930
|
|
|
43931
|
+
export declare interface JsonApiDatasetOutMeta {
|
|
43932
|
+
origin?: JsonApiDatasetOutMetaOrigin;
|
|
43933
|
+
}
|
|
43934
|
+
|
|
43935
|
+
export declare interface JsonApiDatasetOutMetaOrigin {
|
|
43936
|
+
/**
|
|
43937
|
+
* defines type of the origin of the entity
|
|
43938
|
+
*/
|
|
43939
|
+
originType: JsonApiDatasetOutMetaOriginOriginTypeEnum;
|
|
43940
|
+
/**
|
|
43941
|
+
* defines id of the workspace where the entity comes from
|
|
43942
|
+
*/
|
|
43943
|
+
originId: string;
|
|
43944
|
+
}
|
|
43945
|
+
|
|
43946
|
+
export declare type JsonApiDatasetOutMetaOriginOriginTypeEnum = "NATIVE" | "PARENT";
|
|
43947
|
+
|
|
43211
43948
|
export declare interface JsonApiDatasetOutRelationships {
|
|
43212
43949
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
43213
43950
|
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
43214
43951
|
aggregatedFacts?: JsonApiDatasetOutRelationshipsAggregatedFacts;
|
|
43215
|
-
references?:
|
|
43952
|
+
references?: JsonApiDatasetOutRelationshipsReferences;
|
|
43216
43953
|
workspaceDataFilters?: JsonApiDatasetOutRelationshipsWorkspaceDataFilters;
|
|
43217
43954
|
}
|
|
43218
43955
|
|
|
@@ -43237,6 +43974,13 @@ export declare interface JsonApiDatasetOutRelationshipsFacts {
|
|
|
43237
43974
|
data: Array<JsonApiFactLinkage>;
|
|
43238
43975
|
}
|
|
43239
43976
|
|
|
43977
|
+
export declare interface JsonApiDatasetOutRelationshipsReferences {
|
|
43978
|
+
/**
|
|
43979
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
43980
|
+
*/
|
|
43981
|
+
data: Array<JsonApiDatasetLinkage>;
|
|
43982
|
+
}
|
|
43983
|
+
|
|
43240
43984
|
export declare interface JsonApiDatasetOutRelationshipsWorkspaceDataFilters {
|
|
43241
43985
|
/**
|
|
43242
43986
|
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
@@ -43255,7 +43999,7 @@ export declare interface JsonApiDatasetOutWithLinks {
|
|
|
43255
43999
|
* API identifier of an object
|
|
43256
44000
|
*/
|
|
43257
44001
|
id: string;
|
|
43258
|
-
meta?:
|
|
44002
|
+
meta?: JsonApiDatasetOutMeta;
|
|
43259
44003
|
attributes: JsonApiDatasetOutAttributes;
|
|
43260
44004
|
relationships?: JsonApiDatasetOutRelationships;
|
|
43261
44005
|
links?: ObjectLinks;
|
|
@@ -43263,6 +44007,33 @@ export declare interface JsonApiDatasetOutWithLinks {
|
|
|
43263
44007
|
|
|
43264
44008
|
export declare type JsonApiDatasetOutWithLinksTypeEnum = "dataset";
|
|
43265
44009
|
|
|
44010
|
+
/**
|
|
44011
|
+
* JSON:API representation of patching dataset entity.
|
|
44012
|
+
*/
|
|
44013
|
+
export declare interface JsonApiDatasetPatch {
|
|
44014
|
+
/**
|
|
44015
|
+
* Object type
|
|
44016
|
+
*/
|
|
44017
|
+
type: JsonApiDatasetPatchTypeEnum;
|
|
44018
|
+
/**
|
|
44019
|
+
* API identifier of an object
|
|
44020
|
+
*/
|
|
44021
|
+
id: string;
|
|
44022
|
+
attributes?: JsonApiDatasetPatchAttributes;
|
|
44023
|
+
}
|
|
44024
|
+
|
|
44025
|
+
export declare interface JsonApiDatasetPatchAttributes {
|
|
44026
|
+
title?: string;
|
|
44027
|
+
description?: string;
|
|
44028
|
+
tags?: Array<string>;
|
|
44029
|
+
}
|
|
44030
|
+
|
|
44031
|
+
export declare interface JsonApiDatasetPatchDocument {
|
|
44032
|
+
data: JsonApiDatasetPatch;
|
|
44033
|
+
}
|
|
44034
|
+
|
|
44035
|
+
export declare type JsonApiDatasetPatchTypeEnum = "dataset";
|
|
44036
|
+
|
|
43266
44037
|
/**
|
|
43267
44038
|
* JSON:API representation of dataSourceIdentifier entity.
|
|
43268
44039
|
*/
|
|
@@ -43653,27 +44424,14 @@ export declare interface JsonApiExportDefinitionIn {
|
|
|
43653
44424
|
* API identifier of an object
|
|
43654
44425
|
*/
|
|
43655
44426
|
id: string;
|
|
43656
|
-
attributes?:
|
|
43657
|
-
relationships?:
|
|
43658
|
-
}
|
|
43659
|
-
|
|
43660
|
-
export declare interface JsonApiExportDefinitionInAttributes {
|
|
43661
|
-
title?: string;
|
|
43662
|
-
description?: string;
|
|
43663
|
-
tags?: Array<string>;
|
|
43664
|
-
requestPayload?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
43665
|
-
areRelationsValid?: boolean;
|
|
44427
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
44428
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
43666
44429
|
}
|
|
43667
44430
|
|
|
43668
44431
|
export declare interface JsonApiExportDefinitionInDocument {
|
|
43669
44432
|
data: JsonApiExportDefinitionIn;
|
|
43670
44433
|
}
|
|
43671
44434
|
|
|
43672
|
-
export declare interface JsonApiExportDefinitionInRelationships {
|
|
43673
|
-
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
43674
|
-
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
43675
|
-
}
|
|
43676
|
-
|
|
43677
44435
|
export declare type JsonApiExportDefinitionInTypeEnum = "exportDefinition";
|
|
43678
44436
|
|
|
43679
44437
|
/**
|
|
@@ -43698,7 +44456,7 @@ export declare interface JsonApiExportDefinitionOut {
|
|
|
43698
44456
|
* API identifier of an object
|
|
43699
44457
|
*/
|
|
43700
44458
|
id: string;
|
|
43701
|
-
meta?:
|
|
44459
|
+
meta?: JsonApiDatasetOutMeta;
|
|
43702
44460
|
attributes?: JsonApiExportDefinitionOutAttributes;
|
|
43703
44461
|
relationships?: JsonApiExportDefinitionOutRelationships;
|
|
43704
44462
|
}
|
|
@@ -43746,16 +44504,12 @@ export declare interface JsonApiExportDefinitionOutList {
|
|
|
43746
44504
|
included?: Array<JsonApiExportDefinitionOutIncludes>;
|
|
43747
44505
|
}
|
|
43748
44506
|
|
|
43749
|
-
export declare interface JsonApiExportDefinitionOutMeta {
|
|
43750
|
-
origin?: JsonApiAnalyticalDashboardOutMetaOrigin;
|
|
43751
|
-
}
|
|
43752
|
-
|
|
43753
44507
|
export declare interface JsonApiExportDefinitionOutRelationships {
|
|
43754
44508
|
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
43755
44509
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
43756
44510
|
automation?: JsonApiExportDefinitionOutRelationshipsAutomation;
|
|
43757
|
-
createdBy?:
|
|
43758
|
-
modifiedBy?:
|
|
44511
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
44512
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
43759
44513
|
}
|
|
43760
44514
|
|
|
43761
44515
|
export declare interface JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard {
|
|
@@ -43781,7 +44535,7 @@ export declare interface JsonApiExportDefinitionOutWithLinks {
|
|
|
43781
44535
|
* API identifier of an object
|
|
43782
44536
|
*/
|
|
43783
44537
|
id: string;
|
|
43784
|
-
meta?:
|
|
44538
|
+
meta?: JsonApiDatasetOutMeta;
|
|
43785
44539
|
attributes?: JsonApiExportDefinitionOutAttributes;
|
|
43786
44540
|
relationships?: JsonApiExportDefinitionOutRelationships;
|
|
43787
44541
|
links?: ObjectLinks;
|
|
@@ -43801,8 +44555,8 @@ export declare interface JsonApiExportDefinitionPatch {
|
|
|
43801
44555
|
* API identifier of an object
|
|
43802
44556
|
*/
|
|
43803
44557
|
id: string;
|
|
43804
|
-
attributes?:
|
|
43805
|
-
relationships?:
|
|
44558
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
44559
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
43806
44560
|
}
|
|
43807
44561
|
|
|
43808
44562
|
export declare interface JsonApiExportDefinitionPatchDocument {
|
|
@@ -43823,14 +44577,27 @@ export declare interface JsonApiExportDefinitionPostOptionalId {
|
|
|
43823
44577
|
* API identifier of an object
|
|
43824
44578
|
*/
|
|
43825
44579
|
id?: string;
|
|
43826
|
-
attributes?:
|
|
43827
|
-
relationships?:
|
|
44580
|
+
attributes?: JsonApiExportDefinitionPostOptionalIdAttributes;
|
|
44581
|
+
relationships?: JsonApiExportDefinitionPostOptionalIdRelationships;
|
|
44582
|
+
}
|
|
44583
|
+
|
|
44584
|
+
export declare interface JsonApiExportDefinitionPostOptionalIdAttributes {
|
|
44585
|
+
title?: string;
|
|
44586
|
+
description?: string;
|
|
44587
|
+
tags?: Array<string>;
|
|
44588
|
+
requestPayload?: JsonApiExportDefinitionOutAttributesRequestPayload;
|
|
44589
|
+
areRelationsValid?: boolean;
|
|
43828
44590
|
}
|
|
43829
44591
|
|
|
43830
44592
|
export declare interface JsonApiExportDefinitionPostOptionalIdDocument {
|
|
43831
44593
|
data: JsonApiExportDefinitionPostOptionalId;
|
|
43832
44594
|
}
|
|
43833
44595
|
|
|
44596
|
+
export declare interface JsonApiExportDefinitionPostOptionalIdRelationships {
|
|
44597
|
+
visualizationObject?: JsonApiExportDefinitionOutRelationshipsVisualizationObject;
|
|
44598
|
+
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
44599
|
+
}
|
|
44600
|
+
|
|
43834
44601
|
export declare type JsonApiExportDefinitionPostOptionalIdTypeEnum = "exportDefinition";
|
|
43835
44602
|
|
|
43836
44603
|
/**
|
|
@@ -44011,7 +44778,7 @@ export declare interface JsonApiFactOut {
|
|
|
44011
44778
|
* API identifier of an object
|
|
44012
44779
|
*/
|
|
44013
44780
|
id: string;
|
|
44014
|
-
meta?:
|
|
44781
|
+
meta?: JsonApiDatasetOutMeta;
|
|
44015
44782
|
attributes?: JsonApiFactOutAttributes;
|
|
44016
44783
|
relationships?: JsonApiFactOutRelationships;
|
|
44017
44784
|
}
|
|
@@ -44069,7 +44836,7 @@ export declare interface JsonApiFactOutWithLinks {
|
|
|
44069
44836
|
* API identifier of an object
|
|
44070
44837
|
*/
|
|
44071
44838
|
id: string;
|
|
44072
|
-
meta?:
|
|
44839
|
+
meta?: JsonApiDatasetOutMeta;
|
|
44073
44840
|
attributes?: JsonApiFactOutAttributes;
|
|
44074
44841
|
relationships?: JsonApiFactOutRelationships;
|
|
44075
44842
|
links?: ObjectLinks;
|
|
@@ -44077,6 +44844,27 @@ export declare interface JsonApiFactOutWithLinks {
|
|
|
44077
44844
|
|
|
44078
44845
|
export declare type JsonApiFactOutWithLinksTypeEnum = "fact";
|
|
44079
44846
|
|
|
44847
|
+
/**
|
|
44848
|
+
* JSON:API representation of patching fact entity.
|
|
44849
|
+
*/
|
|
44850
|
+
export declare interface JsonApiFactPatch {
|
|
44851
|
+
/**
|
|
44852
|
+
* Object type
|
|
44853
|
+
*/
|
|
44854
|
+
type: JsonApiFactPatchTypeEnum;
|
|
44855
|
+
/**
|
|
44856
|
+
* API identifier of an object
|
|
44857
|
+
*/
|
|
44858
|
+
id: string;
|
|
44859
|
+
attributes?: JsonApiDatasetPatchAttributes;
|
|
44860
|
+
}
|
|
44861
|
+
|
|
44862
|
+
export declare interface JsonApiFactPatchDocument {
|
|
44863
|
+
data: JsonApiFactPatch;
|
|
44864
|
+
}
|
|
44865
|
+
|
|
44866
|
+
export declare type JsonApiFactPatchTypeEnum = "fact";
|
|
44867
|
+
|
|
44080
44868
|
/**
|
|
44081
44869
|
* JSON:API representation of filterContext entity.
|
|
44082
44870
|
*/
|
|
@@ -44120,7 +44908,7 @@ export declare interface JsonApiFilterContextOut {
|
|
|
44120
44908
|
* API identifier of an object
|
|
44121
44909
|
*/
|
|
44122
44910
|
id: string;
|
|
44123
|
-
meta?:
|
|
44911
|
+
meta?: JsonApiDatasetOutMeta;
|
|
44124
44912
|
attributes: JsonApiFilterContextOutAttributes;
|
|
44125
44913
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
44126
44914
|
}
|
|
@@ -44165,8 +44953,8 @@ export declare interface JsonApiFilterContextOutList {
|
|
|
44165
44953
|
|
|
44166
44954
|
export declare interface JsonApiFilterContextOutRelationships {
|
|
44167
44955
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
44168
|
-
datasets?:
|
|
44169
|
-
labels?:
|
|
44956
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
44957
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
44170
44958
|
}
|
|
44171
44959
|
|
|
44172
44960
|
export declare type JsonApiFilterContextOutTypeEnum = "filterContext";
|
|
@@ -44180,7 +44968,7 @@ export declare interface JsonApiFilterContextOutWithLinks {
|
|
|
44180
44968
|
* API identifier of an object
|
|
44181
44969
|
*/
|
|
44182
44970
|
id: string;
|
|
44183
|
-
meta?:
|
|
44971
|
+
meta?: JsonApiDatasetOutMeta;
|
|
44184
44972
|
attributes: JsonApiFilterContextOutAttributes;
|
|
44185
44973
|
relationships?: JsonApiFilterContextOutRelationships;
|
|
44186
44974
|
links?: ObjectLinks;
|
|
@@ -44312,11 +45100,7 @@ export declare interface JsonApiFilterViewOutList {
|
|
|
44312
45100
|
|
|
44313
45101
|
export declare interface JsonApiFilterViewOutRelationships {
|
|
44314
45102
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
44315
|
-
user?:
|
|
44316
|
-
}
|
|
44317
|
-
|
|
44318
|
-
export declare interface JsonApiFilterViewOutRelationshipsUser {
|
|
44319
|
-
data: JsonApiUserLinkage | null;
|
|
45103
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
44320
45104
|
}
|
|
44321
45105
|
|
|
44322
45106
|
export declare type JsonApiFilterViewOutTypeEnum = "filterView";
|
|
@@ -44391,62 +45175,9 @@ export declare interface JsonApiIdentityProviderIn {
|
|
|
44391
45175
|
* API identifier of an object
|
|
44392
45176
|
*/
|
|
44393
45177
|
id: string;
|
|
44394
|
-
attributes?:
|
|
45178
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
44395
45179
|
}
|
|
44396
45180
|
|
|
44397
|
-
export declare interface JsonApiIdentityProviderInAttributes {
|
|
44398
|
-
/**
|
|
44399
|
-
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
44400
|
-
*/
|
|
44401
|
-
identifiers?: Array<string>;
|
|
44402
|
-
/**
|
|
44403
|
-
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
44404
|
-
*/
|
|
44405
|
-
customClaimMapping?: {
|
|
44406
|
-
[key: string]: string;
|
|
44407
|
-
};
|
|
44408
|
-
/**
|
|
44409
|
-
* Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
|
|
44410
|
-
*/
|
|
44411
|
-
samlMetadata?: string;
|
|
44412
|
-
/**
|
|
44413
|
-
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
44414
|
-
*/
|
|
44415
|
-
oauthClientId?: string;
|
|
44416
|
-
/**
|
|
44417
|
-
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
44418
|
-
*/
|
|
44419
|
-
oauthClientSecret?: string;
|
|
44420
|
-
/**
|
|
44421
|
-
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
44422
|
-
*/
|
|
44423
|
-
oauthIssuerLocation?: string;
|
|
44424
|
-
/**
|
|
44425
|
-
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
44426
|
-
*/
|
|
44427
|
-
oauthIssuerId?: string;
|
|
44428
|
-
/**
|
|
44429
|
-
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
44430
|
-
*/
|
|
44431
|
-
oauthSubjectIdClaim?: string;
|
|
44432
|
-
/**
|
|
44433
|
-
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
44434
|
-
*/
|
|
44435
|
-
oauthCustomAuthAttributes?: {
|
|
44436
|
-
[key: string]: string;
|
|
44437
|
-
};
|
|
44438
|
-
/**
|
|
44439
|
-
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
44440
|
-
*/
|
|
44441
|
-
oauthCustomScopes?: Array<string> | null;
|
|
44442
|
-
/**
|
|
44443
|
-
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
44444
|
-
*/
|
|
44445
|
-
idpType?: JsonApiIdentityProviderInAttributesIdpTypeEnum;
|
|
44446
|
-
}
|
|
44447
|
-
|
|
44448
|
-
export declare type JsonApiIdentityProviderInAttributesIdpTypeEnum = "MANAGED_IDP" | "FIM_IDP" | "DEX_IDP" | "CUSTOM_IDP";
|
|
44449
|
-
|
|
44450
45181
|
export declare interface JsonApiIdentityProviderInDocument {
|
|
44451
45182
|
data: JsonApiIdentityProviderIn;
|
|
44452
45183
|
}
|
|
@@ -44566,9 +45297,62 @@ export declare interface JsonApiIdentityProviderPatch {
|
|
|
44566
45297
|
* API identifier of an object
|
|
44567
45298
|
*/
|
|
44568
45299
|
id: string;
|
|
44569
|
-
attributes?:
|
|
45300
|
+
attributes?: JsonApiIdentityProviderPatchAttributes;
|
|
45301
|
+
}
|
|
45302
|
+
|
|
45303
|
+
export declare interface JsonApiIdentityProviderPatchAttributes {
|
|
45304
|
+
/**
|
|
45305
|
+
* List of identifiers for this IdP, where an identifier is a domain name. Users with email addresses belonging to these domains will be authenticated by this IdP.
|
|
45306
|
+
*/
|
|
45307
|
+
identifiers?: Array<string>;
|
|
45308
|
+
/**
|
|
45309
|
+
* Map of custom claim overrides. To be used when your Idp does not provide default claims (sub, email, name, given_name, family_name). Define the key pair for the claim you wish to override, where the key is the default name of the attribute and the value is your custom name for the given attribute.
|
|
45310
|
+
*/
|
|
45311
|
+
customClaimMapping?: {
|
|
45312
|
+
[key: string]: string;
|
|
45313
|
+
};
|
|
45314
|
+
/**
|
|
45315
|
+
* Base64 encoded xml document with SAML metadata. This document is issued by your SAML provider. It includes the issuer\'s name, expiration information, and keys that can be used to validate the response from the identity provider. This field is mandatory for SAML IdP.
|
|
45316
|
+
*/
|
|
45317
|
+
samlMetadata?: string;
|
|
45318
|
+
/**
|
|
45319
|
+
* The OAuth client id of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
45320
|
+
*/
|
|
45321
|
+
oauthClientId?: string;
|
|
45322
|
+
/**
|
|
45323
|
+
* The OAuth client secret of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
45324
|
+
*/
|
|
45325
|
+
oauthClientSecret?: string;
|
|
45326
|
+
/**
|
|
45327
|
+
* The location of your OIDC provider. This field is mandatory for OIDC IdP.
|
|
45328
|
+
*/
|
|
45329
|
+
oauthIssuerLocation?: string;
|
|
45330
|
+
/**
|
|
45331
|
+
* Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
|
|
45332
|
+
*/
|
|
45333
|
+
oauthIssuerId?: string;
|
|
45334
|
+
/**
|
|
45335
|
+
* Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
|
|
45336
|
+
*/
|
|
45337
|
+
oauthSubjectIdClaim?: string;
|
|
45338
|
+
/**
|
|
45339
|
+
* Map of additional authentication attributes that should be added to the OAuth2 authentication requests, where the key is the name of the attribute and the value is the value of the attribute.
|
|
45340
|
+
*/
|
|
45341
|
+
oauthCustomAuthAttributes?: {
|
|
45342
|
+
[key: string]: string;
|
|
45343
|
+
};
|
|
45344
|
+
/**
|
|
45345
|
+
* List of additional OAuth scopes which may be required by other providers (e.g. Snowflake)
|
|
45346
|
+
*/
|
|
45347
|
+
oauthCustomScopes?: Array<string> | null;
|
|
45348
|
+
/**
|
|
45349
|
+
* Type of IdP for management purposes. MANAGED_IDP represents a GoodData managed IdP used in single OIDC setup, which is protected from altering/deletion. FIM_IDP represents a GoodData managed IdP used in federated identity management setup, which is protected from altering/deletion. DEX_IDP represents internal Dex IdP which is protected from altering/deletion. CUSTOM_IDP represents customer\'s own IdP, protected from deletion if currently used by org for authentication, deletable otherwise.
|
|
45350
|
+
*/
|
|
45351
|
+
idpType?: JsonApiIdentityProviderPatchAttributesIdpTypeEnum;
|
|
44570
45352
|
}
|
|
44571
45353
|
|
|
45354
|
+
export declare type JsonApiIdentityProviderPatchAttributesIdpTypeEnum = "MANAGED_IDP" | "FIM_IDP" | "DEX_IDP" | "CUSTOM_IDP";
|
|
45355
|
+
|
|
44572
45356
|
export declare interface JsonApiIdentityProviderPatchDocument {
|
|
44573
45357
|
data: JsonApiIdentityProviderPatch;
|
|
44574
45358
|
}
|
|
@@ -44689,7 +45473,7 @@ export declare interface JsonApiLabelOut {
|
|
|
44689
45473
|
* API identifier of an object
|
|
44690
45474
|
*/
|
|
44691
45475
|
id: string;
|
|
44692
|
-
meta?:
|
|
45476
|
+
meta?: JsonApiDatasetOutMeta;
|
|
44693
45477
|
attributes?: JsonApiLabelOutAttributes;
|
|
44694
45478
|
relationships?: JsonApiLabelOutRelationships;
|
|
44695
45479
|
}
|
|
@@ -44766,7 +45550,7 @@ export declare interface JsonApiLabelOutWithLinks {
|
|
|
44766
45550
|
* API identifier of an object
|
|
44767
45551
|
*/
|
|
44768
45552
|
id: string;
|
|
44769
|
-
meta?:
|
|
45553
|
+
meta?: JsonApiDatasetOutMeta;
|
|
44770
45554
|
attributes?: JsonApiLabelOutAttributes;
|
|
44771
45555
|
relationships?: JsonApiLabelOutRelationships;
|
|
44772
45556
|
links?: ObjectLinks;
|
|
@@ -44774,6 +45558,35 @@ export declare interface JsonApiLabelOutWithLinks {
|
|
|
44774
45558
|
|
|
44775
45559
|
export declare type JsonApiLabelOutWithLinksTypeEnum = "label";
|
|
44776
45560
|
|
|
45561
|
+
/**
|
|
45562
|
+
* JSON:API representation of patching label entity.
|
|
45563
|
+
*/
|
|
45564
|
+
export declare interface JsonApiLabelPatch {
|
|
45565
|
+
/**
|
|
45566
|
+
* Object type
|
|
45567
|
+
*/
|
|
45568
|
+
type: JsonApiLabelPatchTypeEnum;
|
|
45569
|
+
/**
|
|
45570
|
+
* API identifier of an object
|
|
45571
|
+
*/
|
|
45572
|
+
id: string;
|
|
45573
|
+
attributes?: JsonApiLabelPatchAttributes;
|
|
45574
|
+
}
|
|
45575
|
+
|
|
45576
|
+
export declare interface JsonApiLabelPatchAttributes {
|
|
45577
|
+
title?: string;
|
|
45578
|
+
description?: string;
|
|
45579
|
+
tags?: Array<string>;
|
|
45580
|
+
locale?: string;
|
|
45581
|
+
translations?: Array<JsonApiLabelOutAttributesTranslationsInner>;
|
|
45582
|
+
}
|
|
45583
|
+
|
|
45584
|
+
export declare interface JsonApiLabelPatchDocument {
|
|
45585
|
+
data: JsonApiLabelPatch;
|
|
45586
|
+
}
|
|
45587
|
+
|
|
45588
|
+
export declare type JsonApiLabelPatchTypeEnum = "label";
|
|
45589
|
+
|
|
44777
45590
|
/**
|
|
44778
45591
|
* JSON:API representation of llmEndpoint entity.
|
|
44779
45592
|
*/
|
|
@@ -44957,34 +45770,9 @@ export declare interface JsonApiMemoryItemIn {
|
|
|
44957
45770
|
* API identifier of an object
|
|
44958
45771
|
*/
|
|
44959
45772
|
id: string;
|
|
44960
|
-
attributes:
|
|
45773
|
+
attributes: JsonApiMemoryItemPostOptionalIdAttributes;
|
|
44961
45774
|
}
|
|
44962
45775
|
|
|
44963
|
-
export declare interface JsonApiMemoryItemInAttributes {
|
|
44964
|
-
title?: string;
|
|
44965
|
-
description?: string;
|
|
44966
|
-
tags?: Array<string>;
|
|
44967
|
-
areRelationsValid?: boolean;
|
|
44968
|
-
/**
|
|
44969
|
-
* Strategy defining when the memory item should be applied
|
|
44970
|
-
*/
|
|
44971
|
-
strategy: JsonApiMemoryItemInAttributesStrategyEnum;
|
|
44972
|
-
/**
|
|
44973
|
-
* The text that will be injected into the system prompt
|
|
44974
|
-
*/
|
|
44975
|
-
instruction: string;
|
|
44976
|
-
/**
|
|
44977
|
-
* Set of unique strings used for semantic similarity filtering
|
|
44978
|
-
*/
|
|
44979
|
-
keywords?: Array<string>;
|
|
44980
|
-
/**
|
|
44981
|
-
* Whether memory item is disabled
|
|
44982
|
-
*/
|
|
44983
|
-
isDisabled?: boolean;
|
|
44984
|
-
}
|
|
44985
|
-
|
|
44986
|
-
export declare type JsonApiMemoryItemInAttributesStrategyEnum = "ALWAYS" | "AUTO";
|
|
44987
|
-
|
|
44988
45776
|
export declare interface JsonApiMemoryItemInDocument {
|
|
44989
45777
|
data: JsonApiMemoryItemIn;
|
|
44990
45778
|
}
|
|
@@ -45003,7 +45791,7 @@ export declare interface JsonApiMemoryItemOut {
|
|
|
45003
45791
|
* API identifier of an object
|
|
45004
45792
|
*/
|
|
45005
45793
|
id: string;
|
|
45006
|
-
meta?:
|
|
45794
|
+
meta?: JsonApiDatasetOutMeta;
|
|
45007
45795
|
attributes: JsonApiMemoryItemOutAttributes;
|
|
45008
45796
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
45009
45797
|
}
|
|
@@ -45068,7 +45856,7 @@ export declare interface JsonApiMemoryItemOutWithLinks {
|
|
|
45068
45856
|
* API identifier of an object
|
|
45069
45857
|
*/
|
|
45070
45858
|
id: string;
|
|
45071
|
-
meta?:
|
|
45859
|
+
meta?: JsonApiDatasetOutMeta;
|
|
45072
45860
|
attributes: JsonApiMemoryItemOutAttributes;
|
|
45073
45861
|
relationships?: JsonApiDashboardPluginOutRelationships;
|
|
45074
45862
|
links?: ObjectLinks;
|
|
@@ -45134,9 +45922,34 @@ export declare interface JsonApiMemoryItemPostOptionalId {
|
|
|
45134
45922
|
* API identifier of an object
|
|
45135
45923
|
*/
|
|
45136
45924
|
id?: string;
|
|
45137
|
-
attributes:
|
|
45925
|
+
attributes: JsonApiMemoryItemPostOptionalIdAttributes;
|
|
45138
45926
|
}
|
|
45139
45927
|
|
|
45928
|
+
export declare interface JsonApiMemoryItemPostOptionalIdAttributes {
|
|
45929
|
+
title?: string;
|
|
45930
|
+
description?: string;
|
|
45931
|
+
tags?: Array<string>;
|
|
45932
|
+
areRelationsValid?: boolean;
|
|
45933
|
+
/**
|
|
45934
|
+
* Strategy defining when the memory item should be applied
|
|
45935
|
+
*/
|
|
45936
|
+
strategy: JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum;
|
|
45937
|
+
/**
|
|
45938
|
+
* The text that will be injected into the system prompt
|
|
45939
|
+
*/
|
|
45940
|
+
instruction: string;
|
|
45941
|
+
/**
|
|
45942
|
+
* Set of unique strings used for semantic similarity filtering
|
|
45943
|
+
*/
|
|
45944
|
+
keywords?: Array<string>;
|
|
45945
|
+
/**
|
|
45946
|
+
* Whether memory item is disabled
|
|
45947
|
+
*/
|
|
45948
|
+
isDisabled?: boolean;
|
|
45949
|
+
}
|
|
45950
|
+
|
|
45951
|
+
export declare type JsonApiMemoryItemPostOptionalIdAttributesStrategyEnum = "ALWAYS" | "AUTO";
|
|
45952
|
+
|
|
45140
45953
|
export declare interface JsonApiMemoryItemPostOptionalIdDocument {
|
|
45141
45954
|
data: JsonApiMemoryItemPostOptionalId;
|
|
45142
45955
|
}
|
|
@@ -45155,16 +45968,7 @@ export declare interface JsonApiMetricIn {
|
|
|
45155
45968
|
* API identifier of an object
|
|
45156
45969
|
*/
|
|
45157
45970
|
id: string;
|
|
45158
|
-
attributes:
|
|
45159
|
-
}
|
|
45160
|
-
|
|
45161
|
-
export declare interface JsonApiMetricInAttributes {
|
|
45162
|
-
title?: string;
|
|
45163
|
-
description?: string;
|
|
45164
|
-
tags?: Array<string>;
|
|
45165
|
-
areRelationsValid?: boolean;
|
|
45166
|
-
content: JsonApiMetricOutAttributesContent;
|
|
45167
|
-
isHidden?: boolean;
|
|
45971
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
45168
45972
|
}
|
|
45169
45973
|
|
|
45170
45974
|
export declare interface JsonApiMetricInDocument {
|
|
@@ -45195,7 +45999,7 @@ export declare interface JsonApiMetricOut {
|
|
|
45195
45999
|
* API identifier of an object
|
|
45196
46000
|
*/
|
|
45197
46001
|
id: string;
|
|
45198
|
-
meta?:
|
|
46002
|
+
meta?: JsonApiDatasetOutMeta;
|
|
45199
46003
|
attributes: JsonApiMetricOutAttributes;
|
|
45200
46004
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
45201
46005
|
}
|
|
@@ -45260,7 +46064,7 @@ export declare interface JsonApiMetricOutWithLinks {
|
|
|
45260
46064
|
* API identifier of an object
|
|
45261
46065
|
*/
|
|
45262
46066
|
id: string;
|
|
45263
|
-
meta?:
|
|
46067
|
+
meta?: JsonApiDatasetOutMeta;
|
|
45264
46068
|
attributes: JsonApiMetricOutAttributes;
|
|
45265
46069
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
45266
46070
|
links?: ObjectLinks;
|
|
@@ -45310,7 +46114,16 @@ export declare interface JsonApiMetricPostOptionalId {
|
|
|
45310
46114
|
* API identifier of an object
|
|
45311
46115
|
*/
|
|
45312
46116
|
id?: string;
|
|
45313
|
-
attributes:
|
|
46117
|
+
attributes: JsonApiMetricPostOptionalIdAttributes;
|
|
46118
|
+
}
|
|
46119
|
+
|
|
46120
|
+
export declare interface JsonApiMetricPostOptionalIdAttributes {
|
|
46121
|
+
title?: string;
|
|
46122
|
+
description?: string;
|
|
46123
|
+
tags?: Array<string>;
|
|
46124
|
+
areRelationsValid?: boolean;
|
|
46125
|
+
content: JsonApiMetricOutAttributesContent;
|
|
46126
|
+
isHidden?: boolean;
|
|
45314
46127
|
}
|
|
45315
46128
|
|
|
45316
46129
|
export declare interface JsonApiMetricPostOptionalIdDocument {
|
|
@@ -45391,41 +46204,9 @@ export declare interface JsonApiNotificationChannelIn {
|
|
|
45391
46204
|
* API identifier of an object
|
|
45392
46205
|
*/
|
|
45393
46206
|
id: string;
|
|
45394
|
-
attributes?:
|
|
46207
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
45395
46208
|
}
|
|
45396
46209
|
|
|
45397
|
-
export declare interface JsonApiNotificationChannelInAttributes {
|
|
45398
|
-
name?: string | null;
|
|
45399
|
-
description?: string | null;
|
|
45400
|
-
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
45401
|
-
/**
|
|
45402
|
-
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
45403
|
-
*/
|
|
45404
|
-
customDashboardUrl?: string;
|
|
45405
|
-
/**
|
|
45406
|
-
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
45407
|
-
*/
|
|
45408
|
-
dashboardLinkVisibility?: JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum;
|
|
45409
|
-
/**
|
|
45410
|
-
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
45411
|
-
*/
|
|
45412
|
-
notificationSource?: string;
|
|
45413
|
-
/**
|
|
45414
|
-
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
45415
|
-
*/
|
|
45416
|
-
allowedRecipients?: JsonApiNotificationChannelInAttributesAllowedRecipientsEnum;
|
|
45417
|
-
/**
|
|
45418
|
-
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
45419
|
-
*/
|
|
45420
|
-
inPlatformNotification?: JsonApiNotificationChannelInAttributesInPlatformNotificationEnum;
|
|
45421
|
-
}
|
|
45422
|
-
|
|
45423
|
-
export declare type JsonApiNotificationChannelInAttributesAllowedRecipientsEnum = "CREATOR" | "INTERNAL" | "EXTERNAL";
|
|
45424
|
-
|
|
45425
|
-
export declare type JsonApiNotificationChannelInAttributesDashboardLinkVisibilityEnum = "HIDDEN" | "INTERNAL_ONLY" | "ALL";
|
|
45426
|
-
|
|
45427
|
-
export declare type JsonApiNotificationChannelInAttributesInPlatformNotificationEnum = "DISABLED" | "ENABLED";
|
|
45428
|
-
|
|
45429
46210
|
export declare interface JsonApiNotificationChannelInDocument {
|
|
45430
46211
|
data: JsonApiNotificationChannelIn;
|
|
45431
46212
|
}
|
|
@@ -45541,9 +46322,41 @@ export declare interface JsonApiNotificationChannelPatch {
|
|
|
45541
46322
|
* API identifier of an object
|
|
45542
46323
|
*/
|
|
45543
46324
|
id: string;
|
|
45544
|
-
attributes?:
|
|
46325
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
45545
46326
|
}
|
|
45546
46327
|
|
|
46328
|
+
export declare interface JsonApiNotificationChannelPatchAttributes {
|
|
46329
|
+
name?: string | null;
|
|
46330
|
+
description?: string | null;
|
|
46331
|
+
destination?: JsonApiNotificationChannelOutAttributesDestination;
|
|
46332
|
+
/**
|
|
46333
|
+
* Custom dashboard url that is going to be used in the notification. If not specified it is going to be deduced based on the context. Allowed placeholders are: {workspaceId} {dashboardId} {automationId} {asOfDate}
|
|
46334
|
+
*/
|
|
46335
|
+
customDashboardUrl?: string;
|
|
46336
|
+
/**
|
|
46337
|
+
* Dashboard link visibility in notifications. HIDDEN - the link will not be included INTERNAL_ONLY - only internal users will see the link ALL - all users will see the link
|
|
46338
|
+
*/
|
|
46339
|
+
dashboardLinkVisibility?: JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum;
|
|
46340
|
+
/**
|
|
46341
|
+
* Human-readable description of the source of the notification. If specified, this propertywill be included in the notifications to this channel.Allowed placeholders are: {{workspaceId}} {{workspaceName}} {{workspaceDescription}} {{dashboardId}} {{dashboardName}} {{dashboardDescription}}
|
|
46342
|
+
*/
|
|
46343
|
+
notificationSource?: string;
|
|
46344
|
+
/**
|
|
46345
|
+
* Allowed recipients of notifications from this channel. CREATOR - only the creator INTERNAL - all users within the organization EXTERNAL - all recipients including those outside the organization
|
|
46346
|
+
*/
|
|
46347
|
+
allowedRecipients?: JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum;
|
|
46348
|
+
/**
|
|
46349
|
+
* In-platform notifications configuration. No effect if the destination type is IN_PLATFORM. DISABLED - in-platform notifications are not sent ENABLED - in-platform notifications are sent in addition to the regular notifications
|
|
46350
|
+
*/
|
|
46351
|
+
inPlatformNotification?: JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum;
|
|
46352
|
+
}
|
|
46353
|
+
|
|
46354
|
+
export declare type JsonApiNotificationChannelPatchAttributesAllowedRecipientsEnum = "CREATOR" | "INTERNAL" | "EXTERNAL";
|
|
46355
|
+
|
|
46356
|
+
export declare type JsonApiNotificationChannelPatchAttributesDashboardLinkVisibilityEnum = "HIDDEN" | "INTERNAL_ONLY" | "ALL";
|
|
46357
|
+
|
|
46358
|
+
export declare type JsonApiNotificationChannelPatchAttributesInPlatformNotificationEnum = "DISABLED" | "ENABLED";
|
|
46359
|
+
|
|
45547
46360
|
export declare interface JsonApiNotificationChannelPatchDocument {
|
|
45548
46361
|
data: JsonApiNotificationChannelPatch;
|
|
45549
46362
|
}
|
|
@@ -45562,7 +46375,7 @@ export declare interface JsonApiNotificationChannelPostOptionalId {
|
|
|
45562
46375
|
* API identifier of an object
|
|
45563
46376
|
*/
|
|
45564
46377
|
id?: string;
|
|
45565
|
-
attributes?:
|
|
46378
|
+
attributes?: JsonApiNotificationChannelPatchAttributes;
|
|
45566
46379
|
}
|
|
45567
46380
|
|
|
45568
46381
|
export declare interface JsonApiNotificationChannelPostOptionalIdDocument {
|
|
@@ -45583,37 +46396,14 @@ export declare interface JsonApiOrganizationIn {
|
|
|
45583
46396
|
* API identifier of an object
|
|
45584
46397
|
*/
|
|
45585
46398
|
id: string;
|
|
45586
|
-
attributes?:
|
|
45587
|
-
relationships?:
|
|
45588
|
-
}
|
|
45589
|
-
|
|
45590
|
-
export declare interface JsonApiOrganizationInAttributes {
|
|
45591
|
-
name?: string | null;
|
|
45592
|
-
hostname?: string;
|
|
45593
|
-
allowedOrigins?: Array<string>;
|
|
45594
|
-
/**
|
|
45595
|
-
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
45596
|
-
* @deprecated
|
|
45597
|
-
*/
|
|
45598
|
-
earlyAccess?: string | null;
|
|
45599
|
-
/**
|
|
45600
|
-
* The early access feature identifiers. They are used to enable experimental features.
|
|
45601
|
-
*/
|
|
45602
|
-
earlyAccessValues?: Array<string> | null;
|
|
46399
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
46400
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
45603
46401
|
}
|
|
45604
46402
|
|
|
45605
46403
|
export declare interface JsonApiOrganizationInDocument {
|
|
45606
46404
|
data: JsonApiOrganizationIn;
|
|
45607
46405
|
}
|
|
45608
46406
|
|
|
45609
|
-
export declare interface JsonApiOrganizationInRelationships {
|
|
45610
|
-
identityProvider?: JsonApiOrganizationInRelationshipsIdentityProvider;
|
|
45611
|
-
}
|
|
45612
|
-
|
|
45613
|
-
export declare interface JsonApiOrganizationInRelationshipsIdentityProvider {
|
|
45614
|
-
data: JsonApiIdentityProviderLinkage | null;
|
|
45615
|
-
}
|
|
45616
|
-
|
|
45617
46407
|
export declare type JsonApiOrganizationInTypeEnum = "organization";
|
|
45618
46408
|
|
|
45619
46409
|
/**
|
|
@@ -45680,9 +46470,17 @@ export declare interface JsonApiOrganizationOutMeta {
|
|
|
45680
46470
|
export declare type JsonApiOrganizationOutMetaPermissionsEnum = "MANAGE" | "SELF_CREATE_TOKEN";
|
|
45681
46471
|
|
|
45682
46472
|
export declare interface JsonApiOrganizationOutRelationships {
|
|
45683
|
-
bootstrapUser?:
|
|
45684
|
-
bootstrapUserGroup?:
|
|
45685
|
-
identityProvider?:
|
|
46473
|
+
bootstrapUser?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
46474
|
+
bootstrapUserGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
46475
|
+
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
46476
|
+
}
|
|
46477
|
+
|
|
46478
|
+
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUser {
|
|
46479
|
+
data: JsonApiUserLinkage | null;
|
|
46480
|
+
}
|
|
46481
|
+
|
|
46482
|
+
export declare interface JsonApiOrganizationOutRelationshipsBootstrapUserGroup {
|
|
46483
|
+
data: JsonApiUserGroupLinkage | null;
|
|
45686
46484
|
}
|
|
45687
46485
|
|
|
45688
46486
|
export declare type JsonApiOrganizationOutTypeEnum = "organization";
|
|
@@ -45699,14 +46497,37 @@ export declare interface JsonApiOrganizationPatch {
|
|
|
45699
46497
|
* API identifier of an object
|
|
45700
46498
|
*/
|
|
45701
46499
|
id: string;
|
|
45702
|
-
attributes?:
|
|
45703
|
-
relationships?:
|
|
46500
|
+
attributes?: JsonApiOrganizationPatchAttributes;
|
|
46501
|
+
relationships?: JsonApiOrganizationPatchRelationships;
|
|
46502
|
+
}
|
|
46503
|
+
|
|
46504
|
+
export declare interface JsonApiOrganizationPatchAttributes {
|
|
46505
|
+
name?: string | null;
|
|
46506
|
+
hostname?: string;
|
|
46507
|
+
allowedOrigins?: Array<string>;
|
|
46508
|
+
/**
|
|
46509
|
+
* The early access feature identifier. It is used to enable experimental features. Deprecated in favor of earlyAccessValues.
|
|
46510
|
+
* @deprecated
|
|
46511
|
+
*/
|
|
46512
|
+
earlyAccess?: string | null;
|
|
46513
|
+
/**
|
|
46514
|
+
* The early access feature identifiers. They are used to enable experimental features.
|
|
46515
|
+
*/
|
|
46516
|
+
earlyAccessValues?: Array<string> | null;
|
|
45704
46517
|
}
|
|
45705
46518
|
|
|
45706
46519
|
export declare interface JsonApiOrganizationPatchDocument {
|
|
45707
46520
|
data: JsonApiOrganizationPatch;
|
|
45708
46521
|
}
|
|
45709
46522
|
|
|
46523
|
+
export declare interface JsonApiOrganizationPatchRelationships {
|
|
46524
|
+
identityProvider?: JsonApiOrganizationPatchRelationshipsIdentityProvider;
|
|
46525
|
+
}
|
|
46526
|
+
|
|
46527
|
+
export declare interface JsonApiOrganizationPatchRelationshipsIdentityProvider {
|
|
46528
|
+
data: JsonApiIdentityProviderLinkage | null;
|
|
46529
|
+
}
|
|
46530
|
+
|
|
45710
46531
|
export declare type JsonApiOrganizationPatchTypeEnum = "organization";
|
|
45711
46532
|
|
|
45712
46533
|
/**
|
|
@@ -45721,7 +46542,7 @@ export declare interface JsonApiOrganizationSettingIn {
|
|
|
45721
46542
|
* API identifier of an object
|
|
45722
46543
|
*/
|
|
45723
46544
|
id: string;
|
|
45724
|
-
attributes?:
|
|
46545
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
45725
46546
|
}
|
|
45726
46547
|
|
|
45727
46548
|
export declare interface JsonApiOrganizationSettingInDocument {
|
|
@@ -45742,19 +46563,9 @@ export declare interface JsonApiOrganizationSettingOut {
|
|
|
45742
46563
|
* API identifier of an object
|
|
45743
46564
|
*/
|
|
45744
46565
|
id: string;
|
|
45745
|
-
attributes?:
|
|
46566
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
45746
46567
|
}
|
|
45747
46568
|
|
|
45748
|
-
export declare interface JsonApiOrganizationSettingOutAttributes {
|
|
45749
|
-
/**
|
|
45750
|
-
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
45751
|
-
*/
|
|
45752
|
-
content?: object;
|
|
45753
|
-
type?: JsonApiOrganizationSettingOutAttributesTypeEnum;
|
|
45754
|
-
}
|
|
45755
|
-
|
|
45756
|
-
export declare type JsonApiOrganizationSettingOutAttributesTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE";
|
|
45757
|
-
|
|
45758
46569
|
export declare interface JsonApiOrganizationSettingOutDocument {
|
|
45759
46570
|
data: JsonApiOrganizationSettingOut;
|
|
45760
46571
|
links?: ObjectLinks;
|
|
@@ -45780,7 +46591,7 @@ export declare interface JsonApiOrganizationSettingOutWithLinks {
|
|
|
45780
46591
|
* API identifier of an object
|
|
45781
46592
|
*/
|
|
45782
46593
|
id: string;
|
|
45783
|
-
attributes?:
|
|
46594
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
45784
46595
|
links?: ObjectLinks;
|
|
45785
46596
|
}
|
|
45786
46597
|
|
|
@@ -45798,7 +46609,7 @@ export declare interface JsonApiOrganizationSettingPatch {
|
|
|
45798
46609
|
* API identifier of an object
|
|
45799
46610
|
*/
|
|
45800
46611
|
id: string;
|
|
45801
|
-
attributes?:
|
|
46612
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
45802
46613
|
}
|
|
45803
46614
|
|
|
45804
46615
|
export declare interface JsonApiOrganizationSettingPatchDocument {
|
|
@@ -45908,18 +46719,13 @@ export declare interface JsonApiUserDataFilterIn {
|
|
|
45908
46719
|
*/
|
|
45909
46720
|
id: string;
|
|
45910
46721
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
45911
|
-
relationships?:
|
|
46722
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
45912
46723
|
}
|
|
45913
46724
|
|
|
45914
46725
|
export declare interface JsonApiUserDataFilterInDocument {
|
|
45915
46726
|
data: JsonApiUserDataFilterIn;
|
|
45916
46727
|
}
|
|
45917
46728
|
|
|
45918
|
-
export declare interface JsonApiUserDataFilterInRelationships {
|
|
45919
|
-
user?: JsonApiFilterViewOutRelationshipsUser;
|
|
45920
|
-
userGroup?: JsonApiUserDataFilterOutRelationshipsUserGroup;
|
|
45921
|
-
}
|
|
45922
|
-
|
|
45923
46729
|
export declare type JsonApiUserDataFilterInTypeEnum = "userDataFilter";
|
|
45924
46730
|
|
|
45925
46731
|
/**
|
|
@@ -45934,7 +46740,7 @@ export declare interface JsonApiUserDataFilterOut {
|
|
|
45934
46740
|
* API identifier of an object
|
|
45935
46741
|
*/
|
|
45936
46742
|
id: string;
|
|
45937
|
-
meta?:
|
|
46743
|
+
meta?: JsonApiDatasetOutMeta;
|
|
45938
46744
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
45939
46745
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
45940
46746
|
}
|
|
@@ -45975,17 +46781,13 @@ export declare interface JsonApiUserDataFilterOutList {
|
|
|
45975
46781
|
}
|
|
45976
46782
|
|
|
45977
46783
|
export declare interface JsonApiUserDataFilterOutRelationships {
|
|
45978
|
-
user?:
|
|
45979
|
-
userGroup?:
|
|
46784
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
46785
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
45980
46786
|
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
45981
46787
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
45982
|
-
labels?:
|
|
45983
|
-
metrics?:
|
|
45984
|
-
datasets?:
|
|
45985
|
-
}
|
|
45986
|
-
|
|
45987
|
-
export declare interface JsonApiUserDataFilterOutRelationshipsUserGroup {
|
|
45988
|
-
data: JsonApiUserGroupLinkage | null;
|
|
46788
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
46789
|
+
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
46790
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
45989
46791
|
}
|
|
45990
46792
|
|
|
45991
46793
|
export declare type JsonApiUserDataFilterOutTypeEnum = "userDataFilter";
|
|
@@ -45999,7 +46801,7 @@ export declare interface JsonApiUserDataFilterOutWithLinks {
|
|
|
45999
46801
|
* API identifier of an object
|
|
46000
46802
|
*/
|
|
46001
46803
|
id: string;
|
|
46002
|
-
meta?:
|
|
46804
|
+
meta?: JsonApiDatasetOutMeta;
|
|
46003
46805
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
46004
46806
|
relationships?: JsonApiUserDataFilterOutRelationships;
|
|
46005
46807
|
links?: ObjectLinks;
|
|
@@ -46020,7 +46822,7 @@ export declare interface JsonApiUserDataFilterPatch {
|
|
|
46020
46822
|
*/
|
|
46021
46823
|
id: string;
|
|
46022
46824
|
attributes: JsonApiUserDataFilterPatchAttributes;
|
|
46023
|
-
relationships?:
|
|
46825
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
46024
46826
|
}
|
|
46025
46827
|
|
|
46026
46828
|
export declare interface JsonApiUserDataFilterPatchAttributes {
|
|
@@ -46050,13 +46852,18 @@ export declare interface JsonApiUserDataFilterPostOptionalId {
|
|
|
46050
46852
|
*/
|
|
46051
46853
|
id?: string;
|
|
46052
46854
|
attributes: JsonApiUserDataFilterOutAttributes;
|
|
46053
|
-
relationships?:
|
|
46855
|
+
relationships?: JsonApiUserDataFilterPostOptionalIdRelationships;
|
|
46054
46856
|
}
|
|
46055
46857
|
|
|
46056
46858
|
export declare interface JsonApiUserDataFilterPostOptionalIdDocument {
|
|
46057
46859
|
data: JsonApiUserDataFilterPostOptionalId;
|
|
46058
46860
|
}
|
|
46059
46861
|
|
|
46862
|
+
export declare interface JsonApiUserDataFilterPostOptionalIdRelationships {
|
|
46863
|
+
user?: JsonApiOrganizationOutRelationshipsBootstrapUser;
|
|
46864
|
+
userGroup?: JsonApiOrganizationOutRelationshipsBootstrapUserGroup;
|
|
46865
|
+
}
|
|
46866
|
+
|
|
46060
46867
|
export declare type JsonApiUserDataFilterPostOptionalIdTypeEnum = "userDataFilter";
|
|
46061
46868
|
|
|
46062
46869
|
/**
|
|
@@ -46134,14 +46941,7 @@ export declare interface JsonApiUserGroupOutList {
|
|
|
46134
46941
|
}
|
|
46135
46942
|
|
|
46136
46943
|
export declare interface JsonApiUserGroupOutRelationships {
|
|
46137
|
-
parents?:
|
|
46138
|
-
}
|
|
46139
|
-
|
|
46140
|
-
export declare interface JsonApiUserGroupOutRelationshipsParents {
|
|
46141
|
-
/**
|
|
46142
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
46143
|
-
*/
|
|
46144
|
-
data: Array<JsonApiUserGroupLinkage>;
|
|
46944
|
+
parents?: JsonApiUserOutRelationshipsUserGroups;
|
|
46145
46945
|
}
|
|
46146
46946
|
|
|
46147
46947
|
export declare type JsonApiUserGroupOutTypeEnum = "userGroup";
|
|
@@ -46324,7 +47124,14 @@ export declare interface JsonApiUserOutList {
|
|
|
46324
47124
|
}
|
|
46325
47125
|
|
|
46326
47126
|
export declare interface JsonApiUserOutRelationships {
|
|
46327
|
-
userGroups?:
|
|
47127
|
+
userGroups?: JsonApiUserOutRelationshipsUserGroups;
|
|
47128
|
+
}
|
|
47129
|
+
|
|
47130
|
+
export declare interface JsonApiUserOutRelationshipsUserGroups {
|
|
47131
|
+
/**
|
|
47132
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47133
|
+
*/
|
|
47134
|
+
data: Array<JsonApiUserGroupLinkage>;
|
|
46328
47135
|
}
|
|
46329
47136
|
|
|
46330
47137
|
export declare type JsonApiUserOutTypeEnum = "user";
|
|
@@ -46379,7 +47186,7 @@ export declare interface JsonApiUserSettingIn {
|
|
|
46379
47186
|
* API identifier of an object
|
|
46380
47187
|
*/
|
|
46381
47188
|
id: string;
|
|
46382
|
-
attributes?:
|
|
47189
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
46383
47190
|
}
|
|
46384
47191
|
|
|
46385
47192
|
export declare interface JsonApiUserSettingInDocument {
|
|
@@ -46400,7 +47207,7 @@ export declare interface JsonApiUserSettingOut {
|
|
|
46400
47207
|
* API identifier of an object
|
|
46401
47208
|
*/
|
|
46402
47209
|
id: string;
|
|
46403
|
-
attributes?:
|
|
47210
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
46404
47211
|
}
|
|
46405
47212
|
|
|
46406
47213
|
export declare interface JsonApiUserSettingOutDocument {
|
|
@@ -46428,7 +47235,7 @@ export declare interface JsonApiUserSettingOutWithLinks {
|
|
|
46428
47235
|
* API identifier of an object
|
|
46429
47236
|
*/
|
|
46430
47237
|
id: string;
|
|
46431
|
-
attributes?:
|
|
47238
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
46432
47239
|
links?: ObjectLinks;
|
|
46433
47240
|
}
|
|
46434
47241
|
|
|
@@ -46446,19 +47253,7 @@ export declare interface JsonApiVisualizationObjectIn {
|
|
|
46446
47253
|
* API identifier of an object
|
|
46447
47254
|
*/
|
|
46448
47255
|
id: string;
|
|
46449
|
-
attributes:
|
|
46450
|
-
}
|
|
46451
|
-
|
|
46452
|
-
export declare interface JsonApiVisualizationObjectInAttributes {
|
|
46453
|
-
title?: string;
|
|
46454
|
-
description?: string;
|
|
46455
|
-
tags?: Array<string>;
|
|
46456
|
-
areRelationsValid?: boolean;
|
|
46457
|
-
/**
|
|
46458
|
-
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
46459
|
-
*/
|
|
46460
|
-
content: object;
|
|
46461
|
-
isHidden?: boolean;
|
|
47256
|
+
attributes: JsonApiVisualizationObjectPostOptionalIdAttributes;
|
|
46462
47257
|
}
|
|
46463
47258
|
|
|
46464
47259
|
export declare interface JsonApiVisualizationObjectInDocument {
|
|
@@ -46489,7 +47284,7 @@ export declare interface JsonApiVisualizationObjectOut {
|
|
|
46489
47284
|
* API identifier of an object
|
|
46490
47285
|
*/
|
|
46491
47286
|
id: string;
|
|
46492
|
-
meta?:
|
|
47287
|
+
meta?: JsonApiDatasetOutMeta;
|
|
46493
47288
|
attributes: JsonApiVisualizationObjectOutAttributes;
|
|
46494
47289
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
46495
47290
|
}
|
|
@@ -46531,13 +47326,31 @@ export declare interface JsonApiVisualizationObjectOutList {
|
|
|
46531
47326
|
}
|
|
46532
47327
|
|
|
46533
47328
|
export declare interface JsonApiVisualizationObjectOutRelationships {
|
|
46534
|
-
createdBy?:
|
|
46535
|
-
modifiedBy?:
|
|
47329
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
47330
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
46536
47331
|
facts?: JsonApiDatasetOutRelationshipsFacts;
|
|
46537
47332
|
attributes?: JsonApiDatasetOutRelationshipsAttributes;
|
|
46538
|
-
labels?:
|
|
46539
|
-
metrics?:
|
|
46540
|
-
datasets?:
|
|
47333
|
+
labels?: JsonApiVisualizationObjectOutRelationshipsLabels;
|
|
47334
|
+
metrics?: JsonApiVisualizationObjectOutRelationshipsMetrics;
|
|
47335
|
+
datasets?: JsonApiDatasetOutRelationshipsReferences;
|
|
47336
|
+
}
|
|
47337
|
+
|
|
47338
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsCreatedBy {
|
|
47339
|
+
data: JsonApiUserIdentifierLinkage | null;
|
|
47340
|
+
}
|
|
47341
|
+
|
|
47342
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsLabels {
|
|
47343
|
+
/**
|
|
47344
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47345
|
+
*/
|
|
47346
|
+
data: Array<JsonApiLabelLinkage>;
|
|
47347
|
+
}
|
|
47348
|
+
|
|
47349
|
+
export declare interface JsonApiVisualizationObjectOutRelationshipsMetrics {
|
|
47350
|
+
/**
|
|
47351
|
+
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
47352
|
+
*/
|
|
47353
|
+
data: Array<JsonApiMetricLinkage>;
|
|
46541
47354
|
}
|
|
46542
47355
|
|
|
46543
47356
|
export declare type JsonApiVisualizationObjectOutTypeEnum = "visualizationObject";
|
|
@@ -46551,7 +47364,7 @@ export declare interface JsonApiVisualizationObjectOutWithLinks {
|
|
|
46551
47364
|
* API identifier of an object
|
|
46552
47365
|
*/
|
|
46553
47366
|
id: string;
|
|
46554
|
-
meta?:
|
|
47367
|
+
meta?: JsonApiDatasetOutMeta;
|
|
46555
47368
|
attributes: JsonApiVisualizationObjectOutAttributes;
|
|
46556
47369
|
relationships?: JsonApiVisualizationObjectOutRelationships;
|
|
46557
47370
|
links?: ObjectLinks;
|
|
@@ -46604,7 +47417,19 @@ export declare interface JsonApiVisualizationObjectPostOptionalId {
|
|
|
46604
47417
|
* API identifier of an object
|
|
46605
47418
|
*/
|
|
46606
47419
|
id?: string;
|
|
46607
|
-
attributes:
|
|
47420
|
+
attributes: JsonApiVisualizationObjectPostOptionalIdAttributes;
|
|
47421
|
+
}
|
|
47422
|
+
|
|
47423
|
+
export declare interface JsonApiVisualizationObjectPostOptionalIdAttributes {
|
|
47424
|
+
title?: string;
|
|
47425
|
+
description?: string;
|
|
47426
|
+
tags?: Array<string>;
|
|
47427
|
+
areRelationsValid?: boolean;
|
|
47428
|
+
/**
|
|
47429
|
+
* Free-form JSON content. Maximum supported length is 250000 characters.
|
|
47430
|
+
*/
|
|
47431
|
+
content: object;
|
|
47432
|
+
isHidden?: boolean;
|
|
46608
47433
|
}
|
|
46609
47434
|
|
|
46610
47435
|
export declare interface JsonApiVisualizationObjectPostOptionalIdDocument {
|
|
@@ -46625,118 +47450,10 @@ export declare interface JsonApiWorkspaceAutomationOut {
|
|
|
46625
47450
|
* API identifier of an object
|
|
46626
47451
|
*/
|
|
46627
47452
|
id: string;
|
|
46628
|
-
attributes?:
|
|
47453
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
46629
47454
|
relationships?: JsonApiWorkspaceAutomationOutRelationships;
|
|
46630
47455
|
}
|
|
46631
47456
|
|
|
46632
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributes {
|
|
46633
|
-
title?: string;
|
|
46634
|
-
description?: string;
|
|
46635
|
-
tags?: Array<string>;
|
|
46636
|
-
areRelationsValid?: boolean;
|
|
46637
|
-
/**
|
|
46638
|
-
* Additional details to be included in the automated message.
|
|
46639
|
-
*/
|
|
46640
|
-
details?: object;
|
|
46641
|
-
metadata?: JsonApiWorkspaceAutomationOutAttributesMetadata | null;
|
|
46642
|
-
/**
|
|
46643
|
-
* Current state of the automation.
|
|
46644
|
-
*/
|
|
46645
|
-
state?: JsonApiWorkspaceAutomationOutAttributesStateEnum;
|
|
46646
|
-
/**
|
|
46647
|
-
* Specify automation evaluation mode.
|
|
46648
|
-
*/
|
|
46649
|
-
evaluationMode?: JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum;
|
|
46650
|
-
schedule?: JsonApiWorkspaceAutomationOutAttributesSchedule;
|
|
46651
|
-
alert?: JsonApiWorkspaceAutomationOutAttributesAlert;
|
|
46652
|
-
tabularExports?: Array<JsonApiWorkspaceAutomationOutAttributesTabularExportsInner>;
|
|
46653
|
-
visualExports?: Array<JsonApiWorkspaceAutomationOutAttributesVisualExportsInner>;
|
|
46654
|
-
imageExports?: Array<JsonApiWorkspaceAutomationOutAttributesImageExportsInner>;
|
|
46655
|
-
rawExports?: Array<JsonApiWorkspaceAutomationOutAttributesRawExportsInner>;
|
|
46656
|
-
slidesExports?: Array<JsonApiWorkspaceAutomationOutAttributesSlidesExportsInner>;
|
|
46657
|
-
dashboardTabularExports?: Array<JsonApiWorkspaceAutomationOutAttributesDashboardTabularExportsInner>;
|
|
46658
|
-
/**
|
|
46659
|
-
* External recipients of the automation action results.
|
|
46660
|
-
*/
|
|
46661
|
-
externalRecipients?: Array<JsonApiWorkspaceAutomationOutAttributesExternalRecipientsInner>;
|
|
46662
|
-
createdAt?: string;
|
|
46663
|
-
modifiedAt?: string;
|
|
46664
|
-
}
|
|
46665
|
-
|
|
46666
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesAlert {
|
|
46667
|
-
execution: AlertAfm;
|
|
46668
|
-
condition: AlertCondition;
|
|
46669
|
-
/**
|
|
46670
|
-
* Trigger behavior for the alert. ALWAYS - alert is triggered every time the condition is met. ONCE - alert is triggered only once when the condition is met.
|
|
46671
|
-
*/
|
|
46672
|
-
trigger?: JsonApiWorkspaceAutomationOutAttributesAlertTriggerEnum;
|
|
46673
|
-
}
|
|
46674
|
-
|
|
46675
|
-
export declare type JsonApiWorkspaceAutomationOutAttributesAlertTriggerEnum = "ALWAYS" | "ONCE";
|
|
46676
|
-
|
|
46677
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesDashboardTabularExportsInner {
|
|
46678
|
-
requestPayload: DashboardTabularExportRequestV2;
|
|
46679
|
-
}
|
|
46680
|
-
|
|
46681
|
-
export declare type JsonApiWorkspaceAutomationOutAttributesEvaluationModeEnum = "SHARED" | "PER_RECIPIENT";
|
|
46682
|
-
|
|
46683
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesExternalRecipientsInner {
|
|
46684
|
-
/**
|
|
46685
|
-
* E-mail address to send notifications from.
|
|
46686
|
-
*/
|
|
46687
|
-
email: string;
|
|
46688
|
-
}
|
|
46689
|
-
|
|
46690
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesImageExportsInner {
|
|
46691
|
-
requestPayload: ImageExportRequest;
|
|
46692
|
-
}
|
|
46693
|
-
|
|
46694
|
-
/**
|
|
46695
|
-
* Additional information for the automation.
|
|
46696
|
-
*/
|
|
46697
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesMetadata {
|
|
46698
|
-
[key: string]: any;
|
|
46699
|
-
widget?: string;
|
|
46700
|
-
visibleFilters?: Array<VisibleFilter>;
|
|
46701
|
-
}
|
|
46702
|
-
|
|
46703
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesRawExportsInner {
|
|
46704
|
-
requestPayload: RawExportAutomationRequest;
|
|
46705
|
-
}
|
|
46706
|
-
|
|
46707
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesSchedule {
|
|
46708
|
-
/**
|
|
46709
|
-
* Cron expression defining the schedule of the automation. The format is SECOND MINUTE HOUR DAY-OF-MONTH MONTH DAY-OF-WEEK (YEAR). The example expression signifies an action every 30 minutes from 9:00 to 17:00 on workdays.
|
|
46710
|
-
*/
|
|
46711
|
-
cron: string;
|
|
46712
|
-
/**
|
|
46713
|
-
* Human-readable description of the cron expression.
|
|
46714
|
-
*/
|
|
46715
|
-
cronDescription?: string;
|
|
46716
|
-
/**
|
|
46717
|
-
* Timezone in which the schedule is defined.
|
|
46718
|
-
*/
|
|
46719
|
-
timezone: string;
|
|
46720
|
-
/**
|
|
46721
|
-
* Timestamp of the first scheduled action. If not provided default to the next scheduled time.
|
|
46722
|
-
*/
|
|
46723
|
-
firstRun?: string;
|
|
46724
|
-
}
|
|
46725
|
-
|
|
46726
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesSlidesExportsInner {
|
|
46727
|
-
requestPayload: SlidesExportRequest;
|
|
46728
|
-
}
|
|
46729
|
-
|
|
46730
|
-
export declare type JsonApiWorkspaceAutomationOutAttributesStateEnum = "ACTIVE" | "PAUSED";
|
|
46731
|
-
|
|
46732
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesTabularExportsInner {
|
|
46733
|
-
requestPayload: TabularExportRequest;
|
|
46734
|
-
}
|
|
46735
|
-
|
|
46736
|
-
export declare interface JsonApiWorkspaceAutomationOutAttributesVisualExportsInner {
|
|
46737
|
-
requestPayload: VisualExportRequest;
|
|
46738
|
-
}
|
|
46739
|
-
|
|
46740
47457
|
/**
|
|
46741
47458
|
* @type JsonApiWorkspaceAutomationOutIncludes
|
|
46742
47459
|
*/
|
|
@@ -46761,38 +47478,13 @@ export declare interface JsonApiWorkspaceAutomationOutListMeta {
|
|
|
46761
47478
|
|
|
46762
47479
|
export declare interface JsonApiWorkspaceAutomationOutRelationships {
|
|
46763
47480
|
workspace?: JsonApiWorkspaceOutRelationshipsParent;
|
|
46764
|
-
notificationChannel?:
|
|
47481
|
+
notificationChannel?: JsonApiAutomationOutRelationshipsNotificationChannel;
|
|
46765
47482
|
analyticalDashboard?: JsonApiExportDefinitionOutRelationshipsAnalyticalDashboard;
|
|
46766
|
-
createdBy?:
|
|
46767
|
-
modifiedBy?:
|
|
46768
|
-
exportDefinitions?:
|
|
46769
|
-
recipients?:
|
|
46770
|
-
automationResults?:
|
|
46771
|
-
}
|
|
46772
|
-
|
|
46773
|
-
export declare interface JsonApiWorkspaceAutomationOutRelationshipsAutomationResults {
|
|
46774
|
-
/**
|
|
46775
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
46776
|
-
*/
|
|
46777
|
-
data: Array<JsonApiAutomationResultLinkage>;
|
|
46778
|
-
}
|
|
46779
|
-
|
|
46780
|
-
export declare interface JsonApiWorkspaceAutomationOutRelationshipsExportDefinitions {
|
|
46781
|
-
/**
|
|
46782
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
46783
|
-
*/
|
|
46784
|
-
data: Array<JsonApiExportDefinitionLinkage>;
|
|
46785
|
-
}
|
|
46786
|
-
|
|
46787
|
-
export declare interface JsonApiWorkspaceAutomationOutRelationshipsNotificationChannel {
|
|
46788
|
-
data: JsonApiNotificationChannelLinkage | null;
|
|
46789
|
-
}
|
|
46790
|
-
|
|
46791
|
-
export declare interface JsonApiWorkspaceAutomationOutRelationshipsRecipients {
|
|
46792
|
-
/**
|
|
46793
|
-
* References to other resource objects in a to-many (\\\"relationship\\\"). Relationships can be specified by including a member in a resource\'s links object.
|
|
46794
|
-
*/
|
|
46795
|
-
data: Array<JsonApiUserLinkage>;
|
|
47483
|
+
createdBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
47484
|
+
modifiedBy?: JsonApiVisualizationObjectOutRelationshipsCreatedBy;
|
|
47485
|
+
exportDefinitions?: JsonApiAutomationOutRelationshipsExportDefinitions;
|
|
47486
|
+
recipients?: JsonApiAutomationOutRelationshipsRecipients;
|
|
47487
|
+
automationResults?: JsonApiAutomationOutRelationshipsAutomationResults;
|
|
46796
47488
|
}
|
|
46797
47489
|
|
|
46798
47490
|
export declare type JsonApiWorkspaceAutomationOutTypeEnum = "workspaceAutomation";
|
|
@@ -46806,7 +47498,7 @@ export declare interface JsonApiWorkspaceAutomationOutWithLinks {
|
|
|
46806
47498
|
* API identifier of an object
|
|
46807
47499
|
*/
|
|
46808
47500
|
id: string;
|
|
46809
|
-
attributes?:
|
|
47501
|
+
attributes?: JsonApiAutomationOutAttributes;
|
|
46810
47502
|
relationships?: JsonApiWorkspaceAutomationOutRelationships;
|
|
46811
47503
|
links?: ObjectLinks;
|
|
46812
47504
|
}
|
|
@@ -46857,7 +47549,7 @@ export declare interface JsonApiWorkspaceDataFilterOut {
|
|
|
46857
47549
|
* API identifier of an object
|
|
46858
47550
|
*/
|
|
46859
47551
|
id: string;
|
|
46860
|
-
meta?:
|
|
47552
|
+
meta?: JsonApiDatasetOutMeta;
|
|
46861
47553
|
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
46862
47554
|
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
46863
47555
|
}
|
|
@@ -46912,7 +47604,7 @@ export declare interface JsonApiWorkspaceDataFilterOutWithLinks {
|
|
|
46912
47604
|
* API identifier of an object
|
|
46913
47605
|
*/
|
|
46914
47606
|
id: string;
|
|
46915
|
-
meta?:
|
|
47607
|
+
meta?: JsonApiDatasetOutMeta;
|
|
46916
47608
|
attributes?: JsonApiWorkspaceDataFilterOutAttributes;
|
|
46917
47609
|
relationships?: JsonApiWorkspaceDataFilterOutRelationships;
|
|
46918
47610
|
links?: ObjectLinks;
|
|
@@ -46986,7 +47678,7 @@ export declare interface JsonApiWorkspaceDataFilterSettingOut {
|
|
|
46986
47678
|
* API identifier of an object
|
|
46987
47679
|
*/
|
|
46988
47680
|
id: string;
|
|
46989
|
-
meta?:
|
|
47681
|
+
meta?: JsonApiDatasetOutMeta;
|
|
46990
47682
|
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
46991
47683
|
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
46992
47684
|
}
|
|
@@ -47038,7 +47730,7 @@ export declare interface JsonApiWorkspaceDataFilterSettingOutWithLinks {
|
|
|
47038
47730
|
* API identifier of an object
|
|
47039
47731
|
*/
|
|
47040
47732
|
id: string;
|
|
47041
|
-
meta?:
|
|
47733
|
+
meta?: JsonApiDatasetOutMeta;
|
|
47042
47734
|
attributes?: JsonApiWorkspaceDataFilterSettingOutAttributes;
|
|
47043
47735
|
relationships?: JsonApiWorkspaceDataFilterSettingOutRelationships;
|
|
47044
47736
|
links?: ObjectLinks;
|
|
@@ -47275,7 +47967,7 @@ export declare interface JsonApiWorkspaceSettingIn {
|
|
|
47275
47967
|
* API identifier of an object
|
|
47276
47968
|
*/
|
|
47277
47969
|
id: string;
|
|
47278
|
-
attributes?:
|
|
47970
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
47279
47971
|
}
|
|
47280
47972
|
|
|
47281
47973
|
export declare interface JsonApiWorkspaceSettingInDocument {
|
|
@@ -47296,10 +47988,20 @@ export declare interface JsonApiWorkspaceSettingOut {
|
|
|
47296
47988
|
* API identifier of an object
|
|
47297
47989
|
*/
|
|
47298
47990
|
id: string;
|
|
47299
|
-
meta?:
|
|
47300
|
-
attributes?:
|
|
47991
|
+
meta?: JsonApiDatasetOutMeta;
|
|
47992
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
47301
47993
|
}
|
|
47302
47994
|
|
|
47995
|
+
export declare interface JsonApiWorkspaceSettingOutAttributes {
|
|
47996
|
+
/**
|
|
47997
|
+
* Free-form JSON content. Maximum supported length is 15000 characters.
|
|
47998
|
+
*/
|
|
47999
|
+
content?: object;
|
|
48000
|
+
type?: JsonApiWorkspaceSettingOutAttributesTypeEnum;
|
|
48001
|
+
}
|
|
48002
|
+
|
|
48003
|
+
export declare type JsonApiWorkspaceSettingOutAttributesTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE" | "ENABLE_AI_ON_DATA";
|
|
48004
|
+
|
|
47303
48005
|
export declare interface JsonApiWorkspaceSettingOutDocument {
|
|
47304
48006
|
data: JsonApiWorkspaceSettingOut;
|
|
47305
48007
|
links?: ObjectLinks;
|
|
@@ -47325,8 +48027,8 @@ export declare interface JsonApiWorkspaceSettingOutWithLinks {
|
|
|
47325
48027
|
* API identifier of an object
|
|
47326
48028
|
*/
|
|
47327
48029
|
id: string;
|
|
47328
|
-
meta?:
|
|
47329
|
-
attributes?:
|
|
48030
|
+
meta?: JsonApiDatasetOutMeta;
|
|
48031
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
47330
48032
|
links?: ObjectLinks;
|
|
47331
48033
|
}
|
|
47332
48034
|
|
|
@@ -47344,7 +48046,7 @@ export declare interface JsonApiWorkspaceSettingPatch {
|
|
|
47344
48046
|
* API identifier of an object
|
|
47345
48047
|
*/
|
|
47346
48048
|
id: string;
|
|
47347
|
-
attributes?:
|
|
48049
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
47348
48050
|
}
|
|
47349
48051
|
|
|
47350
48052
|
export declare interface JsonApiWorkspaceSettingPatchDocument {
|
|
@@ -47365,7 +48067,7 @@ export declare interface JsonApiWorkspaceSettingPostOptionalId {
|
|
|
47365
48067
|
* API identifier of an object
|
|
47366
48068
|
*/
|
|
47367
48069
|
id?: string;
|
|
47368
|
-
attributes?:
|
|
48070
|
+
attributes?: JsonApiWorkspaceSettingOutAttributes;
|
|
47369
48071
|
}
|
|
47370
48072
|
|
|
47371
48073
|
export declare interface JsonApiWorkspaceSettingPostOptionalIdDocument {
|
|
@@ -47951,6 +48653,15 @@ export declare class LabelsApi extends MetadataBaseApi implements LabelsApiInter
|
|
|
47951
48653
|
* @memberof LabelsApi
|
|
47952
48654
|
*/
|
|
47953
48655
|
getEntityLabels(requestParameters: LabelsApiGetEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
48656
|
+
/**
|
|
48657
|
+
*
|
|
48658
|
+
* @summary Patch a Label (beta)
|
|
48659
|
+
* @param {LabelsApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
48660
|
+
* @param {*} [options] Override http request option.
|
|
48661
|
+
* @throws {RequiredError}
|
|
48662
|
+
* @memberof LabelsApi
|
|
48663
|
+
*/
|
|
48664
|
+
patchEntityLabels(requestParameters: LabelsApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
47954
48665
|
}
|
|
47955
48666
|
|
|
47956
48667
|
/**
|
|
@@ -47977,6 +48688,18 @@ export declare function LabelsApi_GetAllEntitiesLabels(axios: AxiosInstance, bas
|
|
|
47977
48688
|
*/
|
|
47978
48689
|
export declare function LabelsApi_GetEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: LabelsApiGetEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
47979
48690
|
|
|
48691
|
+
/**
|
|
48692
|
+
*
|
|
48693
|
+
* @summary Patch a Label (beta)
|
|
48694
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
48695
|
+
* @param {string} basePath Base path.
|
|
48696
|
+
* @param {LabelsApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
48697
|
+
* @param {*} [options] Override http request option.
|
|
48698
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
48699
|
+
* @throws {RequiredError}
|
|
48700
|
+
*/
|
|
48701
|
+
export declare function LabelsApi_PatchEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: LabelsApiPatchEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
48702
|
+
|
|
47980
48703
|
/**
|
|
47981
48704
|
*
|
|
47982
48705
|
* @summary Get all Labels
|
|
@@ -48010,6 +48733,20 @@ export declare function LabelsApiAxiosParamCreator_GetAllEntitiesLabels(workspac
|
|
|
48010
48733
|
*/
|
|
48011
48734
|
export declare function LabelsApiAxiosParamCreator_GetEntityLabels(workspaceId: string, objectId: string, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, xGDCVALIDATERELATIONS?: boolean, metaInclude?: Array<"origin" | "all" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
48012
48735
|
|
|
48736
|
+
/**
|
|
48737
|
+
*
|
|
48738
|
+
* @summary Patch a Label (beta)
|
|
48739
|
+
* @param {string} workspaceId
|
|
48740
|
+
* @param {string} objectId
|
|
48741
|
+
* @param {JsonApiLabelPatchDocument} jsonApiLabelPatchDocument
|
|
48742
|
+
* @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\').
|
|
48743
|
+
* @param {Array<'attributes' | 'attribute' | '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.
|
|
48744
|
+
* @param {*} [options] Override http request option.
|
|
48745
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
48746
|
+
* @throws {RequiredError}
|
|
48747
|
+
*/
|
|
48748
|
+
export declare function LabelsApiAxiosParamCreator_PatchEntityLabels(workspaceId: string, objectId: string, jsonApiLabelPatchDocument: JsonApiLabelPatchDocument, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
48749
|
+
|
|
48013
48750
|
/**
|
|
48014
48751
|
* Request parameters for getAllEntitiesLabels operation in LabelsApi.
|
|
48015
48752
|
* @export
|
|
@@ -48140,6 +48877,53 @@ export declare interface LabelsApiInterface {
|
|
|
48140
48877
|
* @memberof LabelsApiInterface
|
|
48141
48878
|
*/
|
|
48142
48879
|
getEntityLabels(requestParameters: LabelsApiGetEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
48880
|
+
/**
|
|
48881
|
+
*
|
|
48882
|
+
* @summary Patch a Label (beta)
|
|
48883
|
+
* @param {LabelsApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
48884
|
+
* @param {*} [options] Override http request option.
|
|
48885
|
+
* @throws {RequiredError}
|
|
48886
|
+
* @memberof LabelsApiInterface
|
|
48887
|
+
*/
|
|
48888
|
+
patchEntityLabels(requestParameters: LabelsApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
48889
|
+
}
|
|
48890
|
+
|
|
48891
|
+
/**
|
|
48892
|
+
* Request parameters for patchEntityLabels operation in LabelsApi.
|
|
48893
|
+
* @export
|
|
48894
|
+
* @interface LabelsApiPatchEntityLabelsRequest
|
|
48895
|
+
*/
|
|
48896
|
+
export declare interface LabelsApiPatchEntityLabelsRequest {
|
|
48897
|
+
/**
|
|
48898
|
+
*
|
|
48899
|
+
* @type {string}
|
|
48900
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
48901
|
+
*/
|
|
48902
|
+
readonly workspaceId: string;
|
|
48903
|
+
/**
|
|
48904
|
+
*
|
|
48905
|
+
* @type {string}
|
|
48906
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
48907
|
+
*/
|
|
48908
|
+
readonly objectId: string;
|
|
48909
|
+
/**
|
|
48910
|
+
*
|
|
48911
|
+
* @type {JsonApiLabelPatchDocument}
|
|
48912
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
48913
|
+
*/
|
|
48914
|
+
readonly jsonApiLabelPatchDocument: JsonApiLabelPatchDocument;
|
|
48915
|
+
/**
|
|
48916
|
+
* 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\').
|
|
48917
|
+
* @type {string}
|
|
48918
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
48919
|
+
*/
|
|
48920
|
+
readonly filter?: string;
|
|
48921
|
+
/**
|
|
48922
|
+
* 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.
|
|
48923
|
+
* @type {Array<'attributes' | 'attribute' | 'ALL'>}
|
|
48924
|
+
* @memberof LabelsApiPatchEntityLabels
|
|
48925
|
+
*/
|
|
48926
|
+
readonly include?: Array<"attributes" | "attribute" | "ALL">;
|
|
48143
48927
|
}
|
|
48144
48928
|
|
|
48145
48929
|
/**
|
|
@@ -62606,7 +63390,7 @@ export declare interface ResolvedSetting {
|
|
|
62606
63390
|
type?: ResolvedSettingTypeEnum;
|
|
62607
63391
|
}
|
|
62608
63392
|
|
|
62609
|
-
export declare type ResolvedSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE";
|
|
63393
|
+
export declare type ResolvedSettingTypeEnum = "TIMEZONE" | "ACTIVE_THEME" | "ACTIVE_COLOR_PALETTE" | "ACTIVE_LLM_ENDPOINT" | "WHITE_LABELING" | "LOCALE" | "METADATA_LOCALE" | "FORMAT_LOCALE" | "MAPBOX_TOKEN" | "AG_GRID_TOKEN" | "WEEK_START" | "FISCAL_YEAR" | "SHOW_HIDDEN_CATALOG_ITEMS" | "OPERATOR_OVERRIDES" | "TIMEZONE_VALIDATION_ENABLED" | "OPENAI_CONFIG" | "ENABLE_FILE_ANALYTICS" | "ALERT" | "SEPARATORS" | "DATE_FILTER_CONFIG" | "JIT_PROVISIONING" | "JWT_JIT_PROVISIONING" | "DASHBOARD_FILTERS_APPLY_MODE" | "ENABLE_SLIDES_EXPORT" | "ENABLE_SNAPSHOT_EXPORT" | "AI_RATE_LIMIT" | "ATTACHMENT_SIZE_LIMIT" | "ATTACHMENT_LINK_TTL" | "AD_CATALOG_GROUPS_DEFAULT_EXPAND_STATE" | "ENABLE_DRILL_TO_URL_BY_DEFAULT" | "ALLOW_UNSAFE_FLEX_CONNECT_ENDPOINTS" | "ENABLE_AUTOMATION_EVALUATION_MODE" | "ENABLE_ACCESSIBILITY_MODE" | "REGISTERED_PLUGGABLE_APPLICATIONS" | "DATA_LOCALE" | "LDM_DEFAULT_LOCALE" | "EXPORT_RESULT_POLLING_TIMEOUT_SECONDS" | "SORT_CASE_SENSITIVE" | "METRIC_FORMAT_OVERRIDE" | "ENABLE_AI_ON_DATA";
|
|
62610
63394
|
|
|
62611
63395
|
/**
|
|
62612
63396
|
* A request containing setting IDs to resolve.
|
|
@@ -69682,6 +70466,15 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
69682
70466
|
* @memberof WorkspaceObjectControllerApi
|
|
69683
70467
|
*/
|
|
69684
70468
|
patchEntityAttributeHierarchies(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
70469
|
+
/**
|
|
70470
|
+
*
|
|
70471
|
+
* @summary Patch an Attribute (beta)
|
|
70472
|
+
* @param {WorkspaceObjectControllerApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
70473
|
+
* @param {*} [options] Override http request option.
|
|
70474
|
+
* @throws {RequiredError}
|
|
70475
|
+
* @memberof WorkspaceObjectControllerApi
|
|
70476
|
+
*/
|
|
70477
|
+
patchEntityAttributes(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
69685
70478
|
/**
|
|
69686
70479
|
*
|
|
69687
70480
|
* @summary Patch an Automation
|
|
@@ -69709,6 +70502,15 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
69709
70502
|
* @memberof WorkspaceObjectControllerApi
|
|
69710
70503
|
*/
|
|
69711
70504
|
patchEntityDashboardPlugins(requestParameters: WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
70505
|
+
/**
|
|
70506
|
+
*
|
|
70507
|
+
* @summary Patch a Dataset (beta)
|
|
70508
|
+
* @param {WorkspaceObjectControllerApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
70509
|
+
* @param {*} [options] Override http request option.
|
|
70510
|
+
* @throws {RequiredError}
|
|
70511
|
+
* @memberof WorkspaceObjectControllerApi
|
|
70512
|
+
*/
|
|
70513
|
+
patchEntityDatasets(requestParameters: WorkspaceObjectControllerApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
69712
70514
|
/**
|
|
69713
70515
|
*
|
|
69714
70516
|
* @summary Patch an Export Definition
|
|
@@ -69718,6 +70520,15 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
69718
70520
|
* @memberof WorkspaceObjectControllerApi
|
|
69719
70521
|
*/
|
|
69720
70522
|
patchEntityExportDefinitions(requestParameters: WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportDefinitionOutDocument>;
|
|
70523
|
+
/**
|
|
70524
|
+
*
|
|
70525
|
+
* @summary Patch a Fact (beta)
|
|
70526
|
+
* @param {WorkspaceObjectControllerApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
70527
|
+
* @param {*} [options] Override http request option.
|
|
70528
|
+
* @throws {RequiredError}
|
|
70529
|
+
* @memberof WorkspaceObjectControllerApi
|
|
70530
|
+
*/
|
|
70531
|
+
patchEntityFacts(requestParameters: WorkspaceObjectControllerApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
69721
70532
|
/**
|
|
69722
70533
|
*
|
|
69723
70534
|
* @summary Patch a Context Filter
|
|
@@ -69736,6 +70547,15 @@ export declare class WorkspaceObjectControllerApi extends MetadataBaseApi implem
|
|
|
69736
70547
|
* @memberof WorkspaceObjectControllerApi
|
|
69737
70548
|
*/
|
|
69738
70549
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
70550
|
+
/**
|
|
70551
|
+
*
|
|
70552
|
+
* @summary Patch a Label (beta)
|
|
70553
|
+
* @param {WorkspaceObjectControllerApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
70554
|
+
* @param {*} [options] Override http request option.
|
|
70555
|
+
* @throws {RequiredError}
|
|
70556
|
+
* @memberof WorkspaceObjectControllerApi
|
|
70557
|
+
*/
|
|
70558
|
+
patchEntityLabels(requestParameters: WorkspaceObjectControllerApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
69739
70559
|
/**
|
|
69740
70560
|
*
|
|
69741
70561
|
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
@@ -70980,6 +71800,18 @@ export declare function WorkspaceObjectControllerApi_PatchEntityAnalyticalDashbo
|
|
|
70980
71800
|
*/
|
|
70981
71801
|
export declare function WorkspaceObjectControllerApi_PatchEntityAttributeHierarchies(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
70982
71802
|
|
|
71803
|
+
/**
|
|
71804
|
+
*
|
|
71805
|
+
* @summary Patch an Attribute (beta)
|
|
71806
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
71807
|
+
* @param {string} basePath Base path.
|
|
71808
|
+
* @param {WorkspaceObjectControllerApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
71809
|
+
* @param {*} [options] Override http request option.
|
|
71810
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
71811
|
+
* @throws {RequiredError}
|
|
71812
|
+
*/
|
|
71813
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityAttributes(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityAttributesRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
71814
|
+
|
|
70983
71815
|
/**
|
|
70984
71816
|
*
|
|
70985
71817
|
* @summary Patch an Automation
|
|
@@ -71016,6 +71848,18 @@ export declare function WorkspaceObjectControllerApi_PatchEntityCustomApplicatio
|
|
|
71016
71848
|
*/
|
|
71017
71849
|
export declare function WorkspaceObjectControllerApi_PatchEntityDashboardPlugins(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
71018
71850
|
|
|
71851
|
+
/**
|
|
71852
|
+
*
|
|
71853
|
+
* @summary Patch a Dataset (beta)
|
|
71854
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
71855
|
+
* @param {string} basePath Base path.
|
|
71856
|
+
* @param {WorkspaceObjectControllerApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
71857
|
+
* @param {*} [options] Override http request option.
|
|
71858
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
71859
|
+
* @throws {RequiredError}
|
|
71860
|
+
*/
|
|
71861
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityDatasets(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
71862
|
+
|
|
71019
71863
|
/**
|
|
71020
71864
|
*
|
|
71021
71865
|
* @summary Patch an Export Definition
|
|
@@ -71028,6 +71872,18 @@ export declare function WorkspaceObjectControllerApi_PatchEntityDashboardPlugins
|
|
|
71028
71872
|
*/
|
|
71029
71873
|
export declare function WorkspaceObjectControllerApi_PatchEntityExportDefinitions(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiExportDefinitionOutDocument>;
|
|
71030
71874
|
|
|
71875
|
+
/**
|
|
71876
|
+
*
|
|
71877
|
+
* @summary Patch a Fact (beta)
|
|
71878
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
71879
|
+
* @param {string} basePath Base path.
|
|
71880
|
+
* @param {WorkspaceObjectControllerApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
71881
|
+
* @param {*} [options] Override http request option.
|
|
71882
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
71883
|
+
* @throws {RequiredError}
|
|
71884
|
+
*/
|
|
71885
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityFacts(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityFactsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiFactOutDocument>;
|
|
71886
|
+
|
|
71031
71887
|
/**
|
|
71032
71888
|
*
|
|
71033
71889
|
* @summary Patch a Context Filter
|
|
@@ -71052,6 +71908,18 @@ export declare function WorkspaceObjectControllerApi_PatchEntityFilterContexts(a
|
|
|
71052
71908
|
*/
|
|
71053
71909
|
export declare function WorkspaceObjectControllerApi_PatchEntityFilterViews(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
71054
71910
|
|
|
71911
|
+
/**
|
|
71912
|
+
*
|
|
71913
|
+
* @summary Patch a Label (beta)
|
|
71914
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
71915
|
+
* @param {string} basePath Base path.
|
|
71916
|
+
* @param {WorkspaceObjectControllerApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
71917
|
+
* @param {*} [options] Override http request option.
|
|
71918
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
71919
|
+
* @throws {RequiredError}
|
|
71920
|
+
*/
|
|
71921
|
+
export declare function WorkspaceObjectControllerApi_PatchEntityLabels(axios: AxiosInstance, basePath: string, requestParameters: WorkspaceObjectControllerApiPatchEntityLabelsRequest, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): AxiosPromise<JsonApiLabelOutDocument>;
|
|
71922
|
+
|
|
71055
71923
|
/**
|
|
71056
71924
|
*
|
|
71057
71925
|
* @param {AxiosInstance} axios Axios instance.
|
|
@@ -72614,6 +73482,20 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
72614
73482
|
*/
|
|
72615
73483
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityAttributeHierarchies(workspaceId: string, objectId: string, jsonApiAttributeHierarchyPatchDocument: JsonApiAttributeHierarchyPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
72616
73484
|
|
|
73485
|
+
/**
|
|
73486
|
+
*
|
|
73487
|
+
* @summary Patch an Attribute (beta)
|
|
73488
|
+
* @param {string} workspaceId
|
|
73489
|
+
* @param {string} objectId
|
|
73490
|
+
* @param {JsonApiAttributePatchDocument} jsonApiAttributePatchDocument
|
|
73491
|
+
* @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\').
|
|
73492
|
+
* @param {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | '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.
|
|
73493
|
+
* @param {*} [options] Override http request option.
|
|
73494
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
73495
|
+
* @throws {RequiredError}
|
|
73496
|
+
*/
|
|
73497
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityAttributes(workspaceId: string, objectId: string, jsonApiAttributePatchDocument: JsonApiAttributePatchDocument, filter?: string, include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
73498
|
+
|
|
72617
73499
|
/**
|
|
72618
73500
|
*
|
|
72619
73501
|
* @summary Patch an Automation
|
|
@@ -72655,6 +73537,20 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
72655
73537
|
*/
|
|
72656
73538
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityDashboardPlugins(workspaceId: string, objectId: string, jsonApiDashboardPluginPatchDocument: JsonApiDashboardPluginPatchDocument, filter?: string, include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
72657
73539
|
|
|
73540
|
+
/**
|
|
73541
|
+
*
|
|
73542
|
+
* @summary Patch a Dataset (beta)
|
|
73543
|
+
* @param {string} workspaceId
|
|
73544
|
+
* @param {string} objectId
|
|
73545
|
+
* @param {JsonApiDatasetPatchDocument} jsonApiDatasetPatchDocument
|
|
73546
|
+
* @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\').
|
|
73547
|
+
* @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.
|
|
73548
|
+
* @param {*} [options] Override http request option.
|
|
73549
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
73550
|
+
* @throws {RequiredError}
|
|
73551
|
+
*/
|
|
73552
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityDatasets(workspaceId: string, objectId: string, jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument, filter?: string, include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
73553
|
+
|
|
72658
73554
|
/**
|
|
72659
73555
|
*
|
|
72660
73556
|
* @summary Patch an Export Definition
|
|
@@ -72669,6 +73565,20 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
72669
73565
|
*/
|
|
72670
73566
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityExportDefinitions(workspaceId: string, objectId: string, jsonApiExportDefinitionPatchDocument: JsonApiExportDefinitionPatchDocument, filter?: string, include?: Array<"visualizationObjects" | "analyticalDashboards" | "automations" | "userIdentifiers" | "visualizationObject" | "analyticalDashboard" | "automation" | "createdBy" | "modifiedBy" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
72671
73567
|
|
|
73568
|
+
/**
|
|
73569
|
+
*
|
|
73570
|
+
* @summary Patch a Fact (beta)
|
|
73571
|
+
* @param {string} workspaceId
|
|
73572
|
+
* @param {string} objectId
|
|
73573
|
+
* @param {JsonApiFactPatchDocument} jsonApiFactPatchDocument
|
|
73574
|
+
* @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\').
|
|
73575
|
+
* @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.
|
|
73576
|
+
* @param {*} [options] Override http request option.
|
|
73577
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
73578
|
+
* @throws {RequiredError}
|
|
73579
|
+
*/
|
|
73580
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityFacts(workspaceId: string, objectId: string, jsonApiFactPatchDocument: JsonApiFactPatchDocument, filter?: string, include?: Array<"datasets" | "dataset" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
73581
|
+
|
|
72672
73582
|
/**
|
|
72673
73583
|
*
|
|
72674
73584
|
* @summary Patch a Context Filter
|
|
@@ -72697,6 +73607,20 @@ export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntit
|
|
|
72697
73607
|
*/
|
|
72698
73608
|
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityFilterViews(workspaceId: string, objectId: string, jsonApiFilterViewPatchDocument: JsonApiFilterViewPatchDocument, filter?: string, include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
72699
73609
|
|
|
73610
|
+
/**
|
|
73611
|
+
*
|
|
73612
|
+
* @summary Patch a Label (beta)
|
|
73613
|
+
* @param {string} workspaceId
|
|
73614
|
+
* @param {string} objectId
|
|
73615
|
+
* @param {JsonApiLabelPatchDocument} jsonApiLabelPatchDocument
|
|
73616
|
+
* @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\').
|
|
73617
|
+
* @param {Array<'attributes' | 'attribute' | '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.
|
|
73618
|
+
* @param {*} [options] Override http request option.
|
|
73619
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
73620
|
+
* @throws {RequiredError}
|
|
73621
|
+
*/
|
|
73622
|
+
export declare function WorkspaceObjectControllerApiAxiosParamCreator_PatchEntityLabels(workspaceId: string, objectId: string, jsonApiLabelPatchDocument: JsonApiLabelPatchDocument, filter?: string, include?: Array<"attributes" | "attribute" | "ALL">, options?: AxiosRequestConfig, configuration?: MetadataConfiguration): Promise<MetadataRequestArgs>;
|
|
73623
|
+
|
|
72700
73624
|
/**
|
|
72701
73625
|
*
|
|
72702
73626
|
* @param {string} workspaceId
|
|
@@ -76862,6 +77786,15 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
76862
77786
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
76863
77787
|
*/
|
|
76864
77788
|
patchEntityAttributeHierarchies(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributeHierarchiesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeHierarchyOutDocument>;
|
|
77789
|
+
/**
|
|
77790
|
+
*
|
|
77791
|
+
* @summary Patch an Attribute (beta)
|
|
77792
|
+
* @param {WorkspaceObjectControllerApiPatchEntityAttributesRequest} requestParameters Request parameters.
|
|
77793
|
+
* @param {*} [options] Override http request option.
|
|
77794
|
+
* @throws {RequiredError}
|
|
77795
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
77796
|
+
*/
|
|
77797
|
+
patchEntityAttributes(requestParameters: WorkspaceObjectControllerApiPatchEntityAttributesRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiAttributeOutDocument>;
|
|
76865
77798
|
/**
|
|
76866
77799
|
*
|
|
76867
77800
|
* @summary Patch an Automation
|
|
@@ -76889,6 +77822,15 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
76889
77822
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
76890
77823
|
*/
|
|
76891
77824
|
patchEntityDashboardPlugins(requestParameters: WorkspaceObjectControllerApiPatchEntityDashboardPluginsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDashboardPluginOutDocument>;
|
|
77825
|
+
/**
|
|
77826
|
+
*
|
|
77827
|
+
* @summary Patch a Dataset (beta)
|
|
77828
|
+
* @param {WorkspaceObjectControllerApiPatchEntityDatasetsRequest} requestParameters Request parameters.
|
|
77829
|
+
* @param {*} [options] Override http request option.
|
|
77830
|
+
* @throws {RequiredError}
|
|
77831
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
77832
|
+
*/
|
|
77833
|
+
patchEntityDatasets(requestParameters: WorkspaceObjectControllerApiPatchEntityDatasetsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiDatasetOutDocument>;
|
|
76892
77834
|
/**
|
|
76893
77835
|
*
|
|
76894
77836
|
* @summary Patch an Export Definition
|
|
@@ -76898,6 +77840,15 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
76898
77840
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
76899
77841
|
*/
|
|
76900
77842
|
patchEntityExportDefinitions(requestParameters: WorkspaceObjectControllerApiPatchEntityExportDefinitionsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiExportDefinitionOutDocument>;
|
|
77843
|
+
/**
|
|
77844
|
+
*
|
|
77845
|
+
* @summary Patch a Fact (beta)
|
|
77846
|
+
* @param {WorkspaceObjectControllerApiPatchEntityFactsRequest} requestParameters Request parameters.
|
|
77847
|
+
* @param {*} [options] Override http request option.
|
|
77848
|
+
* @throws {RequiredError}
|
|
77849
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
77850
|
+
*/
|
|
77851
|
+
patchEntityFacts(requestParameters: WorkspaceObjectControllerApiPatchEntityFactsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFactOutDocument>;
|
|
76901
77852
|
/**
|
|
76902
77853
|
*
|
|
76903
77854
|
* @summary Patch a Context Filter
|
|
@@ -76916,6 +77867,15 @@ export declare interface WorkspaceObjectControllerApiInterface {
|
|
|
76916
77867
|
* @memberof WorkspaceObjectControllerApiInterface
|
|
76917
77868
|
*/
|
|
76918
77869
|
patchEntityFilterViews(requestParameters: WorkspaceObjectControllerApiPatchEntityFilterViewsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiFilterViewOutDocument>;
|
|
77870
|
+
/**
|
|
77871
|
+
*
|
|
77872
|
+
* @summary Patch a Label (beta)
|
|
77873
|
+
* @param {WorkspaceObjectControllerApiPatchEntityLabelsRequest} requestParameters Request parameters.
|
|
77874
|
+
* @param {*} [options] Override http request option.
|
|
77875
|
+
* @throws {RequiredError}
|
|
77876
|
+
* @memberof WorkspaceObjectControllerApiInterface
|
|
77877
|
+
*/
|
|
77878
|
+
patchEntityLabels(requestParameters: WorkspaceObjectControllerApiPatchEntityLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<JsonApiLabelOutDocument>;
|
|
76919
77879
|
/**
|
|
76920
77880
|
*
|
|
76921
77881
|
* @param {WorkspaceObjectControllerApiPatchEntityMemoryItemsRequest} requestParameters Request parameters.
|
|
@@ -77378,6 +78338,44 @@ export declare interface WorkspaceObjectControllerApiPatchEntityAttributeHierarc
|
|
|
77378
78338
|
readonly include?: Array<"userIdentifiers" | "attributes" | "createdBy" | "modifiedBy" | "ALL">;
|
|
77379
78339
|
}
|
|
77380
78340
|
|
|
78341
|
+
/**
|
|
78342
|
+
* Request parameters for patchEntityAttributes operation in WorkspaceObjectControllerApi.
|
|
78343
|
+
* @export
|
|
78344
|
+
* @interface WorkspaceObjectControllerApiPatchEntityAttributesRequest
|
|
78345
|
+
*/
|
|
78346
|
+
export declare interface WorkspaceObjectControllerApiPatchEntityAttributesRequest {
|
|
78347
|
+
/**
|
|
78348
|
+
*
|
|
78349
|
+
* @type {string}
|
|
78350
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
78351
|
+
*/
|
|
78352
|
+
readonly workspaceId: string;
|
|
78353
|
+
/**
|
|
78354
|
+
*
|
|
78355
|
+
* @type {string}
|
|
78356
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
78357
|
+
*/
|
|
78358
|
+
readonly objectId: string;
|
|
78359
|
+
/**
|
|
78360
|
+
*
|
|
78361
|
+
* @type {JsonApiAttributePatchDocument}
|
|
78362
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
78363
|
+
*/
|
|
78364
|
+
readonly jsonApiAttributePatchDocument: JsonApiAttributePatchDocument;
|
|
78365
|
+
/**
|
|
78366
|
+
* 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\').
|
|
78367
|
+
* @type {string}
|
|
78368
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
78369
|
+
*/
|
|
78370
|
+
readonly filter?: string;
|
|
78371
|
+
/**
|
|
78372
|
+
* 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.
|
|
78373
|
+
* @type {Array<'datasets' | 'labels' | 'attributeHierarchies' | 'dataset' | 'defaultView' | 'ALL'>}
|
|
78374
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityAttributes
|
|
78375
|
+
*/
|
|
78376
|
+
readonly include?: Array<"datasets" | "labels" | "attributeHierarchies" | "dataset" | "defaultView" | "ALL">;
|
|
78377
|
+
}
|
|
78378
|
+
|
|
77381
78379
|
/**
|
|
77382
78380
|
* Request parameters for patchEntityAutomations operation in WorkspaceObjectControllerApi.
|
|
77383
78381
|
* @export
|
|
@@ -77486,6 +78484,44 @@ export declare interface WorkspaceObjectControllerApiPatchEntityDashboardPlugins
|
|
|
77486
78484
|
readonly include?: Array<"userIdentifiers" | "createdBy" | "modifiedBy" | "ALL">;
|
|
77487
78485
|
}
|
|
77488
78486
|
|
|
78487
|
+
/**
|
|
78488
|
+
* Request parameters for patchEntityDatasets operation in WorkspaceObjectControllerApi.
|
|
78489
|
+
* @export
|
|
78490
|
+
* @interface WorkspaceObjectControllerApiPatchEntityDatasetsRequest
|
|
78491
|
+
*/
|
|
78492
|
+
export declare interface WorkspaceObjectControllerApiPatchEntityDatasetsRequest {
|
|
78493
|
+
/**
|
|
78494
|
+
*
|
|
78495
|
+
* @type {string}
|
|
78496
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
78497
|
+
*/
|
|
78498
|
+
readonly workspaceId: string;
|
|
78499
|
+
/**
|
|
78500
|
+
*
|
|
78501
|
+
* @type {string}
|
|
78502
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
78503
|
+
*/
|
|
78504
|
+
readonly objectId: string;
|
|
78505
|
+
/**
|
|
78506
|
+
*
|
|
78507
|
+
* @type {JsonApiDatasetPatchDocument}
|
|
78508
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
78509
|
+
*/
|
|
78510
|
+
readonly jsonApiDatasetPatchDocument: JsonApiDatasetPatchDocument;
|
|
78511
|
+
/**
|
|
78512
|
+
* 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\').
|
|
78513
|
+
* @type {string}
|
|
78514
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
78515
|
+
*/
|
|
78516
|
+
readonly filter?: string;
|
|
78517
|
+
/**
|
|
78518
|
+
* 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.
|
|
78519
|
+
* @type {Array<'attributes' | 'facts' | 'aggregatedFacts' | 'datasets' | 'workspaceDataFilters' | 'references' | 'ALL'>}
|
|
78520
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityDatasets
|
|
78521
|
+
*/
|
|
78522
|
+
readonly include?: Array<"attributes" | "facts" | "aggregatedFacts" | "datasets" | "workspaceDataFilters" | "references" | "ALL">;
|
|
78523
|
+
}
|
|
78524
|
+
|
|
77489
78525
|
/**
|
|
77490
78526
|
* Request parameters for patchEntityExportDefinitions operation in WorkspaceObjectControllerApi.
|
|
77491
78527
|
* @export
|
|
@@ -77524,6 +78560,44 @@ export declare interface WorkspaceObjectControllerApiPatchEntityExportDefinition
|
|
|
77524
78560
|
readonly include?: Array<"visualizationObjects" | "analyticalDashboards" | "automations" | "userIdentifiers" | "visualizationObject" | "analyticalDashboard" | "automation" | "createdBy" | "modifiedBy" | "ALL">;
|
|
77525
78561
|
}
|
|
77526
78562
|
|
|
78563
|
+
/**
|
|
78564
|
+
* Request parameters for patchEntityFacts operation in WorkspaceObjectControllerApi.
|
|
78565
|
+
* @export
|
|
78566
|
+
* @interface WorkspaceObjectControllerApiPatchEntityFactsRequest
|
|
78567
|
+
*/
|
|
78568
|
+
export declare interface WorkspaceObjectControllerApiPatchEntityFactsRequest {
|
|
78569
|
+
/**
|
|
78570
|
+
*
|
|
78571
|
+
* @type {string}
|
|
78572
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
78573
|
+
*/
|
|
78574
|
+
readonly workspaceId: string;
|
|
78575
|
+
/**
|
|
78576
|
+
*
|
|
78577
|
+
* @type {string}
|
|
78578
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
78579
|
+
*/
|
|
78580
|
+
readonly objectId: string;
|
|
78581
|
+
/**
|
|
78582
|
+
*
|
|
78583
|
+
* @type {JsonApiFactPatchDocument}
|
|
78584
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
78585
|
+
*/
|
|
78586
|
+
readonly jsonApiFactPatchDocument: JsonApiFactPatchDocument;
|
|
78587
|
+
/**
|
|
78588
|
+
* 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\').
|
|
78589
|
+
* @type {string}
|
|
78590
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
78591
|
+
*/
|
|
78592
|
+
readonly filter?: string;
|
|
78593
|
+
/**
|
|
78594
|
+
* 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.
|
|
78595
|
+
* @type {Array<'datasets' | 'dataset' | 'ALL'>}
|
|
78596
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityFacts
|
|
78597
|
+
*/
|
|
78598
|
+
readonly include?: Array<"datasets" | "dataset" | "ALL">;
|
|
78599
|
+
}
|
|
78600
|
+
|
|
77527
78601
|
/**
|
|
77528
78602
|
* Request parameters for patchEntityFilterContexts operation in WorkspaceObjectControllerApi.
|
|
77529
78603
|
* @export
|
|
@@ -77600,6 +78674,44 @@ export declare interface WorkspaceObjectControllerApiPatchEntityFilterViewsReque
|
|
|
77600
78674
|
readonly include?: Array<"analyticalDashboards" | "users" | "analyticalDashboard" | "user" | "ALL">;
|
|
77601
78675
|
}
|
|
77602
78676
|
|
|
78677
|
+
/**
|
|
78678
|
+
* Request parameters for patchEntityLabels operation in WorkspaceObjectControllerApi.
|
|
78679
|
+
* @export
|
|
78680
|
+
* @interface WorkspaceObjectControllerApiPatchEntityLabelsRequest
|
|
78681
|
+
*/
|
|
78682
|
+
export declare interface WorkspaceObjectControllerApiPatchEntityLabelsRequest {
|
|
78683
|
+
/**
|
|
78684
|
+
*
|
|
78685
|
+
* @type {string}
|
|
78686
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
78687
|
+
*/
|
|
78688
|
+
readonly workspaceId: string;
|
|
78689
|
+
/**
|
|
78690
|
+
*
|
|
78691
|
+
* @type {string}
|
|
78692
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
78693
|
+
*/
|
|
78694
|
+
readonly objectId: string;
|
|
78695
|
+
/**
|
|
78696
|
+
*
|
|
78697
|
+
* @type {JsonApiLabelPatchDocument}
|
|
78698
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
78699
|
+
*/
|
|
78700
|
+
readonly jsonApiLabelPatchDocument: JsonApiLabelPatchDocument;
|
|
78701
|
+
/**
|
|
78702
|
+
* 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\').
|
|
78703
|
+
* @type {string}
|
|
78704
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
78705
|
+
*/
|
|
78706
|
+
readonly filter?: string;
|
|
78707
|
+
/**
|
|
78708
|
+
* 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.
|
|
78709
|
+
* @type {Array<'attributes' | 'attribute' | 'ALL'>}
|
|
78710
|
+
* @memberof WorkspaceObjectControllerApiPatchEntityLabels
|
|
78711
|
+
*/
|
|
78712
|
+
readonly include?: Array<"attributes" | "attribute" | "ALL">;
|
|
78713
|
+
}
|
|
78714
|
+
|
|
77603
78715
|
/**
|
|
77604
78716
|
* Request parameters for patchEntityMemoryItems operation in WorkspaceObjectControllerApi.
|
|
77605
78717
|
* @export
|